Add catalog weighting

Signed-off-by: Harish <[email protected]>

Author: harishsurf

pkg/controller/registry/resolver/cache.go

@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
+	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sort"
 	"sync"
 	"time"
@@ -45,6 +47,7 @@ type OperatorCacheProvider interface {
 type OperatorCache struct {
 	logger    logrus.FieldLogger
 	rcp       RegistryClientProvider
+	crClient  versioned.Interface
 	snapshots map[registry.CatalogKey]*CatalogSnapshot
 	ttl       time.Duration
 	sem       chan struct{}
@@ -53,14 +56,15 @@ type OperatorCache struct {
 
 var _ OperatorCacheProvider = &OperatorCache{}
 
-func NewOperatorCache(rcp RegistryClientProvider, log logrus.FieldLogger) *OperatorCache {
+func NewOperatorCache(rcp RegistryClientProvider, log logrus.FieldLogger, client versioned.Interface) *OperatorCache {
 	const (
 		MaxConcurrentSnapshotUpdates = 4
 	)
 
 	return &OperatorCache{
 		logger:    log,
 		rcp:       rcp,
+		crClient:  client,
 		snapshots: make(map[registry.CatalogKey]*CatalogSnapshot),
 		ttl:       5 * time.Minute,
 		sem:       make(chan struct{}, MaxConcurrentSnapshotUpdates),
@@ -151,11 +155,20 @@ func (c *OperatorCache) Namespaced(namespaces ...string) MultiCatalogOperatorFin
 
 	for _, miss := range misses {
 		ctx, cancel := context.WithTimeout(context.Background(), CachePopulateTimeout)
+
+		catsrcPriority := 0
+		// Ignoring error and treating catalog source priority as 0 if not found
+		catsrc, err := c.crClient.OperatorsV1alpha1().CatalogSources(miss.Namespace).Get(ctx, miss.Name, v1.GetOptions{})
+		if err == nil {
+			catsrcPriority = catsrc.Spec.Priority
+		}
+
 		s := CatalogSnapshot{
-			logger: c.logger.WithField("catalog", miss),
-			key:    miss,
-			expiry: now.Add(c.ttl),
-			pop:    cancel,
+			logger:   c.logger.WithField("catalog", miss),
+			key:      miss,
+			expiry:   now.Add(c.ttl),
+			pop:      cancel,
+			priority: setCatalogPriority(miss, catsrcPriority),
 		}
 		s.m.Lock()
 		c.snapshots[miss] = &s
@@ -277,6 +290,7 @@ type CatalogSnapshot struct {
 	operators []*Operator
 	m         sync.RWMutex
 	pop       context.CancelFunc
+	priority  Priority
 }
 
 func (s *CatalogSnapshot) Cancel() {
@@ -354,6 +368,9 @@ func (s SortableSnapshots) Less(i, j int) bool {
 		return false
 	}
 
+	if s.snapshots[i].priority != s.snapshots[j].priority {
+		return s.snapshots[i].priority.catsrcPriority > s.snapshots[j].priority.catsrcPriority
+	}
 	// the rest are sorted first in namespace preference order, then by name
 	if s.snapshots[i].key.Namespace != s.snapshots[j].key.Namespace {
 		return s.namespaces[s.snapshots[i].key.Namespace] < s.namespaces[s.snapshots[j].key.Namespace]

pkg/controller/registry/resolver/priority_resolver.go

@@ -0,0 +1,40 @@
+package resolver
+
+import "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
+
+type Priority struct {
+	catsrcPriority int
+}
+
+const (
+	defaultRHCatalogSourceName            = ""
+	defaultCertifiedCatalogSourceName     = ""
+	defaultCommunityCatalogSourceName     = ""
+	defaultRHCatalogSourcePriority        = -100
+	defaultCertifiedCatalogSourcePriority = -200
+	defaultCommunityCatalogSourcePriority = -300
+)
+
+func setCatalogPriority(key registry.CatalogKey, catsrc int) Priority {
+	if catsrc == 0 {
+		return assignDefaultCatalogPriority(key, catsrc)
+	}
+	return Priority{catsrcPriority: catsrc}
+}
+
+func assignDefaultCatalogPriority(key registry.CatalogKey, catsrc int) Priority {
+
+	if key.Name == defaultRHCatalogSourceName {
+		return Priority{catsrcPriority: defaultRHCatalogSourcePriority}
+	}
+
+	if key.Name == defaultCertifiedCatalogSourceName {
+		return Priority{catsrcPriority: defaultCertifiedCatalogSourcePriority}
+	}
+
+	if key.Name == defaultCommunityCatalogSourceName {
+		return Priority{catsrcPriority: defaultCommunityCatalogSourcePriority}
+	}
+
+	return Priority{catsrcPriority: 0}
+}

pkg/controller/registry/resolver/resolver.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
 	"sort"
 
 	"github.com/operator-framework/api/pkg/operators/v1alpha1"
@@ -24,9 +25,9 @@ type SatResolver struct {
 	log   logrus.FieldLogger
 }
 
-func NewDefaultSatResolver(rcp RegistryClientProvider, log logrus.FieldLogger) *SatResolver {
+func NewDefaultSatResolver(rcp RegistryClientProvider, log logrus.FieldLogger, client versioned.Interface) *SatResolver {
 	return &SatResolver{
-		cache: NewOperatorCache(rcp, log),
+		cache: NewOperatorCache(rcp, log, client),
 		log:   log,
 	}
 }

pkg/controller/registry/resolver/step_resolver.go

@@ -55,7 +55,7 @@ func NewOperatorStepResolver(lister operatorlister.OperatorLister, client versio
 		client:                 client,
 		kubeclient:             kubeclient,
 		globalCatalogNamespace: globalCatalogNamespace,
-		satResolver:            NewDefaultSatResolver(NewDefaultRegistryClientProvider(log, provider), log),
+		satResolver:            NewDefaultSatResolver(NewDefaultRegistryClientProvider(log, provider), log, client),
 		log:                    log,
 	}
 }