Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VReplication SwitchTraffic: for a dry run check if sequences need to be updated #17842

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

rohit-nayak-ps
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps commented Feb 21, 2025

Description

When resharding an unsharded keyspace or moving a table from an unsharded keyspace to a sharded one, sequences need to replace autoincrements. These sequences need to be set to an initial value which is above the max id. Doing this for each table is tedious and the --initial-target-sequences option was added to SwitchTraffic for this purpose.

However ff there are a lot of tables being resharded the process of getting the max ids from all shards and then updating the value on the unsharded keyspace can take too long. So it might still make sense for the users to update the sequence manually.

This PR adds the ability to find the sequences which need to be updated as part of switching traffic. The user can then decide on setting a value on the targets to a safe value and then not use the --initial-target-sequences flag.

The code to get the max values was intertwined with the rest of the sequence setting code. So this PR also refactors the existing code to have a single code path for the dry run and regular path.

Related Issue(s)

fixes #17831

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

Copy link
Contributor

vitess-bot bot commented Feb 21, 2025

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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Feb 21, 2025
@rohit-nayak-ps rohit-nayak-ps removed 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 21, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 21, 2025
@rohit-nayak-ps rohit-nayak-ps removed the NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work label Feb 21, 2025
Copy link

codecov bot commented Feb 21, 2025

Codecov Report

Attention: Patch coverage is 67.35460% with 174 lines in your changes missing coverage. Please review.

Project coverage is 67.47%. Comparing base (2118bc3) to head (3d1742e).
Report is 15 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtctl/workflow/sequences.go 67.50% 168 Missing ⚠️
go/vt/vtctl/workflow/switcher_dry_run.go 62.50% 6 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17842      +/-   ##
==========================================
+ Coverage   67.45%   67.47%   +0.01%     
==========================================
  Files        1592     1595       +3     
  Lines      258167   259066     +899     
==========================================
+ Hits       174143   174792     +649     
- Misses      84024    84274     +250     

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

@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review February 25, 2025 15:32
Copy link
Contributor

@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! Just a few nits that you can do whatever you prefer with. Thanks! ❤️

if sm.usingTableDefinition != nil && sm.usingTableDefinition.AutoIncrement != nil {
usingCol, err = sqlescape.EnsureEscaped(sm.usingTableDefinition.AutoIncrement.Column)
if err != nil {
err = vterrors.Errorf(vtrpcpb.Code_INTERNAL, "invalid column name %s specified for sequence in table %s: %v",
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit, but INVALID_ARGUMENT is probably a better error code here and throughout this function.

Comment on lines +92 to +94
err = vterrors.Errorf(vtrpcpb.Code_INTERNAL, "invalid database name %s specified for sequence in table %s: %v",
sm.usingTableDBName, sm.usingTableName, err)
return err
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit, but I don't see any reason not to return the errors directly in this function (return vterrors.Errorf...)

errs := ts.ForAllTargets(func(target *MigrationTarget) error {
primary := target.GetPrimary()
if primary == nil || primary.GetAlias() == nil {
return vterrors.Errorf(vtrpcpb.Code_INTERNAL, "no primary tablet found for target shard %s/%s",
Copy link
Contributor

Choose a reason for hiding this comment

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

Another nit but a better code here IMO would be FAILED_PRECONDITION.

Comment on lines +267 to +272
sequenceShard, ierr := ts.TopoServer().GetOnlyShard(ctx, seq.backingTableKeyspace)
if ierr != nil || sequenceShard == nil || sequenceShard.PrimaryAlias == nil {
return vterrors.Errorf(vtrpcpb.Code_INTERNAL, "failed to get the primary tablet for keyspace %s: %v",
seq.backingTableKeyspace, ierr)
}
sequenceTablet, ierr := ts.TopoServer().GetTablet(ctx, sequenceShard.PrimaryAlias)
Copy link
Contributor

Choose a reason for hiding this comment

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

Not necessary to do here, but noting that we could save the tablets used in getCurrentSequenceValue and re-use them here so that we don't double the topo calls. If the total time taken is a concern, this refactor will make that problem worse (though topo calls should be fast vs mysqld calls).


dr.drLog.Log("The following sequence backing tables used by tables being moved will be initialized:")
for _, backingTable := range sortedBackingTableNames {
dr.drLog.Logf("\t\tBacking table: %s, current value %d, new value %d",
Copy link
Contributor

@mattlord mattlord Feb 25, 2025

Choose a reason for hiding this comment

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

Nit, but two tabs is a bit excessive IMO. I think 1 would be enough.

Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

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

LGTM. You seem to have added a unit test that covers the net-new functions 👍


// createMissingSequenceTables will create the backing sequence tables for those that
// could not be found in any current keyspace.
func (ts trafficSwitcher) createMissingSequenceTables(ctx context.Context, sequencesByBackingTable map[string]*sequenceMetadata, tablesFound map[string]struct{}) error {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
func (ts trafficSwitcher) createMissingSequenceTables(ctx context.Context, sequencesByBackingTable map[string]*sequenceMetadata, tablesFound map[string]struct{}) error {
func (ts *trafficSwitcher) createMissingSequenceTables(ctx context.Context, sequencesByBackingTable map[string]*sequenceMetadata, tablesFound map[string]struct{}) error {

Copy link
Member

Choose a reason for hiding this comment

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

GoLand produced a warning for this.

return nil
}

func (ts trafficSwitcher) createSequenceTable(ctx context.Context, tableName string, primary *topo.TabletInfo) error {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
func (ts trafficSwitcher) createSequenceTable(ctx context.Context, tableName string, primary *topo.TabletInfo) error {
func (ts *trafficSwitcher) createSequenceTable(ctx context.Context, tableName string, primary *topo.TabletInfo) error {

Copy link
Member

Choose a reason for hiding this comment

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

Another warning

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants