Skip to content

Rename vstream_dynamic_packet_size and vstream_packet_size flags to use dashes #17926

Closed
mounicasruthi wants to merge 7 commits intovitessio:flags-refactorfrom
mounicasruthi:rename-flags
Closed

Rename vstream_dynamic_packet_size and vstream_packet_size flags to use dashes #17926
mounicasruthi wants to merge 7 commits intovitessio:flags-refactorfrom
mounicasruthi:rename-flags

Conversation

@mounicasruthi
Copy link
Copy Markdown
Collaborator

@mounicasruthi mounicasruthi commented Mar 6, 2025 •
edited
Loading

Description

This PR is a part of an ongoing change to support the transition from _ to - in flag naming conventions.

Flag Count Before vs After:

Before:

  • Total Flags with underscores (_): 1463
  • Total Flags with dashes (-): 553

After:

  • Total Flags with underscores (_): 1459
  • Total Flags with dashes (-): 557

Related Issue(s)

#17880

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

@mounicasruthi
rename vstream_dynamic_packet_size and vstream_packet_size flags to u…
b2db86d 
…se dashes

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot bot commented Mar 6, 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 Mar 6, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Mar 6, 2025
@mounicasruthi
fixed indentation
fff0e3f 
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
deepthi
deepthi reviewed Mar 7, 2025
View reviewed changes
@mounicasruthi @deepthi
Update go/vt/vttablet/common/config_test.go
e632575 
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
GrahamCampbell
GrahamCampbell reviewed Mar 7, 2025
View reviewed changes
@mounicasruthi
rename vstream_dynamic_packet_size and vstream_packet_size flags to u…
793d42a 
…se dashes

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi mounicasruthi added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication and removed 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 Mar 8, 2025
@mounicasruthi
adjust expected error count in invalid values test
fbcded6 
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
@mounicasruthi mounicasruthi removed the NeedsWebsiteDocsUpdate What it says label Mar 8, 2025
@mounicasruthi
style: format Go files using gofmt
8224e26 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 8, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.56%. Comparing base (a9192fd) to head (8f49851).
Report is 47 commits behind head on flags-refactor.

Additional details and impacted files 
@@                Coverage Diff                 @@
##           flags-refactor   #17926      +/-   ##
==================================================
+ Coverage           67.46%   67.56%   +0.09%     
==================================================
  Files                1592     1598       +6     
  Lines              258184   259806    +1622     
==================================================
+ Hits               174181   175534    +1353     
- Misses              84003    84272     +269

☔ 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.

@rohit-nayak-ps
Use helper functions to reduce code duplication
8f49851 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps rohit-nayak-ps changed the base branch from main to flags-refactor March 10, 2025 14:40
@mounicasruthi mounicasruthi deleted the rename-flags branch March 14, 2025 07:25
@mounicasruthi mounicasruthi mentioned this pull request Mar 14, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal will be requested when the pull request is marked ready for review harshit-gangal is a code owner

@systay systay Awaiting requested review from systay systay will be requested when the pull request is marked ready for review systay is a code owner

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach will be requested when the pull request is marked ready for review shlomi-noach is a code owner

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps will be requested when the pull request is marked ready for review rohit-nayak-ps is a code owner

@timvaillancourt timvaillancourt Awaiting requested review from timvaillancourt timvaillancourt will be requested when the pull request is marked ready for review timvaillancourt is a code owner

Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

2 more reviewers

@deepthi deepthi deepthi left review comments

@GrahamCampbell GrahamCampbell GrahamCampbell left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Component: VReplication Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Milestone

v22.0.0

Development

Successfully merging this pull request may close these issues.

4 participants

@mounicasruthi @deepthi @GrahamCampbell @rohit-nayak-ps