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

Internal refactor: LastError as a public struct #12321

Merged
merged 2 commits into from
Feb 14, 2023

Conversation

shlomi-noach
Copy link
Contributor

Description

lastError is a mechanism introduced into VReplication in #10429 ; the idea is that we can have a retry-able operation that waits for some error to clean up, or times out if the error persists.

Up till now this was a local class in vreplication package. I have a use case outside VReplication (well, related, it's Online DDL). Anyway, the mechanism is really quite generic and useful, and so I'm externalizing the structure and moving it to go/vt/vterrors.

There's no real code changes here other than using the name field of LastError in place of hard coded "Vreplication" text.

This refactor includes the recent changes made in #12114

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Documentation was added or is not required

Deployment Notes

@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Feb 12, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Feb 12, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps left a comment

Choose a reason for hiding this comment

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

lgtm

@@ -87,7 +86,7 @@ func (le *lastError) shouldRetry() bool {
// within the max time range
return true
}
log.Errorf("VReplication encountered the same error continuously since %s, we will assume this is a non-recoverable error and will not retry anymore; the workflow will need to be manually restarted once error '%s' has been addressed",
le.firstSeen.UTC(), le.err)
log.Errorf("%s: the same error was encountered continuously since %s, it is now assumed to be unrecoverable; any affected workflows will need to be manually restarted once error '%s' has been addressed",
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we say operations instead of workflows?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed.

Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach
Copy link
Contributor Author

ignoring Upgrade Downgrade Testing Query Serving test

@shlomi-noach shlomi-noach merged commit 003de64 into vitessio:main Feb 14, 2023
@shlomi-noach shlomi-noach deleted the refactor-last-error branch February 14, 2023 08:32
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Feb 14, 2023

I was unable to backport this Pull Request to the following branches: release-16.0.

@shlomi-noach
Copy link
Contributor Author

Will backport this maually

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.

4 participants