Skip to content

Remove CatalogSourceLister usage from resolver/cache. #2648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 28 additions & 25 deletions pkg/controller/registry/resolver/cache/cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ import (

"github.com/sirupsen/logrus"
"k8s.io/apimachinery/pkg/util/errors"

"github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/listers/operators/v1alpha1"
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorlister"
)

const existingOperatorKey = "@existing"
Expand Down Expand Up @@ -75,14 +72,24 @@ type OperatorCacheProvider interface {
Expire(catalog SourceKey)
}

type SourcePriorityProvider interface {
Priority(SourceKey) int
}

type constantSourcePriorityProvider int

func (spp constantSourcePriorityProvider) Priority(SourceKey) int {
return int(spp)
}

type Cache struct {
logger logrus.StdLogger
sp SourceProvider
catsrcLister v1alpha1.CatalogSourceLister
snapshots map[SourceKey]*snapshotHeader
ttl time.Duration
sem chan struct{}
m sync.RWMutex
logger logrus.StdLogger
sp SourceProvider
sourcePriorityProvider SourcePriorityProvider
snapshots map[SourceKey]*snapshotHeader
ttl time.Duration
sem chan struct{}
m sync.RWMutex
}

var _ OperatorCacheProvider = &Cache{}
Expand All @@ -95,9 +102,9 @@ func WithLogger(logger logrus.StdLogger) Option {
}
}

func WithCatalogSourceLister(catalogSourceLister v1alpha1.CatalogSourceLister) Option {
func WithSourcePriorityProvider(spp SourcePriorityProvider) Option {
return func(c *Cache) {
c.catsrcLister = catalogSourceLister
c.sourcePriorityProvider = spp
}
}

Expand All @@ -112,11 +119,11 @@ func New(sp SourceProvider, options ...Option) *Cache {
logger.SetOutput(io.Discard)
return logger
}(),
sp: sp,
catsrcLister: operatorlister.NewLister().OperatorsV1alpha1().CatalogSourceLister(),
snapshots: make(map[SourceKey]*snapshotHeader),
ttl: 5 * time.Minute,
sem: make(chan struct{}, MaxConcurrentSnapshotUpdates),
sp: sp,
sourcePriorityProvider: constantSourcePriorityProvider(0),
snapshots: make(map[SourceKey]*snapshotHeader),
ttl: 5 * time.Minute,
sem: make(chan struct{}, MaxConcurrentSnapshotUpdates),
}

for _, opt := range options {
Expand Down Expand Up @@ -223,14 +230,10 @@ func (c *Cache) Namespaced(namespaces ...string) MultiCatalogOperatorFinder {
ctx, cancel := context.WithTimeout(context.Background(), CachePopulateTimeout)

hdr := snapshotHeader{
key: miss,
expiry: now.Add(c.ttl),
pop: cancel,
}

// Ignoring error and treat catsrc priority as 0 if not found.
if catsrc, _ := c.catsrcLister.CatalogSources(miss.Namespace).Get(miss.Name); catsrc != nil {
hdr.priority = catsrc.Spec.Priority
key: miss,
expiry: now.Add(c.ttl),
pop: cancel,
priority: c.sourcePriorityProvider.Priority(miss),
}

hdr.m.Lock()
Expand Down
5 changes: 2 additions & 3 deletions pkg/controller/registry/resolver/resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import (

"github.com/operator-framework/api/pkg/constraints"
"github.com/operator-framework/api/pkg/operators/v1alpha1"
v1alpha1listers "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/listers/operators/v1alpha1"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/cache"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/projection"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/solver"
Expand All @@ -32,9 +31,9 @@ type SatResolver struct {
systemConstraintsProvider solver.ConstraintProvider
}

func NewDefaultSatResolver(rcp cache.SourceProvider, catsrcLister v1alpha1listers.CatalogSourceLister, logger logrus.FieldLogger) *SatResolver {
func NewDefaultSatResolver(rcp cache.SourceProvider, sourcePriorityProvider cache.SourcePriorityProvider, logger logrus.FieldLogger) *SatResolver {
return &SatResolver{
cache: cache.New(rcp, cache.WithLogger(logger), cache.WithCatalogSourceLister(catsrcLister)),
cache: cache.New(rcp, cache.WithLogger(logger), cache.WithSourcePriorityProvider(sourcePriorityProvider)),
log: logger,
pc: &predicateConverter{
celEnv: constraints.NewCelEnvironment(),
Expand Down
8 changes: 4 additions & 4 deletions pkg/controller/registry/resolver/resolver_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,7 @@ func TestSolveOperators_CatsrcPrioritySorting(t *testing.T) {
}

satResolver := SatResolver{
cache: cache.New(ssp, cache.WithCatalogSourceLister(&stubCatalogSourceLister{
cache: cache.New(ssp, cache.WithSourcePriorityProvider(catsrcPriorityProvider{lister: &stubCatalogSourceLister{
catsrcs: []*v1alpha1.CatalogSource{
{
ObjectMeta: metav1.ObjectMeta{
Expand All @@ -517,7 +517,7 @@ func TestSolveOperators_CatsrcPrioritySorting(t *testing.T) {
},
},
},
})),
}})),
}

operators, err := satResolver.SolveOperators([]string{"olm"}, []*v1alpha1.ClusterServiceVersion{}, subs)
Expand Down Expand Up @@ -545,7 +545,7 @@ func TestSolveOperators_CatsrcPrioritySorting(t *testing.T) {
}

satResolver = SatResolver{
cache: cache.New(ssp, cache.WithCatalogSourceLister(&stubCatalogSourceLister{
cache: cache.New(ssp, cache.WithSourcePriorityProvider(catsrcPriorityProvider{lister: &stubCatalogSourceLister{
catsrcs: []*v1alpha1.CatalogSource{
{
ObjectMeta: metav1.ObjectMeta{
Expand All @@ -566,7 +566,7 @@ func TestSolveOperators_CatsrcPrioritySorting(t *testing.T) {
},
},
},
})),
}})),
}

operators, err = satResolver.SolveOperators([]string{"olm"}, []*v1alpha1.ClusterServiceVersion{}, subs)
Expand Down
14 changes: 13 additions & 1 deletion pkg/controller/registry/resolver/step_resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,18 @@ type OperatorStepResolver struct {

var _ StepResolver = &OperatorStepResolver{}

type catsrcPriorityProvider struct {
lister v1alpha1listers.CatalogSourceLister
}

func (pp catsrcPriorityProvider) Priority(key cache.SourceKey) int {
catsrc, err := pp.lister.CatalogSources(key.Namespace).Get(key.Name)
if err != nil {
return 0
}
return catsrc.Spec.Priority
}

func NewOperatorStepResolver(lister operatorlister.OperatorLister, client versioned.Interface, kubeclient kubernetes.Interface,
globalCatalogNamespace string, provider RegistryClientProvider, log logrus.FieldLogger) *OperatorStepResolver {
stepResolver := &OperatorStepResolver{
Expand All @@ -53,7 +65,7 @@ func NewOperatorStepResolver(lister operatorlister.OperatorLister, client versio
client: client,
kubeclient: kubeclient,
globalCatalogNamespace: globalCatalogNamespace,
satResolver: NewDefaultSatResolver(SourceProviderFromRegistryClientProvider(provider, log), lister.OperatorsV1alpha1().CatalogSourceLister(), log),
satResolver: NewDefaultSatResolver(SourceProviderFromRegistryClientProvider(provider, log), catsrcPriorityProvider{lister: lister.OperatorsV1alpha1().CatalogSourceLister()}, log),
log: log,
}

Expand Down