-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
kvserver: move nondeterministic failures to kvserverbase
They need to be in a leaf package, since we need to return them during standalone log application. Release note: None
- Loading branch information
Showing
7 changed files
with
94 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| // Copyright 2022 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
| // | ||
|
|
||
| package kvserverbase | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/cockroachdb/errors" | ||
| "github.com/cockroachdb/redact" | ||
| ) | ||
|
|
||
| // NonDeterministicError is an error type that indicates that a state machine | ||
| // transition failed due to an unexpected error. Failure to perform a state | ||
| // transition is a form of non-determinism, so it can't be permitted for any | ||
| // reason during the application phase of state machine replication. The only | ||
| // acceptable recourse is to signal that the replica has become corrupted. | ||
| // | ||
| // Many errors returned by apply.Decoder and apply.StateMachine implementations | ||
| // will be instances of this type. | ||
| type NonDeterministicError struct { | ||
| wrapped error | ||
| expl redact.RedactableString | ||
| } | ||
|
|
||
| // NonDeterministicErrorf creates a NonDeterministicError. | ||
| func NonDeterministicErrorf(format string, args ...interface{}) error { | ||
| err := errors.AssertionFailedWithDepthf(1, format, args...) | ||
| return &NonDeterministicError{ | ||
| wrapped: err, | ||
| expl: redact.Sprintf(format, args...), | ||
| } | ||
| } | ||
|
|
||
| // NonDeterministicErrorWrapf wraps the provided error with a NonDeterministicError. | ||
| func NonDeterministicErrorWrapf(err error, format string, args ...interface{}) error { | ||
| return &NonDeterministicError{ | ||
| wrapped: errors.Wrapf(err, format, args...), | ||
| expl: redact.Sprintf(format, args...), | ||
| } | ||
| } | ||
|
|
||
| // Error implements the error interface. | ||
| func (e *NonDeterministicError) Error() string { | ||
| return fmt.Sprintf("non-deterministic failure: %s", e.wrapped.Error()) | ||
| } | ||
|
|
||
| // Cause implements the github.com/pkg/errors.causer interface. | ||
| func (e *NonDeterministicError) Cause() error { return e.wrapped } | ||
|
|
||
| // Unwrap implements the github.com/golang/xerrors.Wrapper interface, which is | ||
| // planned to be moved to the stdlib in go 1.13. | ||
| func (e *NonDeterministicError) Unwrap() error { return e.wrapped } | ||
|
|
||
| // GetRedactedNonDeterministicFailureExplanation loads message from the first wrapped | ||
| // NonDeterministicError, if any. The returned message is *redacted*, | ||
| // i.e. contains no sensitive information. | ||
| func GetRedactedNonDeterministicFailureExplanation(err error) redact.RedactableString { | ||
| if nd := (*NonDeterministicError)(nil); errors.As(err, &nd) { | ||
| return nd.expl.Redact() | ||
| } | ||
| return "???" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters