fbc: promote package-level metdata from olm.csv.metadata to olm.package blob

Signed-off-by: Joe Lanford <[email protected]>

Author: joelanford

alpha/action/migrations/003_promote_package_metadata.go

@@ -0,0 +1,155 @@
+package migrations
+
+import (
+	"encoding/json"
+	"slices"
+	"strings"
+	"unicode"
+	"unicode/utf8"
+
+	"github.com/Masterminds/semver/v3"
+
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
+
+	"github.com/operator-framework/operator-registry/alpha/declcfg"
+	"github.com/operator-framework/operator-registry/alpha/property"
+)
+
+func promotePackageMetadata(cfg *declcfg.DeclarativeConfig) error {
+	metadataByPackage := map[string]promotedMetadata{}
+	for i := range cfg.Bundles {
+		b := &cfg.Bundles[i]
+
+		csvMetadata, csvMetadataIdx, err := getCsvMetadata(b)
+		if err != nil {
+			return err
+		}
+
+		// Skip objects that have no olm.csv.metadata property
+		if csvMetadata == nil {
+			continue
+		}
+
+		// Keep track of the metadata from the highest versioned bundle from each package.
+		cur, ok := metadataByPackage[b.Package]
+		if !ok || compareRegistryV1Semver(cur.version, b.Version) < 0 {
+			metadataByPackage[b.Package] = promotedCSVMetadata(b.Version, csvMetadata)
+		}
+
+		// Delete the package-level metadata from the olm.csv.metadata object and
+		// update the bundle properties to use the new slimmed-down revision of it.
+		csvMetadata.DisplayName = ""
+		delete(csvMetadata.Annotations, "description")
+		csvMetadata.Provider = v1alpha1.AppLink{}
+		csvMetadata.Maintainers = nil
+		csvMetadata.Links = nil
+		csvMetadata.Keywords = nil
+
+		newCSVMetadata, err := json.Marshal(csvMetadata)
+		if err != nil {
+			return err
+		}
+		b.Properties[csvMetadataIdx] = property.Property{
+			Type:  property.TypeCSVMetadata,
+			Value: newCSVMetadata,
+		}
+	}
+
+	// Update each olm.package object to include the metadata we extracted from
+	// bundles in the first loop.
+	for i := range cfg.Packages {
+		pkg := &cfg.Packages[i]
+		metadata, ok := metadataByPackage[pkg.Name]
+		if !ok {
+			continue
+		}
+		pkg.DisplayName = metadata.displayName
+		pkg.ShortDescription = shortenDescription(metadata.shortDescription)
+		if metadata.provider.Name != "" || metadata.provider.URL != "" {
+			pkg.Provider = &metadata.provider
+		}
+		pkg.Maintainers = metadata.maintainers
+		pkg.Links = metadata.links
+		pkg.Keywords = slices.DeleteFunc(metadata.keywords, func(s string) bool {
+			// Delete keywords that are empty strings
+			return s == ""
+		})
+	}
+	return nil
+}
+
+func getCsvMetadata(b *declcfg.Bundle) (*property.CSVMetadata, int, error) {
+	for i, p := range b.Properties {
+		if p.Type != property.TypeCSVMetadata {
+			continue
+		}
+		var csvMetadata property.CSVMetadata
+		if err := json.Unmarshal(p.Value, &csvMetadata); err != nil {
+			return nil, -1, err
+		}
+		return &csvMetadata, i, nil
+	}
+	return nil, -1, nil
+}
+
+func compareRegistryV1Semver(a, b *semver.Version) int {
+	if v := a.Compare(b); v != 0 {
+		return v
+	}
+	aPre := semver.New(0, 0, 0, a.Metadata(), "")
+	bPre := semver.New(0, 0, 0, b.Metadata(), "")
+	return aPre.Compare(bPre)
+}
+
+type promotedMetadata struct {
+	version *semver.Version
+
+	displayName      string
+	shortDescription string
+	provider         v1alpha1.AppLink
+	maintainers      []v1alpha1.Maintainer
+	links            []v1alpha1.AppLink
+	keywords         []string
+}
+
+func promotedCSVMetadata(version *semver.Version, metadata *property.CSVMetadata) promotedMetadata {
+	return promotedMetadata{
+		version:          version,
+		displayName:      metadata.DisplayName,
+		shortDescription: metadata.Annotations["description"],
+		provider:         metadata.Provider,
+		maintainers:      metadata.Maintainers,
+		links:            metadata.Links,
+		keywords:         metadata.Keywords,
+	}
+}
+
+func shortenDescription(input string) string {
+	const maxLen = 256
+	input = strings.TrimSpace(input)
+
+	// If the input is already under the limit return it.
+	if utf8.RuneCountInString(input) <= maxLen {
+		return input
+	}
+
+	// Chop off everything after the first paragraph.
+	if idx := strings.Index(input, "\n\n"); idx != -1 {
+		input = strings.TrimSpace(input[:idx])
+	}
+
+	// If we're _now_ under the limit, return the first paragraph.
+	if utf8.RuneCountInString(input) <= maxLen {
+		return input
+	}
+
+	// If the first paragraph is still over the limit, we'll have to truncate.
+	// We'll truncate at the last word boundary that still allows an ellipsis
+	// to fit within the maximum length. But if there are no word boundaries
+	// (veeeeery unlikely), we'll hard truncate mid-word.
+	input = input[:maxLen-3]
+	if truncatedIdx := strings.LastIndexFunc(input, unicode.IsSpace); truncatedIdx != -1 {
+		return input[:truncatedIdx] + "..."
+	}
+	return input + "..."
+}

alpha/action/migrations/migrations.go

@@ -56,6 +56,7 @@ var allMigrations = []Migration{
 	newMigration("bundle-object-to-csv-metadata", `migrates bundles' "olm.bundle.object" to "olm.csv.metadata"`, bundleObjectToCSVMetadata),
 	newMigration("split-icon", `split package icon out into separate "olm.icon" blob`, splitIcon),
 	newMigration("promote-bundle-version", `promote bundle version into first-class bundle field, remove olm.package properties`, promoteBundleVersion),
+	newMigration("promote-package-metadata", `promote package metadata from "olm.csv.metadata" properties to "olm.package" blob`, promotePackageMetadata),
 }
 
 func NewMigrations(name string) (*Migrations, error) {

alpha/action/migrations/migrations_test.go

@@ -37,8 +37,9 @@ func TestMigrations(t *testing.T) {
 			}
 			return nil
 		},
-		MigrationToken("split-icon"):             func(d *declcfg.DeclarativeConfig) error { return nil },
-		MigrationToken("promote-bundle-version"): func(d *declcfg.DeclarativeConfig) error { return nil },
+		MigrationToken("split-icon"):               func(d *declcfg.DeclarativeConfig) error { return nil },
+		MigrationToken("promote-bundle-version"):   func(d *declcfg.DeclarativeConfig) error { return nil },
+		MigrationToken("promote-package-metadata"): func(d *declcfg.DeclarativeConfig) error { return nil },
 	}
 
 	tests := []struct {

alpha/declcfg/declcfg.go

@@ -11,6 +11,8 @@ import (
 	utilerrors "k8s.io/apimachinery/pkg/util/errors"
 	"k8s.io/apimachinery/pkg/util/sets"
 
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
+
 	"github.com/operator-framework/operator-registry/alpha/property"
 	prettyunmarshaler "github.com/operator-framework/operator-registry/pkg/prettyunmarshaler"
 )
@@ -33,9 +35,15 @@ type DeclarativeConfig struct {
 }
 
 type Package struct {
-	Schema         string `json:"schema"`
-	Name           string `json:"name"`
-	DefaultChannel string `json:"defaultChannel"`
+	Schema           string                `json:"schema"`
+	Name             string                `json:"name"`
+	DisplayName      string                `json:"displayName,omitempty"`
+	ShortDescription string                `json:"shortDescription,omitempty"`
+	Provider         *v1alpha1.AppLink     `json:"provider,omitempty"`
+	Maintainers      []v1alpha1.Maintainer `json:"maintainers,omitempty"`
+	Links            []v1alpha1.AppLink    `json:"links,omitempty"`
+	Keywords         []string              `json:"keywords,omitempty"`
+	DefaultChannel   string                `json:"defaultChannel"`
 
 	// Deprecated: It is no longer recommended to embed an icon in the package.
 	//   Instead, use separate a Icon item alongside the Package.

alpha/declcfg/declcfg_to_model.go

@@ -31,6 +31,13 @@ func ConvertToModel(cfg DeclarativeConfig) (model.Model, error) {
 			Name:        p.Name,
 			Description: p.Description,
 			Channels:    map[string]*model.Channel{},
+
+			DisplayName:      p.DisplayName,
+			ShortDescription: p.ShortDescription,
+			Provider:         p.Provider,
+			Maintainers:      p.Maintainers,
+			Links:            p.Links,
+			Keywords:         p.Keywords,
 		}
 		if p.Icon != nil {
 			mpkg.Icon = &model.Icon{

alpha/model/model.go

@@ -14,6 +14,8 @@ import (
 	"golang.org/x/exp/maps"
 	"k8s.io/apimachinery/pkg/util/sets"
 
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
+
 	"github.com/operator-framework/operator-registry/alpha/property"
 )
 
@@ -51,6 +53,13 @@ type Package struct {
 	DefaultChannel *Channel
 	Channels       map[string]*Channel
 	Deprecation    *Deprecation
+
+	DisplayName      string
+	ShortDescription string
+	Provider         *v1alpha1.AppLink
+	Maintainers      []v1alpha1.Maintainer
+	Links            []v1alpha1.AppLink
+	Keywords         []string
 }
 
 func (m *Package) Validate() error {
@@ -60,6 +69,26 @@ func (m *Package) Validate() error {
 		result.subErrors = append(result.subErrors, errors.New("package name must not be empty"))
 	}
 
+	if len(m.ShortDescription) > 256 {
+		result.subErrors = append(result.subErrors, fmt.Errorf("short description must not be more than 128 characters, found %d characters", len(m.ShortDescription)))
+	}
+
+	for i, maintainer := range m.Maintainers {
+		if maintainer.Name == "" && maintainer.Email == "" {
+			result.subErrors = append(result.subErrors, fmt.Errorf("maintainer at index %d must not be empty", i))
+		}
+	}
+	for i, link := range m.Links {
+		if link.Name == "" && link.URL == "" {
+			result.subErrors = append(result.subErrors, fmt.Errorf("link at index %d must not be empty", i))
+		}
+	}
+	for i, keyword := range m.Keywords {
+		if keyword == "" {
+			result.subErrors = append(result.subErrors, fmt.Errorf("keyword at index %d must not be empty", i))
+		}
+	}
+
 	if err := m.Icon.Validate(); err != nil {
 		result.subErrors = append(result.subErrors, err)
 	}

pkg/api/model_to_api.go

@@ -23,26 +23,7 @@ func ConvertModelBundleToAPIBundle(b model.Bundle) (*Bundle, error) {
 
 	csvJSON := b.CsvJSON
 	if csvJSON == "" && len(props.CSVMetadatas) == 1 {
-		var icons []v1alpha1.Icon
-		if b.Package.Icon != nil {
-			icons = []v1alpha1.Icon{{
-				Data:      base64.StdEncoding.EncodeToString(b.Package.Icon.Data),
-				MediaType: b.Package.Icon.MediaType,
-			}}
-		}
-		csv := csvMetadataToCsv(props.CSVMetadatas[0])
-		csv.Name = b.Name
-		csv.Spec.Icon = icons
-		csv.Spec.InstallStrategy = v1alpha1.NamedInstallStrategy{
-			// This stub is required to avoid a panic in OLM's package server that results in
-			// attemptint to write to a nil map.
-			StrategyName: "deployment",
-		}
-		csv.Spec.Version = version.OperatorVersion{Version: b.Version}
-		csv.Spec.RelatedImages = convertModelRelatedImagesToCSVRelatedImages(b.RelatedImages)
-		if csv.Spec.Description == "" {
-			csv.Spec.Description = b.Package.Description
-		}
+		csv := newSyntheticCSV(b)
 		csvData, err := json.Marshal(csv)
 		if err != nil {
 			return nil, err
@@ -101,29 +82,74 @@ func parseProperties(in []property.Property) (*property.Properties, error) {
 	return props, nil
 }
 
-func csvMetadataToCsv(m property.CSVMetadata) v1alpha1.ClusterServiceVersion {
+func newSyntheticCSV(b model.Bundle) v1alpha1.ClusterServiceVersion {
+	pkg := b.Package
+	csvMetadata := b.PropertiesP.CSVMetadatas[0]
+
+	var icons []v1alpha1.Icon
+	if pkg.Icon != nil {
+		icons = []v1alpha1.Icon{{
+			Data:      base64.StdEncoding.EncodeToString(pkg.Icon.Data),
+			MediaType: pkg.Icon.MediaType,
+		}}
+	}
+
+	// Copy package-level metadata into CSV if fields are unset in CSV
+	if csvMetadata.DisplayName == "" {
+		csvMetadata.DisplayName = pkg.DisplayName
+	}
+	if _, ok := csvMetadata.Annotations["description"]; !ok {
+		csvMetadata.Annotations["description"] = pkg.ShortDescription
+	}
+	if csvMetadata.Description == "" {
+		csvMetadata.Description = pkg.Description
+	}
+	if csvMetadata.Provider.Name == "" && csvMetadata.Provider.URL == "" && pkg.Provider != nil {
+		csvMetadata.Provider = *pkg.Provider
+	}
+	if csvMetadata.Maintainers == nil {
+		csvMetadata.Maintainers = pkg.Maintainers
+	}
+	if csvMetadata.Links == nil {
+		csvMetadata.Links = pkg.Links
+	}
+	if csvMetadata.Keywords == nil {
+		csvMetadata.Keywords = pkg.Keywords
+	}
+
+	// Return syntheticly generated CSV
 	return v1alpha1.ClusterServiceVersion{
 		TypeMeta: metav1.TypeMeta{
 			Kind:       operators.ClusterServiceVersionKind,
 			APIVersion: v1alpha1.ClusterServiceVersionAPIVersion,
 		},
 		ObjectMeta: metav1.ObjectMeta{
-			Annotations: m.Annotations,
-			Labels:      m.Labels,
+			Name:        b.Name,
+			Annotations: csvMetadata.Annotations,
+			Labels:      csvMetadata.Labels,
 		},
 		Spec: v1alpha1.ClusterServiceVersionSpec{
-			APIServiceDefinitions:     m.APIServiceDefinitions,
-			CustomResourceDefinitions: m.CustomResourceDefinitions,
-			Description:               m.Description,
-			DisplayName:               m.DisplayName,
-			InstallModes:              m.InstallModes,
-			Keywords:                  m.Keywords,
-			Links:                     m.Links,
-			Maintainers:               m.Maintainers,
-			Maturity:                  m.Maturity,
-			MinKubeVersion:            m.MinKubeVersion,
-			NativeAPIs:                m.NativeAPIs,
-			Provider:                  m.Provider,
+			APIServiceDefinitions:     csvMetadata.APIServiceDefinitions,
+			CustomResourceDefinitions: csvMetadata.CustomResourceDefinitions,
+			Description:               csvMetadata.Description,
+			DisplayName:               csvMetadata.DisplayName,
+			InstallModes:              csvMetadata.InstallModes,
+			Keywords:                  csvMetadata.Keywords,
+			Links:                     csvMetadata.Links,
+			Maintainers:               csvMetadata.Maintainers,
+			Maturity:                  csvMetadata.Maturity,
+			MinKubeVersion:            csvMetadata.MinKubeVersion,
+			NativeAPIs:                csvMetadata.NativeAPIs,
+			Provider:                  csvMetadata.Provider,
+
+			Icon: icons,
+			InstallStrategy: v1alpha1.NamedInstallStrategy{
+				// This stub is required to avoid a panic in OLM's package server that results in
+				// attemptint to write to a nil map.
+				StrategyName: "deployment",
+			},
+			Version:       version.OperatorVersion{Version: b.Version},
+			RelatedImages: convertModelRelatedImagesToCSVRelatedImages(b.RelatedImages),
 		},
 	}
 }