Use json module for JSON validation in output-cache

[mario-campos]

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.

[Copilot]

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

[mbg]

Good catch, @mario-campos can you address this? You already have COMMAND_CACHE_FILENAME as a constant, export it and use it in the tests instead of duplicating the filename there.

[mbg]

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.

[mbg]

Good catch, @mario-campos can you address this? You already have COMMAND_CACHE_FILENAME as a constant, export it and use it in the tests instead of duplicating the filename there.

[mbg]

Minor: Lift the schemas out of the function definitions to make them named, top-level definitions in this file.

You might almost be able to derive VersionInfo from the schema then, which would be preferable over having a disjoint schema and type.

If the goal is not to diverge from the existing validation by making it stricter, then you could have e.g. something like:

export const versionInfoBaseSchema = {
  version: json.string,
  features: json.optional(json.object({})),
  overlayVersion: json.optional(json.number),
} as const satisfies json.Schema;

export type VersionInfoBase = json.FromSchema<typeof versionInfoBaseSchema>;
export type VersionInfo = VersionInfoBase & {
  // `features` remains optional, but the more specific type takes precedence
  // over the `any` type derived by `FromSchema`.
  features?: { [name: string]: boolean };
};