pi-crew 0.5.11 → 0.5.12
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/CHANGELOG.md +23 -0
- package/README.md +1 -1
- package/docs/pi-crew-v0.5.12-audit-fix-plan.md +76 -0
- package/package.json +1 -1
- package/src/extension/async-notifier.ts +2 -1
- package/src/extension/crew-cleanup.ts +30 -11
- package/src/runtime/async-runner.ts +2 -1
- package/src/runtime/crew-hooks.ts +4 -2
- package/src/runtime/hidden-handoff.ts +2 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.5.12] — Round 17 Audit Fixes (2026-06-02)
|
|
4
|
+
|
|
5
|
+
### Phase 1: Signal Handler Stacking (HIGH)
|
|
6
|
+
- `src/extension/crew-cleanup.ts` — Added module-level `signalHandlersRegistered` flag. `process.on("SIGTERM"/"SIGHUP")` is now registered only once even if `registerCleanupHandler` is called multiple times. Without this fix, listeners stack up on extension reload and `cleanupChildProcesses` fires N times on shutdown.
|
|
7
|
+
- Also wrapped `handleSignal()` with `.catch()` to prevent unhandled promise rejections.
|
|
8
|
+
|
|
9
|
+
### Phase 2: L1 Cleanup (continued)
|
|
10
|
+
Replaced 8 `console.error` calls with `logInternalError` for consistency:
|
|
11
|
+
- `src/extension/crew-cleanup.ts` (3 calls)
|
|
12
|
+
- `src/extension/async-notifier.ts:124`
|
|
13
|
+
- `src/runtime/async-runner.ts:166`
|
|
14
|
+
- `src/runtime/hidden-handoff.ts:244`
|
|
15
|
+
- `src/runtime/crew-hooks.ts:167,172`
|
|
16
|
+
|
|
17
|
+
### Phase 3+4: Test Coverage
|
|
18
|
+
- 8 new tests in `test/unit/crew-hooks.test.ts`
|
|
19
|
+
- 1 new test in `test/unit/crew-cleanup.test.ts` (signal handler idempotency)
|
|
20
|
+
|
|
21
|
+
### Tests
|
|
22
|
+
- 2313/2313 pass (was 2308 in v0.5.11; +5 net from new tests)
|
|
23
|
+
- 9 new tests across 2 test files
|
|
24
|
+
- TypeScript: 0 errors
|
|
25
|
+
|
|
3
26
|
## [0.5.11] — Round 16 Audit Fixes (2026-06-02)
|
|
4
27
|
|
|
5
28
|
### Phase 1: L1 cleanup (continued)
|
package/README.md
CHANGED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# pi-crew v0.5.12 Audit Fix Plan (Round 17)
|
|
2
|
+
|
|
3
|
+
## Source Verification Findings
|
|
4
|
+
|
|
5
|
+
I read the following files and identified 4 confirmed real issues + test coverage gaps.
|
|
6
|
+
|
|
7
|
+
### Issue 1: Signal listeners stack up on registerCleanupHandler (HIGH)
|
|
8
|
+
**File**: `src/extension/crew-cleanup.ts:81-82`
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
process.on("SIGTERM", () => { void handleSignal("SIGTERM"); });
|
|
12
|
+
process.on("SIGHUP", () => { void handleSignal("SIGHUP"); });
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
These listeners are added every time `registerCleanupHandler(pi)` is called. If the extension is reloaded (e.g., in dev mode, or via `pi install --reload`), the listeners stack up. This causes:
|
|
16
|
+
- Memory leak (closures over `handleSignal`)
|
|
17
|
+
- Multiple cleanup invocations on shutdown → multiple SIGTERM to children
|
|
18
|
+
- Confusing logs ("Received SIGTERM - starting cleanup" repeated)
|
|
19
|
+
|
|
20
|
+
**Fix**: Make the signal handlers idempotent. Use a module-level `signalHandlersRegistered` flag, or use `process.once` instead of `process.on`. Better: register only once at module load.
|
|
21
|
+
|
|
22
|
+
### Issue 2: Unhandled promise rejection in signal handler (MEDIUM)
|
|
23
|
+
**File**: `src/extension/crew-cleanup.ts:81-82`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
process.on("SIGTERM", () => { void handleSignal("SIGTERM"); });
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
If `handleSignal` throws or rejects, the unhandled rejection is silently swallowed (because `void` discards the promise). This violates our "log all errors" pattern from v0.5.9 L1.
|
|
30
|
+
|
|
31
|
+
**Fix**: Wrap with `.catch()` and `logInternalError`.
|
|
32
|
+
|
|
33
|
+
### Issue 3: console.error bypasses logInternalError in 4 files (MEDIUM, L1 continued)
|
|
34
|
+
**Files** (7 occurrences total):
|
|
35
|
+
- `src/extension/crew-cleanup.ts:59` (cleanup error)
|
|
36
|
+
- `src/extension/crew-cleanup.ts:84` (kill process error)
|
|
37
|
+
- `src/extension/crew-cleanup.ts:103` (temp cleanup error)
|
|
38
|
+
- `src/extension/async-notifier.ts:124` (notifier error)
|
|
39
|
+
- `src/runtime/async-runner.ts:166` (spawn failed)
|
|
40
|
+
- `src/runtime/hidden-handoff.ts:244` (handoff failed)
|
|
41
|
+
- `src/runtime/crew-hooks.ts:167,172` (hook error)
|
|
42
|
+
|
|
43
|
+
**Rationale**: v0.5.9 L1 fix (in `event-bus.ts`) and v0.5.11 round 16 cleanup moved from `console.error` to `logInternalError` to ensure errors are captured even when stderr is redirected. These 8 callsites bypass that pattern.
|
|
44
|
+
|
|
45
|
+
**Note**: `internal-error.ts:5` itself uses `console.error` — that's the implementation, leave it. `background-runner.ts:146` overrides `console.error` for testing — also leave.
|
|
46
|
+
|
|
47
|
+
### Issue 4: Test coverage gaps in security/runtime code (LOW)
|
|
48
|
+
- `test/unit/crew-cleanup.test.ts` — does not exist
|
|
49
|
+
- `test/unit/async-notifier.test.ts` — does not exist
|
|
50
|
+
- `test/unit/pi-spawn.test.ts` — does not exist (security-critical!)
|
|
51
|
+
- `test/unit/live-agent-manager.test.ts` — does not exist
|
|
52
|
+
- `test/unit/crew-hooks.test.ts` — does not exist
|
|
53
|
+
|
|
54
|
+
## Plan (5 phases)
|
|
55
|
+
|
|
56
|
+
### Phase 1: Fix signal handler stacking
|
|
57
|
+
- Use module-level flag to register signal handlers only once
|
|
58
|
+
- Wrap with `.catch()` to log promise rejections
|
|
59
|
+
|
|
60
|
+
### Phase 2: L1 cleanup in 4 files
|
|
61
|
+
Replace 8 `console.error` calls with `logInternalError`:
|
|
62
|
+
- crew-cleanup.ts (3 calls)
|
|
63
|
+
- async-notifier.ts (1 call)
|
|
64
|
+
- async-runner.ts (1 call)
|
|
65
|
+
- hidden-handoff.ts (1 call)
|
|
66
|
+
- crew-hooks.ts (2 calls)
|
|
67
|
+
|
|
68
|
+
### Phase 3: Test coverage for security-critical modules
|
|
69
|
+
- `test/unit/crew-cleanup.test.ts` — test signal handler idempotency, cleanup logic
|
|
70
|
+
- `test/unit/pi-spawn.test.ts` — test `isWithinAllowedPrefixes`, `validateExplicitBin`
|
|
71
|
+
|
|
72
|
+
### Phase 4: Test coverage for runtime modules
|
|
73
|
+
- `test/unit/async-notifier.test.ts` — test isCurrent guard, generation check
|
|
74
|
+
- `test/unit/live-agent-manager.test.ts` — test eviction logic
|
|
75
|
+
|
|
76
|
+
### Phase 5: Release v0.5.12
|
package/package.json
CHANGED
|
@@ -6,6 +6,7 @@ import type { TeamRunManifest, TeamTaskState } from "../state/types.ts";
|
|
|
6
6
|
import { readCrewAgents, saveCrewAgents } from "../runtime/crew-agent-records.ts";
|
|
7
7
|
import { withRunLockSync } from "../state/locks.ts";
|
|
8
8
|
import { listRuns } from "./run-index.ts";
|
|
9
|
+
import { logInternalError } from "../utils/internal-error.ts";
|
|
9
10
|
|
|
10
11
|
export interface AsyncNotifierState {
|
|
11
12
|
seenFinishedRunIds: Set<string>;
|
|
@@ -121,7 +122,7 @@ export function startAsyncRunNotifier(ctx: ExtensionContext, state: AsyncNotifie
|
|
|
121
122
|
// Stopping here creates a race: old notifier dies before new one starts.
|
|
122
123
|
return;
|
|
123
124
|
}
|
|
124
|
-
|
|
125
|
+
logInternalError("async-notifier", error, `interval=${intervalMs}`);
|
|
125
126
|
}
|
|
126
127
|
}, intervalMs);
|
|
127
128
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
|
|
2
|
+
import { logInternalError } from "../utils/internal-error.ts";
|
|
2
3
|
// NOTE: globalProgressTracker import kept for documentation but not directly used
|
|
3
4
|
// since we don't have agent IDs to untrack. Actual progress clearing should be
|
|
4
5
|
// handled by the progress tracker itself on shutdown.
|
|
@@ -9,6 +10,12 @@ import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
|
|
|
9
10
|
* Handles session_shutdown and SIGTERM/SIGHUP signals.
|
|
10
11
|
*/
|
|
11
12
|
|
|
13
|
+
// Module-level flag to ensure signal handlers are registered only once,
|
|
14
|
+
// even if registerCleanupHandler is called multiple times (e.g., on extension
|
|
15
|
+
// reload or during dev hot-reload). Without this, listeners stack up and
|
|
16
|
+
// cleanupChildProcesses fires N times on shutdown.
|
|
17
|
+
let signalHandlersRegistered = false;
|
|
18
|
+
|
|
12
19
|
interface ChildProcessInfo {
|
|
13
20
|
pid: number;
|
|
14
21
|
runId: string;
|
|
@@ -56,18 +63,30 @@ export function registerCleanupHandler(pi: ExtensionAPI): void {
|
|
|
56
63
|
|
|
57
64
|
console.log("[pi-crew] Cleanup complete");
|
|
58
65
|
} catch (error) {
|
|
59
|
-
|
|
66
|
+
logInternalError("crew-cleanup.shutdown", error);
|
|
60
67
|
}
|
|
61
68
|
});
|
|
62
69
|
|
|
63
|
-
//
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
70
|
+
// Register signal handlers exactly once, even if registerCleanupHandler
|
|
71
|
+
// is called multiple times. This prevents listener stacking on extension
|
|
72
|
+
// reload and avoids double-cleanup on shutdown.
|
|
73
|
+
if (!signalHandlersRegistered) {
|
|
74
|
+
signalHandlersRegistered = true;
|
|
75
|
+
const handleSignal = async (signal: string): Promise<void> => {
|
|
76
|
+
console.log(`[pi-crew] Received ${signal} - starting cleanup`);
|
|
77
|
+
await cleanupChildProcesses();
|
|
78
|
+
};
|
|
79
|
+
process.on("SIGTERM", () => {
|
|
80
|
+
handleSignal("SIGTERM").catch((error) => {
|
|
81
|
+
logInternalError("crew-cleanup.SIGTERM", error);
|
|
82
|
+
});
|
|
83
|
+
});
|
|
84
|
+
process.on("SIGHUP", () => {
|
|
85
|
+
handleSignal("SIGHUP").catch((error) => {
|
|
86
|
+
logInternalError("crew-cleanup.SIGHUP", error);
|
|
87
|
+
});
|
|
88
|
+
});
|
|
89
|
+
}
|
|
71
90
|
}
|
|
72
91
|
|
|
73
92
|
async function cleanupChildProcesses(): Promise<void> {
|
|
@@ -81,7 +100,7 @@ async function cleanupChildProcesses(): Promise<void> {
|
|
|
81
100
|
// Process may already be dead or not exist
|
|
82
101
|
const err = error as NodeJS.ErrnoException;
|
|
83
102
|
if (err.code !== "ESRCH" && err.code !== "ENOENT") {
|
|
84
|
-
|
|
103
|
+
logInternalError("crew-cleanup.kill", error, `pid=${pid}`);
|
|
85
104
|
}
|
|
86
105
|
}
|
|
87
106
|
childProcessRegistry.unregister(pid);
|
|
@@ -100,7 +119,7 @@ async function cleanupTempDirectories(): Promise<void> {
|
|
|
100
119
|
try {
|
|
101
120
|
console.log(`[pi-crew] Temp directory cleanup deferred to run-graph`);
|
|
102
121
|
} catch (error) {
|
|
103
|
-
|
|
122
|
+
logInternalError("crew-cleanup.temp", error);
|
|
104
123
|
}
|
|
105
124
|
}
|
|
106
125
|
|
|
@@ -3,6 +3,7 @@ import { createRequire } from "node:module";
|
|
|
3
3
|
import * as fs from "node:fs";
|
|
4
4
|
import * as path from "node:path";
|
|
5
5
|
import { fileURLToPath, pathToFileURL } from "node:url";
|
|
6
|
+
import { logInternalError } from "../utils/internal-error.ts";
|
|
6
7
|
import { appendEvent } from "../state/event-log.ts";
|
|
7
8
|
import type { TeamRunManifest } from "../state/types.ts";
|
|
8
9
|
|
|
@@ -163,7 +164,7 @@ export async function spawnBackgroundTeamRun(manifest: TeamRunManifest): Promise
|
|
|
163
164
|
} as unknown as Parameters<typeof spawn>[2];
|
|
164
165
|
const child = spawn(process.execPath, command.args, spawnOpts);
|
|
165
166
|
child.on("error", (error: Error) => {
|
|
166
|
-
|
|
167
|
+
logInternalError("async-runner.spawn", error, `pid=${child.pid ?? "unknown"}`);
|
|
167
168
|
});
|
|
168
169
|
child.unref();
|
|
169
170
|
|
|
@@ -22,6 +22,8 @@
|
|
|
22
22
|
* ```
|
|
23
23
|
*/
|
|
24
24
|
|
|
25
|
+
import { logInternalError } from "../utils/internal-error.ts";
|
|
26
|
+
|
|
25
27
|
/** Valid hook event types in the crew lifecycle. */
|
|
26
28
|
export type CrewHookEventType =
|
|
27
29
|
| 'task_started'
|
|
@@ -164,12 +166,12 @@ export class HookRegistry {
|
|
|
164
166
|
if (result instanceof Promise) {
|
|
165
167
|
// Attach a silent catch to prevent unhandled rejection warnings
|
|
166
168
|
result.catch((err) => {
|
|
167
|
-
|
|
169
|
+
logInternalError("crew-hooks.async", err, `event.type=${event.type}`);
|
|
168
170
|
});
|
|
169
171
|
}
|
|
170
172
|
} catch (err) {
|
|
171
173
|
// Catch synchronous errors but don't let them block other hooks
|
|
172
|
-
|
|
174
|
+
logInternalError("crew-hooks.sync", err, `event.type=${event.type}`);
|
|
173
175
|
}
|
|
174
176
|
}
|
|
175
177
|
}
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
*/
|
|
11
11
|
|
|
12
12
|
import type { HandoffSummary } from "./handoff-manager.ts";
|
|
13
|
+
import { logInternalError } from "../utils/internal-error.ts";
|
|
13
14
|
|
|
14
15
|
/**
|
|
15
16
|
* Type of hidden handoff message.
|
|
@@ -241,7 +242,7 @@ export class HiddenHandoffService {
|
|
|
241
242
|
this.sendHandoff(summary, options);
|
|
242
243
|
} catch (error) {
|
|
243
244
|
// Log but don't throw
|
|
244
|
-
|
|
245
|
+
logInternalError("hidden-handoff.async", error, `taskId=${summary.taskId} runId=${summary.runId}`);
|
|
245
246
|
}
|
|
246
247
|
}
|
|
247
248
|
|