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

Support SHOW VITESS_MIGRATIONS from inside a transaction #16399

Merged
merged 4 commits into from
Jul 18, 2024

Conversation

shlomi-noach
Copy link
Contributor

Description

See story in #16242

Related Issue(s)

Fixes #16242

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

Deployment Notes

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Copy link
Contributor

vitess-bot bot commented Jul 16, 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 Jul 16, 2024
@shlomi-noach shlomi-noach 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 Jul 16, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Jul 16, 2024
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@systay
Copy link
Collaborator

systay commented Jul 16, 2024

Could we add an end-to-end test that checks this issue?

Copy link

codecov bot commented Jul 16, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 68.68%. Comparing base (66bf89b) to head (92c5aeb).
Report is 6 commits behind head on main.

Files Patch % Lines
go/vt/vttablet/tabletserver/query_executor.go 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16399      +/-   ##
==========================================
+ Coverage   68.66%   68.68%   +0.02%     
==========================================
  Files        1548     1548              
  Lines      199084   199092       +8     
==========================================
+ Hits       136699   136753      +54     
+ Misses      62385    62339      -46     

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

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach
Copy link
Contributor Author

Could we add an end-to-end test that checks this issue?

Added!

@@ -958,7 +960,7 @@ func (qre *QueryExecutor) execRevertMigration() (*sqltypes.Result, error) {
return qre.tsv.onlineDDLExecutor.SubmitMigration(qre.ctx, qre.plan.FullStmt)
}

func (qre *QueryExecutor) execShowMigrations() (*sqltypes.Result, error) {
func (qre *QueryExecutor) execShowMigrations(conn *StatefulConnection) (*sqltypes.Result, error) {
Copy link
Contributor

Choose a reason for hiding this comment

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

@shlomi-noach is conn *StatefulConnection meant to be used here? I don't follow this part

Copy link
Contributor Author

@shlomi-noach shlomi-noach Jul 18, 2024

Choose a reason for hiding this comment

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

Yes-ish :). I'm not all too familiar with this either, but I got guidance from @harshit-gangal. The StatefulConnection is the standard way for you to implement a transactional behavior working with QueryService. So we should pass that variable. Normally I'd also use the variable -- except:

  • I don't really require show vitess_migrations to exhibit transactional behavior; it's a show command and I don;t need it to e.g. be repeatable-read or anything. I only need it to work from within a transaction.
  • Therefore no need to bloat the transaction.
  • Also, the existing logic uses the executor's own connection pooling, which is fine, and there's no need/reason to now take apart the existing and working mechanism within the executor to accommodate the transactional connection.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok sounds good 👍

@timvaillancourt timvaillancourt self-requested a review July 18, 2024 11:51
@shlomi-noach shlomi-noach merged commit 8e9d294 into vitessio:main Jul 18, 2024
127 checks passed
@shlomi-noach shlomi-noach deleted the show-migrations-within-trx branch July 18, 2024 12:19
frouioui pushed a commit to frouioui/vitess that referenced this pull request Jul 19, 2024
…16399)

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: show vitess_migrations not supported from inside a transaction
3 participants