feat: add tool_result_persist hook

src/agents/session-tool-result-guard.tool-result-persist-hook.test.ts

@@ -0,0 +1,133 @@
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
+import type { AgentMessage } from "@mariozechner/pi-agent-core";
+import { SessionManager } from "@mariozechner/pi-coding-agent";
+import { describe, expect, it, afterEach } from "vitest";
+
+import { loadClawdbotPlugins } from "../plugins/loader.js";
+import { resetGlobalHookRunner } from "../plugins/hook-runner-global.js";
+import { guardSessionManager } from "./session-tool-result-guard-wrapper.js";
+
+const EMPTY_CONFIG_SCHEMA = `configSchema: {
+  validate: () => ({ ok: true }),
+  jsonSchema: { type: "object", additionalProperties: true },
+  uiHints: {}
+}`;
+
+function writeTempPlugin(params: { dir: string; id: string; body: string }): string {
+  const file = path.join(params.dir, `${params.id}.mjs`);
+  fs.writeFileSync(file, params.body, "utf-8");
+  return file;
+}
+
+afterEach(() => {
+  resetGlobalHookRunner();
+});
+
+describe("tool_result_persist hook", () => {
+  it("does not modify persisted toolResult messages when no hook is registered", () => {
+    const sm = guardSessionManager(SessionManager.inMemory(), {
+      agentId: "main",
+      sessionKey: "main",
+    });
+
+    sm.appendMessage({
+      role: "assistant",
+      content: [{ type: "toolCall", id: "call_1", name: "read", arguments: {} }],
+    } as AgentMessage);
+
+    sm.appendMessage({
+      role: "toolResult",
+      toolCallId: "call_1",
+      isError: false,
+      content: [{ type: "text", text: "ok" }],
+      details: { big: "x".repeat(10_000) },
+    } as any);
+
+    const messages = sm
+      .getEntries()
+      .filter((e) => e.type === "message")
+      .map((e) => (e as { message: AgentMessage }).message);
+
+    const toolResult = messages.find((m) => (m as any).role === "toolResult") as any;
+    expect(toolResult).toBeTruthy();
+    expect(toolResult.details).toBeTruthy();
+  });
+
+  it("composes transforms in priority order and allows stripping toolResult.details", () => {
+    const tmp = fs.mkdtempSync(path.join(os.tmpdir(), "clawdbot-toolpersist-"));
+    process.env.CLAWDBOT_BUNDLED_PLUGINS_DIR = "/nonexistent/bundled/plugins";
+
+    const pluginA = writeTempPlugin({
+      dir: tmp,
+      id: "persist-a",
+      body: `export default { id: "persist-a", ${EMPTY_CONFIG_SCHEMA}, register(api) {
+  api.on("tool_result_persist", (event, ctx) => {
+    const msg = event.message;
+    // Example: remove large diagnostic payloads before persistence.
+    const { details: _details, ...rest } = msg;
+    return { message: { ...rest, persistOrder: ["a"], agentSeen: ctx.agentId ?? null } };
+  }, { priority: 10 });
+} };`,
+    });
+
+    const pluginB = writeTempPlugin({
+      dir: tmp,
+      id: "persist-b",
+      body: `export default { id: "persist-b", ${EMPTY_CONFIG_SCHEMA}, register(api) {
+  api.on("tool_result_persist", (event) => {
+    const prior = (event.message && event.message.persistOrder) ? event.message.persistOrder : [];
+    return { message: { ...event.message, persistOrder: [...prior, "b"] } };
+  }, { priority: 5 });
+} };`,
+    });
+
+    loadClawdbotPlugins({
+      cache: false,
+      workspaceDir: tmp,
+      config: {
+        plugins: {
+          load: { paths: [pluginA, pluginB] },
+          allow: ["persist-a", "persist-b"],
+        },
+      },
+    });
+
+    const sm = guardSessionManager(SessionManager.inMemory(), {
+      agentId: "main",
+      sessionKey: "main",
+    });
+
+    // Tool call (so the guard can infer tool name -> id mapping).
+    sm.appendMessage({
+      role: "assistant",
+      content: [{ type: "toolCall", id: "call_1", name: "read", arguments: {} }],
+    } as AgentMessage);
+
+    // Tool result containing a large-ish details payload.
+    sm.appendMessage({
+      role: "toolResult",
+      toolCallId: "call_1",
+      isError: false,
+      content: [{ type: "text", text: "ok" }],
+      details: { big: "x".repeat(10_000) },
+    } as any);
+
+    const messages = sm
+      .getEntries()
+      .filter((e) => e.type === "message")
+      .map((e) => (e as { message: AgentMessage }).message);
+
+    const toolResult = messages.find((m) => (m as any).role === "toolResult") as any;
+    expect(toolResult).toBeTruthy();
+
+    // Default behavior: strip details.
+    expect(toolResult.details).toBeUndefined();
+
+    // Hook composition: priority 10 runs before priority 5.
+    expect(toolResult.persistOrder).toEqual(["a", "b"]);
+    expect(toolResult.agentSeen).toBe("main");
+  });
+});