Skip to content
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

Jump to bottom

[release-1.13] fix: sequence updates subscription where possible, instead of recreating it #7959

Closed
wants to merge 3 commits into from
Closed

[release-1.13] fix: sequence updates subscription where possible, instead of recreating it #7959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d9349a
feat: sequences only recreate subscriptions when the changes are to i…
Cali0707 May 28, 2024
e4f7e14
fix(tests): sequence unit tests correctly check for updates to subscr…
Cali0707 May 28, 2024
5f2ed77
cleanup: use method from api folder to check immutable fields
Cali0707 May 30, 2024
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
12 changes: 10 additions & 2 deletions pkg/reconciler/sequence/sequence.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import (

"go.uber.org/zap"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
apierrs "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand All @@ -46,6 +45,7 @@ import (
listers "knative.dev/eventing/pkg/client/listers/flows/v1"
messaginglisters "knative.dev/eventing/pkg/client/listers/messaging/v1"
"knative.dev/eventing/pkg/duck"
"knative.dev/pkg/kmp"

corev1listers "k8s.io/client-go/listers/core/v1"
"knative.dev/eventing/pkg/reconciler/sequence/resources"
Expand Down Expand Up @@ -204,7 +204,7 @@ func (r *Reconciler) reconcileSubscription(ctx context.Context, step int, p *v1.
// TODO: Send events here, or elsewhere?
//r.Recorder.Eventf(p, corev1.EventTypeWarning, subscriptionCreateFailed, "Create Sequences's subscription failed: %v", err)
return nil, fmt.Errorf("failed to get subscription: %s", err)
} else if !equality.Semantic.DeepDerivative(expected.Spec, sub.Spec) {
} else if immutableFieldsChanged := expected.CheckImmutableFields(ctx, sub); immutableFieldsChanged != nil {
// Given that spec.channel is immutable, we cannot just update the subscription. We delete
// it instead, and re-create it.
err = r.eventingClientSet.MessagingV1().Subscriptions(sub.Namespace).Delete(ctx, sub.Name, metav1.DeleteOptions{})
Expand All @@ -218,6 +218,14 @@ func (r *Reconciler) reconcileSubscription(ctx context.Context, step int, p *v1.
return nil, err
}
return newSub, nil
} else if equal, err := kmp.SafeEqual(sub.Spec, expected.Spec); !equal || err != nil {
// only the mutable fields were changed, so we can update the subscription
updatedSub, err := r.eventingClientSet.MessagingV1().Subscriptions(sub.Namespace).Update(ctx, expected, metav1.UpdateOptions{})
if err != nil {
logging.FromContext(ctx).Infow("Cannot update subscription", zap.Error(err))
return nil, err
}
return updatedSub, nil
}
return sub, nil
}
Expand Down
45 changes: 39 additions & 6 deletions pkg/reconciler/sequence/sequence_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -896,18 +896,15 @@ func TestAllCases(t *testing.T) {
WithSequenceSteps([]v1.SequenceStep{{Destination: createDestination(0)}}))),
},
WantErr: false,
WantDeletes: []clientgotesting.DeleteActionImpl{{
WantUpdates: []clientgotesting.UpdateActionImpl{{
ActionImpl: clientgotesting.ActionImpl{
Namespace: testNS,
Resource: v1.SchemeGroupVersion.WithResource("subscriptions"),
},
Name: resources.SequenceChannelName(sequenceName, 0),
}},
WantCreates: []runtime.Object{
resources.NewSubscription(0, NewSequence(sequenceName, testNS,
Object: resources.NewSubscription(0, NewSequence(sequenceName, testNS,
WithSequenceChannelTemplateSpec(imc),
WithSequenceSteps([]v1.SequenceStep{{Destination: createDestination(1)}}))),
},
}},
WantStatusUpdates: []clientgotesting.UpdateActionImpl{{
Object: NewSequence(sequenceName, testNS,
WithInitSequenceConditions,
Expand Down Expand Up @@ -1001,6 +998,18 @@ func TestAllCases(t *testing.T) {
Name: resources.SequenceChannelName(sequenceName, 2),
},
},
WantUpdates: []clientgotesting.UpdateActionImpl{{
ActionImpl: clientgotesting.ActionImpl{
Namespace: testNS,
Resource: v1.SchemeGroupVersion.WithResource("subscriptions"),
},
Object: resources.NewSubscription(1, NewSequence(sequenceName, testNS,
WithSequenceChannelTemplateSpec(imc),
WithSequenceSteps([]v1.SequenceStep{
{Destination: createDestination(0)},
{Destination: createDestination(1)}},
))),
}},
WantStatusUpdates: []clientgotesting.UpdateActionImpl{{
Object: NewSequence(sequenceName, testNS,
WithInitSequenceConditions,
Expand Down Expand Up @@ -1131,6 +1140,18 @@ func TestAllCases(t *testing.T) {
Name: resources.SequenceChannelName(sequenceName, 2),
},
},
WantUpdates: []clientgotesting.UpdateActionImpl{{
ActionImpl: clientgotesting.ActionImpl{
Namespace: testNS,
Resource: v1.SchemeGroupVersion.WithResource("subscriptions"),
},
Object: resources.NewSubscription(1, NewSequence(sequenceName, testNS,
WithSequenceChannelTemplateSpec(imc),
WithSequenceSteps([]v1.SequenceStep{
{Destination: createDestination(0)},
{Destination: createDestination(1)}},
))),
}},
WantStatusUpdates: []clientgotesting.UpdateActionImpl{{
Object: NewSequence(sequenceName, testNS,
WithInitSequenceConditions,
Expand Down Expand Up @@ -1245,6 +1266,18 @@ func TestAllCases(t *testing.T) {
WantEvents: []string{
Eventf(corev1.EventTypeWarning, "InternalError", "inducing failure for delete inmemorychannels"),
},
WantUpdates: []clientgotesting.UpdateActionImpl{{
ActionImpl: clientgotesting.ActionImpl{
Namespace: testNS,
Resource: v1.SchemeGroupVersion.WithResource("subscriptions"),
},
Object: resources.NewSubscription(1, NewSequence(sequenceName, testNS,
WithSequenceChannelTemplateSpec(imc),
WithSequenceSteps([]v1.SequenceStep{
{Destination: createDestination(0)},
{Destination: createDestination(1)}},
))),
}},

WantDeletes: []clientgotesting.DeleteActionImpl{
{
Expand Down
Loading