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.

Sign up for GitHub

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

Jump to bottom

VDiff: Fix vtctldclient limit bug #14778

Merged
merged 10 commits into from
Dec 14, 2023
Merged

VDiff: Fix vtctldclient limit bug #14778

merged 10 commits into from
Dec 14, 2023

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Dec 13, 2023 •
edited
Loading

Description

This fixes the bug described in #14777. I also adjusted the other max related flag values as I noticed a difference from the vtctlclient implementation in that we were limiting the accepted values to 4,294,967,295 in vtctldclient vs 9,223,372,036,854,775,807 in vtctlclient.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
    • Backporting to v18 as this is safe, the bug can cause errant/unexpected results, and the vtctldclient implementation is brand new in v18
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required
    • The vtctldclient docs will be updated automatically

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 13, 2023

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 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 Dec 13, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 13, 2023
@mattlord mattlord added Backport to: release-18.0 Component: VReplication Type: Bug and removed 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 Dec 13, 2023
@mattlord mattlord marked this pull request as ready for review December 13, 2023 21:18
@mattlord mattlord force-pushed the vtctldclient_vdiff_limit branch from e4abb0a to bcef5b4 Compare December 13, 2023 22:43
deepthi
deepthi reviewed Dec 13, 2023
View reviewed changes
go/cmd/vtctldclient/command/vreplication/vdiff/vdiff.go
@@ -57,13 +57,13 @@ var (
TargetCells []string
TabletTypes []topodatapb.TabletType
Tables []string
Limit uint32 // We only accept positive values but pass on an int64
Limit int64
Copy link
Member

Choose a reason for hiding this comment

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

If we want to accept only positive values, should this not be uint64?? Either that, or we'll need to add validation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That was the idea initially, but vtctlclient allows it and 0 is equivalent to any negative value. We can't use uint64 as we'll then allow larger values than the backend supports. I was on the fence so left it. I can add a quick check for positive values though if you like that more.

Copy link
Member

Choose a reason for hiding this comment

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

What does it mean that "0 is equivalent to any negative value"? What behavior do you get with a value of 0 for any of these flags?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As an example: https://github.com/vitessio/vitess/blob/main/go/vt/vttablet/tabletmanager/vdiff/table_differ.go#L534-L538

But no matter as I added checks to prevent negative values from the client.

go/test/endtoend/vreplication/vdiff2_test.go Outdated Show resolved Hide resolved
@mattlord
Add positive value checks
a3514a5 
Signed-off-by: Matt Lord <[email protected]>
deepthi
deepthi approved these changes Dec 13, 2023
View reviewed changes
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, except for me being nit-picky about the error messages.
s/positive/non-negative
Or even better would be must be 0 or greater or some variant of that.

go/cmd/vtctldclient/command/vreplication/vdiff/vdiff.go Show resolved Hide resolved
@mattlord
Halp... me...
90507a7 
Signed-off-by: Matt Lord <[email protected]>
@rohit-nayak-ps rohit-nayak-ps merged commit 3b906cf into vitessio:main Dec 14, 2023
116 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the vtctldclient_vdiff_limit branch December 14, 2023 09:14
@vitess-bot vitess-bot bot mentioned this pull request Dec 14, 2023
Merged
mattlord added a commit that referenced this pull request Dec 16, 2023
@vitess-bot @mattlord
[release-18.0] VDiff: Fix vtctldclient limit bug (#14778) (#14780)
2f43160 
Signed-off-by: Matt Lord <[email protected]>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Matt Lord <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rohit-nayak-ps rohit-nayak-ps rohit-nayak-ps approved these changes

@deepthi deepthi deepthi approved these changes

@ajm188 ajm188 Awaiting requested review from ajm188 ajm188 is a code owner

@notfelineit notfelineit Awaiting requested review from notfelineit notfelineit is a code owner

Assignees
No one assigned
Labels
Component: VReplication Type: Bug
Projects
VReplication
Status: Done
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.

Bug Report: vtctldclient vdiff incorrectly limits rows
3 participants
@mattlord @deepthi @rohit-nayak-ps