review updates from #1986

Signed-off-by: grokspawn <jordan@nimblewidget.com>

Author: grokspawn

AGENTS.md

@@ -105,13 +105,13 @@ opm render quay.io/my-namespace/my-bundle:v1.0.0 quay.io/my-namespace/my-bundle:
 ### 3. Working with Declarative Config
 ```go
 // Load declarative config
-cfg, err := declcfg.LoadFS(os.DirFS("path/to/catalog"))
+cfg, err := declcfg.LoadFS(ctx, os.DirFS("path/to/catalog"))
 
-// Convert to model
-model, err := declcfg.ConvertToModel(cfg)
+// Validate the config
+err = declcfg.Validate(*cfg)
 
-// Write declarative config
-err = declcfg.Write(cfg, "output.yaml")
+// Write declarative config to filesystem
+err = declcfg.WriteFS(*cfg, "output-dir", declcfg.WriteYAML, ".yaml")
 ```
 
 ### 4. Serving Catalog Content with `opm serve`

alpha/action/list.go

@@ -72,7 +72,7 @@ func getDisplayName(pkg declcfg.Package, channels []declcfg.Channel, bundles []d
 	}
 
 	// Find the head bundle
-	head, err := findChannelHead(defaultCh.Entries)
+	head, err := declcfg.FindChannelHead(defaultCh.Entries)
 	if err != nil {
 		return ""
 	}
@@ -96,41 +96,6 @@ func getDisplayName(pkg declcfg.Package, channels []declcfg.Channel, bundles []d
 	return csv.Spec.DisplayName
 }
 
-// findChannelHead finds the head bundle of a channel by analyzing the replaces chain.
-func findChannelHead(entries []declcfg.ChannelEntry) (string, error) {
-	if len(entries) == 0 {
-		return "", fmt.Errorf("channel has no entries")
-	}
-
-	// Build a map of bundles that are replaced
-	replaced := make(map[string]bool)
-	for _, entry := range entries {
-		if entry.Replaces != "" {
-			replaced[entry.Replaces] = true
-		}
-		for _, skip := range entry.Skips {
-			replaced[skip] = true
-		}
-	}
-
-	// Find bundles that are not replaced by anything
-	var heads []string
-	for _, entry := range entries {
-		if !replaced[entry.Name] {
-			heads = append(heads, entry.Name)
-		}
-	}
-
-	if len(heads) == 0 {
-		return "", fmt.Errorf("channel has circular replaces chain, no head found")
-	}
-	if len(heads) > 1 {
-		return "", fmt.Errorf("channel has multiple heads: %v", heads)
-	}
-
-	return heads[0], nil
-}
-
 type ListChannels struct {
 	IndexReference string
 	PackageName    string
@@ -168,7 +133,7 @@ func (r *ListChannelsResult) WriteColumns(w io.Writer) error {
 	}
 	for _, ch := range r.Channels {
 		headStr := ""
-		head, err := findChannelHead(ch.Entries)
+		head, err := declcfg.FindChannelHead(ch.Entries)
 		if err != nil {
 			headStr = fmt.Sprintf("ERROR: %s", err)
 		} else {

alpha/declcfg/api_conversions.go

@@ -18,24 +18,36 @@ import (
 )
 
 // ConvertBundleToAPIBundle converts a declcfg.Bundle to an api.Bundle.
-// The pkg and channels parameters provide context needed for the conversion.
-func ConvertBundleToAPIBundle(b Bundle, pkg Package, channels []Channel) (*api.Bundle, error) {
+// The pkg, channels, and deprecations parameters provide context needed for the conversion.
+// api.Bundle can only represent one channel, so the first matching channel is used.
+func ConvertBundleToAPIBundle(b Bundle, pkg Package, channels []Channel, deprecations []Deprecation) (*api.Bundle, error) {
 	props, err := parseProperties(b.Properties)
 	if err != nil {
 		return nil, fmt.Errorf("parse properties: %v", err)
 	}
 
 	csvJSON := generateCSVJSON(b, pkg, props)
+	objects := b.Objects
+	if len(objects) == 0 && csvJSON != "" {
+		objects = []string{csvJSON}
+	}
 
-	// Find which channel this bundle belongs to
-	channelName := ""
+	// Find which channel this bundle belongs to and get its entry data.
+	// api.Bundle can only represent one channel, so use the first match.
+	var channelName string
+	var replaces string
+	var skips []string
+	var skipRange string
 	for _, ch := range channels {
 		if ch.Package != b.Package {
 			continue
 		}
 		for _, entry := range ch.Entries {
 			if entry.Name == b.Name {
 				channelName = ch.Name
+				replaces = entry.Replaces
+				skips = entry.Skips
+				skipRange = entry.SkipRange
 				break
 			}
 		}
@@ -44,22 +56,21 @@ func ConvertBundleToAPIBundle(b Bundle, pkg Package, channels []Channel) (*api.B
 		}
 	}
 
-	// Get replaces and skips from channel entry
-	var replaces string
-	var skips []string
-	var skipRange string
-	for _, ch := range channels {
-		if ch.Package != b.Package {
+	// Find bundle deprecation
+	var deprecation *api.Deprecation
+	for _, d := range deprecations {
+		if d.Package != b.Package {
 			continue
 		}
-		for _, entry := range ch.Entries {
-			if entry.Name == b.Name {
-				replaces = entry.Replaces
-				skips = entry.Skips
-				skipRange = entry.SkipRange
+		for _, entry := range d.Entries {
+			if entry.Reference.Schema == SchemaBundle && entry.Reference.Name == b.Name {
+				deprecation = &api.Deprecation{Message: entry.Message}
 				break
 			}
 		}
+		if deprecation != nil {
+			break
+		}
 	}
 
 	apiDeps, err := convertPropertiesToAPIDependencies(b.Properties)
@@ -81,7 +92,8 @@ func ConvertBundleToAPIBundle(b Bundle, pkg Package, channels []Channel) (*api.B
 		Replaces:     replaces,
 		Skips:        skips,
 		CsvJson:      csvJSON,
-		Object:       b.Objects,
+		Object:       objects,
+		Deprecation:  deprecation,
 	}, nil
 }
 
@@ -95,11 +107,7 @@ func generateCSVJSON(b Bundle, pkg Package, props *property.Properties) string {
 	if err != nil {
 		return b.CsvJSON
 	}
-	csvJSON := string(csvData)
-	if len(b.Objects) == 0 {
-		b.Objects = []string{csvJSON}
-	}
-	return csvJSON
+	return string(csvData)
 }
 
 func buildCSV(b Bundle, pkg Package, props *property.Properties) *v1alpha1.ClusterServiceVersion {

alpha/declcfg/declcfg.go

@@ -61,6 +61,40 @@ type ChannelEntry struct {
 	SkipRange string   `json:"skipRange,omitempty"`
 }
 
+// FindChannelHead returns the name of the head entry in the channel — the entry
+// that is not replaced or skipped by any other entry.
+func FindChannelHead(entries []ChannelEntry) (string, error) {
+	if len(entries) == 0 {
+		return "", fmt.Errorf("channel has no entries")
+	}
+
+	replaced := make(map[string]bool)
+	for _, entry := range entries {
+		if entry.Replaces != "" {
+			replaced[entry.Replaces] = true
+		}
+		for _, skip := range entry.Skips {
+			replaced[skip] = true
+		}
+	}
+
+	var heads []string
+	for _, entry := range entries {
+		if !replaced[entry.Name] {
+			heads = append(heads, entry.Name)
+		}
+	}
+
+	if len(heads) == 0 {
+		return "", fmt.Errorf("channel has circular replaces chain, no head found")
+	}
+	if len(heads) > 1 {
+		return "", fmt.Errorf("channel has multiple heads: %v", heads)
+	}
+
+	return heads[0], nil
+}
+
 // Bundle specifies all metadata and data of a bundle object.
 // Top-level fields are the source of truth, i.e. not CSV values.
 //

pkg/cache/cache.go

@@ -428,13 +428,14 @@ func (c *cache) processPackage(ctx context.Context, reader io.Reader) (packageIn
 			}
 		}
 
-		apiBundle, err := declcfg.ConvertBundleToAPIBundle(b, *pkg, relevantChannels)
-		if err != nil {
-			return nil, fmt.Errorf("convert bundle %q: %v", b.Name, err)
-		}
-
-		// Store the bundle for each channel it appears in
+		// Convert and store the bundle for each channel it appears in.
+		// Each channel may have different replaces/skips for the same bundle,
+		// so we convert once per channel.
 		for _, ch := range relevantChannels {
+			apiBundle, err := declcfg.ConvertBundleToAPIBundle(b, *pkg, []declcfg.Channel{ch}, pkgFbc.Deprecations)
+			if err != nil {
+				return nil, fmt.Errorf("convert bundle %q: %v", b.Name, err)
+			}
 			if err := c.backend.PutBundle(ctx, bundleKey{b.Package, ch.Name, b.Name}, apiBundle); err != nil {
 				return nil, fmt.Errorf("store bundle %q: %v", b.Name, err)
 			}

pkg/cache/json_test.go

@@ -28,7 +28,7 @@ func TestJSON_StableDigest(t *testing.T) {
 	//
 	// If validFS needs to change DO NOT CHANGE the json cache implementation
 	// in the same pull request.
-	require.Equal(t, "976864aa02f6a581", actualDigest)
+	require.Equal(t, "9adad9ff6cf54e4f", actualDigest)
 }
 
 func TestJSON_CheckIntegrity(t *testing.T) {

pkg/cache/pkgs.go

@@ -228,7 +228,7 @@ func packagesFromDeclcfg(cfg declcfg.DeclarativeConfig) (map[string]cPkg, error)
 		}
 
 		// Find the head of this channel
-		head, err := findChannelHead(ch.Entries)
+		head, err := declcfg.FindChannelHead(ch.Entries)
 		if err != nil {
 			return nil, fmt.Errorf("find head for channel %q in package %q: %v", ch.Name, ch.Package, err)
 		}
@@ -283,42 +283,6 @@ func packagesFromDeclcfg(cfg declcfg.DeclarativeConfig) (map[string]cPkg, error)
 	return pkgs, nil
 }
 
-// findChannelHead finds the head bundle of a channel by analyzing the replaces chain.
-// The head is the bundle that is not replaced by any other bundle in the channel.
-func findChannelHead(entries []declcfg.ChannelEntry) (string, error) {
-	if len(entries) == 0 {
-		return "", fmt.Errorf("channel has no entries")
-	}
-
-	// Build a map of bundles that are replaced
-	replaced := make(map[string]bool)
-	for _, entry := range entries {
-		if entry.Replaces != "" {
-			replaced[entry.Replaces] = true
-		}
-		for _, skip := range entry.Skips {
-			replaced[skip] = true
-		}
-	}
-
-	// Find bundles that are not replaced by anything
-	var heads []string
-	for _, entry := range entries {
-		if !replaced[entry.Name] {
-			heads = append(heads, entry.Name)
-		}
-	}
-
-	if len(heads) == 0 {
-		return "", fmt.Errorf("channel has circular replaces chain, no head found")
-	}
-	if len(heads) > 1 {
-		return "", fmt.Errorf("channel has multiple heads: %v", heads)
-	}
-
-	return heads[0], nil
-}
-
 func bundleReplaces(b cBundle, name string) bool {
 	if b.Replaces == name {
 		return true

pkg/cache/pogrebv1_test.go

@@ -28,7 +28,7 @@ func TestPogrebV1_StableDigest(t *testing.T) {
 	//
 	// If validFS needs to change DO NOT CHANGE the json cache implementation
 	// in the same pull request.
-	require.Equal(t, "3cc6655887a2d5ce", actualDigest)
+	require.Equal(t, "485a767449dd66d4", actualDigest)
 }
 
 func TestPogrebV1_CheckIntegrity(t *testing.T) {