Skip to content

vtorc: add timeout helpers for remaining recovery topo/tmc calls#19520

Draft
mhamza15 wants to merge 1 commit intovitessio:mainfrom
mhamza15:vtorc-context-timeout
Draft

vtorc: add timeout helpers for remaining recovery topo/tmc calls#19520
mhamza15 wants to merge 1 commit intovitessio:mainfrom
mhamza15:vtorc-context-timeout

Conversation

@mhamza15
Copy link
Collaborator

@mhamza15 mhamza15 commented Feb 27, 2026

Description

We still have a few recovery paths passing bare contexts to topo/tmc calls, which means a stuck RPC can block a recovery indefinitely and keep the recovery row active. This changes those call sites to use helper wrappers with topo.RemoteOperationTimeout:

  • restartDirectReplicas
    • ts.GetTabletsByShard -> getShardTablets
    • tmc.StopReplication -> stopReplication
    • tmc.StartReplication -> startReplication
  • refreshTabletsInKeyspaceShard
    • ts.GetTabletsByShardCell -> getShardTabletsByCell

This also generates a MockTabletManagerClient and adds a test that uses it to simulate a replication RPC hanging forever and verifies we return with context.DeadlineExceeded instead of blocking.

Don't be alarmed by the lines added number, that's the generated mock client 😅.

Related Issue(s)

Fixes #19519

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

Help from Codex.

This follows up on vitessio#19519. We still had a few recovery paths passing bare contexts to topo/tmc calls, which means a stuck RPC can block a recovery indefinitely and keep the recovery row active.

This changes those call sites to use helper wrappers with `topo.RemoteOperationTimeout`:

- `restartDirectReplicas`
  - `ts.GetTabletsByShard` -> `getShardTablets`
  - `tmc.StopReplication` -> `stopReplication`
  - `tmc.StartReplication` -> `startReplication`
- `refreshTabletsInKeyspaceShard`
  - `ts.GetTabletsByShardCell` -> `getShardTabletsByCell`

This also generates a `MockTabletManagerClient` and adds a `synctest` that uses it to simulate a replication RPC hanging forever and verifies we return with `context.DeadlineExceeded` instead of blocking.

Fixes vitessio#19519

Signed-off-by: Mohamed Hamza <mhamza@fastmail.com>
@mhamza15 mhamza15 self-assigned this Feb 27, 2026
@github-actions github-actions bot added this to the v24.0.0 milestone Feb 27, 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 Feb 27, 2026
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Feb 27, 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.

@mhamza15 mhamza15 added Type: Bug Component: VTOrc Vitess Orchestrator integration 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 Feb 27, 2026
@codecov
Copy link

codecov bot commented Feb 27, 2026

Codecov Report

❌ Patch coverage is 76.19048% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 33.14%. Comparing base (70c7a72) to head (476b75b).
⚠️ Report is 37 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtorc/logic/topology_recovery.go 66.66% 5 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (70c7a72) and HEAD (476b75b). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (70c7a72) HEAD (476b75b)
1 0
Additional details and impacted files
@@             Coverage Diff             @@
##             main   #19520       +/-   ##
===========================================
- Coverage   69.67%   33.14%   -36.53%     
===========================================
  Files        1614       13     -1601     
  Lines      216793     2453   -214340     
===========================================
- Hits       151044      813   -150231     
+ Misses      65749     1640    -64109     
Flag Coverage Δ
partial 33.14% <76.19%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

Labels

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 Component: VTOrc Vitess Orchestrator integration Type: Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug Report: Some VTOrc recovery functions use contexts without timeouts

1 participant