Fix autogen to fail-open on missing asset manifests (#4)
Reviewed-on: #4 Co-authored-by: vickydotbat <vickydotbat@tutamail.com> Co-committed-by: vickydotbat <vickydotbat@tutamail.com>
This commit was merged in pull request #4.
This commit is contained in:
+132
-26
@@ -3,6 +3,7 @@ package topdata
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
@@ -16,6 +17,19 @@ import (
|
||||
|
||||
const autogenManifestCacheMaxAge = time.Hour
|
||||
|
||||
// errAutogenManifestUnavailable marks a released autogen manifest that could not
|
||||
// be located or fetched (network failure, missing release/asset, empty payload,
|
||||
// or an undeterminable sow-assets repo). It is deliberately distinct from an
|
||||
// asset that was found but reports a row removed: for an optional consumer this
|
||||
// sentinel triggers a fail-open path that *preserves* the consumer's existing
|
||||
// pinned lock entries instead of pruning them, so StrRef/row IDs are not
|
||||
// reshuffled while the asset source is merely temporarily out of reach.
|
||||
var errAutogenManifestUnavailable = errors.New("autogen manifest unavailable")
|
||||
|
||||
func unavailableAutogenManifest(err error) error {
|
||||
return fmt.Errorf("%w: %w", errAutogenManifestUnavailable, err)
|
||||
}
|
||||
|
||||
type autogenManifest struct {
|
||||
ID string `json:"id"`
|
||||
Repo string `json:"repo"`
|
||||
@@ -61,9 +75,18 @@ func applyAutogenConsumers(p *project.Project, collected []nativeCollectedDatase
|
||||
}
|
||||
manifest, err := resolveAutogenConsumerManifest(p, consumer, progress)
|
||||
if err != nil {
|
||||
if consumer.Optional && isIgnorableOptionalAutogenError(err) {
|
||||
if consumer.Optional && errors.Is(err, errAutogenManifestUnavailable) {
|
||||
// Fail open: the asset manifest is merely unreachable, not
|
||||
// authoritatively empty. Build without its rows, but keep the
|
||||
// consumer's already-pinned lock entries so their IDs are not
|
||||
// freed and reshuffled on a later build once the asset returns.
|
||||
preserved, perr := preserveAutogenConsumerLockEntries(result, consumer)
|
||||
if perr != nil {
|
||||
return nil, perr
|
||||
}
|
||||
result = preserved
|
||||
if progress != nil {
|
||||
progress(fmt.Sprintf("Skipping optional autogen consumer %s: %v", consumer.ID, err))
|
||||
progress(fmt.Sprintf("Autogen consumer %s: released manifest unavailable (%v); preserving existing lock entries, generating no new rows", consumer.ID, err))
|
||||
}
|
||||
continue
|
||||
}
|
||||
@@ -90,32 +113,115 @@ func applyAutogenConsumers(p *project.Project, collected []nativeCollectedDatase
|
||||
|
||||
func autogenConsumerTargetsCollectedDataset(collected []nativeCollectedDataset, consumer project.AutogenConsumerConfig) bool {
|
||||
for _, dataset := range collected {
|
||||
switch consumer.Mode {
|
||||
case "parts_rows":
|
||||
if isAutogenEligiblePartsDataset(dataset) {
|
||||
return true
|
||||
}
|
||||
case "accessory_visualeffects":
|
||||
if dataset.Dataset.Name == "visualeffects" {
|
||||
return true
|
||||
}
|
||||
case "cachedmodels_rows":
|
||||
if dataset.Dataset.Name == "cachedmodels" {
|
||||
return true
|
||||
}
|
||||
if autogenConsumerTargetsDataset(dataset, consumer) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func isIgnorableOptionalAutogenError(err error) bool {
|
||||
if err == nil {
|
||||
// preserveAutogenConsumerLockEntries restores the lock keys that an autogen
|
||||
// consumer owns from the on-disk lockfile back into the in-memory dataset,
|
||||
// reusing this build's already-collected (and pruned) state. It is called only
|
||||
// when the consumer's released manifest is unavailable, so the rows themselves
|
||||
// are not regenerated; we just keep the key->ID pins alive. Keys are matched
|
||||
// against the consumer's own naming policy so unrelated (authored) rows that were
|
||||
// legitimately removed are not resurrected.
|
||||
func preserveAutogenConsumerLockEntries(collected []nativeCollectedDataset, consumer project.AutogenConsumerConfig) ([]nativeCollectedDataset, error) {
|
||||
matches := autogenConsumerManagedLockKeyMatcher(consumer)
|
||||
if matches == nil {
|
||||
// No managed-key matcher for this mode: nothing safe to preserve.
|
||||
return collected, nil
|
||||
}
|
||||
|
||||
result := append([]nativeCollectedDataset(nil), collected...)
|
||||
for i, dataset := range result {
|
||||
if !autogenConsumerTargetsDataset(dataset, consumer) {
|
||||
continue
|
||||
}
|
||||
if strings.TrimSpace(dataset.Dataset.LockPath) == "" {
|
||||
continue
|
||||
}
|
||||
onDisk, err := loadLockfile(dataset.Dataset.LockPath)
|
||||
if err != nil {
|
||||
// No readable lockfile means there is nothing pinned to preserve.
|
||||
continue
|
||||
}
|
||||
lockData := dataset.LockData
|
||||
if lockData == nil {
|
||||
lockData = map[string]int{}
|
||||
}
|
||||
restored := 0
|
||||
for key, rowID := range onDisk {
|
||||
if _, present := lockData[key]; present {
|
||||
continue
|
||||
}
|
||||
if !matches(key) {
|
||||
continue
|
||||
}
|
||||
lockData[key] = rowID
|
||||
restored++
|
||||
}
|
||||
if restored == 0 {
|
||||
continue
|
||||
}
|
||||
result[i].LockData = lockData
|
||||
result[i].LockModified = !lockDataEqual(onDisk, lockData)
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// autogenConsumerManagedLockKeyMatcher returns a predicate identifying the lock
|
||||
// keys an autogen consumer is responsible for, or nil for modes whose keys we
|
||||
// cannot scope precisely (in which case preservation is skipped rather than
|
||||
// risk resurrecting unrelated keys).
|
||||
func autogenConsumerManagedLockKeyMatcher(consumer project.AutogenConsumerConfig) func(string) bool {
|
||||
switch consumer.Mode {
|
||||
case "accessory_visualeffects":
|
||||
policy := resolveHeadVisualeffectsPolicy(consumer, nil)
|
||||
delimiter := policy.Delimiter
|
||||
if delimiter == "" {
|
||||
delimiter = "/"
|
||||
}
|
||||
prefix := "visualeffects:"
|
||||
groups := make(map[string]struct{}, len(policy.Groups))
|
||||
for group, groupPolicy := range policy.Groups {
|
||||
token := applyHeadVisualeffectCase(headVisualeffectGroupToken(group, groupPolicy, policy), policy)
|
||||
if strings.TrimSpace(token) != "" {
|
||||
groups[token] = struct{}{}
|
||||
}
|
||||
}
|
||||
if len(groups) == 0 {
|
||||
return nil
|
||||
}
|
||||
return func(key string) bool {
|
||||
if !strings.HasPrefix(key, prefix) {
|
||||
return false
|
||||
}
|
||||
rest := key[len(prefix):]
|
||||
idx := strings.Index(rest, delimiter)
|
||||
if idx <= 0 {
|
||||
return false
|
||||
}
|
||||
_, ok := groups[rest[:idx]]
|
||||
return ok
|
||||
}
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
func autogenConsumerTargetsDataset(dataset nativeCollectedDataset, consumer project.AutogenConsumerConfig) bool {
|
||||
switch consumer.Mode {
|
||||
case "parts_rows":
|
||||
return isAutogenEligiblePartsDataset(dataset)
|
||||
case "accessory_visualeffects":
|
||||
return dataset.Dataset.Name == "visualeffects"
|
||||
case "cachedmodels_rows":
|
||||
return dataset.Dataset.Name == "cachedmodels"
|
||||
default:
|
||||
return false
|
||||
}
|
||||
message := err.Error()
|
||||
return strings.Contains(message, "HTTP 404") ||
|
||||
strings.Contains(message, "not found") ||
|
||||
strings.Contains(message, "entries is empty")
|
||||
}
|
||||
|
||||
func resolveAutogenConsumerManifest(p *project.Project, consumer project.AutogenConsumerConfig, progress func(string)) (*autogenManifest, error) {
|
||||
@@ -366,14 +472,14 @@ func resolveReleasedAutogenManifest(p *project.Project, consumer project.Autogen
|
||||
|
||||
spec, err := deriveSowAssetsRepoSpec(p)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
return nil, unavailableAutogenManifest(err)
|
||||
}
|
||||
manifestURL, err := resolveAutogenManifestAssetURL(spec, consumer.Manifest.ReleaseTag, consumer.Manifest.AssetName)
|
||||
if err != nil {
|
||||
if consumer.Mode == "parts_rows" {
|
||||
return nil, fmt.Errorf("%s", strings.Replace(err.Error(), "autogen manifest", "parts manifest", 1))
|
||||
return nil, unavailableAutogenManifest(fmt.Errorf("%s", strings.Replace(err.Error(), "autogen manifest", "parts manifest", 1)))
|
||||
}
|
||||
return nil, err
|
||||
return nil, unavailableAutogenManifest(err)
|
||||
}
|
||||
if progress != nil {
|
||||
progress(fmt.Sprintf("Fetching released autogen manifest from %s...", manifestURL))
|
||||
@@ -381,9 +487,9 @@ func resolveReleasedAutogenManifest(p *project.Project, consumer project.Autogen
|
||||
manifest, err := fetchAutogenManifest(manifestURL)
|
||||
if err != nil {
|
||||
if consumer.Mode == "parts_rows" {
|
||||
return nil, fmt.Errorf("%s", strings.Replace(err.Error(), "autogen manifest", "parts manifest", 1))
|
||||
return nil, unavailableAutogenManifest(fmt.Errorf("%s", strings.Replace(err.Error(), "autogen manifest", "parts manifest", 1)))
|
||||
}
|
||||
return nil, err
|
||||
return nil, unavailableAutogenManifest(err)
|
||||
}
|
||||
if manifest.ID != "" && manifest.ID != consumer.Producer {
|
||||
return nil, fmt.Errorf("autogen manifest %s declared id %q, expected %q", consumer.Manifest.AssetName, manifest.ID, consumer.Producer)
|
||||
|
||||
Reference in New Issue
Block a user