Mark invalid SARIF errors as user errors in the upload-sarif Action
#1872
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
angelapwen
previously approved these changes
Sep 6, 2023
src/upload-lib.ts
Outdated
| /** | ||
| * An error that occurred due to an invalid SARIF upload request. | ||
| */ | ||
| class InvalidUploadSarifRequest extends Error { |
There was a problem hiding this comment.
Nit: could we we suffix this with Error?
src/upload-lib.ts
Outdated
| /** | ||
| * Uploads a single SARIF file or a directory of SARIF files depending on what `sarifPath` refers to. | ||
| * | ||
| * @param invalidRequestIsUserError Whether an invalid request, for example one with a `sarifPath` |
There was a problem hiding this comment.
Maybe considerInvalidRequestUserError makes more sense to me, though it's not more concise 😆
6 tasks
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.
Found this while I was looking at CodeQL Action telemetry as I rolled out some other changes.
Categorizing user errors correctly in telemetry helps us detect and respond to incidents faster. This PR starts marking invalid SARIF upload requests as
UserErrorwhen users use theupload-sarifAction, as here the SARIF is not under our control, and things like invalid paths or invalid SARIF are not problems with our service. On the other hand, when uploading SARIF in theanalyzeorinit-poststeps, invalid SARIF upload requests remainErrors, since these could indicate a problem with our service.Suggestions for a better name for
invalidRequestIsUserErrorwelcome — this felt a little awkward.Merge / deployment checklist