Skip to content

Add schema checker to json module#4006

Merged
mbg merged 12 commits into
mainfrom
mbg/json/schema-checker
Jul 13, 2026
Merged

Add schema checker to json module#4006
mbg merged 12 commits into
mainfrom
mbg/json/schema-checker

Conversation

@mbg

@mbg mbg commented Jul 13, 2026

Copy link
Copy Markdown
Member

This PR cherry-picks some commits from #3994 which extend the json module with a schema checker that returns information about which keys are unknown or invalid in the provided value according to the given schema.

This also includes new object and array validators that are parametrised over schemas and other validators, respectively.

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.
  • Other first-party - The changes impact other first-party analyses.
  • Third-party analyses - The changes affect the upload-sarif action.

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.
    • Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.
    • 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.

@mbg mbg requested a review from mario-campos July 13, 2026 09:26
@mbg mbg self-assigned this Jul 13, 2026
@mbg mbg requested a review from a team as a code owner July 13, 2026 09:26
Copilot AI review requested due to automatic review settings July 13, 2026 09:26
@github-actions github-actions Bot added the size/M Should be of average difficulty to review label Jul 13, 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.

Warning

  • Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.

Pull request overview

Extends the JSON validation module with composable validators and detailed schema-checking results, supporting future configuration merging work.

Changes:

  • Adds array and object validators.
  • Adds unknown/invalid key reporting and fail-fast validation.
  • Adds unit tests for nested schemas and diagnostics.
Show a summary per file
File Description
src/json/index.ts Implements validators and schema checking.
src/json/index.test.ts Tests arrays, objects, and key reporting.
lib/entry-points.js Generated bundle; excluded from review.

Review details

Files excluded by content exclusion policy (1)
  • lib/entry-points.js
  • Files reviewed: 2/3 changed files
  • Comments generated: 3
  • Review effort level: Medium

Comment thread src/json/index.ts
Comment thread src/json/index.ts
Comment thread src/json/index.ts
@mbg mbg added this pull request to the merge queue Jul 13, 2026
Merged via the queue into main with commit f133996 Jul 13, 2026
225 checks passed
@mbg mbg deleted the mbg/json/schema-checker branch July 13, 2026 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Should be of average difficulty to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants