File size: 51,921 Bytes
7a1ad33 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 | /**
* @license
* Copyright 2026 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import stripAnsi from 'strip-ansi';
import { getPty, type PtyImplementation } from '../utils/getPty.js';
import { spawn as cpSpawn, type ChildProcess } from 'node:child_process';
import { TextDecoder } from 'node:util';
import type { Writable } from 'node:stream';
import os from 'node:os';
import fs, { mkdirSync } from 'node:fs';
import path from 'node:path';
import type { IPty } from '@lydell/node-pty';
import {
getShellConfiguration,
resolveExecutable,
type ShellType,
} from '../utils/shell-utils.js';
import { isBinary, truncateString } from '../utils/textUtils.js';
import pkg from '@xterm/headless';
import { debugLogger } from '../utils/debugLogger.js';
import { Storage } from '../config/storage.js';
import {
serializeTerminalToObject,
type AnsiOutput,
} from '../utils/terminalSerializer.js';
import {
sanitizeEnvironment,
type EnvironmentSanitizationConfig,
} from './environmentSanitization.js';
import {
NoopSandboxManager,
type SandboxManager,
type SandboxPermissions,
} from './sandboxManager.js';
import type { SandboxConfig } from '../config/config.js';
import { killProcessGroup } from '../utils/process-utils.js';
import { isNodeError } from '../utils/errors.js';
import {
ExecutionLifecycleService,
type ExecutionHandle,
type ExecutionOutputEvent,
type ExecutionResult,
} from './executionLifecycleService.js';
const { Terminal } = pkg;
const MAX_CHILD_PROCESS_BUFFER_SIZE = 16 * 1024 * 1024; // 16MB
/**
* An environment variable that is set for shell executions. This can be used
* by downstream executables and scripts to identify that they were executed
* from within Gemini CLI.
*/
export const GEMINI_CLI_IDENTIFICATION_ENV_VAR = 'GEMINI_CLI';
/**
* The value of {@link GEMINI_CLI_IDENTIFICATION_ENV_VAR}
*/
export const GEMINI_CLI_IDENTIFICATION_ENV_VAR_VALUE = '1';
// We want to allow shell outputs that are close to the context window in size.
// 300,000 lines is roughly equivalent to a large context window, ensuring
// we capture significant output from long-running commands.
export const SCROLLBACK_LIMIT = 300000;
const BASH_SHOPT_OPTIONS = 'promptvars nullglob extglob nocaseglob dotglob';
const BASH_SHOPT_GUARD = `shopt -u ${BASH_SHOPT_OPTIONS};`;
function ensurePromptvarsDisabled(command: string, shell: ShellType): string {
if (shell !== 'bash') {
return command;
}
const trimmed = command.trimStart();
if (trimmed.startsWith(BASH_SHOPT_GUARD)) {
return command;
}
return `${BASH_SHOPT_GUARD} ${command}`;
}
// On Windows, a new ConPTY session inherits its codepage from the system
// OEMCP (microsoft/terminal `src/host/settings.cpp:41` defaults
// `_uCodePage` to `Globals.uiOEMCP`, set from `GetOEMCP()` in
// `srvinit.cpp:44`). On locales without "Beta: Use Unicode UTF-8 for
// worldwide language support" the OEMCP is a legacy codepage (e.g. 850,
// 866, 936, 932), and conhost converts every byte from the child via
// `MultiByteToWideChar(gci.OutputCP, ...)` in `_stream.cpp:341-343`,
// turning UTF-8 output from child processes (perl, python, node, ...)
// into mojibake.
//
// `CreatePseudoConsole` does not accept a codepage argument
// (microsoft/terminal#9174 — open as a feature request). The only way
// to set the ConPTY codepage is from inside the new session via
// `SetConsoleOutputCP` (intercepted by conhost in `getset.cpp:1144`).
// Prefix the command with `chcp 65001` so the first thing the new
// session does is switch its codepage to UTF-8.
function injectUtf8CodepageForPty(
command: string,
shell: ShellType,
isWindows: boolean,
usingPty: boolean,
): string {
if (!isWindows || !usingPty) {
return command;
}
if (shell === 'powershell') {
return `chcp 65001 >$null;${command}`;
}
if (shell === 'cmd') {
return `chcp 65001>nul&${command}`;
}
return command;
}
/** A structured result from a shell command execution. */
export type ShellExecutionResult = ExecutionResult;
/** A handle for an ongoing shell execution. */
export type ShellExecutionHandle = ExecutionHandle;
export interface ShellExecutionConfig {
additionalPermissions?: SandboxPermissions;
terminalWidth?: number;
terminalHeight?: number;
pager?: string;
showColor?: boolean;
defaultFg?: string;
defaultBg?: string;
sanitizationConfig: EnvironmentSanitizationConfig;
sandboxManager: SandboxManager;
// Used for testing
disableDynamicLineTrimming?: boolean;
scrollback?: number;
maxSerializedLines?: number;
sandboxConfig?: SandboxConfig;
backgroundCompletionBehavior?: 'inject' | 'notify' | 'silent';
originalCommand?: string;
sessionId?: string;
env?: Record<string, string | undefined>;
}
/**
* Describes a structured event emitted during shell command execution.
*/
export type ShellOutputEvent = ExecutionOutputEvent;
export type DestroyablePty = IPty & { destroy?: () => void };
interface ActivePty {
ptyProcess: DestroyablePty;
headlessTerminal: pkg.Terminal;
maxSerializedLines?: number;
command: string;
sessionId?: string;
}
interface ActiveChildProcess {
process: ChildProcess;
state: {
output: string;
truncated: boolean;
sniffChunks: Buffer[];
binaryBytesReceived: number;
};
command: string;
sessionId?: string;
}
const findLastContentLine = (
buffer: pkg.IBuffer,
startLine: number,
): number => {
const lineCount = buffer.length;
for (let i = lineCount - 1; i >= startLine; i--) {
const line = buffer.getLine(i);
if (line && line.translateToString(true).length > 0) {
return i;
}
}
return -1;
};
const getFullBufferText = (terminal: pkg.Terminal, startLine = 0): string => {
const buffer = terminal.buffer.active;
const lines: string[] = [];
const lastContentLine = findLastContentLine(buffer, startLine);
if (lastContentLine === -1 || lastContentLine < startLine) return '';
for (let i = startLine; i <= lastContentLine; i++) {
const line = buffer.getLine(i);
if (!line) {
lines.push('');
continue;
}
let trimRight = true;
if (i + 1 <= lastContentLine) {
const nextLine = buffer.getLine(i + 1);
if (nextLine?.isWrapped) {
trimRight = false;
}
}
const lineContent = line.translateToString(trimRight);
if (line.isWrapped && lines.length > 0) {
lines[lines.length - 1] += lineContent;
} else {
lines.push(lineContent);
}
}
return lines.join('\n');
};
const writeBufferToLogStream = (
terminal: pkg.Terminal,
stream: fs.WriteStream,
startLine = 0,
): number => {
const buffer = terminal.buffer.active;
const lastContentLine = findLastContentLine(buffer, startLine);
if (lastContentLine === -1 || lastContentLine < startLine) return startLine;
for (let i = startLine; i <= lastContentLine; i++) {
const line = buffer.getLine(i);
if (!line) {
stream.write('\n');
continue;
}
let trimRight = true;
if (i + 1 <= lastContentLine) {
const nextLine = buffer.getLine(i + 1);
if (nextLine?.isWrapped) {
trimRight = false;
}
}
const lineContent = line.translateToString(trimRight);
const stripped = stripAnsi(lineContent);
if (line.isWrapped) {
stream.write(stripped);
} else {
if (i > startLine) {
stream.write('\n');
}
stream.write(stripped);
}
}
// Ensure it ends with a newline if we wrote anything and the next line is not wrapped
if (lastContentLine >= startLine) {
const nextLine = terminal.buffer.active.getLine(lastContentLine + 1);
if (!nextLine?.isWrapped) {
stream.write('\n');
}
}
return lastContentLine + 1;
};
/**
* A centralized service for executing shell commands with robust process
* management, cross-platform compatibility, and streaming output capabilities.
*
*/
export type BackgroundProcess = {
pid: number;
command: string;
status: 'running' | 'exited';
exitCode?: number | null;
signal?: number | null;
};
export type BackgroundProcessRecord = Omit<BackgroundProcess, 'pid'> & {
startTime: number;
endTime?: number;
};
export class ShellExecutionService {
private static activePtys = new Map<number, ActivePty>();
private static activeChildProcesses = new Map<number, ActiveChildProcess>();
private static backgroundLogPids = new Set<number>();
private static backgroundLogStreams = new Map<number, fs.WriteStream>();
private static backgroundProcessHistory = new Map<
string, // sessionId
Map<number, BackgroundProcessRecord>
>();
static getLogDir(): string {
return path.join(Storage.getGlobalTempDir(), 'background-processes');
}
private static formatShellBackgroundCompletion(
pid: number,
behavior: string,
output: string,
error?: Error,
): string {
const logPath = ShellExecutionService.getLogFilePath(pid);
const status = error ? `with error: ${error.message}` : 'successfully';
if (behavior === 'inject') {
const truncated = truncateString(output, 5000);
return `[Background command completed ${status}. Output saved to ${logPath}]\n\n${truncated}`;
}
return `[Background command completed ${status}. Output saved to ${logPath}]`;
}
static getLogFilePath(pid: number): string {
return path.join(this.getLogDir(), `background-${pid}.log`);
}
private static syncBackgroundLog(pid: number, content: string): void {
if (!this.backgroundLogPids.has(pid)) return;
const stream = this.backgroundLogStreams.get(pid);
if (stream && content) {
// Strip ANSI escape codes before logging
stream.write(stripAnsi(content));
}
}
private static async cleanupLogStream(pid: number): Promise<void> {
const stream = this.backgroundLogStreams.get(pid);
if (stream) {
await new Promise<void>((resolve) => {
stream.end(() => resolve());
});
this.backgroundLogStreams.delete(pid);
}
this.backgroundLogPids.delete(pid);
}
/**
* Executes a shell command using `node-pty`, capturing all output and lifecycle events.
*
* @param commandToExecute The exact command string to run.
* @param cwd The working directory to execute the command in.
* @param onOutputEvent A callback for streaming structured events about the execution, including data chunks and status updates.
* @param abortSignal An AbortSignal to terminate the process and its children.
* @returns An object containing the process ID (pid) and a promise that
* resolves with the complete execution result.
*/
static async execute(
commandToExecute: string,
cwd: string,
onOutputEvent: (event: ShellOutputEvent) => void,
abortSignal: AbortSignal,
shouldUseNodePty: boolean,
shellExecutionConfig: ShellExecutionConfig,
): Promise<ShellExecutionHandle> {
if (shouldUseNodePty) {
const ptyInfo = await getPty();
if (ptyInfo) {
try {
return await this.executeWithPty(
commandToExecute,
cwd,
onOutputEvent,
abortSignal,
shellExecutionConfig,
ptyInfo,
);
} catch {
// Fallback to child_process
}
}
}
return this.childProcessFallback(
commandToExecute,
cwd,
onOutputEvent,
abortSignal,
shellExecutionConfig,
shouldUseNodePty,
);
}
private static appendAndTruncate(
currentBuffer: string,
chunk: string,
maxSize: number,
): { newBuffer: string; truncated: boolean } {
const chunkLength = chunk.length;
const currentLength = currentBuffer.length;
const newTotalLength = currentLength + chunkLength;
if (newTotalLength <= maxSize) {
return { newBuffer: currentBuffer + chunk, truncated: false };
}
// Truncation is needed.
if (chunkLength >= maxSize) {
// The new chunk is larger than or equal to the max buffer size.
// The new buffer will be the tail of the new chunk.
return {
newBuffer: chunk.substring(chunkLength - maxSize),
truncated: true,
};
}
// The combined buffer exceeds the max size, but the new chunk is smaller than it.
// We need to truncate the current buffer from the beginning to make space.
const charsToTrim = newTotalLength - maxSize;
const truncatedBuffer = currentBuffer.substring(charsToTrim);
return { newBuffer: truncatedBuffer + chunk, truncated: true };
}
private static async prepareExecution(
commandToExecute: string,
cwd: string,
shellExecutionConfig: ShellExecutionConfig,
isInteractive: boolean,
usingPty: boolean,
): Promise<{
program: string;
args: string[];
env: NodeJS.ProcessEnv;
cwd: string;
cleanup?: () => void;
}> {
const sandboxManager =
shellExecutionConfig.sandboxManager ?? new NoopSandboxManager();
// 1. Determine Shell Configuration
const isWindows = os.platform() === 'win32';
const isStrictSandbox =
isWindows &&
shellExecutionConfig.sandboxConfig?.enabled &&
shellExecutionConfig.sandboxConfig?.command === 'windows-native' &&
!shellExecutionConfig.sandboxConfig?.networkAccess;
let { executable, argsPrefix, shell } = getShellConfiguration();
if (isStrictSandbox) {
shell = 'cmd';
argsPrefix = ['/c'];
executable = 'cmd.exe';
}
const resolvedExecutable = resolveExecutable(executable) ?? executable;
const guardedCommand = ensurePromptvarsDisabled(commandToExecute, shell);
const finalCommand = injectUtf8CodepageForPty(
guardedCommand,
shell,
isWindows,
usingPty,
);
const spawnArgs = [...argsPrefix, finalCommand];
// 2. Prepare Environment
const sourceEnv = shellExecutionConfig.env ?? process.env;
const gitConfigKeys: string[] = [];
for (const key in sourceEnv) {
if (key.startsWith('GIT_CONFIG_')) {
gitConfigKeys.push(key);
}
}
const sanitizationConfig = {
...shellExecutionConfig.sanitizationConfig,
allowedEnvironmentVariables: [
...(shellExecutionConfig.sanitizationConfig
.allowedEnvironmentVariables || []),
...gitConfigKeys,
],
};
const sanitizedEnv = sanitizeEnvironment(sourceEnv, sanitizationConfig);
const baseEnv: Record<string, string | undefined> = {
...sanitizedEnv,
[GEMINI_CLI_IDENTIFICATION_ENV_VAR]:
GEMINI_CLI_IDENTIFICATION_ENV_VAR_VALUE,
TERM: 'xterm-256color',
PAGER: shellExecutionConfig.pager ?? 'cat',
GIT_PAGER: shellExecutionConfig.pager ?? 'cat',
};
// Ensure all GIT_CONFIG_* variables are preserved even if they were redacted
for (const key of gitConfigKeys) {
baseEnv[key] = sourceEnv[key];
}
let gitConfigCount = parseInt(baseEnv['GIT_CONFIG_COUNT'] || '0', 10);
const devNullPath = os.platform() === 'win32' ? 'NUL' : '/dev/null';
baseEnv['GIT_CONFIG_GLOBAL'] = devNullPath;
baseEnv['GIT_CONFIG_SYSTEM'] = devNullPath;
baseEnv['GIT_CONFIG_NOSYSTEM'] = '1';
sanitizationConfig.allowedEnvironmentVariables.push(
'GIT_CONFIG_COUNT',
'GIT_CONFIG_GLOBAL',
'GIT_CONFIG_SYSTEM',
'GIT_CONFIG_NOSYSTEM',
);
const defaultGitOverrides: Array<[string, string]> = [
['credential.helper', ''],
['core.fsmonitor', ''],
['core.hooksPath', ''],
['core.sshCommand', ''],
['core.pager', 'cat'],
['core.editor', ''],
['sequence.editor', ''],
['diff.external', ''],
];
for (const [overrideKey, overrideVal] of defaultGitOverrides) {
const keyVar = `GIT_CONFIG_KEY_${gitConfigCount}`;
const valVar = `GIT_CONFIG_VALUE_${gitConfigCount}`;
sanitizationConfig.allowedEnvironmentVariables.push(keyVar, valVar);
baseEnv[keyVar] = overrideKey;
baseEnv[valVar] = overrideVal;
gitConfigCount++;
}
baseEnv['GIT_CONFIG_COUNT'] = gitConfigCount.toString();
Object.assign(baseEnv, {
GIT_TERMINAL_PROMPT: '0',
GIT_ASKPASS: '',
SSH_ASKPASS: '',
GH_PROMPT_DISABLED: '1',
GCM_INTERACTIVE: 'never',
DISPLAY: '',
DBUS_SESSION_BUS_ADDRESS: '',
});
// 3. Prepare Sandboxed Command
const sandboxedCommand = await sandboxManager.prepareCommand({
command: resolvedExecutable,
args: spawnArgs,
env: baseEnv,
cwd,
policy: {
...shellExecutionConfig,
...(shellExecutionConfig.sandboxConfig || {}),
sanitizationConfig,
additionalPermissions: shellExecutionConfig.additionalPermissions,
},
});
return {
program: sandboxedCommand.program,
args: sandboxedCommand.args,
env: sandboxedCommand.env,
cwd: sandboxedCommand.cwd ?? cwd,
cleanup: sandboxedCommand.cleanup,
};
}
private static async childProcessFallback(
commandToExecute: string,
cwd: string,
onOutputEvent: (event: ShellOutputEvent) => void,
abortSignal: AbortSignal,
shellExecutionConfig: ShellExecutionConfig,
isInteractive: boolean,
): Promise<ShellExecutionHandle> {
let cmdCleanup: (() => void) | undefined;
try {
const isWindows = os.platform() === 'win32';
const prepared = await this.prepareExecution(
commandToExecute,
cwd,
shellExecutionConfig,
isInteractive,
false,
);
cmdCleanup = prepared.cleanup;
const {
program: finalExecutable,
args: finalArgs,
env: finalEnv,
cwd: finalCwd,
} = prepared;
// Bun's child_process does not properly call setsid() for detached
// processes, leaving children in the parent's session without a
// controlling terminal. They receive SIGHUP immediately. Disable
// detached mode in Bun; killProcessGroup already falls back to
// direct-pid kill when the group kill fails.
const isBun = 'bun' in process.versions;
const child = cpSpawn(finalExecutable, finalArgs, {
cwd: finalCwd,
stdio: ['ignore', 'pipe', 'pipe'],
windowsVerbatimArguments: isWindows ? false : undefined,
shell: false,
detached: !isWindows && !isBun,
env: finalEnv,
});
const state = {
output: '',
truncated: false,
sniffChunks: [] as Buffer[],
binaryBytesReceived: 0,
};
if (child.pid !== undefined) {
this.activeChildProcesses.set(child.pid, {
process: child,
state,
command: shellExecutionConfig.originalCommand ?? commandToExecute,
sessionId: shellExecutionConfig.sessionId,
});
}
const lifecycleHandle = child.pid
? ExecutionLifecycleService.attachExecution(child.pid, {
executionMethod: 'child_process',
getBackgroundOutput: () => state.output,
getSubscriptionSnapshot: () => state.output || undefined,
writeInput: (input) => {
const stdin = child.stdin as Writable | null;
if (stdin) {
stdin.write(input);
}
},
kill: () => {
if (child.pid) {
killProcessGroup({ pid: child.pid }).catch(() => {});
this.activeChildProcesses.delete(child.pid);
}
},
isActive: () => {
if (!child.pid) {
return false;
}
try {
return process.kill(child.pid, 0);
} catch {
return false;
}
},
formatInjection: (output, error) =>
ShellExecutionService.formatShellBackgroundCompletion(
child.pid!,
shellExecutionConfig.backgroundCompletionBehavior || 'silent',
output,
error ?? undefined,
),
completionBehavior:
shellExecutionConfig.backgroundCompletionBehavior || 'silent',
})
: undefined;
let resolveWithoutPid:
| ((result: ShellExecutionResult) => void)
| undefined;
const result =
lifecycleHandle?.result ??
new Promise<ShellExecutionResult>((resolve) => {
resolveWithoutPid = resolve;
});
let stdoutDecoder: TextDecoder | null = null;
let stderrDecoder: TextDecoder | null = null;
let error: Error | null = null;
let exited = false;
let isStreamingRawContent = true;
const MAX_SNIFF_SIZE = 4096;
let sniffedBytes = 0;
const handleOutput = (data: Buffer, stream: 'stdout' | 'stderr') => {
if (!stdoutDecoder || !stderrDecoder) {
stdoutDecoder = new TextDecoder('utf-8');
stderrDecoder = new TextDecoder('utf-8');
}
if (isStreamingRawContent && sniffedBytes < MAX_SNIFF_SIZE) {
state.sniffChunks.push(data);
} else if (!isStreamingRawContent) {
state.binaryBytesReceived += data.length;
}
if (isStreamingRawContent && sniffedBytes < MAX_SNIFF_SIZE) {
const sniffBuffer = Buffer.concat(state.sniffChunks);
sniffedBytes = sniffBuffer.length;
if (isBinary(sniffBuffer)) {
isStreamingRawContent = false;
state.binaryBytesReceived = sniffBuffer.length;
const event: ShellOutputEvent = { type: 'binary_detected' };
onOutputEvent(event);
if (child.pid) {
ExecutionLifecycleService.emitEvent(child.pid, event);
}
}
}
if (isStreamingRawContent) {
const decoder = stream === 'stdout' ? stdoutDecoder : stderrDecoder;
const decodedChunk = decoder.decode(data, { stream: true });
const { newBuffer, truncated } = this.appendAndTruncate(
state.output,
decodedChunk,
MAX_CHILD_PROCESS_BUFFER_SIZE,
);
state.output = newBuffer;
if (truncated) {
state.truncated = true;
}
if (decodedChunk) {
const event: ShellOutputEvent = {
type: 'data',
chunk: decodedChunk,
};
onOutputEvent(event);
if (child.pid) {
ExecutionLifecycleService.emitEvent(child.pid, event);
if (ShellExecutionService.backgroundLogPids.has(child.pid)) {
ShellExecutionService.syncBackgroundLog(
child.pid,
decodedChunk,
);
}
}
}
} else {
const totalBytes = state.binaryBytesReceived;
const event: ShellOutputEvent = {
type: 'binary_progress',
bytesReceived: totalBytes,
};
onOutputEvent(event);
if (child.pid) {
ExecutionLifecycleService.emitEvent(child.pid, event);
}
}
};
const handleExit = (
code: number | null,
signal: NodeJS.Signals | null,
) => {
cleanup();
cmdCleanup?.();
let combinedOutput = state.output;
if (state.truncated) {
const truncationMessage = `\n[GEMINI_CLI_WARNING: Output truncated. The buffer is limited to ${
MAX_CHILD_PROCESS_BUFFER_SIZE / (1024 * 1024)
}MB.]`;
combinedOutput += truncationMessage;
}
const finalStrippedOutput = stripAnsi(combinedOutput).trim();
const exitCode = code;
const exitSignal =
signal && os.constants.signals
? (os.constants.signals[signal] ?? null)
: null;
const resultPayload: ShellExecutionResult = {
rawOutput: Buffer.from(''),
output: finalStrippedOutput,
exitCode,
signal: exitSignal,
error,
aborted: abortSignal.aborted,
pid: child.pid,
executionMethod: 'child_process',
};
if (child.pid) {
const pid = child.pid;
const event: ShellOutputEvent = {
type: 'exit',
exitCode,
signal: exitSignal,
};
const sessionId = shellExecutionConfig.sessionId ?? 'default';
const history =
ShellExecutionService.backgroundProcessHistory.get(sessionId);
const historyItem = history?.get(pid);
if (historyItem) {
historyItem.status = 'exited';
historyItem.exitCode = exitCode ?? undefined;
historyItem.signal = exitSignal ?? undefined;
historyItem.endTime = Date.now();
}
onOutputEvent(event);
// eslint-disable-next-line @typescript-eslint/no-floating-promises
ShellExecutionService.cleanupLogStream(pid).then(() => {
ShellExecutionService.activeChildProcesses.delete(pid);
});
ExecutionLifecycleService.completeWithResult(pid, resultPayload);
} else {
resolveWithoutPid?.(resultPayload);
}
};
child.stdout.on('data', (data) => handleOutput(data, 'stdout'));
child.stderr.on('data', (data) => handleOutput(data, 'stderr'));
child.on('error', (err) => {
error = err;
handleExit(1, null);
});
const abortHandler = async () => {
if (child.pid && !exited) {
await killProcessGroup({
pid: child.pid,
escalate: true,
isExited: () => exited,
});
}
};
abortSignal.addEventListener('abort', abortHandler, { once: true });
child.on('close', (code, signal) => {
handleExit(code, signal);
});
function cleanup() {
exited = true;
abortSignal.removeEventListener('abort', abortHandler);
if (stdoutDecoder) {
const remaining = stdoutDecoder.decode();
if (remaining) {
state.output += remaining;
if (isStreamingRawContent) {
const event: ShellOutputEvent = {
type: 'data',
chunk: remaining,
};
onOutputEvent(event);
if (child.pid) {
ExecutionLifecycleService.emitEvent(child.pid, event);
}
}
}
}
if (stderrDecoder) {
const remaining = stderrDecoder.decode();
if (remaining) {
state.output += remaining;
if (isStreamingRawContent) {
const event: ShellOutputEvent = {
type: 'data',
chunk: remaining,
};
onOutputEvent(event);
if (child.pid) {
ExecutionLifecycleService.emitEvent(child.pid, event);
}
}
}
}
return;
}
return { pid: child.pid, result };
} catch (e) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
const error = e as Error;
cmdCleanup?.();
return {
pid: undefined,
result: Promise.resolve({
error,
rawOutput: Buffer.from(''),
output: '',
exitCode: 1,
signal: null,
aborted: false,
pid: undefined,
executionMethod: 'none',
}),
};
}
}
/**
* Destroys a PTY process to release its file descriptors.
* This is critical to prevent system-wide PTY exhaustion (see #15945).
*/
private static destroyPtyProcess(ptyProcess: DestroyablePty): void {
try {
if (typeof ptyProcess?.destroy === 'function') {
ptyProcess.destroy();
} else if (typeof ptyProcess?.kill === 'function') {
// Fallback: if destroy() is unavailable, kill() may still close FDs
ptyProcess.kill();
}
} catch {
// Ignore errors during PTY cleanup — process may already be dead
}
}
/**
* Cleans up all resources associated with a PTY entry:
* the PTY process (file descriptors) and the headless terminal (memory buffers).
*/
private static cleanupPtyEntry(pid: number): void {
const entry = this.activePtys.get(pid);
if (!entry) return;
this.destroyPtyProcess(entry.ptyProcess);
try {
entry.headlessTerminal.dispose();
} catch {
// Ignore errors during terminal cleanup
}
this.activePtys.delete(pid);
}
private static async executeWithPty(
commandToExecute: string,
cwd: string,
onOutputEvent: (event: ShellOutputEvent) => void,
abortSignal: AbortSignal,
shellExecutionConfig: ShellExecutionConfig,
ptyInfo: PtyImplementation,
): Promise<ShellExecutionHandle> {
if (!ptyInfo) {
// This should not happen, but as a safeguard...
throw new Error('PTY implementation not found');
}
let spawnedPty: DestroyablePty | undefined;
let cmdCleanup: (() => void) | undefined;
let headlessTerminal: pkg.Terminal | undefined;
const disposables: Array<{ dispose: () => void }> = [];
try {
const cols = shellExecutionConfig.terminalWidth ?? 80;
const rows = shellExecutionConfig.terminalHeight ?? 30;
const prepared = await this.prepareExecution(
commandToExecute,
cwd,
shellExecutionConfig,
true,
true,
);
cmdCleanup = prepared.cleanup;
const {
program: finalExecutable,
args: finalArgs,
env: finalEnv,
cwd: finalCwd,
} = prepared;
const isWindowsPlatform = os.platform() === 'win32';
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const ptyProcess = ptyInfo.module.spawn(finalExecutable, finalArgs, {
cwd: finalCwd,
name: 'xterm-256color',
cols,
rows,
env: finalEnv,
// handleFlowControl intercepts XON/XOFF (Ctrl+S/Q) and prevents them
// from reaching the child. On Windows, the flag can interfere with
// ConPTY's internal input routing and cause interactive TUI tools to
// miss key events, so we disable it there.
handleFlowControl: !isWindowsPlatform,
// On Windows, explicitly request ConPTY (introduced in Windows 10 1809).
// Without this, @lydell/node-pty may silently fall back to WinPTY, which
// has known incompatibilities with interactive Node.js TUI applications
// that rely on VT-sequence-based arrow-key navigation.
...(isWindowsPlatform ? { useConpty: true } : {}),
});
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
spawnedPty = ptyProcess as DestroyablePty;
const pty = spawnedPty;
const ptyPid = Number(pty.pid);
headlessTerminal = new Terminal({
allowProposedApi: true,
cols,
rows,
scrollback: shellExecutionConfig.scrollback ?? SCROLLBACK_LIMIT,
});
headlessTerminal.scrollToTop();
const terminal = headlessTerminal;
this.activePtys.set(ptyPid, {
ptyProcess: pty,
headlessTerminal,
maxSerializedLines: shellExecutionConfig.maxSerializedLines,
command: shellExecutionConfig.originalCommand ?? commandToExecute,
sessionId: shellExecutionConfig.sessionId,
});
const result = ExecutionLifecycleService.attachExecution(ptyPid, {
executionMethod: ptyInfo?.name ?? 'node-pty',
writeInput: (input) => {
if (!ExecutionLifecycleService.isActive(ptyPid)) {
return;
}
pty.write(input);
},
kill: () => {
killProcessGroup({
pid: ptyPid,
pty,
}).catch(() => {});
},
isActive: () => {
// On Windows, process.kill(pid, 0) can return false negatives
// for ConPTY-managed shell wrappers (powershell.exe), causing
// writeToPty to silently discard input (including arrow keys).
// Check the internal activePtys map first for reliable status.
if (ShellExecutionService.activePtys.has(ptyPid)) {
return true;
}
try {
return process.kill(ptyPid, 0);
} catch {
return false;
}
},
getBackgroundOutput: () => getFullBufferText(terminal),
getSubscriptionSnapshot: () => {
const endLine = terminal.buffer.active.length;
const startLine = Math.max(
0,
endLine - (shellExecutionConfig.maxSerializedLines ?? 2000),
);
const bufferData = serializeTerminalToObject(
terminal,
startLine,
endLine,
);
return bufferData.length > 0 ? bufferData : undefined;
},
formatInjection: (output, error) =>
ShellExecutionService.formatShellBackgroundCompletion(
ptyPid,
shellExecutionConfig.backgroundCompletionBehavior || 'silent',
output,
error ?? undefined,
),
completionBehavior:
shellExecutionConfig.backgroundCompletionBehavior || 'silent',
}).result;
let processingChain = Promise.resolve();
let decoder: TextDecoder | null = null;
let output: string | AnsiOutput | null = null;
const sniffChunks: Buffer[] = [];
let binaryBytesReceived = 0;
const error: Error | null = null;
let exited = false;
let isStreamingRawContent = true;
const MAX_SNIFF_SIZE = 4096;
let sniffedBytes = 0;
let isWriting = false;
let hasStartedOutput = false;
let renderTimeout: NodeJS.Timeout | null = null;
const renderFn = () => {
renderTimeout = null;
if (!isStreamingRawContent) {
return;
}
if (!shellExecutionConfig.disableDynamicLineTrimming) {
if (!hasStartedOutput) {
const bufferText = getFullBufferText(terminal);
if (bufferText.trim().length === 0) {
return;
}
hasStartedOutput = true;
}
}
const buffer = terminal.buffer.active;
const endLine = buffer.length;
const startLine = Math.max(
0,
endLine - (shellExecutionConfig.maxSerializedLines ?? 2000),
);
let newOutput: AnsiOutput;
if (shellExecutionConfig.showColor) {
newOutput = serializeTerminalToObject(terminal, startLine, endLine);
} else {
newOutput = (
serializeTerminalToObject(terminal, startLine, endLine) || []
).map((line) =>
line.map((token) => {
token.fg = '';
token.bg = '';
return token;
}),
);
}
let lastNonEmptyLine = -1;
for (let i = newOutput.length - 1; i >= 0; i--) {
const line = newOutput[i];
if (
line
.map((segment) => segment.text)
.join('')
.trim().length > 0
) {
lastNonEmptyLine = i;
break;
}
}
const absoluteCursorY = buffer.baseY + buffer.cursorY;
const cursorRelativeIndex = absoluteCursorY - startLine;
if (cursorRelativeIndex > lastNonEmptyLine) {
lastNonEmptyLine = cursorRelativeIndex;
}
const trimmedOutput = newOutput.slice(0, lastNonEmptyLine + 1);
const finalOutput = shellExecutionConfig.disableDynamicLineTrimming
? newOutput
: trimmedOutput;
if (output !== finalOutput) {
output = finalOutput;
const event: ShellOutputEvent = {
type: 'data',
chunk: finalOutput,
};
onOutputEvent(event);
ExecutionLifecycleService.emitEvent(ptyPid, event);
}
};
const render = (finalRender = false) => {
if (finalRender) {
if (renderTimeout) {
clearTimeout(renderTimeout);
}
renderFn();
return;
}
if (renderTimeout) {
return;
}
renderTimeout = setTimeout(() => {
renderFn();
renderTimeout = null;
}, 68);
};
headlessTerminal.onScroll(() => {
if (!isWriting) {
render();
}
});
const handleOutput = (data: Buffer) => {
processingChain = processingChain.then(
() =>
new Promise<void>((resolveChunk) => {
if (!decoder) {
decoder = new TextDecoder('utf-8');
}
if (isStreamingRawContent && sniffedBytes < MAX_SNIFF_SIZE) {
sniffChunks.push(data);
} else if (!isStreamingRawContent) {
binaryBytesReceived += data.length;
}
if (isStreamingRawContent && sniffedBytes < MAX_SNIFF_SIZE) {
const sniffBuffer = Buffer.concat(sniffChunks);
sniffedBytes = sniffBuffer.length;
if (isBinary(sniffBuffer, 512, true)) {
isStreamingRawContent = false;
binaryBytesReceived = sniffBuffer.length;
const event: ShellOutputEvent = { type: 'binary_detected' };
onOutputEvent(event);
ExecutionLifecycleService.emitEvent(ptyPid, event);
}
}
if (isStreamingRawContent) {
const decodedChunk = decoder.decode(data, { stream: true });
if (decodedChunk.length === 0) {
resolveChunk();
return;
}
if (ShellExecutionService.backgroundLogPids.has(ptyPid)) {
ShellExecutionService.syncBackgroundLog(ptyPid, decodedChunk);
}
isWriting = true;
terminal.write(decodedChunk, () => {
render();
isWriting = false;
resolveChunk();
});
} else {
const totalBytes = binaryBytesReceived;
const event: ShellOutputEvent = {
type: 'binary_progress',
bytesReceived: totalBytes,
};
onOutputEvent(event);
ExecutionLifecycleService.emitEvent(ptyPid, event);
resolveChunk();
}
}),
);
};
const dataListener = pty.onData((data) => {
const bufferData = Buffer.from(data, 'utf-8');
handleOutput(bufferData);
});
disposables.push(dataListener);
const exitListener = pty.onExit(({ exitCode, signal }) => {
exited = true;
abortSignal.removeEventListener('abort', abortHandler);
// Immediately destroy the PTY to release its master FD.
// The headless terminal is kept alive until finalize() extracts
// its buffer contents, then disposed to free memory.
ShellExecutionService.destroyPtyProcess(pty);
const finalize = () => {
render(true);
cmdCleanup?.();
// Explicitly dispose of all node-pty event listeners to prevent closures from leaking
disposables.forEach((d) => {
try {
d.dispose();
} catch {
// Ignore
}
});
const event: ShellOutputEvent = {
type: 'exit',
exitCode,
signal: signal ?? null,
};
const sessionId = shellExecutionConfig.sessionId ?? 'default';
const history =
ShellExecutionService.backgroundProcessHistory.get(sessionId);
const historyItem = history?.get(ptyPid);
if (historyItem) {
historyItem.status = 'exited';
historyItem.exitCode = exitCode;
historyItem.signal = signal ?? null;
historyItem.endTime = Date.now();
}
onOutputEvent(event);
const endLine = headlessTerminal
? headlessTerminal.buffer.active.length
: 0;
const startLine = Math.max(
0,
endLine - (shellExecutionConfig.maxSerializedLines ?? 2000),
);
const ansiOutputSnapshot = headlessTerminal
? serializeTerminalToObject(headlessTerminal, startLine, endLine)
: [];
const finalOutput = headlessTerminal
? getFullBufferText(headlessTerminal)
: '';
// Dispose the headless terminal to free scrollback buffers.
// This must happen after getFullBufferText() extracts the output.
try {
headlessTerminal?.dispose();
} catch {
// Ignore errors during terminal cleanup
}
// eslint-disable-next-line @typescript-eslint/no-floating-promises
ShellExecutionService.cleanupLogStream(ptyPid).then(() => {
ShellExecutionService.activePtys.delete(ptyPid);
});
ExecutionLifecycleService.completeWithResult(ptyPid, {
rawOutput: Buffer.from(''),
output: finalOutput,
ansiOutput: ansiOutputSnapshot,
exitCode,
signal: signal ?? null,
error,
aborted: abortSignal.aborted,
pid: ptyPid,
executionMethod: ptyInfo?.name ?? 'node-pty',
});
};
if (abortSignal.aborted) {
finalize();
return;
}
const processingComplete = processingChain.then(() => 'processed');
const abortFired = new Promise<'aborted'>((res) => {
if (abortSignal.aborted) {
res('aborted');
return;
}
abortSignal.addEventListener('abort', () => res('aborted'), {
once: true,
});
});
// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.race([processingComplete, abortFired]).then(() => {
finalize();
});
});
disposables.push(exitListener);
const abortHandler = async () => {
if (ptyProcess.pid && !exited) {
await killProcessGroup({
pid: ptyPid,
escalate: true,
isExited: () => exited,
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
pty: ptyProcess,
});
}
};
abortSignal.addEventListener('abort', abortHandler, { once: true });
return { pid: ptyPid, result };
} catch (e) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
const error = e as Error;
cmdCleanup?.();
if (spawnedPty) {
ShellExecutionService.destroyPtyProcess(spawnedPty);
}
if (headlessTerminal) {
try {
headlessTerminal.dispose();
} catch {
// Ignore
}
}
// Dispose any registered event listeners to prevent leaks
disposables.forEach((d) => {
try {
d.dispose();
} catch {
// Ignore
}
});
const isPtyCreationFailure =
error?.message?.includes('posix_spawnp failed') ||
error?.message?.includes('ENXIO') ||
(isNodeError(error) && error.code === 'ENXIO') ||
error?.message?.includes('Device not configured');
if (isPtyCreationFailure) {
onOutputEvent({
type: 'data',
chunk:
'[GEMINI_CLI_WARNING] PTY execution failed, falling back to child_process. This may be due to terminal exhaustion or sandbox restrictions.\n',
});
throw e;
} else {
return {
pid: undefined,
result: Promise.resolve({
error,
rawOutput: Buffer.from(''),
output: '',
exitCode: 1,
signal: null,
aborted: false,
pid: undefined,
executionMethod: 'none',
}),
};
}
}
}
/**
* Writes a string to the pseudo-terminal (PTY) of a running process.
*
* @param pid The process ID of the target PTY.
* @param input The string to write to the terminal.
*/
static writeToPty(pid: number, input: string): void {
ExecutionLifecycleService.writeInput(pid, input);
}
static isPtyActive(pid: number): boolean {
return ExecutionLifecycleService.isActive(pid);
}
/**
* Registers a callback to be invoked when the process with the given PID exits.
* This attaches directly to the PTY's exit event.
*
* @param pid The process ID to watch.
* @param callback The function to call on exit.
* @returns An unsubscribe function.
*/
static onExit(
pid: number,
callback: (exitCode: number, signal?: number) => void,
): () => void {
return ExecutionLifecycleService.onExit(pid, callback);
}
/**
* Kills a process by its PID.
*
* @param pid The process ID to kill.
*/
static async kill(pid: number): Promise<void> {
await this.cleanupLogStream(pid);
this.activeChildProcesses.delete(pid);
ExecutionLifecycleService.kill(pid);
this.cleanupPtyEntry(pid);
}
/**
* Moves a running shell command to the background.
* This resolves the execution promise but keeps the PTY active.
*
* @param pid The process ID of the target PTY.
*/
static background(pid: number, sessionId?: string, command?: string): void {
const activePty = this.activePtys.get(pid);
const activeChild = this.activeChildProcesses.get(pid);
const resolvedSessionId =
sessionId ?? activePty?.sessionId ?? activeChild?.sessionId;
const resolvedCommand =
command ??
activePty?.command ??
activeChild?.command ??
'unknown command';
if (!resolvedSessionId) {
throw new Error('Session ID is required for background operations');
}
const MAX_BACKGROUND_PROCESS_HISTORY_SIZE = 100;
const history =
this.backgroundProcessHistory.get(resolvedSessionId) ??
new Map<
number,
{
command: string;
status: 'running' | 'exited';
exitCode?: number | null;
signal?: number | null;
startTime: number;
endTime?: number;
}
>();
if (history.size >= MAX_BACKGROUND_PROCESS_HISTORY_SIZE) {
const oldestPid = history.keys().next().value;
if (oldestPid !== undefined) {
history.delete(oldestPid);
}
}
history.set(pid, {
command: resolvedCommand,
status: 'running',
startTime: Date.now(),
});
this.backgroundProcessHistory.set(resolvedSessionId, history);
// Set up background logging
const logPath = this.getLogFilePath(pid);
const logDir = this.getLogDir();
try {
mkdirSync(logDir, { recursive: true, mode: 0o700 });
const stream = fs.createWriteStream(logPath, { flags: 'wx' });
stream.on('error', (err) => {
debugLogger.warn('Background log stream error:', err);
});
this.backgroundLogStreams.set(pid, stream);
if (activePty) {
writeBufferToLogStream(activePty.headlessTerminal, stream, 0);
} else if (activeChild) {
const output = activeChild.state.output;
if (output) {
stream.write(stripAnsi(output) + '\n');
}
}
} catch (e) {
debugLogger.warn('Failed to setup background logging:', e);
}
this.backgroundLogPids.add(pid);
ExecutionLifecycleService.background(pid);
}
static subscribe(
pid: number,
listener: (event: ShellOutputEvent) => void,
): () => void {
return ExecutionLifecycleService.subscribe(pid, listener);
}
/**
* Resizes the pseudo-terminal (PTY) of a running process.
*
* @param pid The process ID of the target PTY.
* @param cols The new number of columns.
* @param rows The new number of rows.
*/
static resizePty(pid: number, cols: number, rows: number): void {
if (!this.isPtyActive(pid)) {
return;
}
const activePty = this.activePtys.get(pid);
if (!activePty) {
return;
}
// Skip Windows: process.kill(pid, 0) is heavy and native errors are catchable there.
if (process.platform !== 'win32') {
try {
process.kill(pid, 0);
} catch (e) {
// Bail only if the process is explicitly confirmed dead (ESRCH).
if (isNodeError(e) && e.code === 'ESRCH') {
return;
}
}
}
try {
activePty.ptyProcess.resize(cols, rows);
activePty.headlessTerminal.resize(cols, rows);
} catch (e) {
// Ignore errors if the pty has already exited, which can happen
// due to a race condition between the exit event and this call.
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
const err = e as { code?: string; message?: string };
const isEsrch = err.code === 'ESRCH';
const isEbadf = err.code === 'EBADF' || err.message?.includes('EBADF');
const isWindowsPtyError = err.message?.includes(
'Cannot resize a pty that has already exited',
);
if (isEsrch || isEbadf || isWindowsPtyError) {
// On Unix, we get an ESRCH or EBADF error.
// On Windows, we get a message-based error.
// In both cases, it's safe to ignore.
} else {
throw e;
}
}
// Force emit the new state after resize
if (activePty) {
const endLine = activePty.headlessTerminal.buffer.active.length;
const startLine = Math.max(
0,
endLine - (activePty.maxSerializedLines ?? 2000),
);
const bufferData = serializeTerminalToObject(
activePty.headlessTerminal,
startLine,
endLine,
);
const event: ShellOutputEvent = { type: 'data', chunk: bufferData };
ExecutionLifecycleService.emitEvent(pid, event);
}
}
/**
* Scrolls the pseudo-terminal (PTY) of a running process.
*
* @param pid The process ID of the target PTY.
* @param lines The number of lines to scroll.
*/
static scrollPty(pid: number, lines: number): void {
if (!this.isPtyActive(pid)) {
return;
}
const activePty = this.activePtys.get(pid);
if (activePty) {
try {
activePty.headlessTerminal.scrollLines(lines);
if (activePty.headlessTerminal.buffer.active.viewportY < 0) {
activePty.headlessTerminal.scrollToTop();
}
} catch (e) {
// Ignore errors if the pty has already exited, which can happen
// due to a race condition between the exit event and this call.
if (e instanceof Error && 'code' in e && e.code === 'ESRCH') {
// ignore
} else {
throw e;
}
}
}
}
static listBackgroundProcesses(sessionId: string): BackgroundProcess[] {
if (!sessionId) {
throw new Error('Session ID is required');
}
const history = this.backgroundProcessHistory.get(sessionId);
if (!history) return [];
return Array.from(history.entries()).map(([pid, info]) => ({
pid,
command: info.command,
status: info.status,
exitCode: info.exitCode,
signal: info.signal,
}));
}
/**
* Resets the internal state of the ShellExecutionService.
* This is intended for use in tests to ensure isolation.
*/
static resetForTest(): void {
this.activePtys.clear();
this.activeChildProcesses.clear();
this.backgroundLogPids.clear();
this.backgroundLogStreams.clear();
this.backgroundProcessHistory.clear();
}
}
|