GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Add context to JSON parse errors by mbg · Pull Request #4161 · github/codeql-action

Conversation

@mbg

@mbg mbg commented Sep 22, 2026

Copy link
Copy Markdown
Member

This PR wraps a few existing JSON.parse calls in try/catch blocks in order to (essentially) re-throw errors with more context added to them about the specific JSON.parse call that failed. That can help with troubleshooting in cases where the context of the failure isn't otherwise apparent from a downstream error handler. This doesn't change any behaviour.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
mbg added 7 commits September 22, 2026 18:40
@mbg
Wrap JSON parse errors in resolveExtractor with context
f042742
@mbg
Wrap JSON parse errors in restoreInputs with context
a5c2338
@mbg
Wrap JSON parse errors in getTracerConfigForCluster with context
c036972
@mbg
Wrap JSON parse errors in parseMatrixInput with context
2294a7a
@mbg
Wrap JSON parse errors in cloneObject with context
8e36092
@mbg
Wrap JSON parse errors in readSarifFile with context
fe0a932
@mbg
Fix formatting
660f7c5
@mbg
mbg requested a review from henrymercer September 22, 2026 17:58
@mbg
mbg requested a review from a team as a code owner September 22, 2026 17:58
Copilot AI balanced review requested due to automatic review settings September 22, 2026 17:58
@github-actions github-actions Bot added the size/S Should be easy to review label Sep 22, 2026
Copilot started reviewing on behalf of mbg September 22, 2026 17:59
View session
Copilot AI reviewed Sep 22, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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.

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.

Copilot review overview

🟡 Changes recommended

Restoring inputs now fails when no persisted state exists, breaking the previous no-op behavior.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1 Medium severity

Open (1)
  • Medium severity Guard against parsing empty persisted state · New
What changed in this PR

Adds contextual error messages to JSON parsing failures across action inputs, CLI output, tracer configuration, and SARIF handling.

Changes:

  • Wraps several JSON.parse calls with contextual errors.
  • Includes relevant paths, inputs, or language details in failures.
  • Updates the generated JavaScript bundle.
File Description
src/​util.ts Adds context to matrix parsing and object cloning errors.
src/​tracer-config.ts Identifies the tracing configuration file on failure.
src/​sarif/​index.ts Identifies the SARIF file on parsing failure.
src/​codeql.ts Adds language and CLI output to extractor parsing errors.
src/​actions-util.ts Adds context when restoring persisted inputs.
lib/​entry-points.js Generated bundle; excluded from review by policy.
Files excluded by content exclusion policy (1)
  • lib/entry-points.js

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/actions-util.ts Resolved

Uh oh!

There was an error while loading. Please reload this page.

@mbg
Restore previous restoreInputs behaviour
fa47128
@mbg

mbg commented Sep 23, 2026

Copy link
Copy Markdown
Member Author

The changes in this PR have already worked in helping us identify the cause for the intermittent (and rare) CI failures we previously observed that resulted in:

Expected ',' or ']' after array element in JSON at position 6 (line 1 column 7)

With the changes in this PR, we now get the missing context:

Error: Failed to parse extractor path for 'python' from CLI: Expected ',' or ']' after array element in JSON at position 6 (line 1 column 7)
Output was: [0.004s][warning][perf,memops] Cannot use file /tmp/hsperfdata_runner/5260 because it is locked by another process (errno = 11)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

mbg added 4 commits September 24, 2026 11:34
@mbg
Log error in restoreInputs instead of re-throwing it
b5f938c
@mbg
Merge remote-tracking branch 'origin/main' into mbg/improve-json-fail…
aa2cb99
…ures
@mbg
Log error in getTracerConfigForCluster instead of re-throwing it
19aa55d
@mbg
Merge remote-tracking branch 'origin/main' into mbg/improve-json-fail…
38c1d74
…ures
henrymercer
henrymercer approved these changes Sep 24, 2026
View reviewed changes
@mbg
mbg enabled auto-merge September 24, 2026 11:11
@mbg
mbg added this pull request to the merge queue Sep 24, 2026
Merged via the queue into main with commit fa8392b Sep 24, 2026
233 checks passed

Uh oh!

There was an error while loading. Please reload this page.

@mbg
mbg deleted the mbg/improve-json-failures branch September 24, 2026 11:30
This was referenced Oct 8, 2026
Merge main into releases/v4 #4214
Merged
Merge releases/v4 into releases/v3 #4216
Merged
@shyouhei shyouhei mentioned this pull request Oct 16, 2026
ci: bump github/codeql-action/upload-sarif from 4.38.2 to 4.38.3 sacloud/sacloud-sdk-go#289
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@henrymercer henrymercer henrymercer approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

size/S Should be easy to review

Projects

None yet

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.

3 participants

@mbg @henrymercer
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.