Skip to content

Conversation

mounicasruthi
Copy link
Collaborator

Description

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

Flags Updated in This PR:

--relay-log-max-items
--relay-log-max-size
--restore-concurrency
--restore-from-backup
--restore-from-backup-ts
--retain-online-ddl-tables
--sanitize-log-messages
--schema-change-signal
--schema-dir
--serving-state-grace-period
--shard-sync-retry-delay
--shutdown-grace-period
--start-mysql
--stream-buffer-size
--stream-health-buffer-size
--table-gc-lifecycle
--tablet-filters
--throttle-tablet-types
--track-schema-versions
--twopc-abandon-age
--tx-throttler-config
--tx-throttler-healthcheck-cells
--unhealthy-threshold

Flag Count Before vs After:

Flags with _ Flags with -
Before 193 1885
After 148 1932

# of migrated flags: 47

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

Copy link
Contributor

vitess-bot bot commented Jul 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 Jul 6, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone Jul 6, 2025
@dbussink
Copy link
Contributor

dbussink commented Aug 5, 2025

There's a relevant test failure here?

        config_test.go:146: NewVReplicationConfig() got num errors = unknown vreplication config flag: relay_log_max_size, want 0

Signed-off-by: mounicasruthi <[email protected]>
@nickvanw nickvanw force-pushed the flags-refactor-vtcombo-pt4 branch from 7b5e55f to cc60db7 Compare September 3, 2025 18:49
Signed-off-by: Nick Van Wiggeren <[email protected]>
@nickvanw nickvanw 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 Sep 3, 2025
@nickvanw nickvanw force-pushed the flags-refactor-vtcombo-pt4 branch from 167651f to c63b8e3 Compare September 3, 2025 20:30
@nickvanw nickvanw added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTCombo labels Sep 3, 2025
@nickvanw nickvanw removed the NeedsWebsiteDocsUpdate What it says label Sep 3, 2025
Signed-off-by: Nick Van Wiggeren <[email protected]>
Copy link

codecov bot commented Sep 4, 2025

Codecov Report

❌ Patch coverage is 67.44186% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 67.48%. Comparing base (b079554) to head (ff62324).

Files with missing lines Patch % Lines
go/vt/utils/flags.go 25.00% 6 Missing ⚠️
go/cmd/vtcombo/cli/main.go 0.00% 2 Missing ⚠️
go/vt/vtgate/vtgate.go 0.00% 2 Missing ⚠️
.../vt/vttablet/tabletmanager/vreplication/vplayer.go 0.00% 2 Missing ⚠️
go/vt/discovery/healthcheck.go 50.00% 1 Missing ⚠️
go/vt/vttablet/tabletserver/gc/tablegc.go 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18422      +/-   ##
==========================================
- Coverage   67.49%   67.48%   -0.01%     
==========================================
  Files        1607     1607              
  Lines      263518   263529      +11     
==========================================
- Hits       177849   177837      -12     
- Misses      85669    85692      +23     

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

@@ -124,6 +124,7 @@ func (vttablet *VttabletProcess) Setup() (err error) {
vttablet.proc.Args = append(vttablet.proc.Args, "--pprof", fmt.Sprintf("cpu,waitSig,path=vttablet_pprof_%s", vttablet.Name))
}

//TODO: Remove underscore(_) flags in v25, replace them with dashed(-) notation
Copy link
Collaborator

Choose a reason for hiding this comment

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

should we mention this in the changelog so people know?

@rohit-nayak-ps rohit-nayak-ps force-pushed the flags-refactor-vtcombo-pt4 branch from baf9fa8 to 436612b Compare September 4, 2025 11:56
@rohit-nayak-ps rohit-nayak-ps merged commit 884aa5a into vitessio:main Sep 4, 2025
203 of 208 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTCombo Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants