Skip to content

Refactor vstream_dynamic_packet_size and vstream_packet_size flags to use dashes#17964

Merged
deepthi merged 11 commits intovitessio:flags-refactorfrom
mounicasruthi:flags-refactor
Mar 20, 2025
Merged

Refactor vstream_dynamic_packet_size and vstream_packet_size flags to use dashes#17964
deepthi merged 11 commits intovitessio:flags-refactorfrom
mounicasruthi:flags-refactor

Conversation

@mounicasruthi
Copy link
Copy Markdown
Collaborator

@mounicasruthi mounicasruthi commented Mar 14, 2025 •
edited
Loading

Description

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

Flag Count Before vs After:

Before:

  • Total flags with underscores (_): 1488
  • Total flags with dashes (-): 572

After:

  • Total flags with underscores (_): 1484
  • Total flags with dashes (-): 576

# of migrated flags: 4

NOTE: This PR replaces #17926. The previous PR was closed due to branch cleanup.

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 and others added 9 commits March 13, 2025 19:25
@mounicasruthi
rename vstream_dynamic_packet_size and vstream_packet_size flags to u…
0d39bc7 
…se dashes

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi
fixed indentation
8786ff9 
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
@mounicasruthi @deepthi
Update go/vt/vttablet/common/config_test.go
77d9b24 
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
@mounicasruthi
rename vstream_dynamic_packet_size and vstream_packet_size flags to u…
1c675a8 
…se dashes

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi
adjust expected error count in invalid values test
65b2c73 
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
@mounicasruthi
style: format Go files using gofmt
f96ee46 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@rohit-nayak-ps @mounicasruthi
Use helper functions to reduce code duplication
93e7b20 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@mounicasruthi
Update flag variant selection for tests
7dbc76b 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi
add script file to count flags with underscores and dashes
2a909d3 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot bot commented Mar 14, 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 14, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Mar 14, 2025
@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 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 Mar 14, 2025
@mounicasruthi
Update flag variant selection for tests
b9ce4ad 
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 16, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.56%. Comparing base (0bf4276) to head (da311f7).
Report is 1 commits behind head on flags-refactor.

Additional details and impacted files 
@@                Coverage Diff                 @@
##           flags-refactor   #17964      +/-   ##
==================================================
- Coverage           67.56%   67.56%   -0.01%     
==================================================
  Files                1597     1598       +1     
  Lines              259763   259796      +33     
==================================================
+ Hits               175506   175525      +19     
- Misses              84257    84271      +14

☔ 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
rohit-nayak-ps approved these changes Mar 17, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@rohit-nayak-ps rohit-nayak-ps left a comment

Choose a reason for hiding this comment

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

Nice work.

@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review March 17, 2025 13:58
@mounicasruthi
Add comments to clarify flag variants handling
da311f7 
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
@deepthi deepthi merged commit c98bd37 into vitessio:flags-refactor Mar 20, 2025
103 checks passed
@mounicasruthi mounicasruthi mentioned this pull request Mar 24, 2025
Open
mounicasruthi added a commit to mounicasruthi/vitess that referenced this pull request Apr 3, 2025
@mounicasruthi @deepthi @rohit-nayak-ps
Refactor vstream_dynamic_packet_size and vstream_packet_size flags to…
0ec79d4 
… use dashes (vitessio#17964)

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Co-authored-by: Rohit Nayak <rohit@planetscale.com>
mounicasruthi added a commit to mounicasruthi/vitess that referenced this pull request May 20, 2025
@mounicasruthi @deepthi @rohit-nayak-ps
Refactor vstream_dynamic_packet_size and vstream_packet_size flags to…
96f84d8 
… use dashes (vitessio#17964)

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Co-authored-by: Rohit Nayak <rohit@planetscale.com>
mounicasruthi added a commit to mounicasruthi/vitess that referenced this pull request May 20, 2025
@mounicasruthi @deepthi @rohit-nayak-ps
Refactor vstream_dynamic_packet_size and vstream_packet_size flags to…
136ae46 
… use dashes (vitessio#17964)

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Co-authored-by: Deepthi Sigireddi <deepthi.sigireddi@gmail.com>
Co-authored-by: Rohit Nayak <rohit@planetscale.com>
@mounicasruthi mounicasruthi mentioned this pull request May 22, 2025
Merged
5 tasks
@anujagrawal380 anujagrawal380 mentioned this pull request Dec 15, 2025
Open
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

@beingnoble03 beingnoble03 Awaiting requested review from beingnoble03

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

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

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach is a code owner

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

+1 more reviewer

@deepthi deepthi deepthi approved these changes

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.

3 participants

@mounicasruthi @deepthi @rohit-nayak-ps