@gotgenes/pi-subagents 6.1.0 → 6.3.0
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 +28 -0
- package/docs/architecture/architecture.md +5 -3
- package/docs/plans/0099-replace-ctx-with-parent-snapshot.md +488 -0
- package/docs/plans/0100-replace-callback-threading-with-session-subscription.md +454 -0
- package/docs/retro/0098-extract-agent-record-state-machine.md +46 -0
- package/docs/retro/0099-replace-ctx-with-parent-snapshot.md +37 -0
- package/package.json +1 -1
- package/src/agent-manager.ts +30 -50
- package/src/agent-runner.ts +18 -135
- package/src/env.ts +4 -5
- package/src/index.ts +4 -3
- package/src/parent-snapshot.ts +27 -0
- package/src/record-observer.ts +60 -0
- package/src/service-adapter.ts +2 -2
- package/src/tools/agent-tool.ts +27 -64
- package/src/types.ts +30 -0
- package/src/ui/agent-menu.ts +2 -3
- package/src/ui/ui-observer.ts +83 -0
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [6.3.0](https://github.com/gotgenes/pi-packages/compare/pi-subagents-v6.2.0...pi-subagents-v6.3.0) (2026-05-21)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Features
|
|
12
|
+
|
|
13
|
+
* add record observer for direct session subscription ([#100](https://github.com/gotgenes/pi-packages/issues/100)) ([3776345](https://github.com/gotgenes/pi-packages/commit/37763454609d38d55c85f89bb051b8c592d425bf))
|
|
14
|
+
* add UI observer for direct session subscription ([#100](https://github.com/gotgenes/pi-packages/issues/100)) ([5b35e80](https://github.com/gotgenes/pi-packages/commit/5b35e80e784d96883ee44bf5e890284efa1047ef))
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Documentation
|
|
18
|
+
|
|
19
|
+
* plan callback-threading replacement with session subscription ([#100](https://github.com/gotgenes/pi-packages/issues/100)) ([7a8e262](https://github.com/gotgenes/pi-packages/commit/7a8e262ebaf99cba017aac00691cc3614ef8c80a))
|
|
20
|
+
* **retro:** add retro notes for issue [#99](https://github.com/gotgenes/pi-packages/issues/99) ([b596d0c](https://github.com/gotgenes/pi-packages/commit/b596d0c34862542d0ebb9fae67dd90e9fc660a8b))
|
|
21
|
+
|
|
22
|
+
## [6.2.0](https://github.com/gotgenes/pi-packages/compare/pi-subagents-v6.1.0...pi-subagents-v6.2.0) (2026-05-21)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Features
|
|
26
|
+
|
|
27
|
+
* add ParentSnapshot type and builder ([#99](https://github.com/gotgenes/pi-packages/issues/99)) ([ee24eb9](https://github.com/gotgenes/pi-packages/commit/ee24eb907eba9f6f917bc166c912e5482eff5bd5))
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
### Documentation
|
|
31
|
+
|
|
32
|
+
* **pi-subagents:** cross-reference issues in architecture decomposition plan ([2242e45](https://github.com/gotgenes/pi-packages/commit/2242e457b7e1bf8cb44e9a1df6fb4d2fd1ba1116))
|
|
33
|
+
* plan replace live ctx capture with ParentSnapshot ([#99](https://github.com/gotgenes/pi-packages/issues/99)) ([b6b63f8](https://github.com/gotgenes/pi-packages/commit/b6b63f8677231617a00cb1e3d1227667cbae7ecd))
|
|
34
|
+
* **retro:** add retro notes for issue [#98](https://github.com/gotgenes/pi-packages/issues/98) ([ef52aaa](https://github.com/gotgenes/pi-packages/commit/ef52aaa4d8b690b309f2129ff34f90c44368cc57))
|
|
35
|
+
|
|
8
36
|
## [6.1.0](https://github.com/gotgenes/pi-packages/compare/pi-subagents-v6.0.1...pi-subagents-v6.1.0) (2026-05-20)
|
|
9
37
|
|
|
10
38
|
|
|
@@ -489,7 +489,7 @@ The `if (record.status !== "stopped")` guards in `.then()` and `.catch()` become
|
|
|
489
489
|
The three designs are independent and can land in any order.
|
|
490
490
|
The recommended sequence minimizes intermediate churn.
|
|
491
491
|
|
|
492
|
-
#### Step 1: Record state machine
|
|
492
|
+
#### Step 1: Record state machine ✓ (done — #98, #102)
|
|
493
493
|
|
|
494
494
|
Extract status-transition methods onto `AgentRecord` (or a `RecordManager` wrapper).
|
|
495
495
|
Purely mechanical — replace scattered field writes with method calls.
|
|
@@ -497,7 +497,9 @@ No interface changes for callers.
|
|
|
497
497
|
|
|
498
498
|
This is the lowest-risk change and immediately reduces `startAgent()` line count.
|
|
499
499
|
|
|
500
|
-
|
|
500
|
+
Issue #102 consolidated test `AgentRecord` construction into a shared factory as follow-up.
|
|
501
|
+
|
|
502
|
+
#### Step 2: Parent snapshot (#99)
|
|
501
503
|
|
|
502
504
|
Replace `ctx: ExtensionContext` in `SpawnArgs` with a `ParentSnapshot` data object.
|
|
503
505
|
Capture the snapshot in `spawn()` or at the tool call site.
|
|
@@ -506,7 +508,7 @@ Remove `pi: ExtensionAPI` from `SpawnArgs` (it is only used to pass to `runner.r
|
|
|
506
508
|
|
|
507
509
|
This change narrows the `AgentRunner` interface and eliminates live-reference capture.
|
|
508
510
|
|
|
509
|
-
#### Step 3: Session-event observation
|
|
511
|
+
#### Step 3: Session-event observation (#100)
|
|
510
512
|
|
|
511
513
|
Replace the callback-threading pattern with direct session subscriptions.
|
|
512
514
|
AgentManager subscribes to the session after creation to update the record.
|
|
@@ -0,0 +1,488 @@
|
|
|
1
|
+
---
|
|
2
|
+
issue: 99
|
|
3
|
+
issue_title: "Replace live `ctx` capture with ParentSnapshot in AgentManager"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Replace live ctx capture with ParentSnapshot
|
|
7
|
+
|
|
8
|
+
## Problem Statement
|
|
9
|
+
|
|
10
|
+
`AgentManager.spawn()` captures a live `ctx: ExtensionContext` reference into `SpawnArgs`, which is held in the concurrency queue until a slot opens.
|
|
11
|
+
When the queued agent eventually dequeues, `runAgent()` reads from this live reference — `ctx.cwd`, `ctx.getSystemPrompt()`, `ctx.model`, `ctx.modelRegistry` — all of which may have changed since the agent was queued (model switch, cwd change, session restart).
|
|
12
|
+
|
|
13
|
+
Additionally, `inheritContext` calls `ctx.sessionManager.getBranch()` at run time, forking the conversation as it exists at dequeue rather than at the point the user asked for the agent.
|
|
14
|
+
|
|
15
|
+
`pi: ExtensionAPI` is also stored in `SpawnArgs` but is only relayed to `runner.run()`, which only uses it for `detectEnv()` — a classic parameter-relay smell.
|
|
16
|
+
|
|
17
|
+
## Goals
|
|
18
|
+
|
|
19
|
+
- Replace `ctx: ExtensionContext` in `SpawnArgs` with a `ParentSnapshot` data object captured once at spawn time.
|
|
20
|
+
- Remove `pi: ExtensionAPI` from `SpawnArgs` by injecting a narrow `ShellExec` callback into `AgentManager` at construction.
|
|
21
|
+
- Update `AgentRunner.run()` to accept `ParentSnapshot` instead of `ctx`.
|
|
22
|
+
- Narrow `detectEnv()` to accept `ShellExec` instead of the full `ExtensionAPI`.
|
|
23
|
+
- Simplify test mocks — plain data snapshots replace SDK mock objects.
|
|
24
|
+
|
|
25
|
+
## Non-Goals
|
|
26
|
+
|
|
27
|
+
- Session-event observation / callback-threading removal (architecture.md Step 3, #100) — separate issue, depends on this one.
|
|
28
|
+
- Cleaning up `runtime.currentCtx` — it holds a live `{ pi, ctx }` for the service-adapter but is always "current" (set on `session_start`, cleared on `session_shutdown`); staleness is not a risk there.
|
|
29
|
+
Simplifying it is a natural follow-up but out of scope.
|
|
30
|
+
- Changes to `SpawnOptions` or the public `SubagentsService` API — both are unchanged.
|
|
31
|
+
|
|
32
|
+
## Background
|
|
33
|
+
|
|
34
|
+
### Relevant modules
|
|
35
|
+
|
|
36
|
+
| Module | Role in this change |
|
|
37
|
+
| ------------------------ | --------------------------------------------------------------------------------------- |
|
|
38
|
+
| `src/agent-manager.ts` | Owns `SpawnArgs`, `spawn()`, `startAgent()` — primary target |
|
|
39
|
+
| `src/agent-runner.ts` | `runAgent()` consumes `ctx` + `pi`; `AgentRunner` interface defines `run()` signature |
|
|
40
|
+
| `src/env.ts` | `detectEnv()` accepts `ExtensionAPI` — narrowing to `ShellExec` |
|
|
41
|
+
| `src/context.ts` | `buildParentContext()` reads `ctx.sessionManager.getBranch()` — called at snapshot time |
|
|
42
|
+
| `src/session-config.ts` | `AssemblerContext` is already a narrow interface; `runAgent` builds it from ctx today |
|
|
43
|
+
| `src/types.ts` | Will host `ParentSnapshot` and `ShellExec` type definitions |
|
|
44
|
+
| `src/service-adapter.ts` | `AgentManagerLike.spawn` — narrow interface that mirrors `AgentManager.spawn()` |
|
|
45
|
+
| `src/index.ts` | Wires `pi.exec` into `AgentManager`; wraps `spawn`/`spawnAndWait` for tools |
|
|
46
|
+
| `src/ui/agent-menu.ts` | `AgentMenuManagerDeps.spawnAndWait` — narrow interface referencing `pi` parameter |
|
|
47
|
+
|
|
48
|
+
### Code-style constraints
|
|
49
|
+
|
|
50
|
+
- **Parameter relay** (code-design skill): `pi` threads through `spawn` → `SpawnArgs` → `startAgent` → `RunOptions` → `runAgent` → `detectEnv`.
|
|
51
|
+
The intermediaries (`spawn`, `startAgent`) never read `pi`.
|
|
52
|
+
Fix: inject exec at the `AgentManager` level.
|
|
53
|
+
- **Dependency width** (code-design skill): `runAgent` receives `ctx: ExtensionContext` but only reads 4 fields plus `sessionManager.getBranch()`.
|
|
54
|
+
Fix: `ParentSnapshot` — a narrow interface with exactly the fields consumed.
|
|
55
|
+
- **Law of Demeter** (design-review): `ctx.sessionManager.getBranch()` is a reach-through that forces tests to mock a nested `sessionManager` object.
|
|
56
|
+
Fix: snapshot pre-computes `parentContext` as a string.
|
|
57
|
+
|
|
58
|
+
### Prerequisite status
|
|
59
|
+
|
|
60
|
+
- Issue #98 (AgentRecord state machine) — **done**.
|
|
61
|
+
`AgentRecord` is a class with encapsulated transition methods.
|
|
62
|
+
- Issue #102 (shared test record factory) — **done**.
|
|
63
|
+
All test record construction goes through `createTestRecord()`.
|
|
64
|
+
|
|
65
|
+
## Design Overview
|
|
66
|
+
|
|
67
|
+
### ParentSnapshot interface
|
|
68
|
+
|
|
69
|
+
A plain data object capturing everything `runAgent()` reads from `ctx`:
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
export interface ParentSnapshot {
|
|
73
|
+
/** Parent working directory. */
|
|
74
|
+
cwd: string;
|
|
75
|
+
/** Parent's effective system prompt (for append-mode agents). */
|
|
76
|
+
systemPrompt: string;
|
|
77
|
+
/** Parent's current model instance (fallback when agent config has no model). */
|
|
78
|
+
model: unknown;
|
|
79
|
+
/** Model registry for resolving config.model strings and creating sessions. */
|
|
80
|
+
modelRegistry: {
|
|
81
|
+
find(provider: string, modelId: string): unknown;
|
|
82
|
+
getAvailable?(): Array<{ provider: string; id: string }>;
|
|
83
|
+
};
|
|
84
|
+
/** Pre-built parent conversation text (when inheritContext was requested). */
|
|
85
|
+
parentContext?: string;
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
The `modelRegistry` field is a reference capture, not a data copy — it's a registry object with methods.
|
|
90
|
+
This is acceptable because the registry is structurally stable within a session (models don't change at runtime).
|
|
91
|
+
The key staleness risks (`cwd`, `systemPrompt`, `model`, conversation state) are all captured as values.
|
|
92
|
+
|
|
93
|
+
### ShellExec type
|
|
94
|
+
|
|
95
|
+
A narrow callback type replacing `ExtensionAPI` in `detectEnv`:
|
|
96
|
+
|
|
97
|
+
```typescript
|
|
98
|
+
export type ShellExec = (
|
|
99
|
+
command: string,
|
|
100
|
+
args: string[],
|
|
101
|
+
options?: { cwd?: string; timeout?: number },
|
|
102
|
+
) => Promise<{ stdout: string; stderr: string; code: number }>;
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
This matches the shape of `pi.exec()` but carries no SDK dependency.
|
|
106
|
+
|
|
107
|
+
### Snapshot built in spawn()
|
|
108
|
+
|
|
109
|
+
`spawn()` keeps receiving `ctx` as a parameter (so callers don't need to know about `ParentSnapshot`).
|
|
110
|
+
Internally, it immediately snapshots `ctx` and stores the snapshot in `SpawnArgs` — never the live `ctx` reference.
|
|
111
|
+
|
|
112
|
+
```typescript
|
|
113
|
+
spawn(ctx: ExtensionContext, type: SubagentType, prompt: string, options: SpawnOptions): string {
|
|
114
|
+
const snapshot: ParentSnapshot = buildParentSnapshot(ctx, options.inheritContext);
|
|
115
|
+
const args: SpawnArgs = { snapshot, type, prompt, options };
|
|
116
|
+
// ...
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
The `pi` parameter is removed from `spawn()`.
|
|
121
|
+
The `exec` function is injected into `AgentManager` at construction time via `AgentManagerOptions`, since `pi.exec` is a stable capability (same function reference for the extension's lifetime).
|
|
122
|
+
|
|
123
|
+
### buildParentSnapshot helper
|
|
124
|
+
|
|
125
|
+
A new `src/parent-snapshot.ts` module with a single exported function:
|
|
126
|
+
|
|
127
|
+
```typescript
|
|
128
|
+
export function buildParentSnapshot(
|
|
129
|
+
ctx: ExtensionContext,
|
|
130
|
+
inheritContext?: boolean,
|
|
131
|
+
): ParentSnapshot {
|
|
132
|
+
return {
|
|
133
|
+
cwd: ctx.cwd,
|
|
134
|
+
systemPrompt: ctx.getSystemPrompt(),
|
|
135
|
+
model: ctx.model,
|
|
136
|
+
modelRegistry: ctx.modelRegistry,
|
|
137
|
+
parentContext: inheritContext ? buildParentContext(ctx) : undefined,
|
|
138
|
+
};
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
This is the only place that touches `ExtensionContext` to build a snapshot.
|
|
143
|
+
It calls `buildParentContext(ctx)` (from `context.ts`) which reads `ctx.sessionManager.getBranch()` — capturing the conversation at spawn time, not dequeue time.
|
|
144
|
+
|
|
145
|
+
### SpawnArgs changes
|
|
146
|
+
|
|
147
|
+
```typescript
|
|
148
|
+
// Before
|
|
149
|
+
interface SpawnArgs {
|
|
150
|
+
pi: ExtensionAPI;
|
|
151
|
+
ctx: ExtensionContext;
|
|
152
|
+
type: SubagentType;
|
|
153
|
+
prompt: string;
|
|
154
|
+
options: SpawnOptions;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
// After
|
|
158
|
+
interface SpawnArgs {
|
|
159
|
+
snapshot: ParentSnapshot;
|
|
160
|
+
type: SubagentType;
|
|
161
|
+
prompt: string;
|
|
162
|
+
options: SpawnOptions;
|
|
163
|
+
}
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### AgentRunner.run() signature change
|
|
167
|
+
|
|
168
|
+
```typescript
|
|
169
|
+
// Before
|
|
170
|
+
run(ctx: ExtensionContext, type: SubagentType, prompt: string, options: RunOptions): Promise<RunResult>;
|
|
171
|
+
|
|
172
|
+
// After
|
|
173
|
+
run(snapshot: ParentSnapshot, type: SubagentType, prompt: string, options: RunOptions): Promise<RunResult>;
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### RunOptions changes
|
|
177
|
+
|
|
178
|
+
```typescript
|
|
179
|
+
// Removed fields:
|
|
180
|
+
// pi: ExtensionAPI → replaced by exec: ShellExec
|
|
181
|
+
// inheritContext?: boolean → handled by snapshot.parentContext
|
|
182
|
+
|
|
183
|
+
// Added field:
|
|
184
|
+
exec: ShellExec;
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### runAgent flow changes
|
|
188
|
+
|
|
189
|
+
Inside `runAgent()`, all `ctx.*` reads become `snapshot.*` reads:
|
|
190
|
+
|
|
191
|
+
```typescript
|
|
192
|
+
// Before
|
|
193
|
+
const effectiveCwd = options.cwd ?? ctx.cwd;
|
|
194
|
+
const env = await detectEnv(options.pi, effectiveCwd);
|
|
195
|
+
const cfg = assembleSessionConfig(type, {
|
|
196
|
+
cwd: ctx.cwd,
|
|
197
|
+
parentSystemPrompt: ctx.getSystemPrompt(),
|
|
198
|
+
parentModel: ctx.model,
|
|
199
|
+
modelRegistry: ctx.modelRegistry,
|
|
200
|
+
}, ...);
|
|
201
|
+
|
|
202
|
+
// After
|
|
203
|
+
const effectiveCwd = options.cwd ?? snapshot.cwd;
|
|
204
|
+
const env = await detectEnv(options.exec, effectiveCwd);
|
|
205
|
+
const cfg = assembleSessionConfig(type, {
|
|
206
|
+
cwd: snapshot.cwd,
|
|
207
|
+
parentSystemPrompt: snapshot.systemPrompt,
|
|
208
|
+
parentModel: snapshot.model,
|
|
209
|
+
modelRegistry: snapshot.modelRegistry,
|
|
210
|
+
}, ...);
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
The `inheritContext` block changes:
|
|
214
|
+
|
|
215
|
+
```typescript
|
|
216
|
+
// Before
|
|
217
|
+
if (options.inheritContext) {
|
|
218
|
+
const parentContext = buildParentContext(ctx);
|
|
219
|
+
if (parentContext) effectivePrompt = parentContext + prompt;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
// After
|
|
223
|
+
if (snapshot.parentContext) {
|
|
224
|
+
effectivePrompt = snapshot.parentContext + prompt;
|
|
225
|
+
}
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
The `createAgentSession()` call changes:
|
|
229
|
+
|
|
230
|
+
```typescript
|
|
231
|
+
// Before: modelRegistry: ctx.modelRegistry
|
|
232
|
+
// After: modelRegistry: snapshot.modelRegistry as ModelRegistry
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### AgentManager constructor change
|
|
236
|
+
|
|
237
|
+
```typescript
|
|
238
|
+
export interface AgentManagerOptions {
|
|
239
|
+
runner: AgentRunner;
|
|
240
|
+
worktrees: WorktreeManager;
|
|
241
|
+
exec: ShellExec; // NEW — injected from pi.exec
|
|
242
|
+
maxConcurrent?: number;
|
|
243
|
+
getRunConfig?: () => RunConfig;
|
|
244
|
+
onStart?: OnAgentStart;
|
|
245
|
+
onComplete?: OnAgentComplete;
|
|
246
|
+
onCompact?: OnAgentCompact;
|
|
247
|
+
}
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
`startAgent()` uses `this.exec` when building `RunOptions`:
|
|
251
|
+
|
|
252
|
+
```typescript
|
|
253
|
+
const promise = this.runner.run(snapshot, type, prompt, {
|
|
254
|
+
exec: this.exec,
|
|
255
|
+
model: options.model,
|
|
256
|
+
// ... (no more pi field)
|
|
257
|
+
});
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
### Caller updates
|
|
261
|
+
|
|
262
|
+
`index.ts`:
|
|
263
|
+
|
|
264
|
+
```typescript
|
|
265
|
+
// Before
|
|
266
|
+
const manager = new AgentManager({
|
|
267
|
+
runner: { run: runAgent, resume: resumeAgent },
|
|
268
|
+
worktrees: new GitWorktreeManager(process.cwd()),
|
|
269
|
+
// ...
|
|
270
|
+
});
|
|
271
|
+
|
|
272
|
+
// After — adds exec
|
|
273
|
+
const manager = new AgentManager({
|
|
274
|
+
runner: { run: runAgent, resume: resumeAgent },
|
|
275
|
+
worktrees: new GitWorktreeManager(process.cwd()),
|
|
276
|
+
exec: (cmd, args, opts) => pi.exec(cmd, args, opts),
|
|
277
|
+
// ...
|
|
278
|
+
});
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
Spawn wrappers simplify — no more `pi` injection:
|
|
282
|
+
|
|
283
|
+
```typescript
|
|
284
|
+
// Before
|
|
285
|
+
spawn: (ctx, type, prompt, opts) => manager.spawn(pi, ctx, type, prompt, opts),
|
|
286
|
+
// After
|
|
287
|
+
spawn: (ctx, type, prompt, opts) => manager.spawn(ctx, type, prompt, opts),
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
`service-adapter.ts`:
|
|
291
|
+
|
|
292
|
+
```typescript
|
|
293
|
+
// AgentManagerLike.spawn — drops pi parameter
|
|
294
|
+
spawn(ctx: unknown, type: string, prompt: string, options: unknown): string;
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
`ui/agent-menu.ts` — `spawnAndWait` drops `pi` parameter:
|
|
298
|
+
|
|
299
|
+
```typescript
|
|
300
|
+
// Before
|
|
301
|
+
spawnAndWait: (pi: ExtensionAPI | null, ctx: ExtensionContext, ...) => Promise<AgentRecord>;
|
|
302
|
+
// After
|
|
303
|
+
spawnAndWait: (ctx: ExtensionContext, ...) => Promise<AgentRecord>;
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
## Module-Level Changes
|
|
307
|
+
|
|
308
|
+
### New files
|
|
309
|
+
|
|
310
|
+
1. `src/parent-snapshot.ts` — `buildParentSnapshot()` function (cycle 3).
|
|
311
|
+
2. `test/parent-snapshot.test.ts` — unit tests for the builder (cycle 3).
|
|
312
|
+
|
|
313
|
+
### Changed files (source)
|
|
314
|
+
|
|
315
|
+
Phase 1 (pi elimination):
|
|
316
|
+
|
|
317
|
+
1. `src/types.ts` — add `ShellExec` type (cycle 1); add `ParentSnapshot` interface (cycle 3).
|
|
318
|
+
2. `src/env.ts` — `detectEnv()` accepts `ShellExec` instead of `ExtensionAPI` (cycle 1).
|
|
319
|
+
3. `src/agent-runner.ts` — `RunOptions` replaces `pi` with `exec` (cycle 1); `runAgent()` first param changes to `ParentSnapshot`, removes `inheritContext` from `RunOptions` (cycle 4).
|
|
320
|
+
4. `src/agent-manager.ts` — `AgentManagerOptions` adds `exec`, `startAgent` uses `this.exec` (cycle 1); `spawn`/`spawnAndWait` drop `pi`, `SpawnArgs` drops `pi` (cycle 2); `spawn` builds snapshot, `SpawnArgs` replaces `ctx` with `snapshot` (cycle 5).
|
|
321
|
+
5. `src/index.ts` — pass `exec` to `AgentManager` constructor (cycle 1); simplify `spawn`/`spawnAndWait` wrappers (cycle 2).
|
|
322
|
+
6. `src/service-adapter.ts` — `AgentManagerLike.spawn` drops `pi` (cycle 2).
|
|
323
|
+
7. `src/ui/agent-menu.ts` — `AgentMenuManagerDeps.spawnAndWait` drops `pi` (cycle 2).
|
|
324
|
+
|
|
325
|
+
### Changed files (tests)
|
|
326
|
+
|
|
327
|
+
1. `test/env.test.ts` — `mockPi()` → `mockExec()` (cycle 1).
|
|
328
|
+
2. `test/agent-runner.test.ts` — `{ pi }` → `{ exec: vi.fn() }` (cycle 1); `ctx` mock → `ParentSnapshot` (cycle 4).
|
|
329
|
+
3. `test/agent-runner-extension-tools.test.ts` — same as agent-runner (cycles 1, 4).
|
|
330
|
+
4. `test/agent-manager.test.ts` — add `exec` to `createManager()` (cycle 1); remove `mockPi` from 27 `spawn()` calls (cycle 2); mock `buildParentSnapshot` (cycle 5).
|
|
331
|
+
5. `test/service-adapter.test.ts` — `AgentManagerLike.spawn` mock drops `pi` (cycle 2).
|
|
332
|
+
6. `test/ui/agent-menu.test.ts` — `spawnAndWait` mock drops `pi` (cycle 2).
|
|
333
|
+
|
|
334
|
+
### Unchanged files
|
|
335
|
+
|
|
336
|
+
- `src/service.ts` — public API unchanged.
|
|
337
|
+
- `src/context.ts` — `buildParentContext()` keeps its current signature; called by `buildParentSnapshot()`.
|
|
338
|
+
- `src/session-config.ts` — `AssemblerContext` unchanged; `runAgent` builds it from snapshot fields.
|
|
339
|
+
- `src/agent-record.ts` — unrelated.
|
|
340
|
+
- `src/tools/agent-tool.ts` — already uses narrow `deps.manager` interface without `pi`; the `(ctx, type, prompt, opts)` shape is unchanged.
|
|
341
|
+
- All other source and test files.
|
|
342
|
+
|
|
343
|
+
## Test Impact Analysis
|
|
344
|
+
|
|
345
|
+
### New tests enabled by the extraction
|
|
346
|
+
|
|
347
|
+
- `buildParentSnapshot()` tested in isolation — verifies field mapping and `inheritContext` pre-computation.
|
|
348
|
+
Previously impossible: the snapshot was implicit (live ctx was passed through).
|
|
349
|
+
- `detectEnv()` tests become SDK-free — a plain `ShellExec` stub replaces the `ExtensionAPI` mock.
|
|
350
|
+
|
|
351
|
+
### Existing tests that simplify
|
|
352
|
+
|
|
353
|
+
- `agent-runner.test.ts` — the `ctx` mock loses its methods (`getSystemPrompt: vi.fn()`, `sessionManager.getBranch: vi.fn()`) and becomes a plain data object.
|
|
354
|
+
The `pi` mock (`{} as any`) is replaced by `exec: vi.fn()`.
|
|
355
|
+
Every `runAgent(ctx, ...)` call is a mechanical replacement.
|
|
356
|
+
- `agent-manager.test.ts` — `mockPi` is eliminated entirely (28 spawn calls).
|
|
357
|
+
The `createManager()` helper gains an `exec` field.
|
|
358
|
+
- `env.test.ts` — `mockPi()` factory simplifies to a `vi.fn()` returning exec results.
|
|
359
|
+
|
|
360
|
+
### Existing tests that stay as-is
|
|
361
|
+
|
|
362
|
+
All `agent-manager.test.ts` tests that verify lifecycle (spawn, complete, abort, resume, queue drain, worktree) remain unchanged in intent — they verify the wiring between `AgentManager` and the record/runner.
|
|
363
|
+
Only the mock construction and `spawn()` call sites change mechanically.
|
|
364
|
+
|
|
365
|
+
## TDD Order
|
|
366
|
+
|
|
367
|
+
The cycles are organized into two phases following the Kent Beck principle "make the change that makes the change easy."
|
|
368
|
+
Phase 1 (cycles 1–2) eliminates the `pi` parameter relay — an orthogonal concern that would otherwise cascade through every snapshot cycle.
|
|
369
|
+
Phase 2 (cycles 3–5) introduces `ParentSnapshot`, landing on clean ground.
|
|
370
|
+
|
|
371
|
+
### Phase 1: Eliminate pi relay
|
|
372
|
+
|
|
373
|
+
#### Cycle 1: ShellExec type + exec injection into runner path
|
|
374
|
+
|
|
375
|
+
Test surface: `test/env.test.ts`, `test/agent-runner.test.ts`, `test/agent-runner-extension-tools.test.ts`, `test/agent-manager.test.ts` (updated).
|
|
376
|
+
|
|
377
|
+
This cycle replaces `pi: ExtensionAPI` with `exec: ShellExec` in the runner path (leaf → middle → top), and injects `exec` into `AgentManager`.
|
|
378
|
+
`SpawnArgs` still carries `pi` (unused) — removed in cycle 2.
|
|
379
|
+
|
|
380
|
+
Changes:
|
|
381
|
+
|
|
382
|
+
- `src/types.ts`: add `ShellExec` type.
|
|
383
|
+
- `src/env.ts`: `detectEnv()` accepts `ShellExec` instead of `ExtensionAPI`.
|
|
384
|
+
- `src/agent-runner.ts`: `RunOptions` replaces `pi: ExtensionAPI` with `exec: ShellExec`; `runAgent()` uses `options.exec` for `detectEnv()`; remove `ExtensionAPI` import.
|
|
385
|
+
- `src/agent-manager.ts`: `AgentManagerOptions` adds `exec: ShellExec`; `startAgent()` passes `exec: this.exec` in `RunOptions` instead of `pi` from `SpawnArgs`; stop destructuring `pi` from `SpawnArgs` (it stays in the type for one cycle).
|
|
386
|
+
- `src/index.ts`: pass `exec: (cmd, args, opts) => pi.exec(cmd, args, opts)` to `AgentManager` constructor.
|
|
387
|
+
- `test/env.test.ts`: `mockPi()` → `mockExec()` returning a `ShellExec` stub.
|
|
388
|
+
- `test/agent-runner.test.ts`: `{ pi }` → `{ exec: vi.fn() }` in all `runAgent()` calls.
|
|
389
|
+
- `test/agent-runner-extension-tools.test.ts`: same.
|
|
390
|
+
- `test/agent-manager.test.ts`: add `exec: vi.fn()` to `createManager()` defaults.
|
|
391
|
+
- Run full test suite + `pnpm run check`.
|
|
392
|
+
|
|
393
|
+
Commit: `refactor: inject ShellExec into runner path, replacing ExtensionAPI (#99)`
|
|
394
|
+
|
|
395
|
+
#### Cycle 2: Remove pi from spawn path and callers
|
|
396
|
+
|
|
397
|
+
Test surface: `test/agent-manager.test.ts`, `test/service-adapter.test.ts`, `test/ui/agent-menu.test.ts` (updated).
|
|
398
|
+
|
|
399
|
+
With `exec` already injected and `pi` unused in `startAgent()`, this cycle removes it from the remaining surfaces.
|
|
400
|
+
|
|
401
|
+
Changes:
|
|
402
|
+
|
|
403
|
+
- `src/agent-manager.ts`: `SpawnArgs` drops `pi`; `spawn()` drops `pi` parameter; `spawnAndWait()` drops `pi` parameter; remove `ExtensionAPI` import.
|
|
404
|
+
- `src/service-adapter.ts`: `AgentManagerLike.spawn()` drops `pi` parameter; `createSubagentsService().spawn()` passes `session.ctx` only.
|
|
405
|
+
- `src/ui/agent-menu.ts`: `AgentMenuManagerDeps.spawnAndWait()` drops `pi` parameter; call site drops `null` first arg.
|
|
406
|
+
- `src/index.ts`: simplify `spawn` wrapper — `(ctx, type, prompt, opts) => manager.spawn(ctx, type, prompt, opts)`; simplify `spawnAndWait` wrappers similarly.
|
|
407
|
+
- `test/agent-manager.test.ts`: remove `mockPi` constant; drop it from all 27 `spawn()` call sites.
|
|
408
|
+
- `test/service-adapter.test.ts`: update `AgentManagerLike.spawn` mock.
|
|
409
|
+
- `test/ui/agent-menu.test.ts`: update `spawnAndWait` mock.
|
|
410
|
+
- Run full test suite + `pnpm run check`.
|
|
411
|
+
|
|
412
|
+
Commit: `refactor: remove pi parameter from spawn path (#99)`
|
|
413
|
+
|
|
414
|
+
### Phase 2: ParentSnapshot
|
|
415
|
+
|
|
416
|
+
#### Cycle 3: ParentSnapshot type and builder
|
|
417
|
+
|
|
418
|
+
Test surface: `test/parent-snapshot.test.ts` (new file).
|
|
419
|
+
|
|
420
|
+
Tests cover:
|
|
421
|
+
|
|
422
|
+
- Snapshots `cwd`, `systemPrompt` (from `getSystemPrompt()`), `model`, `modelRegistry` from a mock `ctx`.
|
|
423
|
+
- When `inheritContext` is true and conversation exists, `parentContext` is populated.
|
|
424
|
+
- When `inheritContext` is false or undefined, `parentContext` is undefined.
|
|
425
|
+
- When `inheritContext` is true but conversation is empty, `parentContext` is undefined.
|
|
426
|
+
|
|
427
|
+
Changes:
|
|
428
|
+
|
|
429
|
+
- Add `ParentSnapshot` interface to `src/types.ts`.
|
|
430
|
+
- Create `src/parent-snapshot.ts` with `buildParentSnapshot()`.
|
|
431
|
+
- Create `test/parent-snapshot.test.ts`.
|
|
432
|
+
|
|
433
|
+
Commit: `feat: add ParentSnapshot type and builder (#99)`
|
|
434
|
+
|
|
435
|
+
#### Cycle 4: runAgent and AgentRunner accept ParentSnapshot
|
|
436
|
+
|
|
437
|
+
Test surface: `test/agent-runner.test.ts`, `test/agent-runner-extension-tools.test.ts` (updated).
|
|
438
|
+
|
|
439
|
+
With `pi` already eliminated (phase 1), this cycle only changes the first parameter of `runAgent()` — no other `RunOptions` churn.
|
|
440
|
+
|
|
441
|
+
Changes:
|
|
442
|
+
|
|
443
|
+
- `src/agent-runner.ts`:
|
|
444
|
+
- `runAgent()` first parameter: `ctx: ExtensionContext` → `snapshot: ParentSnapshot`.
|
|
445
|
+
- `AgentRunner.run()` interface: first parameter changes to `snapshot: ParentSnapshot`.
|
|
446
|
+
- Remove `inheritContext` from `RunOptions` (snapshot has `parentContext`).
|
|
447
|
+
- `inheritContext` block → `if (snapshot.parentContext)`.
|
|
448
|
+
- `assembleSessionConfig` and `createAgentSession` calls read from `snapshot.*` instead of `ctx.*`.
|
|
449
|
+
- Remove `ExtensionContext` import; remove `buildParentContext` import (no longer called here).
|
|
450
|
+
- `test/agent-runner.test.ts`: replace `ctx` mock with a plain `ParentSnapshot` object.
|
|
451
|
+
- `test/agent-runner-extension-tools.test.ts`: same.
|
|
452
|
+
- Run `pnpm run check` — catches `agent-manager.ts` type error in `startAgent()`'s `runner.run()` call (still passing `ctx`); addressed in cycle 5.
|
|
453
|
+
|
|
454
|
+
Commit: `refactor: AgentRunner accepts ParentSnapshot instead of ExtensionContext (#99)`
|
|
455
|
+
|
|
456
|
+
#### Cycle 5: AgentManager spawn builds snapshot
|
|
457
|
+
|
|
458
|
+
Test surface: `test/agent-manager.test.ts` (updated).
|
|
459
|
+
|
|
460
|
+
Changes:
|
|
461
|
+
|
|
462
|
+
- `src/agent-manager.ts`:
|
|
463
|
+
- `spawn()` calls `buildParentSnapshot(ctx, options.inheritContext)` and stores the snapshot in `SpawnArgs`.
|
|
464
|
+
- `SpawnArgs`: replace `ctx: ExtensionContext` with `snapshot: ParentSnapshot`.
|
|
465
|
+
- `startAgent()` destructures `snapshot` from `SpawnArgs`; passes it to `runner.run(snapshot, ...)`.
|
|
466
|
+
- Remove `ExtensionContext` import.
|
|
467
|
+
- `test/agent-manager.test.ts`: `vi.mock("../src/parent-snapshot.js")` to isolate `buildParentSnapshot`; `mockCtx` stays minimal (`{ cwd: "/tmp" } as any`) because `spawn()` delegates to the mocked builder.
|
|
468
|
+
- Run full test suite + `pnpm run check`.
|
|
469
|
+
|
|
470
|
+
Commit: `refactor: AgentManager captures ParentSnapshot at spawn time (#99)`
|
|
471
|
+
|
|
472
|
+
## Risks and Mitigations
|
|
473
|
+
|
|
474
|
+
| Risk | Mitigation |
|
|
475
|
+
| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
476
|
+
| `modelRegistry` is a reference capture, not a data copy — could theoretically go stale | Registries are structurally stable within a session; the staleness risk applies to `cwd`/`systemPrompt`/`model`/conversation, all of which are value-captured |
|
|
477
|
+
| Large test files (~410 + ~686 lines) need mechanical updates | Phase 1 handles `pi` churn (27 spawn calls) separately from phase 2's `ctx` → `snapshot` change, so each cycle touches one concern per test file |
|
|
478
|
+
| `spawn()` still receives `ctx` — caller could accidentally use it post-snapshot | `ctx` is a function parameter, not stored; `SpawnArgs` holds only the snapshot; the type system prevents re-storing ctx since `SpawnArgs.ctx` no longer exists |
|
|
479
|
+
| `buildParentContext` still accepts `ExtensionContext` — mocking it requires a nested `sessionManager` mock | The mock only appears in `parent-snapshot.test.ts` (one place); a follow-up could narrow `buildParentContext` to accept just the branch data |
|
|
480
|
+
| Phase 1 temporarily leaves `pi` in `SpawnArgs` (cycle 1) before removing it (cycle 2) | The field is unused after cycle 1 (`startAgent` uses `this.exec` instead); cycle 2 removes it in the next commit |
|
|
481
|
+
|
|
482
|
+
## Open Questions
|
|
483
|
+
|
|
484
|
+
- Whether to narrow `buildParentContext()` to accept `getBranch()` data directly instead of `ExtensionContext`.
|
|
485
|
+
This would eliminate the last `ExtensionContext` usage in the snapshot path but is a separate refactoring of `context.ts`.
|
|
486
|
+
Deferred — the current `buildParentSnapshot` wrapper isolates the SDK dependency to one module.
|
|
487
|
+
- Whether `runtime.currentCtx` should be simplified from `{ pi, ctx }` to just `ctx` now that `pi` is not passed to `spawn()`.
|
|
488
|
+
Natural follow-up but out of scope — `currentCtx.pi` has no other consumers and removing it is a 3-line change.
|