Fix: installed bundle provider

The installed bundle provider, which is necessary for safely handling
package upgrades, was too strict. It required the currently installed
bundle to exist in the catalog in order to "find" the installed bundle.

This is problematic in several  situations:
- If a user receives a catalog update that no longer contains their
  installed bundle (perhaps its was pulled from the catalog for security
  or policy reasons)
- If a user is trying to transition to a different catalog that provides
  that package
- If a bundle was directly installed, and the user is trying to have a
  catalog-backed ClusterExtension adopt it.

This change simply returns the name and version of the installed bundle,
and makes some minor changes in the successors functions to handle the
simplified installed bundle metadata.

Author: joelanford

internal/catalogmetadata/filter/bundle_predicates.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/operator-framework/operator-registry/alpha/declcfg"
 
+	ocv1alpha1 "github.com/operator-framework/operator-controller/api/v1alpha1"
 	"github.com/operator-framework/operator-controller/internal/catalogmetadata"
 )
 
@@ -66,7 +67,7 @@ func WithBundleName(bundleName string) Predicate[catalogmetadata.Bundle] {
 	}
 }
 
-func LegacySuccessor(installedBundle *catalogmetadata.Bundle) Predicate[catalogmetadata.Bundle] {
+func LegacySuccessor(installedBundle *ocv1alpha1.BundleMetadata) Predicate[catalogmetadata.Bundle] {
 	isSuccessor := func(candidateBundleEntry declcfg.ChannelEntry) bool {
 		if candidateBundleEntry.Replaces == installedBundle.Name {
 			return true
@@ -77,9 +78,9 @@ func LegacySuccessor(installedBundle *catalogmetadata.Bundle) Predicate[catalogm
 			}
 		}
 		if candidateBundleEntry.SkipRange != "" {
-			installedBundleVersion, _ := installedBundle.Version()
-			skipRange, _ := bsemver.ParseRange(candidateBundleEntry.SkipRange)
-			if installedBundleVersion != nil && skipRange != nil && skipRange(*installedBundleVersion) {
+			installedBundleVersion, vErr := bsemver.Parse(installedBundle.Version)
+			skipRange, srErr := bsemver.ParseRange(candidateBundleEntry.SkipRange)
+			if vErr == nil && srErr == nil && skipRange(installedBundleVersion) {
 				return true
 			}
 		}

internal/catalogmetadata/filter/bundle_predicates_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/operator-framework/operator-registry/alpha/declcfg"
 	"github.com/operator-framework/operator-registry/alpha/property"
 
+	ocv1alpha1 "github.com/operator-framework/operator-controller/api/v1alpha1"
 	"github.com/operator-framework/operator-controller/internal/catalogmetadata"
 	"github.com/operator-framework/operator-controller/internal/catalogmetadata/filter"
 )
@@ -150,13 +151,9 @@ func TestLegacySuccessor(t *testing.T) {
 			},
 		},
 	}
-	installedBundle := &catalogmetadata.Bundle{
-		Bundle: declcfg.Bundle{
-			Name: "package1.v0.0.1",
-			Properties: []property.Property{
-				{Type: property.TypePackage, Value: json.RawMessage(`{"packageName": "package1", "version": "0.0.1"}`)},
-			},
-		},
+	installedBundle := &ocv1alpha1.BundleMetadata{
+		Name:    "package1.v0.0.1",
+		Version: "0.0.1",
 	}
 
 	b2 := &catalogmetadata.Bundle{

internal/controllers/clusterextension_controller.go

@@ -94,7 +94,7 @@ type ClusterExtensionReconciler struct {
 }
 
 type InstalledBundleGetter interface {
-	GetInstalledBundle(ctx context.Context, acg helmclient.ActionClientGetter, allBundles []*catalogmetadata.Bundle, ext *ocv1alpha1.ClusterExtension) (*catalogmetadata.Bundle, error)
+	GetInstalledBundle(ctx context.Context, ext *ocv1alpha1.ClusterExtension) (*ocv1alpha1.BundleMetadata, error)
 }
 
 //+kubebuilder:rbac:groups=olm.operatorframework.io,resources=clusterextensions,verbs=get;list;watch
@@ -370,7 +370,7 @@ func (r *ClusterExtensionReconciler) resolve(ctx context.Context, ext ocv1alpha1
 	channelName := ext.Spec.Channel
 	versionRange := ext.Spec.Version
 
-	installedBundle, err := r.InstalledBundleGetter.GetInstalledBundle(ctx, r.ActionClientGetter, allBundles, &ext)
+	installedBundle, err := r.InstalledBundleGetter.GetInstalledBundle(ctx, &ext)
 	if err != nil {
 		return nil, err
 	}
@@ -392,7 +392,7 @@ func (r *ClusterExtensionReconciler) resolve(ctx context.Context, ext ocv1alpha1
 	}
 
 	if ext.Spec.UpgradeConstraintPolicy != ocv1alpha1.UpgradeConstraintPolicyIgnore && installedBundle != nil {
-		upgradePredicate, err := SuccessorsPredicate(installedBundle)
+		upgradePredicate, err := SuccessorsPredicate(ext.Spec.PackageName, installedBundle)
 		if err != nil {
 			return nil, err
 		}
@@ -404,7 +404,7 @@ func (r *ClusterExtensionReconciler) resolve(ctx context.Context, ext ocv1alpha1
 
 	var upgradeErrorPrefix string
 	if installedBundle != nil {
-		installedBundleVersion, err := installedBundle.Version()
+		installedBundleVersion, err := mmsemver.NewVersion(installedBundle.Version)
 		if err != nil {
 			return nil, err
 		}
@@ -568,6 +568,11 @@ func (r *ClusterExtensionReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	r.controller = controller
 	r.cache = mgr.GetCache()
 	r.dynamicWatchGVKs = map[schema.GroupVersionKind]struct{}{}
+
+	if r.InstalledBundleGetter == nil {
+		r.InstalledBundleGetter = &DefaultInstalledBundleGetter{r.ActionClientGetter}
+	}
+
 	return nil
 }
 
@@ -663,10 +668,12 @@ func (r *ClusterExtensionReconciler) getReleaseState(cl helmclient.ActionInterfa
 	return currentRelease, stateUnchanged, nil
 }
 
-type DefaultInstalledBundleGetter struct{}
+type DefaultInstalledBundleGetter struct {
+	helmclient.ActionClientGetter
+}
 
-func (d *DefaultInstalledBundleGetter) GetInstalledBundle(ctx context.Context, acg helmclient.ActionClientGetter, allBundles []*catalogmetadata.Bundle, ext *ocv1alpha1.ClusterExtension) (*catalogmetadata.Bundle, error) {
-	cl, err := acg.ActionClientFor(ctx, ext)
+func (d *DefaultInstalledBundleGetter) GetInstalledBundle(ctx context.Context, ext *ocv1alpha1.ClusterExtension) (*ocv1alpha1.BundleMetadata, error) {
+	cl, err := d.ActionClientFor(ctx, ext)
 	if err != nil {
 		return nil, err
 	}
@@ -679,27 +686,10 @@ func (d *DefaultInstalledBundleGetter) GetInstalledBundle(ctx context.Context, a
 		return nil, nil
 	}
 
-	// Bundle must match installed version exactly
-	vr, err := mmsemver.NewConstraint(release.Labels[labels.BundleVersionKey])
-	if err != nil {
-		return nil, err
-	}
-
-	// find corresponding bundle for the installed content
-	resultSet := catalogfilter.Filter(allBundles, catalogfilter.And(
-		catalogfilter.WithPackageName(release.Labels[labels.PackageNameKey]),
-		catalogfilter.WithBundleName(release.Labels[labels.BundleNameKey]),
-		catalogfilter.InMastermindsSemverRange(vr),
-	))
-	if len(resultSet) == 0 {
-		return nil, fmt.Errorf("bundle %q for package %q not found in available catalogs but is currently installed in namespace %q", release.Labels[labels.BundleNameKey], ext.Spec.PackageName, release.Namespace)
-	}
-
-	sort.SliceStable(resultSet, func(i, j int) bool {
-		return catalogsort.ByVersion(resultSet[i], resultSet[j])
-	})
-
-	return resultSet[0], nil
+	return &ocv1alpha1.BundleMetadata{
+		Name:    release.Labels[labels.BundleNameKey],
+		Version: release.Labels[labels.BundleVersionKey],
+	}, nil
 }
 
 type postrenderer struct {
@@ -749,7 +739,7 @@ func bundleMetadataFor(bundle *catalogmetadata.Bundle) *ocv1alpha1.BundleMetadat
 }
 
 func (r *ClusterExtensionReconciler) validateBundle(bundle *catalogmetadata.Bundle) error {
-	unsupportedProps := sets.New(
+	unsupportedProps := sets.New[string](
 		property.TypePackageRequired,
 		property.TypeGVKRequired,
 		property.TypeConstraint,