Gate terminal chunk debug logs#7
Merged
Merged
Conversation
Signed-off-by: zebbern <185730623+zebbern@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR reduces noise from terminal chunk emission in @sentris/component-sdk by disabling chunk console.debug output by default, while still allowing targeted diagnostics via an environment flag, and adds tests to cover the new behavior.
Changes:
- Gate terminal chunk debug logging behind
SENTRIS_DEBUG_TERMINAL=1. - Add unit tests asserting the default “quiet” behavior and the explicit debug-enabled behavior.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
packages/component-sdk/src/terminal.ts |
Wraps terminal chunk console.debug behind an env-flag check. |
packages/component-sdk/src/__tests__/terminal-chunk.test.ts |
Adds coverage for default no-debug behavior and debug-enabled logging. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+5
to
+7
| function shouldDebugTerminalChunks(): boolean { | ||
| return process.env.SENTRIS_DEBUG_TERMINAL === '1'; | ||
| } |
Comment on lines
+53
to
+71
| it('does not write debug logs by default', () => { | ||
| const debugSpy = vi.spyOn(console, 'debug').mockImplementation(() => {}); | ||
|
|
||
| try { | ||
| const collector = vi.fn(); | ||
| const context = createExecutionContext({ | ||
| runId: 'run-1', | ||
| componentRef: 'node.a', | ||
| terminalCollector: collector, | ||
| }); | ||
|
|
||
| const emitter = createTerminalChunkEmitter(context, 'stdout'); | ||
| emitter('data'); | ||
|
|
||
| expect(debugSpy).not.toHaveBeenCalled(); | ||
| } finally { | ||
| debugSpy.mockRestore(); | ||
| } | ||
| }); |
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
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.
Summary
Verification