FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Disable `UsePerfData` for `resolveExtractor` by mbg · Pull Request #4162 · github/codeql-action · GitHub

  1. github
  2. codeql-action

Repository navigation

Disable UsePerfData for resolveExtractor - #4162

Merged
mbg merged 1 commit into
mainfrom
mbg/cli/disable-perfdata
Sep 23, 2026
ConversationCommits (1)ChecksFiles changed
Merged

Disable UsePerfData for resolveExtractor#4162
mbg merged 1 commit into
mainfrom
mbg/cli/disable-perfdata

Conversation

mbg commented Sep 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Disables UsePerfData for codeql resolve extractor calls by default. This is not needed for the command to work correctly and reduces the risk of failures resulting from a race condition if the CLI is invoked concurrently (example). This is currently possible if we are analysing multiple languages at the same time, because we invoke codeql resolve extractor in parallel for each language.

We could consider disabling UsePerfData for other CLI calls as well, but this PR is a minimal change to resolve the immediate issue we have observed in our CI that sometimes occurs as a result of the possible race condition.

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?

  • 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.
  • Special considerations - This change should only be merged once certain preconditions are met. Please provide details of those or link to this PR from an internal issue.

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.

github-actions Bot added the size/XS Should be very easy to review label Sep 23, 2026
mbg force-pushed the mbg/cli/disable-perfdata branch from 26b16d8 to 9691115 Compare September 23, 2026 10:29
mbg marked this pull request as ready for review September 23, 2026 11:25
mbg requested a review from a team as a code owner September 23, 2026 11:25
mbg requested review from henrymercer and a balanced review from Copilot September 23, 2026 11:25
Copilot AI reviewed Sep 23, 2026
View reviewed changes

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Add a unit test verifying that resolveExtractor passes the exact JVM argument to ToolRunner.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1

Open (1) What changed in this PR

Disables JVM performance data for codeql resolve extractor to reduce concurrent-invocation race failures.

Changes:

  • Adds -J-XX:-UsePerfData to extractor resolution.
  • Updates the generated JavaScript bundle.
File Description
src/​codeql.ts Disables JVM performance data during extractor resolution; a focused unit test was requested.
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.

Comment thread src/codeql.ts
henrymercer approved these changes Sep 23, 2026
View reviewed changes

henrymercer left a comment •
edited
Loading

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Happy to merge this for now as a workaround, but there might be other cases where the JVM will also log messages to stdout, breaking JSON parsing. So consider a more robust fix e.g. passing something like -J-Xlog:all=off:stdout and -J-Xlog:all=warning:stderr to all CLI commands. The fix should probably go in the launcher for future releases, but it is probably worth having the Action pass these flags for previous CLI versions.

mbg added this pull request to the merge queue Sep 23, 2026

mbg commented Sep 23, 2026

Copy link
Copy Markdown
Member Author

but there might be other cases where the JVM will also log messages to stdout, breaking JSON parsing.

@henrymercer Agreed; this is just a quick fix/improvement that targets the immediate issue directly. Redirecting all of the JVM output is probably a good idea as well, but we should check that we don't have any error matching in the Action (e.g. in cli-errors.ts) that currently depends on JVM errors in stdout. (If we do, we can update that of course, but we should check.)

Merged via the queue into main with commit f0064b2 Sep 23, 2026
235 checks passed
mbg deleted the mbg/cli/disable-perfdata branch September 23, 2026 12:30
This was referenced Sep 23, 2026
Closed
Merged
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
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 approved these changes

Assignees

No one assigned

Labels

size/XS Should be very easy to review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL