fix: prevent terminal corruption during background bun install #2369
+185
−20
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| import { afterEach, beforeEach, describe, expect, it, spyOn } from "bun:test" | ||
|
|
||
| import * as loggerModule from "../../shared/logger" | ||
| import * as spawnWithWindowsHideModule from "../../shared/spawn-with-windows-hide" | ||
| import { resetConfigContext } from "./config-context" | ||
| import { runBunInstallWithDetails } from "./bun-install" | ||
|
|
||
| function createProc( | ||
| exitCode: number, | ||
| output?: { stdout?: string; stderr?: string } | ||
| ): ReturnType<typeof spawnWithWindowsHideModule.spawnWithWindowsHide> { | ||
| return { | ||
| exited: Promise.resolve(exitCode), | ||
| exitCode, | ||
| stdout: output?.stdout ? new Blob([output.stdout]).stream() : undefined, | ||
| stderr: output?.stderr ? new Blob([output.stderr]).stream() : undefined, | ||
| kill: () => {}, | ||
| } satisfies ReturnType<typeof spawnWithWindowsHideModule.spawnWithWindowsHide> | ||
| } | ||
|
|
||
| describe("runBunInstallWithDetails", () => { | ||
| beforeEach(() => { | ||
| process.env.OPENCODE_CONFIG_DIR = "/test/opencode" | ||
| resetConfigContext() | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| resetConfigContext() | ||
| delete process.env.OPENCODE_CONFIG_DIR | ||
| }) | ||
|
|
||
| it("inherits install output by default", async () => { | ||
| // given | ||
| const spawnSpy = spyOn(spawnWithWindowsHideModule, "spawnWithWindowsHide").mockReturnValue(createProc(0)) | ||
|
|
||
| try { | ||
| // when | ||
| const result = await runBunInstallWithDetails() | ||
|
|
||
| // then | ||
| expect(result).toEqual({ success: true }) | ||
| const [_, options] = spawnSpy.mock.calls[0] as Parameters<typeof spawnWithWindowsHideModule.spawnWithWindowsHide> | ||
| expect(options.stdout).toBe("inherit") | ||
| expect(options.stderr).toBe("inherit") | ||
| } finally { | ||
| spawnSpy.mockRestore() | ||
| } | ||
| }) | ||
|
|
||
| it("pipes install output when requested", async () => { | ||
| // given | ||
| const spawnSpy = spyOn(spawnWithWindowsHideModule, "spawnWithWindowsHide").mockReturnValue(createProc(0)) | ||
|
|
||
| try { | ||
| // when | ||
| const result = await runBunInstallWithDetails({ outputMode: "pipe" }) | ||
|
|
||
| // then | ||
| expect(result).toEqual({ success: true }) | ||
| const [_, options] = spawnSpy.mock.calls[0] as Parameters<typeof spawnWithWindowsHideModule.spawnWithWindowsHide> | ||
| expect(options.stdout).toBe("pipe") | ||
| expect(options.stderr).toBe("pipe") | ||
| } finally { | ||
| spawnSpy.mockRestore() | ||
| } | ||
| }) | ||
|
|
||
| it("logs captured output when piped install fails", async () => { | ||
| // given | ||
| const spawnSpy = spyOn(spawnWithWindowsHideModule, "spawnWithWindowsHide").mockReturnValue( | ||
| createProc(1, { | ||
| stdout: "resolved 10 packages", | ||
| stderr: "network error", | ||
| }) | ||
| ) | ||
| const logSpy = spyOn(loggerModule, "log").mockImplementation(() => {}) | ||
|
|
||
| try { | ||
| // when | ||
| const result = await runBunInstallWithDetails({ outputMode: "pipe" }) | ||
|
|
||
| // then | ||
| expect(result).toEqual({ | ||
| success: false, | ||
| error: "bun install failed with exit code 1", | ||
| }) | ||
| expect(logSpy).toHaveBeenCalledWith("[bun-install] Captured output from failed bun install", { | ||
| stdout: "resolved 10 packages", | ||
| stderr: "network error", | ||
| }) | ||
| } finally { | ||
| logSpy.mockRestore() | ||
| spawnSpy.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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
P2: Unconditionally deleting
process.env.OPENCODE_CONFIG_DIRcan corrupt the test environment if it was previously set by a developer or another test suite.Without restoring the original environment variable, this test pollutes the environment and can cause flaky, hard-to-debug failures in other concurrent tests that rely on
OPENCODE_CONFIG_DIR(as seen safely handled ininstall.test.ts).Prompt for AI agents