Skip validating SARIF produced by CodeQL#2894
Merged
henrymercer merged 6 commits intomainfrom May 14, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves performance by skipping SARIF schema validation for CodeQL-produced results outside of testing environments and reducing redundant file reads when uploading a single SARIF file.
- Introduce getTestingEnvironment to centralize test-environment checks.
- Split validateSarifFileSchema into readSarifFile + validate so a single-file upload is read only once.
- Update uploadFiles to skip validation for pure CodeQL SARIF in production and streamline multi-/single-file flows.
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/util.ts | Add getTestingEnvironment and refine JSDoc for test-mode logic. |
| src/workflow.ts | Use getTestingEnvironment instead of direct process.env check. |
| src/upload-lib.ts | Extract readSarifFile, update validateSarifFileSchema signature, skip validation by default for CodeQL SARIF. |
| src/upload-lib.test.ts | Update schema tests to use readSarifFile before validation. |
| src/status-report.ts | Use getTestingEnvironment for status payload and export logic. |
| src/analyze.ts | Remove in-place validation in getPerQueryAlertCounts and update its signature. |
| lib/… | Mirror changes in compiled JS for util, workflow, upload-lib, status-report, analyze, and tests. |
| CHANGELOG.md | Document skipping SARIF validation for CodeQL. |
Comments suppressed due to low confidence (1)
src/analyze.ts:683
- Consider updating this JSDoc to reflect that the function no longer performs validation and no longer accepts a logger parameter.
/** Get an object with all queries and their counts parsed from a SARIF file path. */
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
|
Pushed a commit to rebuild the Action. Please mark the PR as ready for review to trigger PR checks. |
oscarsj
approved these changes
May 14, 2025
Comment on lines
+767
to
+773
| export function getTestingEnvironment(): string | undefined { | ||
| const testingEnvironment = process.env[EnvVar.TESTING_ENVIRONMENT] || ""; | ||
| if (testingEnvironment === "") { | ||
| return undefined; | ||
| } | ||
| return testingEnvironment; | ||
| } |
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.
This PR skips validating SARIF files produced by CodeQL, unless we are running in a testing environment. This improves end-to-end performance.
We also only read the SARIF file once in the common case that only one file is being uploaded. Previously we read it twice. This should also speed things up, particularly for large SARIF files.
Merge / deployment checklist