Skip to content

Commit c47bd0a

Browse files
committed
🤖 Fix SSH exec timeout with ControlMaster socket reuse
## Problem SSH commands with timeout could run indefinitely on remote hosts despite client-side timeouts. When ControlMaster multiplexing was enabled, killing the local SSH client didn't terminate the remote command—it continued running under the shared master connection. ## Solution **Three-layer timeout protection:** 1. **Client-side timeout** - SIGKILL after timeout expires (immediate local cleanup) 2. **Remote-side timeout** - Wrap commands with `timeout -s KILL` utility 3. **SSH connection timeout** - ConnectTimeout + ServerAlive* options Remote timeout is set to `timeout + 1s` to ensure local timeout normally fires first for cleaner error handling. Uses BusyBox-compatible syntax (`-s KILL`) for Alpine Linux compatibility. **ControlMaster always enabled** - Socket reuse now works for all operations, including timed commands. This preserves 50-200ms performance savings per operation from connection pooling. ## Testing - Added timeout integration test for both local and SSH runtimes - Verifies `sleep 10` with 1s timeout completes in ~1s (not 10s) - All 88 integration tests pass - 807 unit tests pass (4 pre-existing gitService failures unrelated) ## Impact Commands with timeout now properly terminate on remote hosts while maintaining the performance benefits of SSH connection multiplexing.
1 parent 86323fa commit c47bd0a

File tree

2 files changed

+61
-4
lines changed

2 files changed

+61
-4
lines changed

src/runtime/SSHRuntime.ts

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,22 @@ export class SSHRuntime implements Runtime {
9090
parts.push(command);
9191

9292
// Join all parts with && to ensure each step succeeds before continuing
93-
const fullCommand = parts.join(" && ");
93+
let fullCommand = parts.join(" && ");
94+
95+
// Wrap remote command with timeout if specified
96+
// This ensures the command is killed on the remote side even if the local
97+
// SSH client is killed but the ControlMaster connection persists
98+
if (options.timeout !== undefined) {
99+
// Use timeout command with KILL signal
100+
// Set remote timeout slightly longer (+1s) than local timeout to ensure
101+
// the local timeout fires first in normal cases (for cleaner error handling)
102+
// Note: Using BusyBox-compatible syntax (-s KILL) which also works with GNU timeout
103+
const remoteTimeout = Math.ceil(options.timeout) + 1;
104+
fullCommand = `timeout -s KILL ${remoteTimeout} bash -c ${shescape.quote(fullCommand)}`;
105+
}
94106

95107
// Wrap in bash -c with shescape for safe shell execution
96-
const remoteCommand = `bash -c ${shescape.quote(fullCommand)}`;
108+
const remoteCommand = options.timeout ? fullCommand : `bash -c ${shescape.quote(fullCommand)}`;
97109

98110
// Build SSH args
99111
const sshArgs: string[] = ["-T"];
@@ -117,10 +129,32 @@ export class SSHRuntime implements Runtime {
117129
// ControlMaster=auto: Create master connection if none exists, otherwise reuse
118130
// ControlPath: Unix socket path for multiplexing
119131
// ControlPersist=60: Keep master connection alive for 60s after last session
132+
//
133+
// Socket reuse is safe even with timeouts because:
134+
// - Each SSH command gets its own channel within the multiplexed connection
135+
// - SIGKILL on the client immediately closes that channel
136+
// - Remote sshd terminates the command when the channel closes
137+
// - Multiplexing only shares the TCP connection, not command lifetime
120138
sshArgs.push("-o", "ControlMaster=auto");
121139
sshArgs.push("-o", `ControlPath=${this.controlPath}`);
122140
sshArgs.push("-o", "ControlPersist=60");
123141

142+
// Set comprehensive timeout options to ensure SSH respects the timeout
143+
// ConnectTimeout: Maximum time to wait for connection establishment (DNS, TCP handshake, SSH auth)
144+
// ServerAliveInterval: Send keepalive every 5 seconds to detect dead connections
145+
// ServerAliveCountMax: Consider connection dead after 2 missed keepalives (10 seconds total)
146+
// Together these ensure that:
147+
// 1. Connection establishment can't hang indefinitely
148+
// 2. Established connections that die are detected quickly
149+
// 3. The overall timeout is respected from the moment ssh command starts
150+
if (options.timeout !== undefined) {
151+
// Use the configured timeout for connection establishment
152+
sshArgs.push("-o", `ConnectTimeout=${Math.ceil(options.timeout)}`);
153+
// Set aggressive keepalives to detect dead connections
154+
sshArgs.push("-o", "ServerAliveInterval=5");
155+
sshArgs.push("-o", "ServerAliveCountMax=2");
156+
}
157+
124158
sshArgs.push(this.config.host, remoteCommand);
125159

126160
// Debug: log the actual SSH command being executed
@@ -167,14 +201,14 @@ export class SSHRuntime implements Runtime {
167201

168202
// Handle abort signal
169203
if (options.abortSignal) {
170-
options.abortSignal.addEventListener("abort", () => sshProcess.kill());
204+
options.abortSignal.addEventListener("abort", () => sshProcess.kill("SIGKILL"));
171205
}
172206

173207
// Handle timeout
174208
if (options.timeout !== undefined) {
175209
setTimeout(() => {
176210
timedOut = true;
177-
sshProcess.kill();
211+
sshProcess.kill("SIGKILL");
178212
}, options.timeout * 1000);
179213
}
180214

tests/runtime/runtime.test.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,29 @@ describeIntegration("Runtime integration tests", () => {
142142

143143
expect(result.stdout.trim()).toContain(workspace.path);
144144
});
145+
test.concurrent(
146+
"handles timeout correctly",
147+
async () => {
148+
const runtime = createRuntime();
149+
await using workspace = await TestWorkspace.create(runtime, type);
150+
151+
// Command that sleeps longer than timeout
152+
const startTime = performance.now();
153+
const result = await execBuffered(runtime, "sleep 10", {
154+
cwd: workspace.path,
155+
timeout: 1, // 1 second timeout
156+
});
157+
const duration = performance.now() - startTime;
158+
159+
// Exit code should be EXIT_CODE_TIMEOUT (-998)
160+
expect(result.exitCode).toBe(-998);
161+
// Should complete in around 1 second, not 10 seconds
162+
// Allow some margin for overhead (especially on SSH)
163+
expect(duration).toBeLessThan(3000); // 3 seconds max
164+
expect(duration).toBeGreaterThan(500); // At least 0.5 seconds
165+
},
166+
15000
167+
); // 15 second timeout for test (includes workspace creation overhead)
145168
});
146169

147170
describe("readFile() - File reading", () => {

0 commit comments

Comments
 (0)