feat(ado-improvements-1): Refactor reporter errors #1046
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
14 tasks
| })().catch((error) => { | ||
| console.log('Exception thrown in extension: ', error); | ||
| process.exit(1); | ||
| console.log('##[error][Exception] Exception thrown in extension: ', error); |
There was a problem hiding this comment.
I was about to ask if we should use a logger method instead here, but if I understand right, we don't have access to it in this scope
There was a problem hiding this comment.
That's correct. We get a Logger further upstream, but it a failure occurs before it's initialized, using console.log ensures that we can always produce the output
DaveTryon
commented
Feb 11, 2022
| })().catch((error) => { | ||
| console.log('Exception thrown in action: ', error); | ||
| process.exit(1); | ||
| console.log('::error::[Exception] Exception thrown in extension: ', error); |
There was a problem hiding this comment.
This uses the action error syntax described at https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message. I'll create a separate PR that uses this through the Logger API
brocktaylor7
approved these changes
Feb 11, 2022
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.
Details
As called out in #950, we throw an
Errorif a scan fails, then we log theErrortwice. To a user, it looks like our tool has crashed, when in reality it's an accessibility error that the user should fix. This PR does the following to improve this:ProgressReporter.failRunused to throw an Error to force the program to fail. The new code merely sets a flag inProgressReporter.failRun, then a new API,ProgressReporter.didScanSucceed, serves as an indicator of whether or not the scan succeeded.ProgressReporter.failRunwith a message is now responsible for logging the error message viaLogger.logErrororLogger.trackException, depending on the circumstance. With this change order of theProgressReporterobjects no longer matters, so I removed the associated comment.Scanner.scannow returns aPromise<boolean>instead of aPromise<void>. The resolved value of the promise indicates user action. A successful value (true) means that no corrective action is needed by the user. A failed value (false) means that the user need to take some corrective action.ExitCode.ScanCompletedNoUserActionIsNeeded) means that the scan completed successfully and no corrective user action is needed.ExitCode.ScanCompletedUserActionIsNeeded) means that the scan completed successfully, but corrective user action is needed.ExitCode.ScanFailedToComplete) means that the scan failed to complete. This will always be accompanied by a log of the Error that led to the failure.I also wordsmithed a couple of error messages while I was updating the code and associated tests. A couple of linting issues were also flagged, so I tidied them up.
Motivation
Make progress toward #950
Before and after
Output before this change--baseline file doesn't match the scan results. Notice the duplicated stack dumps and the fact that the error message is lost as the message of the stack dump
Output after this change--baseline file doesn't match the scan results. Notice that the stack dumps are removed and that the message is called out with an `##[error]` tag near the end of the output
Context
Pull request checklist
yarn test)<rootDir>/test-results/unit/coverageyarn precheckin)