Skip to content

Conversation

@Aman-Cool
Copy link

This PR documents and fixes a correctness issue in the watch compaction path.

Issue

When the number of unsynced watchers was below the sync limit, choose() returned the original watcher group instead of a copy. During compaction, this caused the watcher map to be modified while it was being iterated, which could lead to:

  • etcd panicking with removing missing watcher!
  • Watchers silently missing compaction notifications and hanging indefinitely

This can occur during normal operation with auto-compaction enabled.

Fix

  • choose() now always returns a copy of the watcher group
  • chooseAll() no longer deletes watchers while iterating
  • Compacted watchers are cleaned up safely in syncWatchers()

Result

The fix eliminates panics and silent watch failures while preserving existing behavior.
All relevant MVCC tests pass, including compaction-related watch tests.

Screenshot 2026-01-24 at 5 19 40 PM Screenshot 2026-01-24 at 5 21 01 PM

@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Aman-Cool
Once this PR has been reviewed and has the lgtm label, please assign jmhbnz for approval. For more information see the Code Review Process.

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

Details Needs approval from an approver in each of these files:

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

@k8s-ci-robot
Copy link

Hi @Aman-Cool. Thanks for your PR.

I'm waiting for a etcd-io 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.

The choose() function conditionally returned the original unsynced
group when len(watchers) < maxWatchers. This caused chooseAll() to
modify the original group during iteration, leading to:
- Potential panic from double-delete of watchers
- Race condition causing duplicate compaction notifications

Fix by always returning a copy in choose() and properly handling
compacted watcher cleanup in syncWatchers().

Signed-off-by: Aman-Cool <[email protected]>
@Aman-Cool Aman-Cool force-pushed the fix-watch-compaction-race branch from 9e8da9d to eca4fac Compare January 24, 2026 11:55
@Aman-Cool
Copy link
Author

@serathius @ahrtr , This PR fixes a watch compaction bug where chooseAll() could mutate the unsynced watcher map during iteration when the watcher count is small, leading to panics or silent watch hangs.
The fix always works on a copy and defers cleanup to syncWatchers().

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants