Skip to content

mysqlctl: propagate remote shutdown timeout#20059

Merged
mhamza15 merged 2 commits into
vitessio:mainfrom
mhamza15:backup-shutdown-timeout
May 11, 2026
Merged

mysqlctl: propagate remote shutdown timeout#20059
mhamza15 merged 2 commits into
vitessio:mainfrom
mhamza15:backup-shutdown-timeout

Conversation

@mhamza15
Copy link
Copy Markdown
Collaborator

@mhamza15 mhamza15 commented May 7, 2026

Description

Remote mysqlctl shutdown calls accepted a caller-provided timeout but dropped it when building the gRPC request, causing mysqlctld to fall back to its default shutdown timeout. This carries the timeout through the client interface and serializes it into the shutdown request.

This is a small, isolated bug fix, so I'm suggesting to backport it to v23 and v24.

Related Issue(s)

Closes #20061

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 GPT 5.5.

Remote mysqlctl shutdown calls accepted a caller-provided timeout but dropped it when building the gRPC request, causing mysqlctld to fall back to its default shutdown timeout. This carries the timeout through the client interface and serializes it into the shutdown request.

Signed-off-by: Mohamed Hamza <mhamza@fastmail.com>
Copilot AI review requested due to automatic review settings May 7, 2026 18:30
@github-actions github-actions Bot added this to the v25.0.0 milestone May 7, 2026
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot Bot commented May 7, 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.

@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 May 7, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes remote mysqlctl shutdown behavior by ensuring the caller-provided shutdown timeout is propagated over the mysqlctld gRPC boundary, instead of being dropped and replaced by mysqlctld’s default.

Changes:

  • Extend the MysqlctlClient Shutdown method to accept a shutdownTimeout time.Duration.
  • Pass the shutdown timeout through Mysqld.Shutdown when executing remotely via mysqlctld.
  • Serialize the timeout into mysqlctlpb.ShutdownRequest using protoutil.DurationToProto.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
go/vt/mysqlctl/mysqld.go Propagates shutdownTimeout into the remote mysqlctld shutdown call.
go/vt/mysqlctl/mysqlctlclient/interface.go Updates the client interface to carry shutdownTimeout for remote shutdowns.
go/vt/mysqlctl/grpcmysqlctlclient/client.go Adds MysqlShutdownTimeout to the gRPC ShutdownRequest payload.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.27%. Comparing base (70c7a72) to head (9603493).
⚠️ Report is 238 commits behind head on main.

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

HEAD has 1 upload less than BASE
Flag BASE (70c7a72) HEAD (9603493)
1 0
Additional details and impacted files
@@             Coverage Diff             @@
##             main   #20059       +/-   ##
===========================================
- Coverage   69.67%   52.27%   -17.40%     
===========================================
  Files        1614       46     -1568     
  Lines      216793     7128   -209665     
===========================================
- Hits       151044     3726   -147318     
+ Misses      65749     3402    -62347     
Flag Coverage Δ
partial 52.27% <100.00%> (?)

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.

@mhamza15 mhamza15 added Type: Bug Component: Backup and Restore Backport to: release-23.0 Needs to be backport to release-23.0 Backport to: release-24.0 Needs to be backport to release-24.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 May 7, 2026
@mhamza15 mhamza15 marked this pull request as ready for review May 7, 2026 19:07
@mhamza15 mhamza15 requested review from frouioui and mattlord as code owners May 7, 2026 19:07
@mhamza15 mhamza15 requested review from arthurschreiber, nickvanw and timvaillancourt and removed request for frouioui May 7, 2026 19:08
Copy link
Copy Markdown
Member

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Can we add some kind of test coverage for it?

Signed-off-by: Mohamed Hamza <mhamza@fastmail.com>
Copy link
Copy Markdown
Member

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @mhamza15 ! ❤️

@mhamza15 mhamza15 merged commit 29d1760 into vitessio:main May 11, 2026
109 checks passed
@mhamza15 mhamza15 deleted the backup-shutdown-timeout branch May 11, 2026 14:33
timvaillancourt pushed a commit to timvaillancourt/vitess that referenced this pull request May 12, 2026
Signed-off-by: Mohamed Hamza <mhamza@fastmail.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
arthurschreiber pushed a commit that referenced this pull request May 22, 2026
…20075)

Signed-off-by: Mohamed Hamza <mhamza@fastmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Mohamed Hamza <mhamza@fastmail.com>
arthurschreiber pushed a commit that referenced this pull request May 22, 2026
…20074)

Signed-off-by: Mohamed Hamza <mhamza@fastmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Mohamed Hamza <mhamza@fastmail.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Backport to: release-23.0 Needs to be backport to release-23.0 Backport to: release-24.0 Needs to be backport to release-24.0 Component: Backup and Restore Type: Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug Report: --mysql-shutdown-timeout is ignored when shutdown runs through mysqlctld

4 participants