feat(api): Attach error recovery debug notes to commands #16608
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
SyntaxColoring
added
the
gen-analyses-snapshot-pr
|
A PR has been opened to address analyses snapshot changes. Please review the changes here: #16609 |
SyntaxColoring
added a commit
that referenced
this pull request
Oct 25, 2024
…hots (#16609) This PR was requested on the PR #16608 Co-authored-by: SyntaxColoring <[email protected]>
SyntaxColoring
removed
the
gen-analyses-snapshot-pr
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## false_positive_state_update #16608 +/- ##
==============================================================
Coverage ? 92.43%
==============================================================
Files ? 77
Lines ? 1283
Branches ? 0
==============================================================
Hits ? 1186
Misses ? 97
Partials ? 0
Flags with carried forward coverage won't be shown. Click here to find out more. |
sfoster1
approved these changes
Oct 25, 2024
|
Will merge behind #16556. |
…hots (#16609) This PR was requested on the PR #16608 Co-authored-by: SyntaxColoring <[email protected]>
SyntaxColoring
force-pushed
the
error_recovery_debug_notes
branch
from
5850cc3
to
7d5d1c7
Compare
SyntaxColoring
changed the base branch from
false_positive_state_update
to
edge
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.
Overview
User interactions for error recovery are already "logged", as the run's
actions. However, stuff that the robot does automatically is not. This closes that gap in a basic way. When a command fails, we'll append a human-readablenoteto it that mentions how Protocol Engine is basically treating it. (FAIL_RUN,WAIT_FOR_RECOVERY,CONTINUE_WITH_ERROR, orASSUME_FALSE_POSITIVE_AND_CONTINUE.)In particular, this means that when a user selects Ignore all errors of this type, the run log can show us all the commands that the robot auto-handled in that way.
Closes EXEC-780.
Test Plan and Hands on Testing
Review requests
The existing
CommandNoteshape is just human-readable. So for simplicity, I'm matching that and just providing a human-readable string.Would it be a good idea to also expand
CommandNotewith aMapping[str, Any]field, like we have for errors? Then we could put stuff likeStateUpdates in there without it being a gross monolithic string.Risk assessment
Low.