Skip to content

Refactor vtcombo flags - Part 1#18291

Merged
deepthi merged 5 commits intovitessio:mainfrom
mounicasruthi:flags-refactor-vtcombo
May 28, 2025
Merged

Refactor vtcombo flags - Part 1#18291
deepthi merged 5 commits intovitessio:mainfrom
mounicasruthi:flags-refactor-vtcombo

Conversation

@mounicasruthi
Copy link
Collaborator

@mounicasruthi mounicasruthi commented May 22, 2025

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:
--enable-buffer-dry-run
--enable-consolidator
--enable-consolidator-replicas
--enable-hot-row-protection
--enable-hot-row-protection-dry-run
--enable-replication-reporter
--enable-set-var
--enable-transaction-limit
--enable-transaction-limit-dry-run
--enable-tx-throttler

--mysql-allow-clear-text-without-tls
--mysql-default-workload
--mysql-server-bind-address
--mysql-server-flush-delay
--mysql-server-query-timeout
--mysql-server-read-timeout
--mysql-server-require-secure-transport
--mysql-server-socket-path
--mysql-server-ssl-ca
--mysql-server-ssl-cert
--mysql-server-ssl-crl
--mysql-server-ssl-key
--mysql-server-ssl-server-ca
--mysql-server-tls-min-version
--mysql-server-write-timeout
--mysql-slow-connect-warn-threshold
--mysql-tcp-version

--vreplication-copy-phase-duration
--vreplication-copy-phase-max-innodb-history-list-length
--vreplication-copy-phase-max-mysql-replication-lag
--vreplication-experimental-flags
--vreplication-heartbeat-update-interval
--vreplication-max-time-to-retry-on-error
--vreplication-net-read-timeout
--vreplication-net-write-timeout
--vreplication-replica-lag-tolerance
--vreplication-retry-delay
--vreplication-store-compressed-gtid

Flag Count Before vs After:

Flags with _ Flags with -
Before 371 1709
After 318 1760

# of migrated flags: 51

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

@vitess-bot
Copy link
Contributor

vitess-bot bot commented May 22, 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 May 22, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone May 22, 2025
@codecov
Copy link

codecov bot commented May 22, 2025

Codecov Report

Attention: Patch coverage is 56.52174% with 30 lines in your changes missing coverage. Please review.

Project coverage is 67.48%. Comparing base (fcfa0c8) to head (16cb8dc).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtgate/plugin_mysql_server.go 0.00% 20 Missing ⚠️
go/mysql/auth_server_clientcert.go 0.00% 7 Missing ⚠️
go/vt/vtgate/vtgate.go 0.00% 1 Missing ⚠️
...vttablet/tabletmanager/vreplication/vreplicator.go 0.00% 1 Missing ⚠️
go/vt/vttablet/tabletserver/tabletenv/config.go 90.90% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18291      +/-   ##
==========================================
- Coverage   67.48%   67.48%   -0.01%     
==========================================
  Files        1603     1603              
  Lines      262337   262389      +52     
==========================================
+ Hits       177034   177067      +33     
- Misses      85303    85322      +19     

☔ 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 mounicasruthi added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTCombo 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 May 23, 2025
@twthorn twthorn mentioned this pull request May 23, 2025
5 tasks
@mounicasruthi mounicasruthi force-pushed the flags-refactor-vtcombo branch from c10adae to e503a2f Compare May 26, 2025 12:51
@mounicasruthi mounicasruthi marked this pull request as ready for review May 26, 2025 14:20
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi mounicasruthi force-pushed the flags-refactor-vtcombo branch from e503a2f to fd6f054 Compare May 28, 2025 16:31
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi mounicasruthi force-pushed the flags-refactor-vtcombo branch from fd6f054 to 16cb8dc Compare May 28, 2025 17:54
@deepthi deepthi merged commit fc93d4f into vitessio:main May 28, 2025
102 of 111 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.

3 participants