Skip to content

Bug 2002276: Remove oudated subscription update logic to improve resolution delay #211

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.

Sign up for GitHub

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 2 commits into from
Nov 2, 2021
Merged

Bug 2002276: Remove oudated subscription update logic to improve resolution delay #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f70bd92
Remove oudated subscription update logic to improve resolution delay …
dinhxuanvu Sep 29, 2021
807c857
pkg/controller: Migrate to using a read lock instead of a readwrite l…
timflannagan Sep 30, 2021
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
16 changes: 2 additions & 14 deletions staging/operator-lifecycle-manager/pkg/controller/operators/catalog/operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1044,11 +1044,6 @@ func (o *Operator) syncSubscriptions(obj interface{}) error {
}

func (o *Operator) nothingToUpdate(logger *logrus.Entry, sub *v1alpha1.Subscription) bool {
// Only sync if catalog has been updated since last sync time
if o.sourcesLastUpdate.Before(sub.Status.LastUpdated.Time) && sub.Status.State != v1alpha1.SubscriptionStateNone && sub.Status.State != v1alpha1.SubscriptionStateUpgradeAvailable {
logger.Debugf("skipping update: no new updates to catalog since last sync at %s", sub.Status.LastUpdated.String())
return true
}
if sub.Status.InstallPlanRef != nil && sub.Status.State == v1alpha1.SubscriptionStateUpgradePending {
logger.Debugf("skipping update: installplan already created")
return true
Expand Down Expand Up @@ -1102,7 +1097,7 @@ func (o *Operator) ensureSubscriptionCSVState(logger *logrus.Entry, sub *v1alpha
return sub, false, nil
}

csv, err := o.client.OperatorsV1alpha1().ClusterServiceVersions(sub.GetNamespace()).Get(context.TODO(), sub.Status.CurrentCSV, metav1.GetOptions{})
_, err := o.client.OperatorsV1alpha1().ClusterServiceVersions(sub.GetNamespace()).Get(context.TODO(), sub.Status.CurrentCSV, metav1.GetOptions{})
out := sub.DeepCopy()
if err != nil {
logger.WithError(err).WithField("currentCSV", sub.Status.CurrentCSV).Debug("error fetching csv listed in subscription status")
Expand All @@ -1112,14 +1107,7 @@ func (o *Operator) ensureSubscriptionCSVState(logger *logrus.Entry, sub *v1alpha
if err := querier.Queryable(); err != nil {
return nil, false, err
}
b, _, _ := querier.FindReplacement(&csv.Spec.Version.Version, sub.Status.CurrentCSV, sub.Spec.Package, sub.Spec.Channel, registry.CatalogKey{Name: sub.Spec.CatalogSource, Namespace: sub.Spec.CatalogSourceNamespace})
if b != nil {
o.logger.Tracef("replacement %s bundle found for current bundle %s", b.CsvName, sub.Status.CurrentCSV)
out.Status.State = v1alpha1.SubscriptionStateUpgradeAvailable
} else {
out.Status.State = v1alpha1.SubscriptionStateAtLatest
}

out.Status.State = v1alpha1.SubscriptionStateAtLatest
out.Status.InstalledCSV = sub.Status.CurrentCSV
}

Expand Down
2 changes: 2 additions & 0 deletions staging/operator-lifecycle-manager/pkg/controller/operators/catalog/querier.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ type SourceRef struct {
}

type SourceQuerier interface {
// Deprecated: This FindReplacement function will be deprecated soon
FindReplacement(currentVersion *semver.Version, bundleName, pkgName, channelName string, initialSource registry.CatalogKey) (*api.Bundle, *registry.CatalogKey, error)
Queryable() error
}
Expand All @@ -49,6 +50,7 @@ func (q *NamespaceSourceQuerier) Queryable() error {
return nil
}

// Deprecated: This FindReplacement function will be deprecated soon
func (q *NamespaceSourceQuerier) FindReplacement(currentVersion *semver.Version, bundleName, pkgName, channelName string, initialSource registry.CatalogKey) (*api.Bundle, *registry.CatalogKey, error) {
errs := []error{}

Expand Down
182 changes: 0 additions & 182 deletions staging/operator-lifecycle-manager/pkg/controller/operators/catalog/querier_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
package catalog

import (
"context"
"encoding/json"
"fmt"
"testing"

"github.com/blang/semver/v4"
"github.com/operator-framework/operator-registry/pkg/api"
"github.com/operator-framework/operator-registry/pkg/client"
"github.com/stretchr/testify/require"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

"github.com/operator-framework/api/pkg/lib/version"
"github.com/operator-framework/api/pkg/operators/v1alpha1"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/operators/catalog/fakes"
"github.com/operator-framework/operator-lifecycle-manager/pkg/controller/registry"
)
Expand Down Expand Up @@ -112,178 +105,3 @@ func TestNamespaceSourceQuerier_Queryable(t *testing.T) {
})
}
}

func TestNamespaceSourceQuerier_FindReplacement(t *testing.T) {
// TODO: clean up this test setup
initialSource := fakes.FakeClientInterface{}
otherSource := fakes.FakeClientInterface{}
replacementSource := fakes.FakeClientInterface{}
replacementAndLatestSource := fakes.FakeClientInterface{}
replacementAndNoAnnotationLatestSource := fakes.FakeClientInterface{}

latestVersion := semver.MustParse("1.0.0-1556661308")
csv := v1alpha1.ClusterServiceVersion{
TypeMeta: metav1.TypeMeta{
Kind: v1alpha1.ClusterServiceVersionKind,
APIVersion: v1alpha1.GroupVersion,
},
ObjectMeta: metav1.ObjectMeta{
Name: "latest",
Namespace: "placeholder",
Annotations: map[string]string{
"olm.skipRange": ">= 1.0.0-0 < 1.0.0-1556661308",
},
},
Spec: v1alpha1.ClusterServiceVersionSpec{
CustomResourceDefinitions: v1alpha1.CustomResourceDefinitions{
Owned: []v1alpha1.CRDDescription{},
Required: []v1alpha1.CRDDescription{},
},
APIServiceDefinitions: v1alpha1.APIServiceDefinitions{
Owned: []v1alpha1.APIServiceDescription{},
Required: []v1alpha1.APIServiceDescription{},
},
Version: version.OperatorVersion{latestVersion},
},
}
csvJson, err := json.Marshal(csv)
require.NoError(t, err)

nextBundle := &api.Bundle{CsvName: "test.v1", PackageName: "testPkg", ChannelName: "testChannel"}
latestBundle := &api.Bundle{CsvName: "latest", PackageName: "testPkg", ChannelName: "testChannel", CsvJson: string(csvJson), Object: []string{string(csvJson)}, SkipRange: ">= 1.0.0-0 < 1.0.0-1556661308", Version: latestVersion.String()}

csv.SetAnnotations(map[string]string{})
csvUnstNoAnnotationJson, err := json.Marshal(csv)
require.NoError(t, err)
latestBundleNoAnnotation := &api.Bundle{CsvName: "latest", PackageName: "testPkg", ChannelName: "testChannel", CsvJson: string(csvUnstNoAnnotationJson), Object: []string{string(csvUnstNoAnnotationJson)}}

initialSource.GetReplacementBundleInPackageChannelStub = func(ctx context.Context, bundleName, pkgName, channelName string) (*api.Bundle, error) {
return nil, fmt.Errorf("not found")
}
replacementSource.GetReplacementBundleInPackageChannelStub = func(ctx context.Context, bundleName, pkgName, channelName string) (*api.Bundle, error) {
return nextBundle, nil
}
initialSource.GetBundleInPackageChannelStub = func(ctx context.Context, pkgName, channelName string) (*api.Bundle, error) {
if pkgName != latestBundle.PackageName {
return nil, fmt.Errorf("not found")
}
return latestBundle, nil
}
otherSource.GetBundleInPackageChannelStub = func(ctx context.Context, pkgName, channelName string) (*api.Bundle, error) {
if pkgName != latestBundle.PackageName {
return nil, fmt.Errorf("not found")
}
return latestBundle, nil
}
replacementAndLatestSource.GetReplacementBundleInPackageChannelStub = func(ctx context.Context, bundleName, pkgName, channelName string) (*api.Bundle, error) {
return nextBundle, nil
}
replacementAndLatestSource.GetBundleInPackageChannelStub = func(ctx context.Context, pkgName, channelName string) (*api.Bundle, error) {
return latestBundle, nil
}
replacementAndNoAnnotationLatestSource.GetReplacementBundleInPackageChannelStub = func(ctx context.Context, bundleName, pkgName, channelName string) (*api.Bundle, error) {
return nextBundle, nil
}
replacementAndNoAnnotationLatestSource.GetBundleInPackageChannelStub = func(ctx context.Context, pkgName, channelName string) (*api.Bundle, error) {
return latestBundleNoAnnotation, nil
}

initialKey := registry.CatalogKey{"initial", "ns"}
otherKey := registry.CatalogKey{"other", "other"}
replacementKey := registry.CatalogKey{"replacement", "ns"}
replacementAndLatestKey := registry.CatalogKey{"replat", "ns"}
replacementAndNoAnnotationLatestKey := registry.CatalogKey{"replatbad", "ns"}

sources := map[registry.CatalogKey]registry.ClientInterface{
initialKey: &initialSource,
otherKey: &otherSource,
replacementKey: &replacementSource,
replacementAndLatestKey: &replacementAndLatestSource,
replacementAndNoAnnotationLatestKey: &replacementAndNoAnnotationLatestSource,
}

startVersion := semver.MustParse("1.0.0-0")
notInRange := semver.MustParse("1.0.0-1556661347")

type fields struct {
sources map[registry.CatalogKey]registry.ClientInterface
}
type args struct {
currentVersion *semver.Version
pkgName string
channelName string
bundleName string
initialSource registry.CatalogKey
}
type out struct {
bundle *api.Bundle
key *registry.CatalogKey
err error
}
tests := []struct {
name string
fields fields
args args
out out
}{
{
name: "FindsLatestInPrimaryCatalog",
fields: fields{sources: sources},
args: args{&startVersion, "testPkg", "testChannel", "test.v1", initialKey},
out: out{bundle: latestBundle, key: &initialKey, err: nil},
},
{
name: "FindsLatestInSecondaryCatalog",
fields: fields{sources: sources},
args: args{&startVersion, "testPkg", "testChannel", "test.v1", otherKey},
out: out{bundle: latestBundle, key: &otherKey, err: nil},
},
{
name: "PrefersLatestToReplaced/SameCatalog",
fields: fields{sources: sources},
args: args{&startVersion, "testPkg", "testChannel", "test.v1", replacementAndLatestKey},
out: out{bundle: latestBundle, key: &replacementAndLatestKey, err: nil},
},
{
name: "PrefersLatestToReplaced/OtherCatalog",
fields: fields{sources: sources},
args: args{&startVersion, "testPkg", "testChannel", "test.v1", initialKey},
out: out{bundle: latestBundle, key: &initialKey, err: nil},
},
{
name: "IgnoresLatestWithoutAnnotation",
fields: fields{sources: sources},
args: args{&startVersion, "testPkg", "testChannel", "test.v1", replacementAndNoAnnotationLatestKey},
out: out{bundle: nextBundle, key: &replacementAndNoAnnotationLatestKey, err: nil},
},
{
name: "IgnoresLatestNotInRange",
fields: fields{sources: sources},
args: args{&notInRange, "testPkg", "testChannel", "test.v1", replacementAndLatestKey},
out: out{bundle: nextBundle, key: &replacementAndLatestKey, err: nil},
},
{
name: "IgnoresLatestAtLatest",
fields: fields{sources: sources},
args: args{&latestVersion, "testPkg", "testChannel", "test.v1", otherKey},
out: out{bundle: nil, key: nil, err: nil},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
q := &NamespaceSourceQuerier{
sources: tt.fields.sources,
}
var got *api.Bundle
var key *registry.CatalogKey
var err error
got, key, err = q.FindReplacement(tt.args.currentVersion, tt.args.bundleName, tt.args.pkgName, tt.args.channelName, tt.args.initialSource)
if err != nil {
t.Log(err.Error())
}
require.Equal(t, tt.out.err, err, "%v", err)
require.Equal(t, tt.out.bundle, got)
require.Equal(t, tt.out.key, key)
})
}
}
4 changes: 2 additions & 2 deletions staging/operator-lifecycle-manager/pkg/controller/registry/resolver/cache/cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,9 @@ type NamespacedOperatorCache struct {
func (c *NamespacedOperatorCache) Error() error {
var errs []error
for key, snapshot := range c.snapshots {
snapshot.m.Lock()
snapshot.m.RLock()
err := snapshot.err
snapshot.m.Unlock()
snapshot.m.RUnlock()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dinhxuanvu One question, maybe I missed something, why not us use the defer here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You wouldn't be able to use defer here as we're performing locking/unlocking operations during a for loop and the defer statement only triggers once the function finishes execution. In order to use a defer statement here, you would need to wrap the lock/unlock logic into an anonymous function:

for key, snapshot := range c.snapshots {
    func() {
        snapshot.m.RLock()
        defer snapshot.m.RUnlock()
        ...
    }
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@timflannagan Thanks for your clarification! I think we should make sure the RLock can be released successfully. Actually, we met an issue: https://bugzilla.redhat.com/show_bug.cgi?id=2020486 that the status of the CatalogSource is lastObservedState: IDLE sometimes, and I checked the logs, found the warning: level=warning msg="couldn't find service in cache". I guess it's related to this PR.

if err != nil {
errs = append(errs, fmt.Errorf("error using catalog %s (in namespace %s): %w", key.Name, key.Namespace, err))
}
Expand Down
2 changes: 1 addition & 1 deletion staging/operator-lifecycle-manager/test/e2e/subscription_e2e_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2066,7 +2066,7 @@ var _ = Describe("Subscription", func() {
}
updateInternalCatalog(GinkgoT(), kubeClient, crClient, catalogSourceName, testNamespace, []apiextensions.CustomResourceDefinition{crd, crd2}, []operatorsv1alpha1.ClusterServiceVersion{csvNewA, csvA, csvB}, manifests)
csvAsub := strings.Join([]string{packageName1, stableChannel, catalogSourceName, testNamespace}, "-")
_, err = fetchSubscription(crClient, testNamespace, csvAsub, subscriptionStateUpgradeAvailableChecker)
_, err = fetchSubscription(crClient, testNamespace, csvAsub, subscriptionStateAtLatestChecker)
require.NoError(GinkgoT(), err)
// Ensure csvNewA is not installed
_, err = crClient.OperatorsV1alpha1().ClusterServiceVersions(testNamespace).Get(context.Background(), csvNewA.Name, metav1.GetOptions{})
Expand Down
16 changes: 2 additions & 14 deletions ...perator-framework/operator-lifecycle-manager/pkg/controller/operators/catalog/operator.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions ...operator-framework/operator-lifecycle-manager/pkg/controller/operators/catalog/querier.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions ...ator-framework/operator-lifecycle-manager/pkg/controller/registry/resolver/cache/cache.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.