Clarify CheckpointVerifier errors #1260
Merged
Conversation
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
And make an unreachable error into a panic.
teor2345
added
A-rust
yaahc
approved these changes
Nov 6, 2020
There was a problem hiding this comment.
Looks perfect.
In the future I hope to deduplicate some of this information. A lot of these errors are grabbing the height and hash which I think might be better associated with a tracing::span that all of these errors are captured in the context of. For now though we cannot easily work with TracedErrors here because the fn to map the inner error type hasn't been released yet. Once the newer version of tracing comes out though I think it might be good to introduce TracedError alongside most of our error types and do our best to leverage spans for contextual runtime data.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
I can't diagnose the repeated
Duplicateerrors from theCheckpointVerifier(#1259), because the error names and messages are ambiguous, the same error is used in multiple unrelated places, and the errors don't contain enough context.Solution
Improve the
CheckpointVerifiererrors:unreachable!The code in this pull request has:
Documentation Comments- minor modifications to existing error handling codeUnit Tests and Property Tests- minor modifications to existing error handling codeReview
I'd like @yaahc to review this change, because she knows a lot about error handling.
This change is urgent, because it's blocking the tests for the difficulty PR #1256.
I'd like @hdevalence to be aware of these changes, because he is fixing the
Duplicateerrors in #1259.Related Issues
This PR contains diagnostics for the
Duplicateerrors bug #1259.Bug #1259 blocks the tests for the difficulty fix PR #1256.
Follow Up Work
Once #1259 is fixed, we'll probably want to reduce the
AlreadyVerifiedinfo log to a trace. I'll make a note on the sync tracking issue.