@botbuddy/cli 1.59.3 → 1.59.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/commands.mjs +81 -0
- package/src/run.mjs +295 -32
- package/src/test-lane.mjs +16 -5
package/package.json
CHANGED
package/src/commands.mjs
CHANGED
|
@@ -212,6 +212,8 @@ ${bold("MCP CONFIG KEY")}
|
|
|
212
212
|
${bold("TOOLS")}
|
|
213
213
|
help --tools List every BotBuddy tool
|
|
214
214
|
help <tool> Show one tool's arguments
|
|
215
|
+
help test Safe test-lane launch and recovery guidance
|
|
216
|
+
help symptom <name> Diagnose a known block without source-diving
|
|
215
217
|
call <tool> [--key value] Invoke any tool
|
|
216
218
|
call <tool> --json '{...}' Invoke with a JSON arguments object
|
|
217
219
|
call <tool> --pin <slug> Pin the connection tenant (a user token needs one;
|
|
@@ -362,6 +364,11 @@ async function cmdCall(args) {
|
|
|
362
364
|
}
|
|
363
365
|
|
|
364
366
|
async function cmdToolHelp(args) {
|
|
367
|
+
const local = recoveryHelp(args);
|
|
368
|
+
if (local) {
|
|
369
|
+
console.log(local);
|
|
370
|
+
return;
|
|
371
|
+
}
|
|
365
372
|
// `help --tools` (or `help --all`) lists the catalog; `help <tool>` details one.
|
|
366
373
|
const tool = args[0].startsWith("-") ? null : args[0];
|
|
367
374
|
const res = await fetch(discoveryUrlFor(SERVER_URL, tool));
|
|
@@ -373,6 +380,80 @@ async function cmdToolHelp(args) {
|
|
|
373
380
|
console.log(formatDiscovery(await res.json(), { tool }));
|
|
374
381
|
}
|
|
375
382
|
|
|
383
|
+
// Keep the most common lifecycle recoveries local: an agent must be able to
|
|
384
|
+
// discover the safe next action even when the MCP discovery endpoint is down.
|
|
385
|
+
// This deliberately names only stable, already-shipped commands. New lifecycle
|
|
386
|
+
// commands belong in their owning feature ticket before they are documented here.
|
|
387
|
+
export function recoveryHelp(args) {
|
|
388
|
+
const topic = args.map((arg) => String(arg).trim().toLowerCase()).filter(Boolean).join(" ");
|
|
389
|
+
if (topic === "test") return `${bold("bb help test")} — launch tests without losing their evidence
|
|
390
|
+
|
|
391
|
+
${bold("SAFE DEFAULT")}
|
|
392
|
+
1. Run ${cyan("bb doctor --json")} from the target worktree.
|
|
393
|
+
2. Run the repository's configured test command without manually copying a
|
|
394
|
+
session ID or session token unless the harness explicitly requires it.
|
|
395
|
+
3. Keep the command's original result and receipt path. Do not start a second
|
|
396
|
+
full suite merely because telemetry is missing.
|
|
397
|
+
|
|
398
|
+
${bold("WHEN TEST TELEMETRY IS UNAVAILABLE")}
|
|
399
|
+
Run ${cyan("bb help symptom telemetry-unavailable")}. A null test-run ID means
|
|
400
|
+
there is no semantic test-run wait to arm; it is not a passing result.
|
|
401
|
+
|
|
402
|
+
${bold("WAITING")}
|
|
403
|
+
Use ${cyan("bb wait 'test-run:id=<id>' --heartbeat")} only when the launch output
|
|
404
|
+
contains a real test-run ID. Do not replace a missing lifecycle signal with a
|
|
405
|
+
timer or status-polling loop.`;
|
|
406
|
+
|
|
407
|
+
if (topic === "symptom" || topic === "symptoms") return `${bold("bb help symptom <name>")} — supported recovery topics
|
|
408
|
+
|
|
409
|
+
${cyan("telemetry-unavailable")} A test launch has no test-run ID or wait command.
|
|
410
|
+
${cyan("command-run-stuck")} A local command receipt and remote lifecycle disagree.
|
|
411
|
+
|
|
412
|
+
Choose the symptom printed by the command. If neither applies, preserve the
|
|
413
|
+
original command result and receipt, then report the exact error and command ID.`;
|
|
414
|
+
|
|
415
|
+
if (topic === "symptom telemetry-unavailable") return `${bold("Symptom: telemetry unavailable")}
|
|
416
|
+
|
|
417
|
+
${bold("Meaning")}
|
|
418
|
+
The workload may have started, but BotBuddy did not create a test-run record.
|
|
419
|
+
There is no ${cyan("test-run:id")} wait to arm and silence is never a green result.
|
|
420
|
+
|
|
421
|
+
${bold("Safe recovery")}
|
|
422
|
+
1. Do not launch another full suite yet.
|
|
423
|
+
2. Preserve the original ${cyan("command_run_id")} and receipt path from its output.
|
|
424
|
+
3. Read the terminal receipt when the original runner returns. A receipt with a
|
|
425
|
+
terminal status is evidence of that workload's result.
|
|
426
|
+
4. If the receipt is not terminal, keep the original runner result pending;
|
|
427
|
+
do not poll it or use a timer as a completion signal.
|
|
428
|
+
5. After a terminal receipt, fix the launch/authentication cause and rerun the
|
|
429
|
+
smallest affected scope once, with an explicit rerun reason when supported.
|
|
430
|
+
|
|
431
|
+
${bold("Escalation payload")}
|
|
432
|
+
Include CLI version, exact command (with secrets removed), command-run ID,
|
|
433
|
+
receipt status/exit code, and whether a test-run ID was created.`;
|
|
434
|
+
|
|
435
|
+
if (topic === "symptom command-run-stuck") return `${bold("Symptom: command run appears stuck")}
|
|
436
|
+
|
|
437
|
+
${bold("Meaning")}
|
|
438
|
+
A remote lifecycle record can lag or fail to receive a terminal callback. It
|
|
439
|
+
does not prove that the workload is still running.
|
|
440
|
+
|
|
441
|
+
${bold("Safe recovery")}
|
|
442
|
+
1. Preserve the command-run ID and the original result.
|
|
443
|
+
2. Prefer the owning runner's local terminal receipt for the workload verdict.
|
|
444
|
+
3. If the receipt is terminal, do not cancel or duplicate the command solely
|
|
445
|
+
because remote state remains ${cyan("registered")} or ${cyan("running")}.
|
|
446
|
+
4. If the receipt is absent/non-terminal, retain the original runner result;
|
|
447
|
+
do not poll or infer completion from elapsed time.
|
|
448
|
+
5. Report the receipt and remote discrepancy as telemetry evidence.
|
|
449
|
+
|
|
450
|
+
${bold("Boundary")}
|
|
451
|
+
Command-run status is agent-owned. A different agent may be denied access; that
|
|
452
|
+
denial is not evidence that the run is missing or terminal.`;
|
|
453
|
+
|
|
454
|
+
return null;
|
|
455
|
+
}
|
|
456
|
+
|
|
376
457
|
// BOT-1566 C1: a tenant slug as the server accepts it on `?tenant=` — lowercase
|
|
377
458
|
// alphanumerics and hyphens, 2–63 chars, not starting with a hyphen.
|
|
378
459
|
export const TENANT_SLUG_RE = /^[a-z0-9][a-z0-9-]{1,62}$/;
|
package/src/run.mjs
CHANGED
|
@@ -215,6 +215,66 @@ export function commandHash(command) { return createHash("sha256").update(JSON.s
|
|
|
215
215
|
export function environmentHash(cwd, environment) { return createHash("sha256").update(`${cwd}\0${environment}`).digest("hex"); }
|
|
216
216
|
export function receiptPath(runId) { return join(homedir(), ".botbuddy", "command-runs", `${runId}.receipt.json`); }
|
|
217
217
|
export function contextPath(runId) { return join(homedir(), ".botbuddy", "command-runs", `${runId}.context.json`); }
|
|
218
|
+
function cancellationPath(contextFile) { return `${contextFile}.cancelled`; }
|
|
219
|
+
|
|
220
|
+
async function markCancellation(contextFile, runId) {
|
|
221
|
+
try {
|
|
222
|
+
await writeFile(cancellationPath(contextFile), JSON.stringify({ run_id: runId, reason: "cancelled_before_workload_start", requested_at: new Date().toISOString() }), { mode: 0o600, flag: "wx" });
|
|
223
|
+
return true;
|
|
224
|
+
} catch (error) {
|
|
225
|
+
if (error?.code === "EEXIST") return false;
|
|
226
|
+
throw error;
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
async function hasCancellationMarker(contextFile) {
|
|
231
|
+
try { await readFile(cancellationPath(contextFile), "utf8"); return true; } catch (error) {
|
|
232
|
+
if (error?.code === "ENOENT") return false;
|
|
233
|
+
throw error;
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
async function preWorkloadCancellationReceipt(context) {
|
|
238
|
+
const now = new Date().toISOString();
|
|
239
|
+
const receipt = {
|
|
240
|
+
schema_version: RUN_SCHEMA_VERSION,
|
|
241
|
+
run_id: context.run_id,
|
|
242
|
+
status: "cancelled",
|
|
243
|
+
started_at: now,
|
|
244
|
+
ended_at: now,
|
|
245
|
+
exit_code: null,
|
|
246
|
+
signal: "SIGTERM",
|
|
247
|
+
recovery_command: null,
|
|
248
|
+
bounded_log: "",
|
|
249
|
+
output_characters: 0,
|
|
250
|
+
reason: "cancelled_before_workload_start",
|
|
251
|
+
};
|
|
252
|
+
await writeJson(context.receipt_path, receipt);
|
|
253
|
+
return receipt;
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
async function retryCancellationHandoff(context, call, { sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)) } = {}) {
|
|
257
|
+
let attempts = 0;
|
|
258
|
+
let delay = 1_000;
|
|
259
|
+
for (;;) {
|
|
260
|
+
let result;
|
|
261
|
+
try {
|
|
262
|
+
result = await call("cancel_command_run", {
|
|
263
|
+
run_id: context.run_id,
|
|
264
|
+
run_credential: context.run_credential,
|
|
265
|
+
reason: "cancelled_before_workload_start",
|
|
266
|
+
});
|
|
267
|
+
} catch (error) { result = { ok: false, error: error instanceof Error ? error.message : String(error) }; }
|
|
268
|
+
if (result?.ok && !result.isError && result.data?.status === "cancelled") return result;
|
|
269
|
+
attempts += 1;
|
|
270
|
+
await writeJson(context.context_path, {
|
|
271
|
+
...context,
|
|
272
|
+
cancellation_handoff: { attempts, last_error: result?.error ?? result?.data?.error ?? "cancellation_handoff_rejected", next_retry_at: new Date(Date.now() + delay).toISOString() },
|
|
273
|
+
});
|
|
274
|
+
await sleep(delay);
|
|
275
|
+
delay = Math.min(delay * 2, 60_000);
|
|
276
|
+
}
|
|
277
|
+
}
|
|
218
278
|
|
|
219
279
|
async function writeJson(path, value) {
|
|
220
280
|
await mkdir(dirname(path), { recursive: true });
|
|
@@ -222,7 +282,7 @@ async function writeJson(path, value) {
|
|
|
222
282
|
// file, or a poller) never observes a torn/empty file mid-write. rename(2)
|
|
223
283
|
// is atomic within a directory, so readers see either the old or the new
|
|
224
284
|
// complete JSON, never a partial one.
|
|
225
|
-
const tmp = `${path}.${process.pid}.tmp`;
|
|
285
|
+
const tmp = `${path}.${process.pid}.${randomUUID()}.tmp`;
|
|
226
286
|
await writeFile(tmp, JSON.stringify(value), { mode: 0o600 });
|
|
227
287
|
await chmod(tmp, 0o600);
|
|
228
288
|
await rename(tmp, path);
|
|
@@ -340,7 +400,12 @@ export async function launchRun(argv, {
|
|
|
340
400
|
}
|
|
341
401
|
const context = contextPath(runId);
|
|
342
402
|
const receipt = receiptPath(runId);
|
|
343
|
-
|
|
403
|
+
// The detached worker has no ambient credential after its launcher exits.
|
|
404
|
+
// Seal the already-resolved owning session in the private (0600) context so
|
|
405
|
+
// every callback is attributable to the same agent. It deliberately stays
|
|
406
|
+
// outside child_env, receipts, and the workload's process environment.
|
|
407
|
+
const knownSession = opts.sessionId ?? managedCredential?.identity?.sessionId ?? managedCredential?.sessionId;
|
|
408
|
+
await writeJson(context, { schema_version: RUN_SCHEMA_VERSION, context_path: context, run_id: runId, run_credential: registration.data.run_credential, receipt_upload: registration.data.receipt_upload, command, cwd, timeout_seconds: opts.timeout, receipt_path: receipt, launched_at: new Date().toISOString(), ...(opts.sessionToken ? { callback_session_token: opts.sessionToken } : {}), ...(knownSession ? { callback_session_id: knownSession } : {}), ...(childEnv && Object.keys(childEnv).length ? { child_env: childEnv } : {}), ...(testRun ? { test_run: testRun } : {}) });
|
|
344
409
|
const [file, args] = workerInvocation(context);
|
|
345
410
|
try {
|
|
346
411
|
const worker = spawnImpl(file, args, { detached: true, stdio: "ignore", windowsHide: true });
|
|
@@ -351,25 +416,85 @@ export async function launchRun(argv, {
|
|
|
351
416
|
await effectiveCall("update_command_run", { run_id: runId, run_credential: registration.data.run_credential, status: "owner_lost", invalidated_reason: `launcher_failed:${error instanceof Error ? error.message : String(error)}` });
|
|
352
417
|
return { exitCode: EXIT.INTERNAL, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "owner_lost", run_id: runId, exit_code: EXIT.INTERNAL } };
|
|
353
418
|
}
|
|
354
|
-
const knownSession = opts.sessionId ?? managedCredential?.identity?.sessionId ?? managedCredential?.sessionId;
|
|
355
419
|
return { exitCode: EXIT.OK, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "launched", run_id: runId,
|
|
356
420
|
...(knownSession ? { session_id: knownSession } : { session_binding: "server_derived" }),
|
|
357
421
|
durable_owner: "detached_worker", receipt_path: receipt, reentry: "update_command_run publishes the terminal callback for this run_id", exit_code: EXIT.OK } };
|
|
358
422
|
}
|
|
359
423
|
|
|
360
|
-
export async function runWorker(contextFile, {
|
|
424
|
+
export async function runWorker(contextFile, {
|
|
425
|
+
spawnImpl = spawn,
|
|
426
|
+
call = callToolJson,
|
|
427
|
+
signalEmitter = process,
|
|
428
|
+
terminate = terminateProcessGroup,
|
|
429
|
+
} = {}) {
|
|
361
430
|
const context = JSON.parse(await readFile(contextFile, "utf8"));
|
|
431
|
+
const callbackCall = callWithContextIdentity(context, call);
|
|
432
|
+
const ownerHeartbeat = startOwnerHeartbeat(context, callbackCall);
|
|
362
433
|
const startedAt = new Date().toISOString();
|
|
363
434
|
let timedOut = false;
|
|
364
435
|
let child;
|
|
436
|
+
let cancellationStateWrite = Promise.resolve();
|
|
437
|
+
let contextWrite = Promise.resolve();
|
|
438
|
+
const persistWorkerContext = (state) => {
|
|
439
|
+
const next = contextWrite.then(() => writeJson(context.context_path, {
|
|
440
|
+
...context,
|
|
441
|
+
worker_pid: process.pid,
|
|
442
|
+
...state,
|
|
443
|
+
}));
|
|
444
|
+
contextWrite = next;
|
|
445
|
+
return next;
|
|
446
|
+
};
|
|
447
|
+
// `cancelRun` creates a durable marker before it acknowledges an unstarted
|
|
448
|
+
// cancellation. The worker owns its own process group, so SIGTERM is also
|
|
449
|
+
// the fence for the tiny interval after the final marker check: if spawn won
|
|
450
|
+
// that interval, the handler terminates the just-created workload instead.
|
|
451
|
+
const cancellationHandler = () => {
|
|
452
|
+
void hasCancellationMarker(context.context_path).then(async (marked) => {
|
|
453
|
+
if (!marked) {
|
|
454
|
+
// Preserve the old default SIGTERM behaviour for a signal that was not
|
|
455
|
+
// issued by `cancelRun` for this durable context.
|
|
456
|
+
signalEmitter.removeListener("SIGTERM", cancellationHandler);
|
|
457
|
+
process.kill(process.pid, "SIGTERM");
|
|
458
|
+
return;
|
|
459
|
+
}
|
|
460
|
+
if (child) {
|
|
461
|
+
terminate(child, "SIGTERM");
|
|
462
|
+
cancellationStateWrite = persistWorkerContext({ workload_pid: child.pid, worker_state: "cancelling_workload" });
|
|
463
|
+
} else {
|
|
464
|
+
cancellationStateWrite = persistWorkerContext({ worker_state: "cancelled_before_workload_start" });
|
|
465
|
+
}
|
|
466
|
+
await cancellationStateWrite;
|
|
467
|
+
}).catch(() => { /* the durable marker remains the source of truth for recovery */ });
|
|
468
|
+
};
|
|
469
|
+
signalEmitter.once("SIGTERM", cancellationHandler);
|
|
365
470
|
try {
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
471
|
+
if (await hasCancellationMarker(context.context_path)) {
|
|
472
|
+
if (!context.cancellation_handoff?.accepted) await retryCancellationHandoff(context, callbackCall);
|
|
473
|
+
if (context.test_run) {
|
|
474
|
+
const endedAt = new Date().toISOString();
|
|
475
|
+
await completeTestRun(context, { status: "cancelled", exitCode: null, signal: "SIGTERM", startedAt: context.launched_at ?? endedAt, endedAt, call: callbackCall });
|
|
476
|
+
}
|
|
477
|
+
return await preWorkloadCancellationReceipt(context);
|
|
478
|
+
}
|
|
479
|
+
// Publish worker ownership before the first workload spawn. Cancellation
|
|
480
|
+
// can now signal this private process group instead of terminalizing the
|
|
481
|
+
// server run while a local worker still has authority to start work.
|
|
482
|
+
await persistWorkerContext({ worker_state: "starting" });
|
|
483
|
+
if (await hasCancellationMarker(context.context_path)) {
|
|
484
|
+
if (!context.cancellation_handoff?.accepted) await retryCancellationHandoff(context, callbackCall);
|
|
485
|
+
if (context.test_run) {
|
|
486
|
+
const endedAt = new Date().toISOString();
|
|
487
|
+
await completeTestRun(context, { status: "cancelled", exitCode: null, signal: "SIGTERM", startedAt: context.launched_at ?? endedAt, endedAt, call: callbackCall });
|
|
488
|
+
}
|
|
489
|
+
return await preWorkloadCancellationReceipt(context);
|
|
490
|
+
}
|
|
491
|
+
try {
|
|
492
|
+
child = spawnImpl(context.command[0], context.command.slice(1), { cwd: context.cwd, detached: true, stdio: ["ignore", "pipe", "pipe"], windowsHide: true, ...(context.child_env ? { env: { ...process.env, ...context.child_env } } : {}) });
|
|
493
|
+
} catch (error) {
|
|
494
|
+
const endedAt = new Date().toISOString();
|
|
495
|
+
const receipt = await finalize(context, { status: "owner_lost", startedAt, endedAt, exitCode: null, signal: null, reason: `workload_spawn_failed:${error instanceof Error ? error.message : String(error)}` }, callbackCall);
|
|
496
|
+
return receipt;
|
|
497
|
+
}
|
|
373
498
|
// A failed spawn can report through the child `error` event on the next turn.
|
|
374
499
|
// Subscribe before any filesystem I/O so a busy parallel test run (or a real
|
|
375
500
|
// fast failure) cannot lose the sole terminal event.
|
|
@@ -381,32 +506,57 @@ export async function runWorker(contextFile, { spawnImpl = spawn, call = callToo
|
|
|
381
506
|
const capture = boundedCapture();
|
|
382
507
|
child.stdout?.on("data", (chunk) => capture.append(chunk));
|
|
383
508
|
child.stderr?.on("data", (chunk) => capture.append(chunk));
|
|
384
|
-
|
|
509
|
+
await persistWorkerContext({ workload_pid: child.pid, worker_state: "running" });
|
|
385
510
|
// BOT-1510: for a test lane, tail the reporter's NDJSON and flush per-case
|
|
386
511
|
// verdicts while the child runs. The test process never touches the network.
|
|
387
|
-
const lane = context.test_run ? startLaneFlusher(context,
|
|
512
|
+
const lane = context.test_run ? startLaneFlusher(context, callbackCall) : null;
|
|
388
513
|
let killTimer;
|
|
389
514
|
const timer = setTimeout(() => {
|
|
390
515
|
timedOut = true;
|
|
391
|
-
|
|
392
|
-
killTimer = setTimeout(() =>
|
|
516
|
+
terminate(child, "SIGTERM");
|
|
517
|
+
killTimer = setTimeout(() => terminate(child, "SIGKILL"), context.timeout_grace_ms ?? TIMEOUT_GRACE_MS);
|
|
393
518
|
}, context.timeout_seconds * 1000);
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
519
|
+
const result = await completion;
|
|
520
|
+
clearTimeout(timer);
|
|
521
|
+
clearTimeout(killTimer);
|
|
522
|
+
await cancellationStateWrite;
|
|
523
|
+
if (lane) await lane.stop();
|
|
524
|
+
const endedAt = new Date().toISOString();
|
|
525
|
+
if (result.error) {
|
|
526
|
+
const receipt = await finalize(context, { status: "owner_lost", startedAt, endedAt, exitCode: null, signal: null, reason: `workload_spawn_failed:${result.error.message}`, output: capture.output, outputCharacters: capture.characters }, callbackCall);
|
|
527
|
+
return receipt;
|
|
528
|
+
}
|
|
529
|
+
const status = terminalStatus({ ...result, timedOut });
|
|
530
|
+
const receipt = await finalize(context, { status, startedAt, endedAt, exitCode: result.exitCode, signal: result.signal, output: capture.output, outputCharacters: capture.characters }, callbackCall);
|
|
402
531
|
return receipt;
|
|
532
|
+
} finally {
|
|
533
|
+
if (ownerHeartbeat) await ownerHeartbeat.stop();
|
|
534
|
+
signalEmitter.removeListener("SIGTERM", cancellationHandler);
|
|
403
535
|
}
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
//
|
|
408
|
-
|
|
409
|
-
return
|
|
536
|
+
}
|
|
537
|
+
|
|
538
|
+
function startOwnerHeartbeat(context, call, { intervalMs = 5 * 60_000, setIntervalFn = setInterval } = {}) {
|
|
539
|
+
// A detached worker must never acquire liveness through its ambient default
|
|
540
|
+
// identity. It can only refresh the bearer sealed for its owner.
|
|
541
|
+
if (typeof context.callback_session_token !== "string" || !context.callback_session_token) return null;
|
|
542
|
+
// A token-only launch intentionally omits its public session id. The server
|
|
543
|
+
// derives the exact active session from the sealed bearer, so it must still
|
|
544
|
+
// heartbeat rather than waiting for the eight-hour token window to lapse.
|
|
545
|
+
// Supplying an id when one was sealed retains the same explicit scope fence.
|
|
546
|
+
const heartbeatArgs = typeof context.callback_session_id === "string" && context.callback_session_id
|
|
547
|
+
? { session_id: context.callback_session_id } : {};
|
|
548
|
+
let stopped = false;
|
|
549
|
+
let chain = Promise.resolve();
|
|
550
|
+
const tick = () => {
|
|
551
|
+
chain = chain.then(async () => {
|
|
552
|
+
if (stopped) return;
|
|
553
|
+
try { await call("heartbeat", heartbeatArgs); } catch { /* terminal delivery retains its own retry path */ }
|
|
554
|
+
});
|
|
555
|
+
};
|
|
556
|
+
tick();
|
|
557
|
+
const timer = setIntervalFn(tick, intervalMs);
|
|
558
|
+
timer.unref?.();
|
|
559
|
+
return { async stop() { stopped = true; clearInterval(timer); await chain; } };
|
|
410
560
|
}
|
|
411
561
|
|
|
412
562
|
// Periodic lane flusher: reduce the NDJSON events file to the current case state
|
|
@@ -496,6 +646,30 @@ function terminateProcessGroup(child, signal) {
|
|
|
496
646
|
try { child.kill?.(signal); } catch { /* already exited */ }
|
|
497
647
|
}
|
|
498
648
|
|
|
649
|
+
function workerProcessGroupAlive(pid) {
|
|
650
|
+
if (!Number.isInteger(pid) || pid <= 0 || process.platform === "win32") return false;
|
|
651
|
+
try { process.kill(-pid, 0); return true; } catch (error) { return error?.code !== "ESRCH"; }
|
|
652
|
+
}
|
|
653
|
+
|
|
654
|
+
async function waitForWorkerCancellation(contextFile, { sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)), attempts = 25 } = {}) {
|
|
655
|
+
let latest = null;
|
|
656
|
+
for (let attempt = 0; attempt < attempts; attempt++) {
|
|
657
|
+
try { latest = JSON.parse(await readFile(contextFile, "utf8")); } catch { /* the context is atomically replaced */ }
|
|
658
|
+
if (Number.isInteger(latest?.workload_pid) || latest?.worker_state === "cancelled_before_workload_start") return latest;
|
|
659
|
+
await sleep(20);
|
|
660
|
+
}
|
|
661
|
+
return latest;
|
|
662
|
+
}
|
|
663
|
+
|
|
664
|
+
async function sealedTerminalStatus(context) {
|
|
665
|
+
if (typeof context.terminal_update?.status === "string") return context.terminal_update.status;
|
|
666
|
+
if (!context.receipt_path) return null;
|
|
667
|
+
try {
|
|
668
|
+
const receipt = JSON.parse(await readFile(context.receipt_path, "utf8"));
|
|
669
|
+
return receipt?.run_id === context.run_id && typeof receipt.status === "string" ? receipt.status : null;
|
|
670
|
+
} catch { return null; }
|
|
671
|
+
}
|
|
672
|
+
|
|
499
673
|
function forwardTerminationSignals(child, signalEmitter) {
|
|
500
674
|
let signal = null;
|
|
501
675
|
let escalation = null;
|
|
@@ -525,15 +699,87 @@ function waitForChild(child) {
|
|
|
525
699
|
});
|
|
526
700
|
}
|
|
527
701
|
|
|
528
|
-
export async function cancelRun(runId, {
|
|
702
|
+
export async function cancelRun(runId, {
|
|
703
|
+
call = callToolJson,
|
|
704
|
+
waitForCancellation = waitForWorkerCancellation,
|
|
705
|
+
killWorker = (pid) => process.kill(-pid, "SIGTERM"),
|
|
706
|
+
workerAlive = workerProcessGroupAlive,
|
|
707
|
+
} = {}) {
|
|
529
708
|
const context = JSON.parse(await readFile(contextPath(runId), "utf8"));
|
|
709
|
+
const callbackCall = callWithContextIdentity(context, call);
|
|
710
|
+
const sealedStatus = await sealedTerminalStatus(context);
|
|
711
|
+
if (sealedStatus) {
|
|
712
|
+
return { exitCode: EXIT.OK, receipt: {
|
|
713
|
+
schema_version: RUN_SCHEMA_VERSION,
|
|
714
|
+
outcome: "terminal_delivery_pending",
|
|
715
|
+
run_id: runId,
|
|
716
|
+
terminal_status: sealedStatus,
|
|
717
|
+
exit_code: EXIT.OK,
|
|
718
|
+
} };
|
|
719
|
+
}
|
|
720
|
+
const requestCancellation = async () => {
|
|
721
|
+
// No worker remains to publish the linked test-run terminal event. Complete
|
|
722
|
+
// it before revoking the one-run credential so an armed `test-run:` wait
|
|
723
|
+
// cannot be stranded active after the command cancellation is accepted.
|
|
724
|
+
if (context.test_run) {
|
|
725
|
+
const endedAt = new Date().toISOString();
|
|
726
|
+
await completeTestRun(context, {
|
|
727
|
+
status: "cancelled",
|
|
728
|
+
exitCode: null,
|
|
729
|
+
signal: "SIGTERM",
|
|
730
|
+
startedAt: context.launched_at ?? endedAt,
|
|
731
|
+
endedAt,
|
|
732
|
+
call: callbackCall,
|
|
733
|
+
});
|
|
734
|
+
}
|
|
735
|
+
let cancellation;
|
|
736
|
+
try {
|
|
737
|
+
cancellation = await callbackCall("cancel_command_run", {
|
|
738
|
+
run_id: context.run_id,
|
|
739
|
+
run_credential: context.run_credential,
|
|
740
|
+
reason: "cancelled_before_workload_start",
|
|
741
|
+
});
|
|
742
|
+
} catch (error) {
|
|
743
|
+
cancellation = { ok: false, error: error instanceof Error ? error.message : String(error) };
|
|
744
|
+
}
|
|
745
|
+
if (cancellation?.ok && !cancellation.isError && cancellation.data?.status === "cancelled") {
|
|
746
|
+
await writeJson(context.context_path ?? contextPath(runId), { ...context, cancellation_handoff: { accepted: true, accepted_at: new Date().toISOString() } });
|
|
747
|
+
return { exitCode: EXIT.OK, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "cancellation_requested", run_id: runId, exit_code: EXIT.OK } };
|
|
748
|
+
}
|
|
749
|
+
return { exitCode: EXIT.BACKEND, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "rejected", run_id: runId, error: cancellation?.error ?? cancellation?.data?.error ?? "cancellation_handoff_failed", exit_code: EXIT.BACKEND } };
|
|
750
|
+
};
|
|
530
751
|
if (!Number.isInteger(context.workload_pid) || context.workload_pid <= 0) {
|
|
531
|
-
|
|
752
|
+
// The marker is durable and checked twice by the worker. It must exist
|
|
753
|
+
// before the terminal API transition so a launcher-returned worker cannot
|
|
754
|
+
// begin executing after cancellation has been acknowledged.
|
|
755
|
+
const contextFile = context.context_path ?? contextPath(runId);
|
|
756
|
+
try {
|
|
757
|
+
await markCancellation(contextFile, context.run_id);
|
|
758
|
+
} catch (error) {
|
|
759
|
+
return { exitCode: EXIT.INTERNAL, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "rejected", run_id: runId, error: `cancellation_fence_failed:${error instanceof Error ? error.message : String(error)}`, exit_code: EXIT.INTERNAL } };
|
|
760
|
+
}
|
|
761
|
+
if (Number.isInteger(context.worker_pid) && context.worker_pid > 0) {
|
|
762
|
+
// A live worker may have claimed the interval after launcher handoff.
|
|
763
|
+
// Fence it first; its SIGTERM handler either records a no-workload
|
|
764
|
+
// acknowledgement (safe for cancel_command_run) or terminates the
|
|
765
|
+
// workload and keeps ownership of the final update_command_run callback.
|
|
766
|
+
try { killWorker(context.worker_pid); } catch (error) {
|
|
767
|
+
if (error?.code !== "ESRCH") return { exitCode: EXIT.INTERNAL, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "rejected", run_id: runId, error: `cancellation_worker_fence_failed:${error instanceof Error ? error.message : String(error)}`, exit_code: EXIT.INTERNAL } };
|
|
768
|
+
}
|
|
769
|
+
const fenced = await waitForCancellation(contextFile);
|
|
770
|
+
if (Number.isInteger(fenced?.workload_pid) && fenced.workload_pid > 0) {
|
|
771
|
+
terminateProcessGroup({ pid: fenced.workload_pid }, "SIGTERM");
|
|
772
|
+
return { exitCode: EXIT.OK, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "cancellation_requested", run_id: runId, exit_code: EXIT.OK } };
|
|
773
|
+
}
|
|
774
|
+
if (fenced?.worker_state === "cancelled_before_workload_start" || !workerAlive(context.worker_pid)) return requestCancellation();
|
|
775
|
+
return { exitCode: EXIT.BACKEND, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "rejected", run_id: runId, error: "cancellation_worker_fence_unconfirmed", exit_code: EXIT.BACKEND } };
|
|
776
|
+
}
|
|
777
|
+
return requestCancellation();
|
|
532
778
|
}
|
|
533
779
|
try {
|
|
534
780
|
process.kill(-context.workload_pid, "SIGTERM");
|
|
535
781
|
} catch (error) {
|
|
536
|
-
await
|
|
782
|
+
await callbackCall("update_command_run", { run_id: context.run_id, run_credential: context.run_credential, status: "owner_lost", invalidated_reason: `cancel_owner_unreachable:${error instanceof Error ? error.message : String(error)}` });
|
|
537
783
|
return { exitCode: EXIT.INTERNAL, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "owner_lost", run_id: runId, exit_code: EXIT.INTERNAL } };
|
|
538
784
|
}
|
|
539
785
|
return { exitCode: EXIT.OK, receipt: { schema_version: RUN_SCHEMA_VERSION, outcome: "cancellation_requested", run_id: runId, exit_code: EXIT.OK } };
|
|
@@ -548,11 +794,28 @@ async function finalize(context, state, call) {
|
|
|
548
794
|
const sha256 = createHash("sha256").update(await readFile(context.receipt_path)).digest("hex");
|
|
549
795
|
const apiStatus = ({ success: "succeeded", failure: "failed", cancelled: "cancelled", timed_out: "timed_out", owner_lost: "owner_lost" })[state.status];
|
|
550
796
|
const update = { run_id: context.run_id, run_credential: context.run_credential, status: apiStatus, exit_code: state.exitCode ?? undefined, invalidated_reason: state.reason ?? (state.status === "timed_out" ? "timeout" : state.status === "owner_lost" ? "owner_lost" : undefined), receipt_path: context.receipt_upload, receipt_content_type: "application/json", receipt_byte_size: bytes.size, receipt_sha256: sha256, output_characters: outputCharacters, truncated: outputCharacters > MAX_CAPTURE_BYTES };
|
|
797
|
+
// A locally durable receipt is enough to publish the linked test run. Do it
|
|
798
|
+
// before the command callback's intentionally unbounded retry: otherwise an
|
|
799
|
+
// auth outage (for example agent_identity_required) strands a 0-case run in
|
|
800
|
+
// active state forever even though its command has already failed locally.
|
|
801
|
+
if (context.test_run) await completeTestRun(context, { status: state.status, exitCode: state.exitCode, signal: state.signal, startedAt: state.startedAt, endedAt: state.endedAt, call });
|
|
551
802
|
await retryTerminalUpdate(context, update, call);
|
|
552
803
|
try { await unlink(context.context_path); } catch { /* receipt is authoritative; context cleanup is best effort */ }
|
|
553
804
|
return receipt;
|
|
554
805
|
}
|
|
555
806
|
|
|
807
|
+
function callWithContextIdentity(context, call) {
|
|
808
|
+
const token = typeof context.callback_session_token === "string" && SESSION_TOKEN_RE.test(context.callback_session_token)
|
|
809
|
+
? context.callback_session_token
|
|
810
|
+
: null;
|
|
811
|
+
// Old contexts cannot safely fall back to the machine-level owner key. Ask
|
|
812
|
+
// the API layer to require a session instead; the retained receipt/context
|
|
813
|
+
// makes recovery possible without attributing a callback to the wrong agent.
|
|
814
|
+
return (name, args) => call(name, args, token
|
|
815
|
+
? { auth: { "x-agent-api-key": token } }
|
|
816
|
+
: { requireSessionToken: true });
|
|
817
|
+
}
|
|
818
|
+
|
|
556
819
|
export async function retryTerminalUpdate(context, update, call, { sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)) } = {}) {
|
|
557
820
|
let attempts = 0;
|
|
558
821
|
let delay = 1_000;
|
package/src/test-lane.mjs
CHANGED
|
@@ -176,18 +176,29 @@ export async function launchTestLane(argv, {
|
|
|
176
176
|
return { exitCode: EXIT_TEST.INVALID, line: JSON.stringify({ outcome: "rejected", errors }) };
|
|
177
177
|
}
|
|
178
178
|
let managedCredential = null;
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
179
|
+
// A session id names a session but is not an API credential. Resolve the
|
|
180
|
+
// worktree's token even when the caller supplied --session-id, so the
|
|
181
|
+
// create/update calls are authenticated and the launched lane has a durable
|
|
182
|
+
// test-run to wait on. Without this, an otherwise valid explicit id could
|
|
183
|
+
// launch a real test with test_run_id:null and no supported wait condition.
|
|
184
|
+
//
|
|
185
|
+
// Test doubles that provide only a synthetic session id retain the old
|
|
186
|
+
// no-network seam. Production, and every caller that supplies a resolver,
|
|
187
|
+
// must resolve the token or fail before launching an untrackable run.
|
|
188
|
+
const mustResolveCredential = !opts.sessionToken
|
|
189
|
+
&& (!opts.sessionId || !!resolveCredential || call === callToolJson);
|
|
190
|
+
if (mustResolveCredential) {
|
|
182
191
|
if (!resolveCredential && call !== callToolJson) {
|
|
183
192
|
process.stderr.write("botbuddy test: --session-id is required (or set BOTBUDDY_AGENT_SESSION_TOKEN)\n");
|
|
184
193
|
return { exitCode: EXIT_TEST.INVALID, line: JSON.stringify({ outcome: "rejected", errors: ["--session-id is required"] }) };
|
|
185
194
|
}
|
|
186
195
|
try {
|
|
187
|
-
const credential = await (resolveCredential ?? resolveAgentSessionCredential)({ argv, env, cwd });
|
|
196
|
+
const credential = await (resolveCredential ?? resolveAgentSessionCredential)({ argv, env, cwd, sessionId: opts.sessionId });
|
|
188
197
|
managedCredential = credential;
|
|
189
198
|
opts.sessionToken = credential.token;
|
|
190
|
-
|
|
199
|
+
// --session-id is a deliberate caller choice. The resolved token proves
|
|
200
|
+
// authority; it must not silently replace the session the caller named.
|
|
201
|
+
opts.sessionId ??= credential.sessionId ?? null;
|
|
191
202
|
} catch (error) {
|
|
192
203
|
const code = error?.code ?? "agent_session_unavailable";
|
|
193
204
|
process.stderr.write(`botbuddy test: ${error?.message ?? code}\n`);
|