Classify third-party upload SyntaxErrors as configuration errors#2171
Merged
angelapwen merged 3 commits intoFeb 28, 2024
github:maingithub/codeql-action:mainfrom
angelapwen:classify-syntax-errorsangelapwen/codeql-action:classify-syntax-errorsCopy head branch name to clipboard
Merged
Classify third-party upload SyntaxErrors as configuration errors#2171angelapwen merged 3 commits intogithub:maingithub/codeql-action:mainfrom angelapwen:classify-syntax-errorsangelapwen/codeql-action:classify-syntax-errorsCopy head branch name to clipboard
SyntaxErrors as configuration errors#2171angelapwen merged 3 commits into
github:maingithub/codeql-action:mainfrom
angelapwen:classify-syntax-errorsangelapwen/codeql-action:classify-syntax-errorsCopy head branch name to clipboard
Conversation
This describes what we are trying to do more accurately.
henrymercer
previously approved these changes
Feb 28, 2024
Contributor
Author
|
Ah.. I think we are already attempting to catch this error, but it's not happening in the right place. Let me try to fix. |
Contributor
Author
|
Ok, I think this should do it with the appropriate error wrapping (see updated PR body)! |
henrymercer
reviewed
Feb 28, 2024
| )}`, | ||
| ); | ||
| } | ||
| } catch (e) { |
Contributor
There was a problem hiding this comment.
Nit: this now wraps quite a lot of code, for safety, consider wrapping just the JSON.parse call, or catching just SyntaxErrors.
Contributor
Author
There was a problem hiding this comment.
You're right! I changed it to wrap just the JSON.parse 😄
273f564 to
62712e9
Compare
henrymercer
approved these changes
Feb 28, 2024
8 tasks
This was referenced Feb 29, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
We frequently see
SyntaxErrors from the upload action that are currently classified as failures. We were previously catching this error in thecountResultsInSarifmethod, but this method runs aftervalidateSarifFileSchema, which would have thrown aSyntaxErrorbefore we're able to throw it as anInvalidRequestError.This change moves the error catching to
validateSarifFileSchemaso that we will appropriately classify it as anInvalidRequestError.Merge / deployment checklist