Skip to content

Use json module for JSON validation in output-cache - #4096

Open
mario-campos wants to merge 1 commit into
mainfrom
mario-campos/use-json-module
Open

Use json module for JSON validation in output-cache#4096
mario-campos wants to merge 1 commit into
mainfrom
mario-campos/use-json-module

Conversation

@mario-campos

Copy link
Copy Markdown
Contributor

Use the included json module to improve (make more readable) the validation of the output of codeql version.

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.

@mario-campos
mario-campos requested review from mbg and a balanced review from Copilot August 14, 2026 04:19
@mario-campos
mario-campos requested a review from a team as a code owner August 14, 2026 04:19
@github-actions github-actions Bot added the size/S Should be easy to review label Aug 14, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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

Comment thread src/cli/output-cache.ts
Comment on lines +133 to +139
json.validateSchema(
{
version: json.string,
features: json.optional(json.object({})),
overlayVersion: json.optional(json.number),
} as const satisfies json.Schema,
x,
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Should be easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants