fix: clean up related resources when primary object is deleted by ifdotpy · Pull Request #133 · kcp-dev/api-syncagent

ifdotpy · 2026-02-19T17:56:12Z

Summary

Fixes #116 — related resources with origin: kcp are now cleaned up when the primary object is deleted, preventing orphaned finalizers that block workspace deletion.

Problem

When a primary object (e.g. ChatUIInstance) is deleted:

handleDeletion() deletes the local copy and removes the primary finalizer
handleDeletion() returns requeue=true, so processRelatedResources() is never called
On the next reconcile, the primary object is gone — the controller has nothing to reconcile
Related resources (e.g. a KCP Secret) retain syncagent.kcp.io/cleanup finalizer forever
Workspace deletion is blocked indefinitely

Fix

Process related resources before primary deletion in syncer.go: when the primary object has a DeletionTimestamp, call processRelatedResources(primaryDeleting=true) before the primary syncer runs. This ensures cleanup happens while the local primary copy still exists (needed for reference resolution).
Add forceDelete field to objectSyncer: when set, triggers handleDeletion() even when the source object's DeletionTimestamp is nil. Used for origin: kcp related resources during primary deletion.
Remove early return in handleDeletion() that skipped related resource processing with the comment "For now we do not delete related resources".
Nil-guard for destSide.object after primary deletion to prevent panics when the local copy has already been removed.

Files changed

File	Change
`internal/sync/object_syncer.go`	Added `forceDelete` field; triggers deletion without `DeletionTimestamp`; removed early return
`internal/sync/syncer.go`	Process related resources before primary deletion; nil-guard for destSide
`internal/sync/syncer_related.go`	Added `primaryDeleting` parameter; set `forceDelete=true` for `origin: kcp`

Testing

Tested in our Platform Mesh environment (KCP + Gardener MSP clusters):

Created ChatUIInstance with related origin: kcp Secret
Deleted ChatUIInstance
Verified: Secret finalizer removed, workspace deletion completes cleanly

Discussed the approach with @xrstf in Slack — processing deletions in the opposite order was confirmed as the right approach.

Release Notes

Related resources with origin kcp are now cleaned up when the primary object is deleted, preventing orphaned finalizers that block workspace/namespace deletion.

kcp-ci-bot · 2026-02-19T17:56:24Z

Hi @ifdotpy. Thanks for your PR.

I'm waiting for a kcp-dev member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

xrstf · 2026-02-20T10:57:50Z

Can you please an add e2e testcase that shows that this is working, so we do not break it in the future?

ifdotpy · 2026-02-20T12:01:37Z

@xrstf done

internal/sync/syncer_related.go

test/e2e/sync/related_test.go

Adds a regression test that verifies syncagent.kcp.io/cleanup finalizers are properly removed from kcp-origin related resources when the primary object is deleted. Without the fix, the finalizer remains indefinitely, blocking namespace/workspace deletion. Signed-off-by: Igor Fominykh <ifdotpy@gmail.com>

…ev#116) When a primary object is deleted, related resources with origin kcp retain their syncagent.kcp.io/cleanup finalizer indefinitely because processRelatedResources() is never called during deletion. Process related resources before the primary syncer handles deletion, passing forceDelete=true for kcp-origin related resources so their finalizers are properly removed. Signed-off-by: Igor Fominykh <ifdotpy@gmail.com>

xrstf · 2026-02-20T14:18:49Z

/test all
/approve
/kind bug

kcp-ci-bot · 2026-02-20T14:18:55Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: xrstf

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [xrstf]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Fix whitespace alignment flagged by gimps import formatter. Signed-off-by: Igor Fominykh <ifdotpy@gmail.com>

ifdotpy · 2026-02-20T14:31:51Z

/retest

kcp-ci-bot · 2026-02-20T14:32:08Z

@ifdotpy: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

xrstf · 2026-02-20T14:36:59Z

/ok-to-test

SimonTheLeg · 2026-02-23T09:41:23Z

hi @ifdotpy Thanks for you contribution. For this PR to merge, it will require a release note block.

Basically you need to edit your PR description and at the bottom add a release note block like this (without the tabs, GH markdown, just won't let me do it otherwise)

	```release-note
	related resources are now cleaned up when the primary object is deleted
	```

here is another PR as an example kcp-dev/kcp#3780

ifdotpy · 2026-02-23T09:52:32Z

hi @ifdotpy Thanks for you contribution. For this PR to merge, it will require a release note block.

Basically you need to edit your PR description and at the bottom add a release note block like this (without the tabs, GH markdown, just won't let me do it otherwise)
	```release-note
	related resources are now cleaned up when the primary object is deleted
here is another PR as an example [kcp-dev/kcp#3780](https://github.com/kcp-dev/kcp/pull/3780)

done!

ntnn

/lgtm

Last thing that was missing for tide. Thanks for the contribution!

kcp-ci-bot · 2026-02-23T10:17:36Z

LGTM label has been added.

Details

Git tree hash: ead15efee1b448a590212b0e9207c9061d2a1152

kcp-ci-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 19, 2026

kcp-ci-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 20, 2026

ifdotpy force-pushed the fix/116-related-resource-cleanup branch 2 times, most recently from dca44ae to ec3489e Compare February 20, 2026 11:59

kcp-ci-bot added dco-signoff: yes Indicates the PR's author has signed the DCO. and removed dco-signoff: no Indicates the PR's author has not signed the DCO. labels Feb 20, 2026

xrstf reviewed Feb 20, 2026

View reviewed changes

internal/sync/syncer_related.go Outdated Show resolved Hide resolved

xrstf reviewed Feb 20, 2026

View reviewed changes

test/e2e/sync/related_test.go Show resolved Hide resolved

ifdotpy added 2 commits February 20, 2026 14:29

ifdotpy force-pushed the fix/116-related-resource-cleanup branch from ec3489e to 5493247 Compare February 20, 2026 13:30

kcp-ci-bot added kind/bug Categorizes issue or PR as related to a bug. and removed do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Feb 20, 2026

kcp-ci-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 20, 2026

fix: align struct field formatting in syncer.go

b0766d2

Fix whitespace alignment flagged by gimps import formatter. Signed-off-by: Igor Fominykh <ifdotpy@gmail.com>

kcp-ci-bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 20, 2026

kcp-ci-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Feb 23, 2026

ntnn approved these changes Feb 23, 2026

View reviewed changes

kcp-ci-bot assigned ntnn Feb 23, 2026

kcp-ci-bot added the lgtm Indicates that a PR is ready to be merged. label Feb 23, 2026

kcp-ci-bot merged commit 5d9fc7a into kcp-dev:main Feb 23, 2026
10 checks passed

Conversation

ifdotpy commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Problem

Fix

Files changed

Testing

Release Notes

Uh oh!

kcp-ci-bot commented Feb 19, 2026

Uh oh!

xrstf commented Feb 20, 2026

Uh oh!

ifdotpy commented Feb 20, 2026

Uh oh!

Uh oh!

Uh oh!

xrstf commented Feb 20, 2026

Uh oh!

kcp-ci-bot commented Feb 20, 2026

Uh oh!

ifdotpy commented Feb 20, 2026

Uh oh!

kcp-ci-bot commented Feb 20, 2026

Uh oh!

xrstf commented Feb 20, 2026

Uh oh!

SimonTheLeg commented Feb 23, 2026

Uh oh!

ifdotpy commented Feb 23, 2026

Uh oh!

ntnn left a comment

Choose a reason for hiding this comment

Uh oh!

kcp-ci-bot commented Feb 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ifdotpy commented Feb 19, 2026 •

edited

Loading