Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate twopc_enable flag and change input type for twopc_abandon_age to time.Duration #17279

Merged
merged 9 commits into from
Dec 9, 2024

Conversation

harshit-gangal
Copy link
Member

@harshit-gangal harshit-gangal commented Nov 25, 2024

Description

This PR deprecate twopc_enable flag to enable TwoPC.
The twopc_abandonage is still mandatory to be set on VTTablet for TwoPC transactions prepare to work.
twopc_abandonage can take in float (deprecated) and time.Duration as input and default is set to 15 minutes.

Related Issue(s)

Checklist

  • 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

Signed-off-by: Harshit Gangal <[email protected]>
Copy link
Contributor

vitess-bot bot commented Nov 25, 2024

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 Nov 25, 2024
@harshit-gangal harshit-gangal added Component: Query Serving Type: Internal Cleanup 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 Nov 25, 2024
@harshit-gangal harshit-gangal marked this pull request as ready for review November 25, 2024 14:25
Copy link

codecov bot commented Nov 25, 2024

Codecov Report

Attention: Patch coverage is 97.29730% with 1 line in your changes missing coverage. Please review.

Project coverage is 67.50%. Comparing base (f746c48) to head (8598ce3).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtexplain/vtexplain_vttablet.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17279      +/-   ##
==========================================
+ Coverage   67.48%   67.50%   +0.02%     
==========================================
  Files        1577     1577              
  Lines      253420   253440      +20     
==========================================
+ Hits       171022   171088      +66     
+ Misses      82398    82352      -46     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions github-actions bot added this to the v22.0.0 milestone Nov 25, 2024
Signed-off-by: Harshit Gangal <[email protected]>

#### <a id="vttablet-flags"/>Deprecated VTTablet Flags</a>

- `twopc_enable` flag is deprecated, `twopc_abandonage` flag if set will be used to determine if 2PC is enabled or not.
Copy link
Member

@deepthi deepthi Nov 25, 2024

Choose a reason for hiding this comment

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

Are we really determining whether to allow 2PC based on twopc_abandonage? Ideally it should be controlled solely by transaction_mode on vtgate, and vttablets should be able to participate.
My suggestion would be to pick a reasonable default for twopc_abandonage and use that. Also we should be changing that to a Duration field instead of float which I assume is being interpreted as seconds.

Copy link
Member

Choose a reason for hiding this comment

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

I agree with Deepthi. There is no reason to say explicitly whether twopc is enabled or not. If the transaction mode is twopc then we run it, otherwise not.

Copy link
Member Author

Choose a reason for hiding this comment

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

For first part - I am aligned with it. Just did not do it in one go.

Changing from seconds to Duration, this would mean a breaking change otherwise would have to add a new flag.

Copy link
Member

@deepthi deepthi Dec 4, 2024

Choose a reason for hiding this comment

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

there's some prior art on how to change this over 2 releases without changing the flag name. you should be able to find the relevant PRs in GH history.

Copy link
Member Author

Choose a reason for hiding this comment

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

done dfcd94c

Signed-off-by: Harshit Gangal <[email protected]>
Copy link
Collaborator

@systay systay left a comment

Choose a reason for hiding this comment

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

still looks good

@harshit-gangal harshit-gangal changed the title Deprecate twopc_enable flag Deprecate twopc_enable flag and change input type for twopc_abandon_age to time.Duration Dec 9, 2024
Signed-off-by: Harshit Gangal <[email protected]>
@harshit-gangal harshit-gangal merged commit 9b71606 into vitessio:main Dec 9, 2024
100 checks passed
@harshit-gangal harshit-gangal deleted the remove-twopc-flag branch December 9, 2024 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants