Files
oh-my-pi/packages/coding-agent/test/task/executor-pass-through.test.ts
T
roboomp dde53a8f18 fix(task): forward custom-tool paths to subagents, rebind tools per session
Reviewer flagged that forwarding `LoadedCustomTool[]` from a parent session
to a subagent reused tool instances whose factories had closed over the
parent's `CustomToolAPI` — `cwd`, `exec`, `pushPendingAction`, and `ui` all
pointed at the parent. In isolated tasks the tool would `exec` against the
parent worktree and queue pending actions on the parent session.

Forward only the path list; let each session rebuild tools through
`loadCustomTools` so factories see the right `CustomToolAPI`.

- `extensibility/custom-tools/loader.ts`: extract `discoverCustomToolPaths`
  (FS scan only) from `discoverAndLoadCustomTools`; export
  `ToolPathWithSource`. The combined helper is now `discoverCustomToolPaths`
  + `loadCustomTools`.
- `sdk.ts`: replace `preloadedCustomTools` (`LoadedCustomTool[]`) with
  `preloadedCustomToolPaths` (`ToolPathWithSource[]`). The custom-tools
  block runs `loadCustomTools` unconditionally; only the path scan is
  skipped when the caller pre-discovered it.
- `tools/index.ts`: `ToolSession.loadedCustomTools` →
  `ToolSession.customToolPaths` for the same reason.
- `task/executor.ts` and `task/index.ts`: forward `customToolPaths`.
  Drop the forward for isolated subagents — the worktree shifts `cwd`, so
  the subagent re-discovers tools against its own working tree.
- New `test/sdk-custom-tools-per-session-binding.test.ts` pins the contract:
  two `loadCustomTools` calls on the same path with different `cwd` and
  different `pushPendingAction` callbacks yield distinct tool instances
  whose factories see the per-call bindings.
- Updated `executor-pass-through` and `sdk-preloaded-extensions-isolation`
  tests for the new option name and added a `ToolPathWithSource` fixture.

Refs PR review on #2193
2026-06-09 14:09:37 +00:00

140 lines
5.0 KiB
TypeScript

/**
* Verifies parent-discovered rules, extensions, and custom tools are forwarded
* to `createAgentSession` so subagents skip the FS scans the parent already
* paid for. Regression guard for issue #2190.
*/
import { afterEach, describe, expect, it, vi } from "bun:test";
import type { Rule } from "@oh-my-pi/pi-coding-agent/capability/rule";
import type { ModelRegistry } from "@oh-my-pi/pi-coding-agent/config/model-registry";
import { Settings } from "@oh-my-pi/pi-coding-agent/config/settings";
import type { ToolPathWithSource } from "@oh-my-pi/pi-coding-agent/extensibility/custom-tools";
import type { LoadExtensionsResult } from "@oh-my-pi/pi-coding-agent/extensibility/extensions/types";
import type { CreateAgentSessionResult } from "@oh-my-pi/pi-coding-agent/sdk";
import * as sdkModule from "@oh-my-pi/pi-coding-agent/sdk";
import type { AgentSession, AgentSessionEvent, PromptOptions } from "@oh-my-pi/pi-coding-agent/session/agent-session";
import { runSubprocess } from "@oh-my-pi/pi-coding-agent/task/executor";
import type { AgentDefinition } from "@oh-my-pi/pi-coding-agent/task/types";
import { EventBus } from "@oh-my-pi/pi-coding-agent/utils/event-bus";
function createMockSession(onPrompt: (params: { emit: (event: AgentSessionEvent) => void }) => void): AgentSession {
const listeners: Array<(event: AgentSessionEvent) => void> = [];
const emit = (event: AgentSessionEvent) => {
for (const listener of listeners) listener(event);
};
const session = {
state: { messages: [] },
agent: { state: { systemPrompt: ["test"] } },
model: undefined,
extensionRunner: undefined,
sessionManager: { appendSessionInit: () => {} },
getActiveToolNames: () => ["read", "yield"],
setActiveToolsByName: async (_toolNames: string[]) => {},
subscribe: (listener: (event: AgentSessionEvent) => void) => {
listeners.push(listener);
return () => {
const index = listeners.indexOf(listener);
if (index >= 0) listeners.splice(index, 1);
};
},
prompt: async (_text: string, _options?: PromptOptions) => {
onPrompt({ emit });
},
waitForIdle: async () => {},
getLastAssistantMessage: () => undefined,
abort: async () => {},
dispose: async () => {},
};
return session as unknown as AgentSession;
}
function yieldEmittingSession(): AgentSession {
return createMockSession(({ emit }) => {
emit({
type: "tool_execution_end",
toolCallId: "tool-pass-through",
toolName: "yield",
result: {
content: [{ type: "text", text: "Result submitted." }],
details: { status: "success", data: { ok: true } },
},
isError: false,
});
});
}
function createSessionResult(session: AgentSession): CreateAgentSessionResult {
return {
session,
extensionsResult: { extensions: [], errors: [], runtime: {} as unknown } as unknown as LoadExtensionsResult,
setToolUIContext: () => {},
eventBus: new EventBus(),
};
}
const baseAgent: AgentDefinition = {
name: "task",
description: "test",
systemPrompt: "test",
source: "bundled",
};
const baseOptions = {
cwd: "/tmp",
agent: baseAgent,
task: "do work",
index: 0,
id: "subagent-pass-through",
settings: Settings.isolated(),
modelRegistry: { refresh: async () => {} } as unknown as ModelRegistry,
enableLsp: false,
};
describe("runSubprocess parent-discovery pass-through (issue #2190)", () => {
afterEach(() => {
vi.restoreAllMocks();
});
it("forwards rules, preloadedExtensions, and preloadedCustomToolPaths to createAgentSession", async () => {
const session = yieldEmittingSession();
const spy = vi.spyOn(sdkModule, "createAgentSession").mockResolvedValue(createSessionResult(session));
const rules: Rule[] = [{ name: "rule-a" } as unknown as Rule];
const preloadedExtensions = {
extensions: [],
errors: [],
runtime: { sentinel: "runtime" } as unknown,
} as unknown as LoadExtensionsResult;
const preloadedCustomToolPaths: ToolPathWithSource[] = [
{ path: "tools/x.ts", source: { provider: "config", providerName: "Config", level: "project" } },
];
const result = await runSubprocess({
...baseOptions,
rules,
preloadedExtensions,
preloadedCustomToolPaths,
});
expect(result.exitCode).toBe(0);
expect(spy).toHaveBeenCalledTimes(1);
const forwarded = spy.mock.calls[0]?.[0];
// Identity, not equality: passing a clone would defeat the perf fix.
expect(forwarded?.rules).toBe(rules);
expect(forwarded?.preloadedExtensions).toBe(preloadedExtensions);
expect(forwarded?.preloadedCustomToolPaths).toBe(preloadedCustomToolPaths);
});
it("forwards undefined when the parent has not pre-discovered state", async () => {
const session = yieldEmittingSession();
const spy = vi.spyOn(sdkModule, "createAgentSession").mockResolvedValue(createSessionResult(session));
const result = await runSubprocess({ ...baseOptions });
expect(result.exitCode).toBe(0);
const forwarded = spy.mock.calls[0]?.[0];
expect(forwarded?.rules).toBeUndefined();
expect(forwarded?.preloadedExtensions).toBeUndefined();
expect(forwarded?.preloadedCustomToolPaths).toBeUndefined();
});
});