Skip to content

fix: use VS Code default shell for command execution instead of /bin/sh #509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
p12tic wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −4
Open

fix: use VS Code default shell for command execution instead of /bin/sh #509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/integrations/terminal/ExecaTerminalProcess.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import psTree from "ps-tree"
import process from "process"

import type { RooTerminal } from "./types"
import { getShell } from "../../utils/shell"
import { BaseTerminal } from "./BaseTerminal"
import { BaseTerminalProcess } from "./BaseTerminalProcess"

Expand Down Expand Up @@ -40,7 +41,7 @@ export class ExecaTerminalProcess extends BaseTerminalProcess {
this.isHot = true

this.subprocess = execa({
shell: BaseTerminal.getExecaShellPath() || true,
shell: BaseTerminal.getExecaShellPath() || getShell(),

@edelauna edelauna Jun 22, 2026

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.

Nit: this line picked up an extra leading tab — it's indented one level deeper than its siblings (cwd, all, stdin, env), curious how lint didn't flag this.

cwd: this.terminal.getCurrentWorkingDirectory(),
all: true,
// Ignore stdin to ensure non-interactive mode and prevent hanging
Expand Down
12 changes: 9 additions & 3 deletions src/integrations/terminal/__tests__/ExecaTerminalProcess.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// npx vitest run integrations/terminal/__tests__/ExecaTerminalProcess.spec.ts

const mockPid = 12345
const mockGetShell = vitest.fn(() => "/bin/bash")

@edelauna edelauna Jun 22, 2026

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.

Per the Vitest docs, clearAllMocks() in afterEach resets call history but does not restore mockReturnValue overrides. The fallback test sets mockGetShell.mockReturnValue("/usr/bin/zsh"), which will bleed into any subsequent test that relies on the default "/bin/bash". Would resetAllMocks() + a mockGetShell.mockImplementation(() => "/bin/bash") in beforeEach be safer?


vitest.mock("execa", () => {
const mockKill = vitest.fn()
Expand All @@ -21,6 +22,10 @@ vitest.mock("ps-tree", () => ({
default: vitest.fn((_: number, cb: any) => cb(null, [])),
}))

vitest.mock("../../../utils/shell", () => ({
getShell: () => mockGetShell(),
}))

import { execa } from "execa"
import { ExecaTerminalProcess } from "../ExecaTerminalProcess"
import { BaseTerminal } from "../BaseTerminal"
Expand Down Expand Up @@ -63,7 +68,7 @@ describe("ExecaTerminalProcess", () => {
const execaMock = vitest.mocked(execa)
expect(execaMock).toHaveBeenCalledWith(
expect.objectContaining({
shell: true,
shell: "/bin/bash",
cwd: "/test/cwd",
all: true,
env: expect.objectContaining({
Expand Down Expand Up @@ -105,13 +110,14 @@ describe("ExecaTerminalProcess", () => {
)
})

it("should fall back to shell=true when execaShellPath is undefined", async () => {
it("should fall back to getShell() when execaShellPath is undefined", async () => {
BaseTerminal.setExecaShellPath(undefined)
mockGetShell.mockReturnValue("/usr/bin/zsh")

@edelauna edelauna Jun 22, 2026

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.

The "should use execaShellPath when set" test (above) sets execaShellPath to "/bin/bash" and mockGetShell also defaults to "/bin/bash", so the assertion shell: "/bin/bash" passes regardless of which branch of the || fires. Would adding expect(mockGetShell).not.toHaveBeenCalled() there make it actually verify the short-circuit?

await terminalProcess.run("echo test")
const execaMock = vitest.mocked(execa)
expect(execaMock).toHaveBeenCalledWith(
expect.objectContaining({
shell: true,
shell: "/usr/bin/zsh",
}),
)
})
Comment on lines +113 to 123

@coderabbitai coderabbitai Bot Jun 6, 2026

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.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix test isolation issue to prevent flakiness.

Using mockReturnValue() on Line 115 permanently changes the mock's behavior until explicitly reset. Since clearAllMocks() (Line 62) only clears call history but not mock implementations, the "/usr/bin/zsh" return value will persist if this test runs before others, causing the test at Line 66-80 to fail when it expects "/bin/bash".

🔧 Proposed fix using mockReturnValueOnce 
 		it("should fall back to getShell() when execaShellPath is undefined", async () => {
 			BaseTerminal.setExecaShellPath(undefined)
-			mockGetShell.mockReturnValue("/usr/bin/zsh")
+			mockGetShell.mockReturnValueOnce("/usr/bin/zsh")
 			await terminalProcess.run("echo test")
 			const execaMock = vitest.mocked(execa)
 			expect(execaMock).toHaveBeenCalledWith(
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/integrations/terminal/__tests__/ExecaTerminalProcess.spec.ts` around
lines 113 - 123, The test leaks mock behavior because
mockGetShell.mockReturnValue("/usr/bin/zsh") permanently changes the mock;
change the test to use mockGetShell.mockReturnValueOnce("/usr/bin/zsh") (or
restore/reset the mock implementation) so
BaseTerminal.setExecaShellPath(undefined) test only affects this test; update
the call in the "should fall back to getShell() when execaShellPath is
undefined" spec to use mockReturnValueOnce on mockGetShell to ensure isolation
and prevent interfering with other tests that expect "/bin/bash".

Expand Down
Loading