GeezerVison is showing github.com — Use `json` module for JSON validation in `output-cache` by mario-campos · Pull Request #4096 · github/codeql-action
Conversation
- Use the included
json module to improve (make more readable) the validation of the output of codeql version.
- Refactor
getCachedCodeQlVersion and cacheCodeQlVersion to accept the cache-file-path as an argument, rather than construct it; this makes it easier to test.
- Change the
VersionInfo type to be derived from its JSON schema.
Risk assessment
For internal use only. Please select the risk level of this change:
- Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.
Which use cases does this change impact?
Workflow types:
- Advanced setup - Impacts users who have custom CodeQL workflows.
- Managed - Impacts users with
dynamic workflows (Default Setup, Code Quality, ...).
Products:
- Code Scanning - The changes impact analyses when
analysis-kinds: code-scanning.
- Code Quality - The changes impact analyses when
analysis-kinds: code-quality.
Environments:
- Dotcom - Impacts CodeQL workflows on
github.com and/or GitHub Enterprise Cloud with Data Residency.
- GHES - Impacts CodeQL workflows on GitHub Enterprise Server.
How did/will you validate this change?
- Unit tests - I am depending on unit test coverage (i.e. tests in
.test.ts files).
- End-to-end tests - I am depending on PR checks (i.e. tests in
pr-checks).
If something goes wrong after this change is released, what are the mitigation and rollback strategies?
- Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.
How will you know if something goes wrong after this change is released?
- Telemetry - I rely on existing telemetry or have made changes to the telemetry.
- Alerts - New or existing monitors will trip if something goes wrong with this change.
Are there any special considerations for merging or releasing this change?
- No special considerations - This change can be merged at any time.
Merge / deployment checklist
- Confirm this change is backwards compatible with existing workflows.
- Consider adding a changelog entry for this change.
- Confirm the readme and docs have been updated if necessary.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Refactors output-cache validation to use shared JSON schema utilities.
Changes:
- Validates version information using JSON schemas.
- Validates cache entries before accessing the cached version.
Show a summary per file
| File |
Description |
src/cli/output-cache.ts |
Replaces manual checks with shared JSON validators. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/2 changed files
- Comments generated: 1
- Review effort level: Balanced
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
mbg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks OK, but a good catch from Copilot there that we missed on the previous PR. I also added a comment about avoiding the disconnect between the schema and VersionInfo type. When using the json module for schemas, it is desirable to derive the corresponding type with FromSchema to avoid them going out of sync.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
As well as fixup a few other problems.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
|
@mario-campos Also looks like the linter check is failing again. If you haven't already enabled editor.formatOnSave, that might be a useful thing to do to help prevent this.
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This makes it easier to test. Credit to @mbg.
Also looks like the linter check is failing again.
That was a downstream (in tools-feature.ts) effect of the changes made to VersionInfo. It resulted in VersionInfo.features having type any, despite the override. Copilot suggested using Omit<> to fix it, so I did.
That being said, I wonder if it would be better to define a JSON validator for VersionInfo.features such that we can derive VersionInfo directly from its schema?
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Reviewers
mbg
mbg approved these changes
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Labels
size/M
Should be of average difficulty to review
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
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.
|