Skip to content

Refactor flags - Part 3#18064

Merged
rohit-nayak-ps merged 8 commits intovitessio:flags-refactorfrom
mounicasruthi:flags-refactor-3
Apr 8, 2025
Merged

Refactor flags - Part 3#18064
rohit-nayak-ps merged 8 commits intovitessio:flags-refactorfrom
mounicasruthi:flags-refactor-3

Conversation

@mounicasruthi
Copy link
Copy Markdown
Collaborator

@mounicasruthi mounicasruthi commented Mar 27, 2025

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:
--purge-logs-interval
--log-rotate-max-size
--keep-logs-by-mtime
--keep-logs
--security-policy
--log-err-stacks
--mysql-server-version
--service-map
--onterm-timeout
--pid-file
--onclose-timeout
--tablet-manager-protocol
--tablet-manager-grpc-server-name
--tablet-manager-grpc-key
--tablet-manager-grpc-crl
--tablet-manager-grpc-concurrency
--tablet-manager-grpc-cert
--tablet-manager-grpc-ca
--tablet-manager-grpc-connpool-size
--tablet-dir
--stats-emit-period
--stats-drop-variables
--stats-common-tags
--stats-combine-dimensions
--stats-backend
--db-tls-min-version
--db-ssl-mode
--db-ssl-key
--db-ssl-cert
--db-ssl-ca-path
--db-ssl-ca
--db-socket
--db-server-name
--db-port
--db-host
--db-flavor
--db-flags
--db-conn-query-info
--db-connect-timeout-ms
--db-charset
--db-dba-password
--db-dba-use-ssl
--db-dba-user
--db-erepl-password
--db-erepl-use-ssl
--db-erepl-user
--db-filtered-password
--db-filtered-use-ssl
--db-filtered-user
--db-repl-password
--db-repl-use-ssl
--db-repl-user
--db-allprivs-password
--db-allprivs-use-ssl
--db-allprivs-user
--db-app-password
--db-app-use-ssl
--db-app-user
--db-appdebug-password
--db-appdebug-use-ssl
--db-appdebug-user

Flag Count Before vs After:

Flags with _ Flags with -
Before 1132 948
After 738 1342

# of migrated flags: 394

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
Copy Markdown
Contributor

vitess-bot bot commented Mar 27, 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 27, 2025
@mounicasruthi mounicasruthi added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: General Changes throughout the code base 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 27, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Mar 27, 2025
@mounicasruthi mounicasruthi changed the title Flags refactor 3 Flags refactor part-3 Mar 27, 2025
@mounicasruthi mounicasruthi changed the title Flags refactor part-3 Migrate flag names from underscores to dashes – Part 3 Mar 27, 2025
@mounicasruthi mounicasruthi changed the title Migrate flag names from underscores to dashes – Part 3 Refactor flags: Replace underscores with dashes – Part 3 Mar 28, 2025
@mounicasruthi mounicasruthi changed the title Refactor flags: Replace underscores with dashes – Part 3 Refactor flags - Part 3 Mar 28, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 28, 2025

Codecov Report

Attention: Patch coverage is 85.54217% with 12 lines in your changes missing coverage. Please review.

Project coverage is 67.58%. Comparing base (7f16f70) to head (83cafc8).
Report is 1 commits behind head on flags-refactor.

Files with missing lines Patch % Lines
go/vt/servenv/servenv.go 50.00% 3 Missing ⚠️
go/vt/servenv/service_map.go 33.33% 2 Missing ⚠️
go/vt/utils/flags.go 85.71% 2 Missing ⚠️
go/vt/vttest/vtprocess.go 60.00% 2 Missing ⚠️
go/cmd/vtcombo/cli/main.go 0.00% 1 Missing ⚠️
go/vt/vtcombo/tablet_map.go 0.00% 1 Missing ⚠️
go/vt/vtgate/plugin_mysql_server.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@                Coverage Diff                 @@
##           flags-refactor   #18064      +/-   ##
==================================================
+ Coverage           67.56%   67.58%   +0.01%     
==================================================
  Files                1598     1598              
  Lines              259817   259832      +15     
==================================================
+ Hits               175557   175607      +50     
+ Misses              84260    84225      -35     

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

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>
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
…tput

Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
@mounicasruthi mounicasruthi force-pushed the flags-refactor-3 branch 2 times, most recently from f7c86df to 83cafc8 Compare April 7, 2025 21:35
@rohit-nayak-ps rohit-nayak-ps merged commit bd3bd5e into vitessio:flags-refactor Apr 8, 2025
199 of 203 checks passed
mounicasruthi added a commit to mounicasruthi/vitess that referenced this pull request May 20, 2025
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
mounicasruthi added a commit to mounicasruthi/vitess that referenced this pull request May 20, 2025
Signed-off-by: mounicasruthi <mounicasruthi30@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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