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

VDiff: Comment the VDiffCreate proto msg and set reasonable server side defaults #17026

Merged
merged 2 commits into from
Oct 22, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Oct 22, 2024

Description

This is some internal cleanup that I wanted to do after helping some people use the VtctldServer VDiff RPCs directly. It's mostly comments, but it also enforces a couple of additional server side defaults in a sensible way (and which matches the official vtlctld client flag defaults).

Related Issue(s)

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

Copy link
Contributor

vitess-bot bot commented Oct 22, 2024

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 Oct 22, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 22, 2024
@mattlord mattlord 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 Oct 22, 2024
@mattlord mattlord force-pushed the vdiff_internal_cleanup branch 2 times, most recently from 282ad8d to f701b2e Compare October 22, 2024 02:24
@mattlord mattlord marked this pull request as ready for review October 22, 2024 02:24
@mattlord mattlord requested review from deepthi and removed request for ajm188 October 22, 2024 02:27
And enforce sensible defaults on the server side.

Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord changed the title VDiff: Comment the VDiffCreate proto and set reasonable server side defaults VDiff: Comment the VDiffCreate proto msg and set reasonable server side defaults Oct 22, 2024
Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord removed the request for review from harshit-gangal October 22, 2024 02:47
Copy link

codecov bot commented Oct 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.15%. Comparing base (d651a42) to head (7470cf5).
Report is 8 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #17026   +/-   ##
=======================================
  Coverage   67.15%   67.15%           
=======================================
  Files        1571     1571           
  Lines      251836   251840    +4     
=======================================
+ Hits       169110   169113    +3     
- Misses      82726    82727    +1     

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

@mattlord mattlord merged commit 0f9a985 into vitessio:main Oct 22, 2024
98 checks passed
@mattlord mattlord deleted the vdiff_internal_cleanup branch October 22, 2024 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants