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.

Sign up for GitHub

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

Jump to bottom

VReplication: Improve workflow cancel/delete #15977

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from
Draft

VReplication: Improve workflow cancel/delete #15977

wants to merge 16 commits into from

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented May 20, 2024 •
edited

Description

This work makes two changes:

  1. Remove workflow artifacts after removing workflow in Workflow Delete. Otherwise you can see unexpected query errors in the workflow against the table between when the table is dropped and the workflow deleted.
    • If you have NOT yet switched traffic then this is otherwise benign when , but we should still do these operations in a correct order
    • If you're doing a ReverseTraffic call, however, then this could result in the workflow being gone/deleted when we failed to cleanup the artifacts for any reason
  2. Not fail the delete/cancel if a denied tables entry is not found (we did not put those in place until you've started switching traffic)
    - Related to this, we now put those in place on the target during workflow creation rather than waiting until the first traffic switch (previously those would only be put in place on the target after SwitchTraffic->ReverseTraffic)
    - More generally, we now do not fail the delete/cancel if the thing we went to cleanup is already gone

Related Issue(s)

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

@mattlord mattlord added Type: Bug Component: VReplication Backport to: release-18.0 Needs to be back ported to release-18.0 Backport to: release-19.0 Needs to be back ported to release-19.0 labels May 20, 2024
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented May 20, 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 May 20, 2024
@mattlord mattlord removed NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels May 20, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 20, 2024
@mattlord mattlord changed the title VReplication: remove workflow before artifacts in vtctldclient Workflow Delete VReplication: remove workflow before artifacts after removing workflow in vtctldclient Workflow Delete May 20, 2024
@mattlord mattlord changed the title VReplication: remove workflow before artifacts after removing workflow in vtctldclient Workflow Delete VReplication: remove workflow artifacts after removing workflow in vtctldclient Workflow Delete May 20, 2024
@mattlord mattlord changed the title VReplication: remove workflow artifacts after removing workflow in vtctldclient Workflow Delete VReplication: remove workflow artifacts after removing workflow in Workflow Delete May 20, 2024
@mattlord mattlord changed the title VReplication: remove workflow artifacts after removing workflow in Workflow Delete VReplication: Remove workflow artifacts after removing workflow in Workflow Delete May 20, 2024
@mattlord
Workflow Delete: remove workflow before artifacts
0b12d82 
Otherwise the cancel/delete and cleanup work can fail.

Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Add unit test
4401a21 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Add timeouts to vx.CallbackContext usage
51b75c1 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord changed the title VReplication: Remove workflow artifacts after removing workflow in Workflow Delete VReplication: Improve workflow cancel/delete May 22, 2024
@mattlord mattlord removed the Backport to: release-18.0 Needs to be back ported to release-18.0 label May 22, 2024
@mattlord mattlord mentioned this pull request May 22, 2024
Open
@mattlord
Don't fail workflow cancel/cleanup if there's nothing to do
82005fb 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Improve and unify logging for tablet reference
7dd69c2 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord force-pushed the vtctldclient_wf_delete branch 3 times, most recently from 00eb275 to 06d07f8 Compare May 22, 2024 13:38
@mattlord
Put initial denied tables entries in place on MoveTables create
371c90c 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Get target keyspace lock before adding denied tables entries
7b87e59 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Comment out broken unit test for now
8650d95 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Adjust e2e tests
4b381f5 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Merge remote-tracking branch 'origin/main' into vtctldclient_wf_delete
6fa20cf 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Adjust test after merging origin/main
9fe930f 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Get vrepl e2e tests working
4ea4dbe 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Fix backup tests
dddf1c2 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Correct updatePrimaryTabletControl and test
3758430 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Complete/Cancel fixups
0c6e12a 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord
Uncomment test
862bdba 
Signed-off-by: Matt Lord <mattalord@gmail.com>
@codecov Codecov
Copy link

codecov bot commented May 30, 2024

Codecov Report

Attention: Patch coverage is 42.42424% with 57 lines in your changes are missing coverage. Please review.

Project coverage is 68.24%. Comparing base (a1edaee) to head (862bdba).
Report is 15 commits behind head on main.

Files Patch % Lines
go/vt/vtctl/workflow/server.go 53.12% 30 Missing ⚠️
go/vt/vtctl/workflow/traffic_switcher.go 0.00% 27 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #15977   +/-   ##
=======================================
  Coverage   68.24%   68.24%           
=======================================
  Files        1562     1541   -21     
  Lines      197171   197157   -14     
=======================================
- Hits       134550   134545    -5     
+ Misses      62621    62612    -9

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@deepthi deepthi Awaiting requested review from deepthi deepthi will be requested when the pull request is marked ready for review deepthi is a code owner

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 will be requested when the pull request is marked ready for review GuptaManan100 is a code owner

@rohit-nayak-ps rohit-nayak-ps Awaiting requested review from rohit-nayak-ps rohit-nayak-ps will be requested when the pull request is marked ready for review rohit-nayak-ps is a code owner

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach shlomi-noach will be requested when the pull request is marked ready for review shlomi-noach is a code owner

@ajm188 ajm188 Awaiting requested review from ajm188 ajm188 will be requested when the pull request is marked ready for review ajm188 is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
Backport to: release-19.0 Needs to be back ported to release-19.0 Component: VReplication 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 Type: Bug
Projects
None yet
Milestone
v20.0.0
1 participant
@mattlord