[release-21.0] VReplication: Address SwitchTraffic bugs around replication lag and cancel on error (#17616)

[vitess-bot]

Description

This is a backport of #17616

[vitess-bot]

Hello @mattlord, there are conflicts in this backport.

Please address them in order to merge this Pull Request. You can execute the snippet below to reset your branch and resolve the conflict manually.

Make sure you replace origin by the name of the vitessio/vitess remote

git fetch --all
gh pr checkout 17644 -R vitessio/vitess
git reset --hard origin/release-21.0
git cherry-pick -m 1 39a0ddde8f27431f890662d3de8c62fcda530f7e

[vitess-bot]

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.

[codecov]

Codecov Report

Attention: Patch coverage is 38.31776% with 66 lines in your changes missing coverage. Please review.

Project coverage is 67.54%. Comparing base (332cfc2) to head (37e4185).
Report is 8 commits behind head on release-21.0.

Files with missing lines	Patch %	Lines
go/vt/vtctl/workflow/server.go	43.75%	36 Missing ⚠️
go/vt/vtctl/workflow/traffic_switcher.go	25.00%	21 Missing ⚠️
go/vt/vtctl/workflow/stream_migrator.go	54.54%	5 Missing ⚠️
go/vt/vtctl/workflow/switcher.go	0.00%	2 Missing ⚠️
go/vt/vtctl/workflow/switcher_dry_run.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff                @@
##           release-21.0   #17644      +/-   ##
================================================
+ Coverage         67.51%   67.54%   +0.02%     
================================================
  Files              1570     1570              
  Lines            251472   251522      +50     
================================================
+ Hits             169783   169891     +108     
+ Misses            81689    81631      -58     

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