Skip to content

e2e: fix race in TestFailingReplication#19547

Merged
timvaillancourt merged 1 commit intovitessio:mainfrom
timvaillancourt:vtbackup-fix-restore-race
Mar 3, 2026
Merged

e2e: fix race in TestFailingReplication#19547
timvaillancourt merged 1 commit intovitessio:mainfrom
timvaillancourt:vtbackup-fix-restore-race

Conversation

@timvaillancourt
Copy link
Copy Markdown
Contributor

Description

This PR fixes a race condition in the vtbackup e2e test that causes TestFailingReplication (and other tests using prepareCluster()) to hang in CI.

The problem

prepareCluster() calls restore(), which returns as soon as the vttablet HTTP endpoint responds. But RestoreData continues running in the background holding the actionSema — a weight-1 semaphore. The next call, SetWritable, also needs the actionSema, so it blocks waiting for the restore to finish.

This race has always existed on all branches, but became a consistent failure on main and release-23.0 because MySQL 8.4 restores take longer than MySQL 8.0, widening the race window enough that SetWritable fires before RestoreData completes. In CI this causes a 19+ minute hang followed by a timeout.

The fix

Adds a waitForRestoreComplete() helper between restore() and SetWritable that polls the tablet type via /debug/vars, waiting for the replica → restore → replica transition that signals RestoreData has finished and released the semaphore.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

AI Disclosure

Fix found by Claude while debugging flakiness on PR #19472

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot bot commented Mar 3, 2026

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@github-actions github-actions bot added this to the v24.0.0 milestone Mar 3, 2026
@vitess-bot vitess-bot bot added NeedsWebsiteDocsUpdate What it says NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Mar 3, 2026
@timvaillancourt timvaillancourt added Backport to: release-22.0 Needs to be backport to release-22.0 Backport to: release-23.0 Needs to be backport to release-23.0 and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Mar 3, 2026
@timvaillancourt timvaillancourt marked this pull request as ready for review March 3, 2026 18:00
@timvaillancourt timvaillancourt merged commit 7efc7c4 into vitessio:main Mar 3, 2026
198 of 201 checks passed
@timvaillancourt timvaillancourt deleted the vtbackup-fix-restore-race branch March 3, 2026 19:40
vitess-bot bot added a commit that referenced this pull request Mar 3, 2026
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
timvaillancourt pushed a commit that referenced this pull request Mar 3, 2026
…19548)

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants