Skip to content

fix(host-service): don't crash startup when shell env probe fails #4150

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

Merged
saddlepaddle merged 1 commit into from
May 6, 2026
+47 −5
Merged

fix(host-service): don't crash startup when shell env probe fails #4150

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
35 changes: 31 additions & 4 deletions packages/host-service/src/terminal/clean-shell-env.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import { type ChildProcess, spawn } from "node:child_process";
import * as os from "node:os";

const SHELL_ENV_TIMEOUT_MS = 8_000;
const CACHE_TTL_MS = 60_000;
const DELIMITER = "__SUPERSET_SHELL_ENV__";
const DIAGNOSTIC_OUTPUT_LIMIT = 200;

const SHELL_BOOTSTRAP_KEYS = [
"HOME",
Expand All @@ -29,7 +31,7 @@ const COMMON_MACOS_PATHS = [
"/usr/local/sbin",
];

function augmentPathForMacOS(
export function augmentPathForMacOS(
env: Record<string, string>,
platform: NodeJS.Platform = process.platform,
): void {
Expand Down Expand Up @@ -90,18 +92,32 @@ function parseEnvOutput(stdout: string): Record<string, string> {
return result;
}

function truncateForDiagnostics(value: string): string {
const trimmed = value.trim();
if (trimmed.length <= DIAGNOSTIC_OUTPUT_LIMIT) return trimmed;
return `${trimmed.slice(0, DIAGNOSTIC_OUTPUT_LIMIT)}…`;
}

function spawnCleanShellEnv(): Promise<Record<string, string>> {
return new Promise((resolve, reject) => {
const shell = resolveShellForEnv();
const env = buildMinimalEnv();
const command = `echo -n "${DELIMITER}"; command env; echo -n "${DELIMITER}"; exit`;

// Anchor at $HOME so the snapshot shell doesn't inherit a cwd
// host-service has no control over. Tools called from interactive
// rc files — brew is the recurring offender (#4025) — abort when
// pwd isn't readable to the invoking user, and Electron helpers
// can land at /private/var/... or similar at launch.
const cwd = env.HOME || os.homedir();

let child: ChildProcess;
try {
child = spawn(shell, ["-i", "-l", "-c", command], {
detached: true,
stdio: ["ignore", "pipe", "pipe"],
env,
cwd,
});
} catch (error) {
return reject(
Expand Down Expand Up @@ -139,6 +155,7 @@ function spawnCleanShellEnv(): Promise<Record<string, string>> {
child.on("close", (code, signal) => {
clearTimeout(timeout);

const stdout = Buffer.concat(stdoutBuffers).toString("utf8");
const stderr = Buffer.concat(stderrBuffers).toString("utf8").trim();
if (stderr) {
console.debug("[terminal-clean-shell-env] stderr:", stderr);
Expand All @@ -147,15 +164,25 @@ function spawnCleanShellEnv(): Promise<Record<string, string>> {
if (code !== 0 && code !== null) {
return reject(
new Error(
`Shell ${shell} exited with code ${code}${signal ? `, signal ${signal}` : ""}`,
`Shell ${shell} exited with code ${code}${signal ? `, signal ${signal}` : ""}` +
(stderr ? ` stderr=${truncateForDiagnostics(stderr)}` : "") +
(stdout ? ` stdout=${truncateForDiagnostics(stdout)}` : ""),
),
);
}

try {
resolve(parseEnvOutput(Buffer.concat(stdoutBuffers).toString("utf8")));
resolve(parseEnvOutput(stdout));
} catch (error) {
reject(error);
const detail = error instanceof Error ? error.message : String(error);
reject(
new Error(
`${detail} (shell=${shell}` +
` stdout=${truncateForDiagnostics(stdout)}` +
(stderr ? ` stderr=${truncateForDiagnostics(stderr)}` : "") +
")",
),
);
}
Comment on lines 174 to 186
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Signal not surfaced in parse-error path

When a shell is killed by a signal (e.g. an external SIGTERM arrives before the delimiters are written), code is null so the non-zero-exit branch is skipped, and the subsequent parse error message is built without mentioning signal. The user sees something like Failed to parse shell env output - delimiter not found (shell=/bin/zsh stdout= stderr=) with no indication the process was terminated by a signal. Since signal is already in scope in the close callback, appending (signal ? \ signal=${signal}` : "")to the error string in thecatch` block would surface it, matching the treatment in the non-zero-exit branch above.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: packages/host-service/src/terminal/clean-shell-env.ts
Line: 174-186

Comment:
**Signal not surfaced in parse-error path**

When a shell is killed by a signal (e.g. an external `SIGTERM` arrives before the delimiters are written), `code` is `null` so the non-zero-exit branch is skipped, and the subsequent parse error message is built without mentioning `signal`. The user sees something like `Failed to parse shell env output - delimiter not found (shell=/bin/zsh stdout= stderr=)` with no indication the process was terminated by a signal. Since `signal` is already in scope in the `close` callback, appending `(signal ? \` signal=${signal}\` : "")` to the error string in the `catch` block would surface it, matching the treatment in the non-zero-exit branch above.

How can I resolve this? If you propose a fix, please make it concise.

});

Expand Down
17 changes: 16 additions & 1 deletion packages/host-service/src/terminal/env.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export {
import fs from "node:fs";
import os from "node:os";
import {
augmentPathForMacOS,
clearStrictShellEnvCache,
getStrictShellEnvironment,
} from "./clean-shell-env.ts";
Expand Down Expand Up @@ -56,11 +57,25 @@ function snapshotStringEnv(
/**
* Resolve the shell-derived terminal base env inside the host-service process.
* Desktop main should not construct or own this snapshot.
*
* Falls back to a process.env snapshot if the user's login shell can't be
* probed — crashing host-service startup over a degraded PTY env strands
* users on v2. v1 desktop main does the same in apps/desktop shell-env.ts.
*/
export async function resolveTerminalBaseEnv(): Promise<
Record<string, string>
> {
return getStrictShellEnvironment();
try {
return await getStrictShellEnvironment();
} catch (error) {
const message = error instanceof Error ? error.message : String(error);
console.warn(
`[host-service] Shell env snapshot failed, falling back to process.env: ${message}`,
);
const fallback = snapshotStringEnv(process.env);
augmentPathForMacOS(fallback);
return fallback;
}
}

/**
Expand Down
Loading