Remove getRunnerLogger - #4235
Merged
mbg merged 9 commits intoOct 22, 2026
Merged
mbg merged 9 commits into
mbg merged 9 commits into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
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.
🟡 Changes recommended
RecordingLogger formats array messages differently in its recorded and console outputs.
1 open finding What changed in this PRRemoves the test-only getRunnerLogger, standardizing tests on RecordingLogger.
Changes:
- Adds array-message normalization to the logging interface.
- Moves getCodeQLForTesting into testing utilities.
- Updates affected tests and helpers to use RecordingLogger.
| File | Description |
|---|---|
| lib/entry-points.js | Excluded generated file; contents unavailable for review. |
| src/logging.ts | Removes getRunnerLogger and supports array messages. |
| src/logging.test.ts | Tests message normalization. |
| src/testing-utils.ts | Extends RecordingLogger and adds the CodeQL test helper. |
| src/codeql.ts | Exposes the underlying CodeQL factory and removes its test helper. |
| src/codeql.test.ts | Uses relocated test utilities. |
| src/workflow.test.ts | Uses relocated CodeQL test helper. |
| src/tracer-config.test.ts | Uses relocated CodeQL test helper. |
| src/init-action-post-helper.test.ts | Uses new test logger and CodeQL helper. |
| src/feature-flags/testing-util.ts | Defaults feature tests to RecordingLogger. |
| src/actions-util.test.ts | Replaces runner logger. |
| src/analyses.test.ts | Replaces runner logger. |
| src/analyze.test.ts | Replaces runner logger. |
| src/artifact-scanner.test.ts | Replaces runner logger. |
| src/cli/output-cache.test.ts | Replaces runner logger. |
| src/config-utils.test.ts | Replaces runner logger. |
| src/config/db-config.test.ts | Replaces runner logger. |
| src/diff-informed-analysis-utils.test.ts | Replaces runner logger. |
| src/feature-flags/properties.test.ts | Replaces runner logger. |
| src/fingerprints.test.ts | Replaces runner logger. |
| src/overlay/caching.test.ts | Replaces runner logger. |
| src/overlay/index.test.ts | Replaces runner logger. |
| src/setup-codeql.test.ts | Replaces runner logger. |
| src/start-proxy.test.ts | Replaces runner logger. |
| src/status-report.test.ts | Replaces runner logger. |
| src/tar.test.ts | Replaces runner logger. |
| src/tools-download.test.ts | Replaces runner logger. |
| src/trap-caching.test.ts | Replaces runner logger. |
| src/upload-lib.test.ts | Replaces runner logger. |
| src/upload-sarif.test.ts | Replaces runner logger. |
| src/util.test.ts | Replaces runner logger. |
- lib/entry-points.js
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Sorry, something went wrong.
Comment thread
src/testing-utils.ts
Outdated
Comment thread
src/testing-utils.ts
Dismissed
henrymercer
previously approved these changes
Oct 16, 2026
Comment thread
src/logging.ts
henrymercer
previously approved these changes
Oct 21, 2026
mbg
enabled auto-merge
October 21, 2026 16:02
github-merge-queue
Bot
removed this pull request from the merge queue due to a conflict with the base branch
Oct 21, 2026
henrymercer
approved these changes
Oct 22, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
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.
Follow-up to #4198 (comment), which cherry-picks the commit with the Logger improvement and addresses the getRunnerLogger point.
The getRunnerLogger function is only used in tests where it is largely superseded by getRecordingLogger / the RecordingLogger class. The Logger returned by getRunnerLogger outputs log messages to stdout. In setupTests, we install test hooks which ensure that all stdout/stderr output is captured and printed if a test fails.
The recording logger is able to both record log messages and output them to stdout. The former is useful for assertions while the latter mirrors the behaviour of getRecordingLogger. While RecordingLogger always uses console.debug to output to stdout, this doesn't matter because we capture the output with the hooks installed by setupTests. The debug-level filter of getRunnerLogger was only used by one file and not practically useful -- the tests still pass and the increased output isn't an issue if tests fail. This PR replaces getRunnerLogger with new RecordingLogger.
Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Environments:
How did/will you validate this change?
If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
N/A
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist