Skip to content

Fix controller shutdown status patching with a fresh context for patches #191

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 5 commits into from
Jun 11, 2025
Merged

Fix controller shutdown status patching with a fresh context for patches #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
46614e6
add a graceful context
rushmash91 Jun 2, 2025
2872a05
use fresh context in patch operation
rushmash91 Jun 5, 2025
3fdc952
use withoutcancel instead of trafering values
rushmash91 Jun 10, 2025
8efa3b1
update unit tests
rushmash91 Jun 10, 2025
21f3a8b
use util functions
rushmash91 Jun 10, 2025
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
13 changes: 3 additions & 10 deletions pkg/runtime/adoption_reconciler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,11 +575,8 @@ func (r *adoptionReconciler) patchMetadataAndSpec(
// content returned from apiserver.
// Keep a copy of status field to reset the status of 'res' after patch call
resStatusCopy := res.DeepCopy().Status
err := r.kc.Patch(
ctx,
res,
client.MergeFrom(base),
)

err := patchWithoutCancel(ctx, r.kc, res, client.MergeFrom(base))
res.Status = resStatusCopy
return err
}
Expand All @@ -593,11 +590,7 @@ func (r *adoptionReconciler) patchStatus(
res *ackv1alpha1.AdoptedResource,
base *ackv1alpha1.AdoptedResource,
) error {
return r.kc.Status().Patch(
ctx,
res,
client.MergeFrom(base),
)
return patchStatusWithoutCancel(ctx, r.kc, res, client.MergeFrom(base))
}

// NewAdoptionReconciler returns a new adoptionReconciler object
Expand Down
10 changes: 5 additions & 5 deletions pkg/runtime/adoption_reconciler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ func mockManager() *ackmocks.AWSResourceManager {

func setupMockClientForAdoptedResource(kc *ctrlrtclientmock.Client, statusWriter *ctrlrtclientmock.SubResourceWriter, ctx context.Context, adoptedRes *ackv1alpha1.AdoptedResource) {
kc.On("Status").Return(statusWriter)
statusWriter.On("Patch", ctx, adoptedRes, mock.AnythingOfType("*client.mergeFromPatch")).Return(nil)
kc.On("Patch", ctx, adoptedRes, mock.AnythingOfType("*client.mergeFromPatch")).Return(nil)
statusWriter.On("Patch", withoutCancelContextMatcher, adoptedRes, mock.AnythingOfType("*client.mergeFromPatch")).Return(nil)
kc.On("Patch", withoutCancelContextMatcher, adoptedRes, mock.AnythingOfType("*client.mergeFromPatch")).Return(nil)
}

func setupMockAwsResource(
Expand Down Expand Up @@ -403,7 +403,7 @@ func assertAdoptedCondition(
adoptedRes *ackv1alpha1.AdoptedResource,
) {
kc.AssertCalled(t, "Status")
statusWriter.AssertCalled(t, "Patch", ctx, adoptedRes, mock.AnythingOfType("*client.mergeFromPatch"))
statusWriter.AssertCalled(t, "Patch", withoutCancelContextMatcher, adoptedRes, mock.AnythingOfType("*client.mergeFromPatch"))
// Only one kind of condition present
require.Equal(1, len(adoptedRes.Status.Conditions))
require.Equal(ackv1alpha1.ConditionTypeAdopted, adoptedRes.Status.Conditions[0].Type)
Expand All @@ -421,9 +421,9 @@ func assertAdoptedResourceManaged(
object *ackv1alpha1.AdoptedResource,
) {
if expectedManaged {
kc.AssertCalled(t, "Patch", ctx, object, mock.AnythingOfType("*client.mergeFromPatch"))
kc.AssertCalled(t, "Patch", withoutCancelContextMatcher, object, mock.AnythingOfType("*client.mergeFromPatch"))
} else {
kc.AssertNotCalled(t, "Patch", ctx, object, mock.AnythingOfType("*client.mergeFromPatch"))
kc.AssertNotCalled(t, "Patch", withoutCancelContextMatcher, object, mock.AnythingOfType("*client.mergeFromPatch"))
}
}

Expand Down
17 changes: 5 additions & 12 deletions pkg/runtime/field_export_reconciler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ func (r *fieldExportReconciler) writeToConfigMap(
cm.Data[key] = sourceValue

ackrtlog.DebugFieldExport(r.log, desired, "patching target config map")
err = r.kc.Patch(ctx, cm, patch)
err = patchWithoutCancel(ctx, r.kc, cm, patch)
if err != nil {
return err
}
Expand Down Expand Up @@ -371,7 +371,7 @@ func (r *fieldExportReconciler) writeToSecret(
secret.Data[key] = []byte(sourceValue)

ackrtlog.DebugFieldExport(r.log, desired, "patching target secret")
err = r.kc.Patch(ctx, secret, patch)
err = patchWithoutCancel(ctx, r.kc, secret, patch)
if err != nil {
return err
}
Expand Down Expand Up @@ -528,11 +528,7 @@ func (r *fieldExportReconciler) patchStatus(
res *ackv1alpha1.FieldExport,
base *ackv1alpha1.FieldExport,
) error {
return r.kc.Status().Patch(
ctx,
res,
client.MergeFrom(base),
)
return patchStatusWithoutCancel(ctx, r.kc, res, client.MergeFrom(base))
}

// markManaged places the supplied resource under the management of ACK.
Expand Down Expand Up @@ -579,11 +575,8 @@ func (r *fieldExportReconciler) patchMetadataAndSpec(
// content returned from apiserver.
// Keep a copy of status field to reset the status of 'res' after patch call
resStatusCopy := res.DeepCopy().Status
err := r.kc.Patch(
ctx,
res,
client.MergeFrom(base),
)

err := patchWithoutCancel(ctx, r.kc, res, client.MergeFrom(base))
res.Status = resStatusCopy
return err
}
Expand Down
22 changes: 11 additions & 11 deletions pkg/runtime/field_export_reconciler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ func mockResourceDescriptor() *mocks.AWSResourceDescriptor {

func setupMockClientForFieldExport(kc *ctrlrtclientmock.Client, statusWriter *ctrlrtclientmock.SubResourceWriter, ctx context.Context, fieldExport *ackv1alpha1.FieldExport) {
kc.On("Status").Return(statusWriter)
statusWriter.On("Patch", ctx, mock.Anything, mock.AnythingOfType("*client.mergeFromPatch")).Return(nil)
kc.On("Patch", ctx, mock.Anything, mock.AnythingOfType("*client.mergeFromPatch")).Return(nil)
statusWriter.On("Patch", withoutCancelContextMatcher, mock.Anything, mock.AnythingOfType("*client.mergeFromPatch")).Return(nil)
kc.On("Patch", withoutCancelContextMatcher, mock.Anything, mock.AnythingOfType("*client.mergeFromPatch")).Return(nil)
}

func setupMockApiReaderForFieldExport(apiReader *ctrlrtclientmock.Reader, ctx context.Context, res *mocks.AWSResource) {
Expand Down Expand Up @@ -336,7 +336,7 @@ func TestSync_FailureInPatchConfigMap(t *testing.T) {
statusWriter := &ctrlrtclientmock.SubResourceWriter{}

//Mock behavior setup
kc.On("Patch", ctx, mock.AnythingOfType("*v1.ConfigMap"), mock.AnythingOfType("*client.mergeFromPatch")).Return(errors.New("patching denied"))
kc.On("Patch", withoutCancelContextMatcher, mock.AnythingOfType("*v1.ConfigMap"), mock.AnythingOfType("*client.mergeFromPatch")).Return(errors.New("patching denied"))

setupMockClientForFieldExport(kc, statusWriter, ctx, fieldExport)
setupMockApiReaderForFieldExport(apiReader, ctx, res)
Expand Down Expand Up @@ -557,9 +557,9 @@ func assertPatchedConfigMap(expected bool, t *testing.T, ctx context.Context, kc
return val == "test-book-name"
})
if expected {
kc.AssertCalled(t, "Patch", ctx, dataMatcher, mock.Anything)
kc.AssertCalled(t, "Patch", withoutCancelContextMatcher, dataMatcher, mock.Anything)
} else {
kc.AssertNotCalled(t, "Patch", ctx, dataMatcher, mock.Anything)
kc.AssertNotCalled(t, "Patch", withoutCancelContextMatcher, dataMatcher, mock.Anything)
}
}

Expand All @@ -576,9 +576,9 @@ func assertPatchedSecret(expected bool, t *testing.T, ctx context.Context, kc *c
return bytes.Equal(val, []byte("test-book-name"))
})
if expected {
kc.AssertCalled(t, "Patch", ctx, dataMatcher, mock.Anything)
kc.AssertCalled(t, "Patch", withoutCancelContextMatcher, dataMatcher, mock.Anything)
} else {
kc.AssertNotCalled(t, "Patch", ctx, dataMatcher, mock.Anything)
kc.AssertNotCalled(t, "Patch", withoutCancelContextMatcher, dataMatcher, mock.Anything)
}
}

Expand All @@ -594,9 +594,9 @@ func assertPatchedSecretWithKey(expected bool, t *testing.T, ctx context.Context
return bytes.Equal(val, []byte("test-book-name"))
})
if expected {
kc.AssertCalled(t, "Patch", ctx, dataMatcher, mock.Anything)
kc.AssertCalled(t, "Patch", withoutCancelContextMatcher, dataMatcher, mock.Anything)
} else {
kc.AssertNotCalled(t, "Patch", ctx, dataMatcher, mock.Anything)
kc.AssertNotCalled(t, "Patch", withoutCancelContextMatcher, dataMatcher, mock.Anything)
}
}

Expand All @@ -614,7 +614,7 @@ func assertRecoverableCondition(
latest *ackv1alpha1.FieldExport,
) {
kc.AssertCalled(t, "Status")
statusWriter.AssertCalled(t, "Patch", ctx, mock.AnythingOfType("*v1alpha1.FieldExport"), mock.AnythingOfType("*client.mergeFromPatch"))
statusWriter.AssertCalled(t, "Patch", withoutCancelContextMatcher, mock.AnythingOfType("*v1alpha1.FieldExport"), mock.AnythingOfType("*client.mergeFromPatch"))
// Only one kind of condition present
require.Equal(1, len(latest.Status.Conditions))
require.Equal(ackv1alpha1.ConditionTypeRecoverable, latest.Status.Conditions[0].Type)
Expand All @@ -636,7 +636,7 @@ func assertTerminalCondition(
latest *ackv1alpha1.FieldExport,
) {
kc.AssertCalled(t, "Status")
statusWriter.AssertCalled(t, "Patch", ctx, mock.AnythingOfType("*v1alpha1.FieldExport"), mock.AnythingOfType("*client.mergeFromPatch"))
statusWriter.AssertCalled(t, "Patch", withoutCancelContextMatcher, mock.AnythingOfType("*v1alpha1.FieldExport"), mock.AnythingOfType("*client.mergeFromPatch"))
// Only one kind of condition present
require.Equal(1, len(latest.Status.Conditions))
require.Equal(ackv1alpha1.ConditionTypeTerminal, latest.Status.Conditions[0].Type)
Expand Down
12 changes: 6 additions & 6 deletions pkg/runtime/reconciler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,6 @@ const (
// resource if the CARM cache is not synced yet, or if the roleARN is not
// available.
roleARNNotAvailableRequeueDelay = 15 * time.Second
// adoptOrCreate is an annotation field that decides whether to create the
// resource if it doesn't exist, or adopt the resource if it exists.
// value comes from getAdoptionPolicy
// adoptOrCreate = "adopt-or-create"
)

// reconciler describes a generic reconciler within ACK.
Expand Down Expand Up @@ -880,7 +876,9 @@ func (r *resourceReconciler) patchResourceMetadataAndSpec(
rlog.Enter("kc.Patch (metadata + spec)")
lorig := latestCleaned.DeepCopy()
patch := client.MergeFrom(desiredCleaned.RuntimeObject())
err = r.kc.Patch(ctx, latestCleaned.RuntimeObject(), patch)

err = patchWithoutCancel(ctx, r.kc, latestCleaned.RuntimeObject(), patch)

if err == nil {
if rlog.IsDebugEnabled() {
js := getPatchDocument(patch, lorig.RuntimeObject())
Expand Down Expand Up @@ -916,7 +914,9 @@ func (r *resourceReconciler) patchResourceStatus(
dobj := desired.DeepCopy().RuntimeObject()
lobj := latest.DeepCopy().RuntimeObject()
patch := client.MergeFrom(dobj)
err = r.kc.Status().Patch(ctx, lobj, patch)

err = patchStatusWithoutCancel(ctx, r.kc, lobj, patch)

if err == nil {
if rlog.IsDebugEnabled() {
js := getPatchDocument(patch, lobj)
Expand Down
Loading