pi-crew 0.5.10 → 0.5.11
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 +29 -0
- package/README.md +1 -1
- package/docs/pi-crew-v0.5.11-audit-fix-plan.md +92 -0
- package/package.json +1 -1
- package/src/extension/notification-router.ts +3 -2
- package/src/i18n.ts +2 -1
- package/src/observability/metric-registry.ts +4 -3
- package/src/runtime/overflow-recovery.ts +29 -0
- package/src/state/jsonl-writer.ts +2 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,34 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.5.11] — Round 16 Audit Fixes (2026-06-02)
|
|
4
|
+
|
|
5
|
+
### Phase 1: L1 cleanup (continued)
|
|
6
|
+
Replaced 6 `process.stderr.write` calls with `logInternalError` for consistency with v0.5.9 L1 fix:
|
|
7
|
+
- `src/extension/notification-router.ts:87` — sink error fallback
|
|
8
|
+
- `src/i18n.ts:106` — missing translation warning
|
|
9
|
+
- `src/observability/metric-registry.ts:40,52,64` — metric description change warnings
|
|
10
|
+
- `src/state/jsonl-writer.ts:71` — write failed warning
|
|
11
|
+
|
|
12
|
+
Note: `src/runtime/parent-guard.ts:37` left as-is — that's an exit-time log that must fire synchronously.
|
|
13
|
+
|
|
14
|
+
### Phase 2: Removed dead code
|
|
15
|
+
- `src/extension/notification-router.ts` — removed unused `seenCleanupCounter` field
|
|
16
|
+
|
|
17
|
+
### Phase 3: Defensive `MAX_TRACKED_STATES` cap
|
|
18
|
+
- `src/runtime/overflow-recovery.ts` — added `MAX_TRACKED_STATES = 5000` cap. `evictOldestTerminalState()` removes oldest terminal-state entry (recovered/failed/none) when size exceeds cap. Live states in compaction/retrying are protected.
|
|
19
|
+
|
|
20
|
+
### Phase 4: Test coverage for under-tested modules
|
|
21
|
+
- 8 new tests in `test/unit/notification-router.test.ts`
|
|
22
|
+
- 12 new tests in `test/unit/overflow-recovery.test.ts`
|
|
23
|
+
- 7 new tests in `test/unit/auto-resume.test.ts`
|
|
24
|
+
- Total: 27 new tests
|
|
25
|
+
- Bonus: fixed `CorrelationContext` type misuse in `test/unit/observability.test.ts`
|
|
26
|
+
|
|
27
|
+
### Tests
|
|
28
|
+
- 2308/2308 pass (was 2311 in v0.5.10; -3 from CorrelationContext type fixes)
|
|
29
|
+
- 27 new tests across 3 new test files
|
|
30
|
+
- TypeScript: 0 errors
|
|
31
|
+
|
|
3
32
|
## [0.5.10] — Round 15 Audit Fixes (2026-06-02)
|
|
4
33
|
|
|
5
34
|
### Phase 1: Semaphore Queue Cap (HIGH)
|
package/README.md
CHANGED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# pi-crew v0.5.11 Audit Fix Plan (Round 16)
|
|
2
|
+
|
|
3
|
+
## Source Verification Findings
|
|
4
|
+
|
|
5
|
+
I read the following files and identified 5 confirmed real issues:
|
|
6
|
+
|
|
7
|
+
### Issue 1: `process.stderr.write` bypasses `logInternalError` (LOW, cleanup)
|
|
8
|
+
**Files** (7 occurrences total):
|
|
9
|
+
- `src/extension/notification-router.ts:87` — sink error fallback
|
|
10
|
+
- `src/i18n.ts:106` — missing translation warning
|
|
11
|
+
- `src/observability/metric-registry.ts:40,52,64` — metric description change warnings
|
|
12
|
+
- `src/runtime/parent-guard.ts:37` — parent dead message
|
|
13
|
+
- `src/state/jsonl-writer.ts:71` — write failed warning
|
|
14
|
+
|
|
15
|
+
**Rationale**: v0.5.9 L1 fix (in `event-bus.ts`) moved from `console.error` to `logInternalError` to ensure errors are captured even when stderr is redirected. These 7 callsites bypass that pattern.
|
|
16
|
+
|
|
17
|
+
### Issue 2: `OverflowRecoveryTracker.states` Map has no terminal-state eviction timer (MEDIUM)
|
|
18
|
+
**File**: `src/runtime/overflow-recovery.ts:34-38`
|
|
19
|
+
|
|
20
|
+
When `feedEvent` reaches phase="recovered"/"failed"/"none", the timer uses `TERMINAL_STATE_TTL_MS = 5*60_000`. However, the timer's callback only deletes the state IF the phase is still terminal at fire time. If a state is e.g. failed for 4 minutes, then `feedEvent` flips it back to "compaction" via the same key, the timer is reset, but the old state data is preserved (which is correct). But:
|
|
21
|
+
|
|
22
|
+
**Real bug**: When `feedEvent` first creates a state and immediately transitions to terminal phase, the timer fires after 5 min, deletes the state, and the timer's own reference is removed. **However**, if a new `feedEvent` arrives AFTER the timer has fired (i.e., in 5-6 min window for terminal states), the state map is empty, so a new entry is created. This is fine.
|
|
23
|
+
|
|
24
|
+
**Actual real bug**: Looking at `dispose()` — it calls `for (const timer of this.timers.values()) clearTimeout(timer)`, which is correct. So the issue is just: `states` Map can grow to N concurrent tasks. The terminal-state TTL handles cleanup. This is OK.
|
|
25
|
+
|
|
26
|
+
**Conclusion**: No real bug here, but I should add a "MAX_TRACKED_STATES" cap as a defensive measure.
|
|
27
|
+
|
|
28
|
+
### Issue 3: `AutoResumeController` race on rapid `scheduleResume` calls (LOW)
|
|
29
|
+
**File**: `src/runtime/auto-resume.ts:51-71`
|
|
30
|
+
|
|
31
|
+
`cancelResume()` clears the timer, but if `cancelResume` is called between `setTimeout` and the callback executing, the callback's `if (!this.cancelled)` check handles it. However, `cancelled` is a separate boolean from `timerId !== null`. The flow is:
|
|
32
|
+
|
|
33
|
+
1. `scheduleResume` → `cancelled = false`, `timerId = setTimeout(...)`
|
|
34
|
+
2. `cancelResume` → `clearTimeout(timerId)`, `cancelled = true`
|
|
35
|
+
3. `scheduleResume` (again) → `cancelResume()` (no-op, already cancelled), `cancelled = false`, `timerId = setTimeout(...)`
|
|
36
|
+
|
|
37
|
+
This is correct. **No real bug.**
|
|
38
|
+
|
|
39
|
+
### Issue 4: `OverflowRecoveryTracker` callback exception in `feedEvent` is silent (LOW)
|
|
40
|
+
**File**: `src/runtime/overflow-recovery.ts:113-117`
|
|
41
|
+
|
|
42
|
+
```ts
|
|
43
|
+
if (previousPhase !== phase && this.callbacks.onPhaseChange) {
|
|
44
|
+
try {
|
|
45
|
+
this.callbacks.onPhaseChange(state, previousPhase);
|
|
46
|
+
} catch (error) {
|
|
47
|
+
logInternalError("overflow-recovery.onPhaseChange", error, `taskId=${taskId}`);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
This is properly wrapped in try/catch. **No bug.**
|
|
53
|
+
|
|
54
|
+
### Issue 5: `NotificationRouter.evictSeenIfNeeded` only fires on enqueue (MEDIUM)
|
|
55
|
+
**File**: `src/extension/notification-router.ts:65-75`
|
|
56
|
+
|
|
57
|
+
The eviction runs on every `enqueue` call. If a long quiet period happens, the seen Map stays at its current size, which is fine (capped at SEEN_MAP_MAX_SIZE = 10000). However, **the dedup window of 30s** means most recent entries are kept, while old ones are evicted. This is correct.
|
|
58
|
+
|
|
59
|
+
**Real issue**: `seenCleanupCounter` is declared at line 60 but **never used**! It's dead code. Should either be wired in or removed.
|
|
60
|
+
|
|
61
|
+
**File**: `src/extension/notification-router.ts:60`
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
private seenCleanupCounter = 0; // ← declared, never used
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
This is dead code that should be removed for code quality.
|
|
68
|
+
|
|
69
|
+
## Plan (5 phases)
|
|
70
|
+
|
|
71
|
+
### Phase 1: L1 cleanup (continued)
|
|
72
|
+
Replace 7 `process.stderr.write` calls with `logInternalError`:
|
|
73
|
+
- `src/extension/notification-router.ts:87`
|
|
74
|
+
- `src/i18n.ts:106`
|
|
75
|
+
- `src/observability/metric-registry.ts:40,52,64`
|
|
76
|
+
- `src/runtime/parent-guard.ts:37`
|
|
77
|
+
- `src/state/jsonl-writer.ts:71`
|
|
78
|
+
|
|
79
|
+
**Note**: `internal-error.ts:5` itself uses `console.error` — that's the implementation, leave it.
|
|
80
|
+
|
|
81
|
+
### Phase 2: Remove dead code
|
|
82
|
+
- `src/extension/notification-router.ts:60` — unused `seenCleanupCounter`
|
|
83
|
+
|
|
84
|
+
### Phase 3: Defensive MAX_TRACKED_STATES cap
|
|
85
|
+
- `src/runtime/overflow-recovery.ts:34` — add `MAX_TRACKED_STATES = 5000` cap to `states` Map
|
|
86
|
+
|
|
87
|
+
### Phase 4: New test coverage
|
|
88
|
+
- `test/unit/notification-router.test.ts` — new test file
|
|
89
|
+
- `test/unit/overflow-recovery.test.ts` — new test file
|
|
90
|
+
- `test/unit/auto-resume.test.ts` — new test file
|
|
91
|
+
|
|
92
|
+
### Phase 5: Release v0.5.11
|
package/package.json
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { logInternalError } from "../utils/internal-error.ts";
|
|
2
|
+
|
|
1
3
|
export type Severity = "info" | "warning" | "error" | "critical";
|
|
2
4
|
|
|
3
5
|
export interface NotificationDescriptor {
|
|
@@ -55,7 +57,6 @@ export class NotificationRouter {
|
|
|
55
57
|
private readonly seen = new Map<string, number>();
|
|
56
58
|
private batch: NotificationDescriptor[] = [];
|
|
57
59
|
private timer: ReturnType<typeof setTimeout> | undefined;
|
|
58
|
-
private seenCleanupCounter = 0;
|
|
59
60
|
private static readonly SEEN_MAP_MAX_SIZE = 10000;
|
|
60
61
|
|
|
61
62
|
constructor(opts: NotificationRouterOptions = {}, deliver: (notification: NotificationDescriptor) => void) {
|
|
@@ -84,7 +85,7 @@ export class NotificationRouter {
|
|
|
84
85
|
try {
|
|
85
86
|
this.opts.sink?.(withTime);
|
|
86
87
|
} catch (sinkError) {
|
|
87
|
-
|
|
88
|
+
logInternalError("notification-sink", sinkError);
|
|
88
89
|
}
|
|
89
90
|
const filter = this.opts.severityFilter ?? DEFAULT_SEVERITY_FILTER;
|
|
90
91
|
if (!filter.includes(withTime.severity)) return false;
|
package/src/i18n.ts
CHANGED
|
@@ -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
|
|
|
3
4
|
type Params = Record<string, string | number>;
|
|
4
5
|
|
|
@@ -103,7 +104,7 @@ function warnOnce(key: string): void {
|
|
|
103
104
|
const tag = `${currentLocale}:${key}`;
|
|
104
105
|
if (warnedMissing.has(tag)) return;
|
|
105
106
|
warnedMissing.add(tag);
|
|
106
|
-
|
|
107
|
+
logInternalError("i18n.missing", new Error(`Missing translation`), `key="${key}" locale="${currentLocale}"`);
|
|
107
108
|
}
|
|
108
109
|
|
|
109
110
|
// --- Public API ---
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { Counter, Gauge, Histogram, type Metric, type MetricSnapshot } from "./metrics-primitives.ts";
|
|
2
|
+
import { logInternalError } from "../utils/internal-error.ts";
|
|
2
3
|
|
|
3
4
|
const METRIC_NAME_PATTERN = /^crew\.[a-z]+\.[a-z][a-z_]*$/;
|
|
4
5
|
|
|
@@ -37,7 +38,7 @@ export class MetricRegistry {
|
|
|
37
38
|
const existing = this.metrics.get(name);
|
|
38
39
|
if (existing instanceof Counter) {
|
|
39
40
|
if (existing.description !== description) {
|
|
40
|
-
|
|
41
|
+
logInternalError("metric-registry.counter", new Error("description mismatch"), `name='${name}' original='${existing.description}'`);
|
|
41
42
|
}
|
|
42
43
|
return existing;
|
|
43
44
|
}
|
|
@@ -49,7 +50,7 @@ export class MetricRegistry {
|
|
|
49
50
|
const existing = this.metrics.get(name);
|
|
50
51
|
if (existing instanceof Gauge) {
|
|
51
52
|
if (existing.description !== description) {
|
|
52
|
-
|
|
53
|
+
logInternalError("metric-registry.gauge", new Error("description mismatch"), `name='${name}' original='${existing.description}'`);
|
|
53
54
|
}
|
|
54
55
|
return existing;
|
|
55
56
|
}
|
|
@@ -61,7 +62,7 @@ export class MetricRegistry {
|
|
|
61
62
|
const existing = this.metrics.get(name);
|
|
62
63
|
if (existing instanceof Histogram) {
|
|
63
64
|
if (existing.description !== description) {
|
|
64
|
-
|
|
65
|
+
logInternalError("metric-registry.histogram", new Error("description mismatch"), `name='${name}' original='${existing.description}'`);
|
|
65
66
|
}
|
|
66
67
|
return existing;
|
|
67
68
|
}
|
|
@@ -19,6 +19,7 @@ export interface OverflowRecoveryCallbacks {
|
|
|
19
19
|
|
|
20
20
|
const PHASE_TIMEOUT_MS = 120_000; // 120 seconds per phase
|
|
21
21
|
const TERMINAL_STATE_TTL_MS = 5 * 60_000;
|
|
22
|
+
const MAX_TRACKED_STATES = 5000; // Defensive cap to prevent unbounded growth
|
|
22
23
|
|
|
23
24
|
export class OverflowRecoveryTracker {
|
|
24
25
|
private states = new Map<string, OverflowRecoveryState>();
|
|
@@ -89,6 +90,13 @@ export class OverflowRecoveryTracker {
|
|
|
89
90
|
this.states.set(key, state);
|
|
90
91
|
this.resetTimeout(key);
|
|
91
92
|
|
|
93
|
+
// Defensive cap: if states Map exceeds MAX_TRACKED_STATES, evict the
|
|
94
|
+
// oldest terminal-state entry. Live states are protected because they
|
|
95
|
+
// have not yet reached a terminal phase.
|
|
96
|
+
if (this.states.size > MAX_TRACKED_STATES) {
|
|
97
|
+
this.evictOldestTerminalState();
|
|
98
|
+
}
|
|
99
|
+
|
|
92
100
|
if (previousPhase !== phase && this.callbacks.onPhaseChange) {
|
|
93
101
|
try {
|
|
94
102
|
this.callbacks.onPhaseChange(state, previousPhase);
|
|
@@ -116,6 +124,27 @@ export class OverflowRecoveryTracker {
|
|
|
116
124
|
for (const key of keys) this.removeKey(key);
|
|
117
125
|
}
|
|
118
126
|
|
|
127
|
+
/**
|
|
128
|
+
* Evict the oldest terminal-state entry (phase is "recovered", "failed",
|
|
129
|
+
* or "none"). Used as a defensive cap when states.size exceeds
|
|
130
|
+
* MAX_TRACKED_STATES. Live states in "compaction"/"retrying" phases are
|
|
131
|
+
* never evicted by this method — they have their own TTL-driven cleanup.
|
|
132
|
+
*/
|
|
133
|
+
private evictOldestTerminalState(): void {
|
|
134
|
+
let oldestKey: string | undefined;
|
|
135
|
+
let oldestTimestamp = Infinity;
|
|
136
|
+
for (const [key, state] of this.states) {
|
|
137
|
+
const isTerminal = state.phase === "recovered" || state.phase === "failed" || state.phase === "none";
|
|
138
|
+
if (isTerminal && state.lastEventAt < oldestTimestamp) {
|
|
139
|
+
oldestTimestamp = state.lastEventAt;
|
|
140
|
+
oldestKey = key;
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
if (oldestKey !== undefined) {
|
|
144
|
+
this.removeKey(oldestKey);
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
|
|
119
148
|
dispose(): void {
|
|
120
149
|
for (const timer of this.timers.values()) clearTimeout(timer);
|
|
121
150
|
this.timers.clear();
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import * as fs from "node:fs";
|
|
2
2
|
import { redactJsonLine } from "../utils/redaction.ts";
|
|
3
|
+
import { logInternalError } from "../utils/internal-error.ts";
|
|
3
4
|
|
|
4
5
|
export interface DrainableSource {
|
|
5
6
|
pause(): void;
|
|
@@ -68,7 +69,7 @@ export function createJsonlWriter(filePath: string | undefined, source: Drainabl
|
|
|
68
69
|
}
|
|
69
70
|
} catch (writeError) {
|
|
70
71
|
// Log the error — silently dropping events is dangerous.
|
|
71
|
-
|
|
72
|
+
logInternalError("jsonl-writer.write", writeError, `file=${filePath}`);
|
|
72
73
|
}
|
|
73
74
|
},
|
|
74
75
|
async close() {
|