Files
gstack/lib/spawn-sync.ts
T
Garry Tanandcapy-ai[bot] 36b349d660 Commands that read cut-off output now fail instead of judging part of it (GST-3086) (#4492)
Commands that read large git or gh output, including the credential
pre-push hook, the pre-merge secret and literal scans and the
sealed-output guard, now fail when Bun cuts that output off, instead of
judging the part they got.

Why: Bun can report exit status 0 together with ENOBUFS and partial
stdout, so a push whose diff passed 64 MiB could get a credential past
the pre-push hook.

Nothing to do: the failure names `SPAWN_OUTPUT_INCOMPLETE` and links its
troubleshooting entry.

Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
2026-11-18 17:00:18 +00:00

32 lines
2.1 KiB
TypeScript

/**
* spawnSync that never hands back cut-off output as a finished read (GST-3086).
*
* Bun's node:child_process spawnSync can return status 0 together with error
* ENOBUFS and stdout cut near maxBuffer: when the child exits before the
* overflow kill lands (or ignores SIGTERM), the exit status is the child's own
* clean exit (seen on Bun 1.4.2 and 1.4.4, GSTA-618, #4490). The default
* maxBuffer is 1 MiB, so every buffered call has a limit. A caller that checks
* only `status` then treats part of a diff, a file list or a scan input as the
* whole answer. execFileSync and execSync throw in that case; spawnSync does not.
*
* This keeps Node's signature and result. When `error` is set and `status` is
* not null, or the error is ENOBUFS, it returns `status: null` (so a
* `status === 0` check fails closed), keeps `error.code`, and names
* SPAWN_OUTPUT_INCOMPLETE in `error.message` and on the end of a captured stderr.
* The code's row lives in lib/result-codes-release.ts; this file imports nothing
* from lib/ because the paid test runner's global import closure includes it.
*/
import { spawnSync as nodeSpawnSync, type SpawnSyncReturns } from 'node:child_process';
export const spawnSync = ((...args: unknown[]) => {
const r = (nodeSpawnSync as (...a: unknown[]) => SpawnSyncReturns<string | Buffer>)(...args);
const code = (r.error as NodeJS.ErrnoException | undefined)?.code;
if (!r.error || (r.status === null && code !== 'ENOBUFS')) return r;
const line = `${String(args[0])}: the output may be cut off (${code ?? r.error.message}, exit ${r.status ?? r.signal ?? 'unknown'}), so it was not used; see docs/troubleshooting.md#spawn-output-incomplete (SPAWN_OUTPUT_INCOMPLETE)`;
r.error.message = `${r.error.message} (SPAWN_OUTPUT_INCOMPLETE)`;
const stderr = typeof r.stderr === 'string' ? `${r.stderr}${r.stderr && !r.stderr.endsWith('\n') ? '\n' : ''}${line}\n`
: Buffer.isBuffer(r.stderr) ? Buffer.concat([r.stderr, Buffer.from(`${r.stderr.length && r.stderr[r.stderr.length - 1] !== 10 ? '\n' : ''}${line}\n`)])
: r.stderr;
return { ...r, status: null, stderr };
}) as typeof nodeSpawnSync;