Skip to content

Standardize topo flags to use hyphen-based naming#17975

Merged
rohit-nayak-ps merged 23 commits intovitessio:flags-refactorfrom
mounicasruthi:topo-flags-refactor
Mar 22, 2025
Merged

Standardize topo flags to use hyphen-based naming#17975
rohit-nayak-ps merged 23 commits intovitessio:flags-refactorfrom
mounicasruthi:topo-flags-refactor

Conversation

@mounicasruthi
Copy link
Copy Markdown
Collaborator

@mounicasruthi mounicasruthi commented Mar 17, 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.

Flags Updated in This PR:
--topo-consul-lock-delay
--topo-consul-lock-session-checks
--topo-consul-lock-session-ttl
--topo-consul-watch-poll-duration
--topo-etcd-lease-ttl
--topo-etcd-tls-ca
--topo-etcd-tls-cert
--topo-etcd-tls-key
--topo-global-root
--topo-global-server-address
--topo-implementation
--topo-information-refresh-duration
--topo-read-concurrency
--topo-zk-auth-file
--topo-zk-base-timeout
--topo-zk-max-concurrency
--topo-zk-tls-ca
--topo-zk-tls-cert
--topo-zk-tls-key

Flag Count Before vs After:

Flags with _ Flags with -
Before 1484 576
After 1366 694

# of migrated flags: 118

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

mounicasruthi and others added 12 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>
@mounicasruthi
Update flag variant selection for tests
b9ce4ad 
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
@mounicasruthi
Refactored topo flags to standardize naming
3312ed0 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi
refactor topo_ flags to follow standard naming convention
0e9b2ff 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi mounicasruthi added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: General Changes throughout the code base labels Mar 17, 2025
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot bot commented Mar 17, 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 17, 2025
@mounicasruthi mounicasruthi 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 17, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Mar 17, 2025
@mounicasruthi
update topo flags in tests to support random notation assignment
dabf1fb 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 17, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 80.95238% with 8 lines in your changes missing coverage. Please review.

Please upload report for BASE (flags-refactor@c98bd37). Learn more about missing BASE report.

Files with missing lines Patch % Lines
go/vt/topo/zk2topo/zk_conn.go 66.66% 3 Missing ⚠️
go/vt/vttest/vtprocess.go 0.00% 3 Missing ⚠️
go/vt/topo/server.go 66.66% 2 Missing ⚠️
Additional details and impacted files 
@@                Coverage Diff                @@
##             flags-refactor   #17975   +/-   ##
=================================================
  Coverage                  ?   67.56%           
=================================================
  Files                     ?     1598           
  Lines                     ?   259808           
  Branches                  ?        0           
=================================================
  Hits                      ?   175545           
  Misses                    ?    84263           
  Partials                  ?        0

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

@mounicasruthi
use flags with dashed notation until v25
da8f113 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi
temporarily use underscore(_) flags to maintain compatibility with ol…
5780f08 
…der binary versions

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi
removed count_flags.sh
8ffab3c 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
rohit-nayak-ps and others added 5 commits March 18, 2025 23:56
@rohit-nayak-ps
Add additional debugs to check reason for backup upgrade/downgrade fa…
079d759 
…ilure

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps
Let vttablet output to stdout since the vttablet.out file seems to be…
f46c1ac 
… not getting printed?

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@mounicasruthi
use underscored naming for flags in env.sh to support older versions
d6ce6c3 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi
Revert "Let vttablet output to stdout since the vttablet.out file see…
39eda7d 
…ms to be not getting printed?"

This reverts commit f46c1ac.

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi
Revert "Add additional debugs to check reason for backup upgrade/down…
5b30d67 
…grade failure"

This reverts commit 079d759.

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
mounicasruthi and others added 2 commits March 22, 2025 00:10
@mounicasruthi
Merge branch 'flags-refactor' into topo-flags-refactor
5455e9a 
Signed-off-by: Mounica Sruthi <78213881+mounicasruthi@users.noreply.github.com>
@mounicasruthi
add missing import to fix errors
934306d 
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review March 22, 2025 08:57
rohit-nayak-ps
rohit-nayak-ps approved these changes Mar 22, 2025
View reviewed changes
go/test/endtoend/cluster/vtbackup_process.go
vtbackup.proc.Args = append(vtbackup.proc.Args, k, v)
}

// vtbackup.proc = exec.Command(
Copy link
Copy Markdown
Member

@rohit-nayak-ps rohit-nayak-ps Mar 22, 2025

Choose a reason for hiding this comment

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

We should remove these comments

@rohit-nayak-ps rohit-nayak-ps merged commit 0a9d1ee into vitessio:flags-refactor Mar 22, 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
Standardize topo flags to use hyphen-based naming (vitessio#17975)
99bb0c5 
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
Standardize topo flags to use hyphen-based naming (vitessio#17975)
f2d671b 
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
Standardize topo flags to use hyphen-based naming (vitessio#17975)
ea5c71e 
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

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

@deepthi deepthi Awaiting requested review from deepthi

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

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

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100

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

Assignees

No one assigned

Labels

Component: General Changes throughout the code base 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.

2 participants

@mounicasruthi @rohit-nayak-ps