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

fix releasing the global read lock when mysqlshell backup fails #17000

Merged
merged 3 commits into from
Oct 18, 2024

Conversation

rvrangel
Copy link
Contributor

@rvrangel rvrangel commented Oct 18, 2024

Description

This fixes an issue we noticed during testing where if the backup process (mysqlsh) fails, be it because of incorrect parameters, missing binary, etc, it won't release the global read lock we are holding on the instance. This ensures we are releasing the lock even if we hit an error early on.

I also added unit tests to capture when those particular scenarios happen.

Related Issue(s)

Fixes #17011, an issue introduced that only affects the new mysqlshell backup engine introduced in #16295

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

Copy link
Contributor

vitess-bot bot commented Oct 18, 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 Oct 18, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 18, 2024
@frouioui frouioui added Type: Bug Component: Backup and Restore Backport to: release-21.0 Needs to be backport to release-21.0 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 Oct 18, 2024
@frouioui
Copy link
Member

I am adding the Backport to: release-21.0 label as the issue was introduced in v21.0.0-rc1 and the fix should be part of v21.0.0-rc2.

Copy link

codecov bot commented Oct 18, 2024

Codecov Report

Attention: Patch coverage is 91.30435% with 2 lines in your changes missing coverage. Please review.

Project coverage is 67.09%. Comparing base (0fa7e58) to head (cfcd511).
Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/mysqlctl/fakemysqldaemon.go 80.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17000      +/-   ##
==========================================
- Coverage   69.34%   67.09%   -2.25%     
==========================================
  Files        1571     1571              
  Lines      204180   251763   +47583     
==========================================
+ Hits       141582   168915   +27333     
- Misses      62598    82848   +20250     

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

Signed-off-by: Renan Rangel <rrangel@slack-corp.com>
Signed-off-by: Renan Rangel <rrangel@slack-corp.com>
@rvrangel rvrangel marked this pull request as ready for review October 18, 2024 16:29
@mattlord mattlord added the NeedsIssue A linked issue is missing for this Pull Request label Oct 18, 2024
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Nice work, @rvrangel ! I only had some minor comments. Let me know what you think and I'll come back to this quickly.

@@ -56,6 +56,8 @@ var (
// disable redo logging and double write buffer
mysqlShellSpeedUpRestore = false

mysqlShellBackupBinaryName = "mysqlsh"
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit, but any reason for this not to remain a const?

Looks like it's only changed for the test, the value used is passed in as a parameter to generate the new file:

generateTestFile(t, mysqlShellBackupBinaryName, "#!/bin/bash\nexit 1")

And we've told the engine to use this other file instead of mysqlsh. This is OK, but couldn't we instead set and unset a shell alias for mysqlsh so that the shell calls our test script? It feels a little less bad than allowing the binary name to be changed although it's the same effect.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Indeed, this is only changed for the test. I am not sure setting an alias would work, as the exec documentation says:

Unlike the "system" library call from C and other languages, the os/exec package intentionally does not invoke the system shell and does not expand any glob patterns or handle other expansions, pipelines, or redirections typically done by shells.

I would imagine the above also means that setting an alias wouldn't work

go/ioutil/writer.go Outdated Show resolved Hide resolved
go/vt/mysqlctl/mysqlshellbackupengine.go Show resolved Hide resolved
go/vt/mysqlctl/mysqlshellbackupengine.go Outdated Show resolved Hide resolved
go/vt/mysqlctl/mysqlshellbackupengine_test.go Outdated Show resolved Hide resolved
go/vt/mysqlctl/mysqlshellbackupengine_test.go Outdated Show resolved Hide resolved
@mattlord mattlord removed the NeedsIssue A linked issue is missing for this Pull Request label Oct 18, 2024
Signed-off-by: Renan Rangel <rrangel@slack-corp.com>
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Thank you, @rvrangel ! ❤️

@mattlord mattlord merged commit a34e22c into vitessio:main Oct 18, 2024
98 checks passed
vitess-bot pushed a commit that referenced this pull request Oct 18, 2024
Signed-off-by: Renan Rangel <rrangel@slack-corp.com>
rohit-nayak-ps pushed a commit that referenced this pull request Oct 18, 2024
…kup fails (#17000) (#17012)

Signed-off-by: Renan Rangel <rrangel@slack-corp.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
rvrangel added a commit to slackhq/vitess that referenced this pull request Oct 24, 2024
…ssio#17000)

Signed-off-by: Renan Rangel <rrangel@slack-corp.com>
Signed-off-by: 'Renan Rangel' <rrangel@slack-corp.com>
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.

Bug Report: MySQL Shell backup engine doesn't release global read lock when backup fails
3 participants