[resolution pt.1] bundle entity #95
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
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 |
|---|---|---|
| @@ -0,0 +1,219 @@ | ||
| package entity | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "sync" | ||
|
|
||
| "github.com/blang/semver/v4" | ||
| "github.com/operator-framework/deppy/pkg/deppy/input" | ||
| "github.com/operator-framework/operator-registry/alpha/property" | ||
| ) | ||
|
|
||
| const PropertyBundlePath = "olm.bundle.path" | ||
|
|
||
| type ChannelProperties struct { | ||
| property.Channel | ||
| Replaces string `json:"replaces,omitempty"` | ||
| Skips []string `json:"skips,omitempty"` | ||
| SkipRange string `json:"skipRange,omitempty"` | ||
| } | ||
|
|
||
| type PackageRequired struct { | ||
| property.PackageRequired | ||
| SemverRange *semver.Range `json:"-"` | ||
| } | ||
|
|
||
| type GVK property.GVK | ||
|
|
||
| func (g GVK) String() string { | ||
| return fmt.Sprintf(`group:"%s" version:"%s" kind:"%s"`, g.Group, g.Version, g.Kind) | ||
| } | ||
|
|
||
| type GVKRequired property.GVKRequired | ||
|
|
||
| func (g GVKRequired) String() string { | ||
| return fmt.Sprintf(`group:"%s" version:"%s" kind:"%s"`, g.Group, g.Version, g.Kind) | ||
| } | ||
|
|
||
| type BundleEntity struct { | ||
| *input.Entity | ||
|
|
||
| // these properties are lazy loaded as they are requested | ||
| bundlePackage *property.Package | ||
| providedGVKs []GVK | ||
| requiredGVKs []GVKRequired | ||
| requiredPackages []PackageRequired | ||
| channelProperties *ChannelProperties | ||
| semVersion *semver.Version | ||
| bundlePath string | ||
| mu sync.RWMutex | ||
| } | ||
|
|
||
| func NewBundleEntity(entity *input.Entity) *BundleEntity { | ||
| return &BundleEntity{ | ||
| Entity: entity, | ||
| mu: sync.RWMutex{}, | ||
| } | ||
| } | ||
|
|
||
| func (b *BundleEntity) PackageName() (string, error) { | ||
| if err := b.loadPackage(); err != nil { | ||
| return "", err | ||
| } | ||
| return b.bundlePackage.PackageName, nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) Version() (*semver.Version, error) { | ||
| if err := b.loadPackage(); err != nil { | ||
| return nil, err | ||
| } | ||
| return b.semVersion, nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) ProvidedGVKs() ([]GVK, error) { | ||
| if err := b.loadProvidedGVKs(); err != nil { | ||
| return nil, err | ||
| } | ||
| return b.providedGVKs, nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) RequiredGVKs() ([]GVKRequired, error) { | ||
| if err := b.loadRequiredGVKs(); err != nil { | ||
| return nil, err | ||
| } | ||
| return b.requiredGVKs, nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) RequiredPackages() ([]PackageRequired, error) { | ||
| if err := b.loadRequiredPackages(); err != nil { | ||
| return nil, err | ||
| } | ||
| return b.requiredPackages, nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) ChannelName() (string, error) { | ||
| if err := b.loadChannelProperties(); err != nil { | ||
| return "", err | ||
| } | ||
| return b.channelProperties.ChannelName, nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) ChannelProperties() (*ChannelProperties, error) { | ||
| if err := b.loadChannelProperties(); err != nil { | ||
| return nil, err | ||
| } | ||
| return b.channelProperties, nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) BundlePath() (string, error) { | ||
| if err := b.loadBundlePath(); err != nil { | ||
| return "", err | ||
| } | ||
| return b.bundlePath, nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) loadPackage() error { | ||
| b.mu.Lock() | ||
| defer b.mu.Unlock() | ||
| if b.bundlePackage == nil { | ||
| bundlePackage, err := loadFromEntity[property.Package](b.Entity, property.TypePackage) | ||
| if err != nil { | ||
| return fmt.Errorf("error determining package for entity '%s': %w", b.ID, err) | ||
| } | ||
| b.bundlePackage = &bundlePackage | ||
| if b.semVersion == nil { | ||
| semVer, err := semver.Parse(b.bundlePackage.Version) | ||
| if err != nil { | ||
| return fmt.Errorf("could not parse semver (%s) for entity '%s': %w", b.bundlePackage.Version, b.ID, err) | ||
| } | ||
| b.semVersion = &semVer | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) loadProvidedGVKs() error { | ||
| b.mu.Lock() | ||
| defer b.mu.Unlock() | ||
| if b.providedGVKs == nil { | ||
|
There was a problem hiding this comment. Is it possible for these values to become out-of-date? If so, if the value in the map was ever updated, this would continue to return the old value right? There was a problem hiding this comment. Great observation and question!! There was a problem hiding this comment.
We may want to document any assumptions that we make. Do we prevent cache changes when deppy is solving? There was a problem hiding this comment. it == There was a problem hiding this comment. Thanks for answering! Makes perfect sense to me. |
||
| providedGVKs, err := loadFromEntity[[]GVK](b.Entity, property.TypeGVK) | ||
| if err != nil { | ||
| return fmt.Errorf("error determining bundle provided gvks for entity '%s': %w", b.ID, err) | ||
| } | ||
| b.providedGVKs = providedGVKs | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) loadRequiredGVKs() error { | ||
| b.mu.Lock() | ||
| defer b.mu.Unlock() | ||
| if b.requiredGVKs == nil { | ||
| requiredGVKs, err := loadFromEntity[[]GVKRequired](b.Entity, property.TypeGVKRequired) | ||
| if err != nil { | ||
| return fmt.Errorf("error determining bundle required gvks for entity '%s': %w", b.ID, err) | ||
| } | ||
| b.requiredGVKs = requiredGVKs | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) loadRequiredPackages() error { | ||
| b.mu.Lock() | ||
| defer b.mu.Unlock() | ||
| if b.requiredPackages == nil { | ||
| requiredPackages, err := loadFromEntity[[]PackageRequired](b.Entity, property.TypePackageRequired) | ||
| if err != nil { | ||
| return fmt.Errorf("error determining bundle required packages for entity '%s': %w", b.ID, err) | ||
| } | ||
| for _, requiredPackage := range requiredPackages { | ||
| semverRange, err := semver.ParseRange(requiredPackage.VersionRange) | ||
| if err != nil { | ||
| return fmt.Errorf("error determining bundle required package semver range for entity '%s': '%w'", b.ID, err) | ||
| } | ||
| requiredPackage.SemverRange = &semverRange | ||
| } | ||
| b.requiredPackages = requiredPackages | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) loadChannelProperties() error { | ||
| b.mu.Lock() | ||
| defer b.mu.Unlock() | ||
| if b.channelProperties == nil { | ||
| channel, err := loadFromEntity[ChannelProperties](b.Entity, property.TypeChannel) | ||
| if err != nil { | ||
| return fmt.Errorf("error determining bundle channel properties for entity '%s': %w", b.ID, err) | ||
| } | ||
| b.channelProperties = &channel | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (b *BundleEntity) loadBundlePath() error { | ||
| b.mu.Lock() | ||
| defer b.mu.Unlock() | ||
| if b.bundlePath == "" { | ||
| bundlePath, err := loadFromEntity[string](b.Entity, PropertyBundlePath) | ||
| if err != nil { | ||
| return fmt.Errorf("error determining bundle path for entity '%s': %w", b.ID, err) | ||
| } | ||
| b.bundlePath = bundlePath | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func loadFromEntity[T interface{}](entity *input.Entity, propertyName string) (T, error) { | ||
| deserializedProperty := *new(T) | ||
| propertyValue, ok := entity.Properties[propertyName] | ||
| if !ok { | ||
| return deserializedProperty, fmt.Errorf("property '%s' not found", propertyName) | ||
| } | ||
|
|
||
| if err := json.Unmarshal([]byte(propertyValue), &deserializedProperty); err != nil { | ||
| return deserializedProperty, fmt.Errorf("property '%s' ('%s') could not be parsed: %w", propertyName, propertyValue, err) | ||
| } | ||
| return deserializedProperty, nil | ||
| } | ||
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.
Is there no mutex lock required here unlike the other
loadXfuncs?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.
Thank you!! Fixed