@research-copilot/plugin 1.1.17 → 1.1.19

package/dist/skills/llm-wiki/workbench/server/src/tool-status-events.test.ts

@@ -0,0 +1,363 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+
+import type { AgentEvent } from "@earendil-works/pi-agent-core";
+
+import {
+	buildToolStatusContractFixture,
+	formatToolDisplay,
+	OrderedSseWriter,
+	PromptRunRegistry,
+	ToolStatusEventAdapter,
+	type ToolStatusContractEvent,
+} from "./tool-status-events.js";
+
+test("tool status adapter emits v1 ordered contract fields", () => {
+	const adapter = createAdapter();
+	const events = [
+		...adapter.adapt(textDelta("hello")),
+		...adapter.adapt(startEvent("read-1", "read", { path: "/Users/example/private/a.md" })),
+		...adapter.finishAssistant(),
+	];
+
+	assert.deepEqual(
+		events.map((event) => ({
+			schemaVersion: event.schemaVersion,
+			runId: event.runId,
+			messageId: event.messageId,
+			seq: event.seq,
+			type: event.type,
+		})),
+		[
+			{ schemaVersion: 1, runId: "run-1", messageId: "message-1", seq: 1, type: "assistant_text_delta" },
+			{ schemaVersion: 1, runId: "run-1", messageId: "message-1", seq: 2, type: "tool_status_start" },
+			{ schemaVersion: 1, runId: "run-1", messageId: "message-1", seq: 3, type: "tool_status_summary" },
+			{ schemaVersion: 1, runId: "run-1", messageId: "message-1", seq: 4, type: "assistant_done" },
+		],
+	);
+});
+
+test("tool status adapter covers start, update, end, failure, and missing args", () => {
+	const adapter = createAdapter();
+
+	const start = expectEvent(adapter.adapt(startEvent("bash-1", "bash", undefined))[0], "tool_status_start");
+	const update = expectEvent(adapter.adapt({
+		type: "tool_execution_update",
+		toolCallId: "bash-1",
+		toolName: "bash",
+		args: undefined,
+		partialResult: { details: { command: "npm run typecheck" } },
+	})[0], "tool_status_update");
+	const failed = expectEvent(adapter.adapt({
+		type: "tool_execution_end",
+		toolCallId: "bash-1",
+		toolName: "bash",
+		result: { error: "failed in /Users/example/private/project" },
+		isError: true,
+	})[0], "tool_status_end");
+
+	assert.equal(start.type, "tool_status_start");
+	assert.equal(start.action, "运行命令");
+	assert.equal(start.target, "未知命令");
+	assert.deepEqual(start.args, {});
+	assert.equal(update.type, "tool_status_update");
+	assert.equal(update.target, "npm run typecheck");
+	assert.equal(failed.type, "tool_status_end");
+	assert.equal(failed.status, "failed");
+	assert.equal(failed.error, "failed in ~/private/project");
+	assert.equal(failed.runningToolCount, 0);
+});
+
+test("tool status adapter formats common tool actions and targets", () => {
+	const redaction = { homeDir: "/Users/example" };
+
+	assert.deepEqual(formatToolDisplay("read", { path: "/Users/example/wiki/index.md" }, undefined, redaction), {
+		action: "读取",
+		target: "~/wiki/index.md",
+	});
+	assert.deepEqual(formatToolDisplay("write", { filePath: "/Users/example/wiki/new.md" }, undefined, redaction), {
+		action: "写入",
+		target: "~/wiki/new.md",
+	});
+	assert.deepEqual(formatToolDisplay("bash", { command: "npm run typecheck --workspace=@llm-wiki-agent/server" }, undefined, redaction), {
+		action: "运行命令",
+		target: "npm run typecheck --workspace=@llm-wiki-agent/server",
+	});
+	assert.deepEqual(formatToolDisplay("search", { query: "tool status", path: "/Users/example/wiki" }, undefined, redaction), {
+		action: "搜索",
+		target: "tool status in ~/wiki",
+	});
+	assert.deepEqual(formatToolDisplay("skill", { skillName: "llm-wiki" }, undefined, redaction), {
+		action: "调用 Skill",
+		target: "llm-wiki",
+	});
+});
+
+test("tool status adapter redacts home paths and long command targets", () => {
+	const adapter = createAdapter();
+	const longCommand = [
+		"node",
+		"/Users/example/private/really/long/path/that/should/not/leak/source.js",
+		"--token",
+		"secret",
+		"--output",
+		"/Users/example/private/really/long/path/that/should/not/leak/output.json",
+	].join(" ");
+
+	const start = expectEvent(adapter.adapt(startEvent("bash-1", "bash", { command: longCommand }))[0], "tool_status_start");
+	const end = expectEvent(adapter.adapt({
+		type: "tool_execution_end",
+		toolCallId: "bash-1",
+		toolName: "bash",
+		result: {
+			content: [
+				{
+					type: "text",
+					text: `wrote /Users/example/private/really/long/path/that/should/not/leak/output.json`,
+				},
+			],
+		},
+		isError: false,
+	})[0], "tool_status_end");
+
+	assert.equal(start.type, "tool_status_start");
+	assert.equal(end.type, "tool_status_end");
+	assert.equal(start.target.includes("/Users/example"), false);
+	assert.equal(JSON.stringify(start).includes("/Users/example"), false);
+	assert.equal(JSON.stringify(end).includes("/Users/example"), false);
+	assert.ok(start.target.length <= 120);
+	assert.ok(end.summary && end.summary.length <= 160);
+});
+
+test("tool status adapter keeps parallel tools independent", () => {
+	const adapter = createAdapter();
+
+	const startA = expectEvent(adapter.adapt(startEvent("read-1", "read", { path: "/Users/example/a.md" }))[0], "tool_status_start");
+	const startB = expectEvent(adapter.adapt(startEvent("write-1", "write", { path: "/Users/example/b.md" }))[0], "tool_status_start");
+	const endB = expectEvent(adapter.adapt({
+		type: "tool_execution_end",
+		toolCallId: "write-1",
+		toolName: "write",
+		result: { content: [{ type: "text", text: "wrote b.md" }] },
+		isError: false,
+	})[0], "tool_status_end");
+
+	assert.equal(startA.type, "tool_status_start");
+	assert.equal(startA.runningToolCount, 1);
+	assert.equal(startA.otherRunningCount, 0);
+	assert.equal(startB.type, "tool_status_start");
+	assert.equal(startB.runningToolCount, 2);
+	assert.equal(startB.otherRunningCount, 1);
+	assert.equal(endB.type, "tool_status_end");
+	assert.equal(endB.toolCallId, "write-1");
+	assert.equal(endB.runningToolCount, 1);
+	assert.deepEqual(adapter.getRunningTools().map((tool) => tool.toolCallId), ["read-1"]);
+});
+
+test("tool status adapter emits cancelled endings for active tools", () => {
+	const adapter = createAdapter();
+	adapter.adapt(startEvent("read-1", "read", { path: "/Users/example/a.md" }));
+	adapter.adapt(startEvent("write-1", "write", { path: "/Users/example/b.md" }));
+
+	const cancelled = adapter.cancelAssistant("client disconnected from /Users/example/private");
+
+	assert.deepEqual(cancelled.map((event) => event.type), [
+		"tool_status_end",
+		"tool_status_end",
+		"assistant_cancelled",
+	]);
+	assert.equal(JSON.stringify(cancelled).includes("/Users/example"), false);
+	assert.deepEqual(adapter.getRunningTools(), []);
+});
+
+test("manual tool events cover knowledge-base retrieval lifecycle", () => {
+	const adapter = createAdapter();
+
+	const start = adapter.startTool({
+		toolCallId: "knowledge-search-1",
+		toolName: "knowledge_search",
+		args: { query: "OpenClaw", path: "/Users/example/wiki" },
+	});
+	const done = adapter.endTool({
+		toolCallId: "knowledge-search-1",
+		toolName: "knowledge_search",
+		result: { summary: "found 2 pages", paths: ["/Users/example/wiki/a.md"] },
+	});
+	const failed = adapter.endTool({
+		toolCallId: "knowledge-search-2",
+		toolName: "knowledge_search",
+		result: { error: "read failed at /Users/example/wiki/private.md" },
+		isError: true,
+	});
+
+	assert.equal(start.type, "tool_status_start");
+	assert.equal(start.action, "搜索");
+	assert.equal(start.target, "OpenClaw in ~/wiki");
+	assert.equal(done.type, "tool_status_end");
+	assert.equal(done.status, "done");
+	assert.equal(done.summary, "found 2 pages");
+	assert.equal(failed.status, "failed");
+	assert.equal(failed.error, "read failed at ~/wiki/private.md");
+});
+
+test("ordered SSE writer serializes mixed async writes", async () => {
+	const order: string[] = [];
+	const writer = new OrderedSseWriter(async (payload) => {
+		await new Promise((resolve) => setTimeout(resolve, payload.event === "slow" ? 5 : 0));
+		order.push(`${payload.event}:${payload.data}`);
+	});
+
+	const first = writer.writeNamed("slow", "1");
+	const second = writer.writeNamed("fast", "2");
+	await Promise.all([second, first]);
+	await writer.flush();
+
+	assert.deepEqual(order, ["slow:1", "fast:2"]);
+});
+
+test("prompt run registry rejects same-session concurrency and releases owner", () => {
+	const registry = new PromptRunRegistry();
+
+	assert.equal(registry.begin("session-1", "run-a"), true);
+	assert.equal(registry.begin("session-1", "run-b"), false);
+	assert.equal(registry.get("session-1"), "run-a");
+	registry.end("session-1", "run-b");
+	assert.equal(registry.get("session-1"), "run-a");
+	registry.end("session-1", "run-a");
+	assert.equal(registry.begin("session-1", "run-b"), true);
+});
+
+test("tool status contract fixture snapshots shared sample events", () => {
+	const fixture = buildToolStatusContractFixture();
+	const compact = fixture.map(compactEvent);
+
+	assert.deepEqual(compact, [
+		{
+			type: "assistant_text_delta",
+			seq: 1,
+			delta: "我来检查。",
+		},
+		{
+			type: "tool_status_start",
+			seq: 2,
+			toolCallId: "read-1",
+			toolName: "read",
+			action: "读取",
+			target: "~/projects/private/source.md",
+			status: "running",
+			runningToolCount: 1,
+			otherRunningCount: 0,
+		},
+		{
+			type: "tool_status_update",
+			seq: 3,
+			toolCallId: "read-1",
+			toolName: "read",
+			action: "读取",
+			target: "~/projects/private/source.md",
+			status: "running",
+			runningToolCount: 1,
+			otherRunningCount: 0,
+		},
+		{
+			type: "tool_status_end",
+			seq: 4,
+			toolCallId: "read-1",
+			toolName: "read",
+			action: "读取",
+			target: "~/projects/private/source.md",
+			status: "done",
+			runningToolCount: 0,
+			otherRunningCount: 0,
+		},
+		{
+			type: "tool_status_summary",
+			seq: 5,
+			items: [
+				{
+					toolCallId: "read-1",
+					toolName: "read",
+					action: "读取",
+					target: "~/projects/private/source.md",
+					status: "done",
+					summary: "ok ~/projects/private/source.md",
+				},
+			],
+			remainingRunningCount: 0,
+		},
+		{
+			type: "assistant_done",
+			seq: 6,
+		},
+	]);
+	assert.equal(JSON.stringify(fixture).includes("/Users/example"), false);
+});
+
+function createAdapter() {
+	let now = 1_000;
+	return new ToolStatusEventAdapter({
+		runId: "run-1",
+		messageId: "message-1",
+		homeDir: "/Users/example",
+		now: () => {
+			now += 25;
+			return now;
+		},
+	});
+}
+
+function textDelta(delta: string): AgentEvent {
+	return {
+		type: "message_update",
+		message: { role: "assistant", content: [] },
+		assistantMessageEvent: {
+			type: "text_delta",
+			contentIndex: 0,
+			delta,
+			partial: { role: "assistant", content: [{ type: "text", text: delta }] },
+		},
+	} as unknown as AgentEvent;
+}
+
+function startEvent(toolCallId: string, toolName: string, args: unknown): AgentEvent {
+	return {
+		type: "tool_execution_start",
+		toolCallId,
+		toolName,
+		args,
+	};
+}
+
+function compactEvent(event: ToolStatusContractEvent): Record<string, unknown> {
+	const base = { type: event.type, seq: event.seq };
+	if (event.type === "assistant_text_delta") return { ...base, delta: event.delta };
+	if (
+		event.type === "assistant_done" ||
+		event.type === "assistant_error" ||
+		event.type === "assistant_cancelled"
+	) {
+		return base;
+	}
+	if (event.type === "tool_status_summary") {
+		return { ...base, items: event.items, remainingRunningCount: event.remainingRunningCount };
+	}
+	return {
+		...base,
+		toolCallId: event.toolCallId,
+		toolName: event.toolName,
+		action: event.action,
+		target: event.target,
+		status: event.status,
+		runningToolCount: event.runningToolCount,
+		otherRunningCount: event.otherRunningCount,
+	};
+}
+
+function expectEvent<T extends ToolStatusContractEvent["type"]>(
+	event: ToolStatusContractEvent | undefined,
+	type: T,
+): Extract<ToolStatusContractEvent, { type: T }> {
+	assert.ok(event);
+	assert.equal(event.type, type);
+	return event as Extract<ToolStatusContractEvent, { type: T }>;
+}