feat(catalog): Add catalog weighting to dependency resolver #1682
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,12 +9,13 @@ import ( | |
| "time" | ||
|
|
||
| "github.com/blang/semver" | ||
| "github.com/sirupsen/logrus" | ||
|
|
||
| "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/listers/operators/v1alpha1" | ||
| "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry" | ||
| "github.com/operator-framework/operator-registry/pkg/api" | ||
| "github.com/operator-framework/operator-registry/pkg/client" | ||
| opregistry "github.com/operator-framework/operator-registry/pkg/registry" | ||
| ) | ||
|
|
||
| type RegistryClientProvider interface { | ||
|
|
@@ -43,27 +44,33 @@ type OperatorCacheProvider interface { | |
| } | ||
|
|
||
| type OperatorCache struct { | ||
| logger logrus.FieldLogger | ||
| rcp RegistryClientProvider | ||
| catsrcLister v1alpha1.CatalogSourceLister | ||
| snapshots map[registry.CatalogKey]*CatalogSnapshot | ||
| ttl time.Duration | ||
| sem chan struct{} | ||
| m sync.RWMutex | ||
| } | ||
|
|
||
| const defaultCatalogSourcePriority int = 0 | ||
|
|
||
| type catalogSourcePriority int | ||
|
|
||
| var _ OperatorCacheProvider = &OperatorCache{} | ||
|
|
||
| func NewOperatorCache(rcp RegistryClientProvider, log logrus.FieldLogger, catsrcLister v1alpha1.CatalogSourceLister) *OperatorCache { | ||
| const ( | ||
| MaxConcurrentSnapshotUpdates = 4 | ||
| ) | ||
|
|
||
| return &OperatorCache{ | ||
| logger: log, | ||
| rcp: rcp, | ||
| catsrcLister: catsrcLister, | ||
| snapshots: make(map[registry.CatalogKey]*CatalogSnapshot), | ||
| ttl: 5 * time.Minute, | ||
| sem: make(chan struct{}, MaxConcurrentSnapshotUpdates), | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -151,11 +158,20 @@ func (c *OperatorCache) Namespaced(namespaces ...string) MultiCatalogOperatorFin | |
|
|
||
| for _, miss := range misses { | ||
| ctx, cancel := context.WithTimeout(context.Background(), CachePopulateTimeout) | ||
|
|
||
| catsrcPriority := defaultCatalogSourcePriority | ||
| // Ignoring error and treat catsrc priority as 0 if not found. | ||
| catsrc, err := c.catsrcLister.CatalogSources(miss.Namespace).Get(miss.Name) | ||
|
There was a problem hiding this comment. Not sure if anything can be done about this in this PR, but really not a fan of There was a problem hiding this comment. I don't know, "miss" has a very specific meaning in a cache implementation. There was a problem hiding this comment. Is that really helpful in a file named |
||
| if err == nil { | ||
| catsrcPriority = catsrc.Spec.Priority | ||
| } | ||
|
|
||
| s := CatalogSnapshot{ | ||
| logger: c.logger.WithField("catalog", miss), | ||
| key: miss, | ||
| expiry: now.Add(c.ttl), | ||
| pop: cancel, | ||
| priority: catalogSourcePriority(catsrcPriority), | ||
| } | ||
| s.m.Lock() | ||
| c.snapshots[miss] = &s | ||
|
|
@@ -222,13 +238,13 @@ func ensurePackageProperty(o *Operator, name, version string) { | |
| PackageName: name, | ||
| Version: version, | ||
| } | ||
| bytes, err := json.Marshal(prop) | ||
| if err != nil { | ||
| return | ||
| } | ||
| o.properties = append(o.properties, &api.Property{ | ||
| Type: opregistry.PackageType, | ||
| Value: string(bytes), | ||
| }) | ||
| } | ||
|
|
||
|
|
@@ -277,6 +293,7 @@ type CatalogSnapshot struct { | |
| operators []*Operator | ||
| m sync.RWMutex | ||
| pop context.CancelFunc | ||
| priority catalogSourcePriority | ||
| } | ||
|
|
||
| func (s *CatalogSnapshot) Cancel() { | ||
|
|
@@ -354,10 +371,14 @@ func (s SortableSnapshots) Less(i, j int) bool { | |
| return false | ||
| } | ||
|
|
||
| // the rest are sorted first on priority, namespace and then by name | ||
Bowenislandsong marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Is this comment necessary here? There was a problem hiding this comment. Maybe could be substitued for more structured comment for the entire There was a problem hiding this comment. +1 to that. "The proper use of comments is to compensate our failure to express ourself in code" "Code changes and evolves. Chunks of it move from here to there. Those chunks bifurcate and reproduce and come together again to form chimeras. Unfortunately the comments don't always follow them, can't always follow them." Further reading on comments: https://blog.usejournal.com/stop-writing-code-comments-28fef5272752 |
||
| if s.snapshots[i].priority != s.snapshots[j].priority { | ||
| return s.snapshots[i].priority > s.snapshots[j].priority | ||
| } | ||
| 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] | ||
| } | ||
|
|
||
|
|
||
| return s.snapshots[i].key.Name < s.snapshots[j].key.Name | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you get rid of this noise? Clutters the PR a bit.