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

release-22.1: schemachanger: improve panic- and error handling #91555

Merged
merged 1 commit into from
Nov 9, 2022

Conversation

postamar
Copy link
Contributor

@postamar postamar commented Nov 8, 2022

Backport 1/1 commits from #91411.

/cc @cockroachdb/release


Previously, the declarative schema changer would only recover from runtime errors in certain subsystems like building the targets or planning the execution of operations. Consequently an implementation bug leading to a runtime error in the execution layer would trigger a panic which would not be recovered and which would cause the whole process to crash.

This commit fixes this by introducing a common error handler in the form of scerrors.HandleErrorOrPanic, which recovers from panics, wraps errors, and prints informative log messages in a uniform way, to be used at the top of (or near the top of) the declarative schema changer call stack.

Fixes #91400.

Release note (bug fix): fixed a bug in which panics triggered by certain DDL statements were not properly recovered, leading to the cluster node crashing.


Release justification: low-risk high-benefit improvement

@blathers-crl
Copy link

blathers-crl bot commented Nov 8, 2022

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@postamar postamar requested a review from ajwerner November 8, 2022 21:52
Copy link
Contributor

@ajwerner ajwerner left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained

@postamar postamar marked this pull request as ready for review November 9, 2022 12:19
@postamar postamar requested a review from a team as a code owner November 9, 2022 12:19
@postamar postamar requested a review from a team November 9, 2022 12:19
Previously, the declarative schema changer would only recover from
runtime errors in certain subsystems like building the targets or
planning the execution of operations. Consequently an implementation bug
leading to a runtime error in the execution layer would trigger a panic
which would not be recovered and which would cause the whole process to
crash.

This commit fixes this by introducing a common error handler in the form
of scerrors.EventLogger, which recovers from panics, wraps errors, and
prints informative log messages in a uniform way, to be used at the top
of (or near the top of) the declarative schema changer call stack.

Fixes cockroachdb#91400.

Release note (bug fix): fixed a bug in which panics triggered by certain
DDL statements were not properly recovered, leading to the cluster node
crashing.
Copy link
Contributor

@ajwerner ajwerner left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 10 of 14 files at r1, 4 of 4 files at r2, all commit messages.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @postamar)

@postamar postamar merged commit 36052be into cockroachdb:release-22.1 Nov 9, 2022
@postamar postamar deleted the backport22.1-91411 branch November 9, 2022 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants