mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-15 19:05:11 +00:00
Major changes: - Replace monolithic SessionEvent with reason discriminator with individual event types: session_start, session_before_switch, session_switch, session_before_new, session_new, session_before_branch, session_branch, session_before_compact, session_compact, session_shutdown - Each event has dedicated result type (SessionBeforeSwitchResult, etc.) - HookHandler type now allows bare return statements (void in return type) - HookAPI.on() has proper overloads for each event with correct typing Additional fixes: - AgentSession now always subscribes to agent in constructor (was only subscribing when external subscribe() called, breaking internal handlers) - Standardize on undefined over null throughout codebase - HookUIContext methods return undefined instead of null - SessionManager methods return undefined instead of null - Simplify hook exports to 'export type * from types.js' - Add detailed JSDoc for skipConversationRestore vs cancel - Fix createBranchedSession to rebuild index in persist mode - newSession() now returns the session file path Updated all example hooks, tests, and emission sites to use new event types.
413 lines
12 KiB
TypeScript
413 lines
12 KiB
TypeScript
/**
|
|
* Tests for compaction hook events (before_compact / compact).
|
|
*/
|
|
|
|
import { existsSync, mkdirSync, rmSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import { join } from "node:path";
|
|
import { Agent } from "@mariozechner/pi-agent-core";
|
|
import { getModel } from "@mariozechner/pi-ai";
|
|
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
import { AgentSession } from "../src/core/agent-session.js";
|
|
import { AuthStorage } from "../src/core/auth-storage.js";
|
|
import {
|
|
HookRunner,
|
|
type LoadedHook,
|
|
type SessionBeforeCompactEvent,
|
|
type SessionCompactEvent,
|
|
type SessionEvent,
|
|
} from "../src/core/hooks/index.js";
|
|
import { ModelRegistry } from "../src/core/model-registry.js";
|
|
import { SessionManager } from "../src/core/session-manager.js";
|
|
import { SettingsManager } from "../src/core/settings-manager.js";
|
|
import { codingTools } from "../src/core/tools/index.js";
|
|
|
|
const API_KEY = process.env.ANTHROPIC_OAUTH_TOKEN || process.env.ANTHROPIC_API_KEY;
|
|
|
|
describe.skipIf(!API_KEY)("Compaction hooks", () => {
|
|
let session: AgentSession;
|
|
let tempDir: string;
|
|
let hookRunner: HookRunner;
|
|
let capturedEvents: SessionEvent[];
|
|
|
|
beforeEach(() => {
|
|
tempDir = join(tmpdir(), `pi-compaction-hooks-test-${Date.now()}`);
|
|
mkdirSync(tempDir, { recursive: true });
|
|
capturedEvents = [];
|
|
});
|
|
|
|
afterEach(async () => {
|
|
if (session) {
|
|
session.dispose();
|
|
}
|
|
if (tempDir && existsSync(tempDir)) {
|
|
rmSync(tempDir, { recursive: true });
|
|
}
|
|
});
|
|
|
|
function createHook(
|
|
onBeforeCompact?: (event: SessionBeforeCompactEvent) => { cancel?: boolean; compaction?: any } | undefined,
|
|
onCompact?: (event: SessionCompactEvent) => void,
|
|
): LoadedHook {
|
|
const handlers = new Map<string, ((event: any, ctx: any) => Promise<any>)[]>();
|
|
|
|
handlers.set("session_before_compact", [
|
|
async (event: SessionBeforeCompactEvent) => {
|
|
capturedEvents.push(event);
|
|
if (onBeforeCompact) {
|
|
return onBeforeCompact(event);
|
|
}
|
|
return undefined;
|
|
},
|
|
]);
|
|
|
|
handlers.set("session_compact", [
|
|
async (event: SessionCompactEvent) => {
|
|
capturedEvents.push(event);
|
|
if (onCompact) {
|
|
onCompact(event);
|
|
}
|
|
return undefined;
|
|
},
|
|
]);
|
|
|
|
return {
|
|
path: "test-hook",
|
|
resolvedPath: "/test/test-hook.ts",
|
|
handlers,
|
|
messageRenderers: new Map(),
|
|
commands: new Map(),
|
|
setSendMessageHandler: () => {},
|
|
setAppendEntryHandler: () => {},
|
|
};
|
|
}
|
|
|
|
function createSession(hooks: LoadedHook[]) {
|
|
const model = getModel("anthropic", "claude-sonnet-4-5")!;
|
|
const agent = new Agent({
|
|
getApiKey: () => API_KEY,
|
|
initialState: {
|
|
model,
|
|
systemPrompt: "You are a helpful assistant. Be concise.",
|
|
tools: codingTools,
|
|
},
|
|
});
|
|
|
|
const sessionManager = SessionManager.create(tempDir);
|
|
const settingsManager = SettingsManager.create(tempDir, tempDir);
|
|
const authStorage = new AuthStorage(join(tempDir, "auth.json"));
|
|
const modelRegistry = new ModelRegistry(authStorage);
|
|
|
|
hookRunner = new HookRunner(hooks, tempDir, sessionManager, modelRegistry);
|
|
hookRunner.setUIContext(
|
|
{
|
|
select: async () => undefined,
|
|
confirm: async () => false,
|
|
input: async () => undefined,
|
|
notify: () => {},
|
|
custom: () => ({ close: () => {}, requestRender: () => {} }),
|
|
},
|
|
false,
|
|
);
|
|
|
|
session = new AgentSession({
|
|
agent,
|
|
sessionManager,
|
|
settingsManager,
|
|
hookRunner,
|
|
modelRegistry,
|
|
});
|
|
|
|
return session;
|
|
}
|
|
|
|
it("should emit before_compact and compact events", async () => {
|
|
const hook = createHook();
|
|
createSession([hook]);
|
|
|
|
await session.prompt("What is 2+2? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
await session.prompt("What is 3+3? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
await session.compact();
|
|
|
|
const beforeCompactEvents = capturedEvents.filter(
|
|
(e): e is SessionBeforeCompactEvent => e.type === "session_before_compact",
|
|
);
|
|
const compactEvents = capturedEvents.filter((e): e is SessionCompactEvent => e.type === "session_compact");
|
|
|
|
expect(beforeCompactEvents.length).toBe(1);
|
|
expect(compactEvents.length).toBe(1);
|
|
|
|
const beforeEvent = beforeCompactEvents[0];
|
|
expect(beforeEvent.preparation).toBeDefined();
|
|
expect(beforeEvent.preparation.cutPoint.firstKeptEntryIndex).toBeGreaterThanOrEqual(0);
|
|
expect(beforeEvent.preparation.messagesToSummarize).toBeDefined();
|
|
expect(beforeEvent.preparation.messagesToKeep).toBeDefined();
|
|
expect(beforeEvent.preparation.tokensBefore).toBeGreaterThanOrEqual(0);
|
|
expect(beforeEvent.model).toBeDefined();
|
|
// sessionManager and modelRegistry are now on ctx, not event
|
|
|
|
const afterEvent = compactEvents[0];
|
|
expect(afterEvent.compactionEntry).toBeDefined();
|
|
expect(afterEvent.compactionEntry.summary.length).toBeGreaterThan(0);
|
|
expect(afterEvent.compactionEntry.tokensBefore).toBeGreaterThanOrEqual(0);
|
|
expect(afterEvent.fromHook).toBe(false);
|
|
}, 120000);
|
|
|
|
it("should allow hooks to cancel compaction", async () => {
|
|
const hook = createHook(() => ({ cancel: true }));
|
|
createSession([hook]);
|
|
|
|
await session.prompt("What is 2+2? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
await expect(session.compact()).rejects.toThrow("Compaction cancelled");
|
|
|
|
const compactEvents = capturedEvents.filter((e) => e.type === "session_compact");
|
|
expect(compactEvents.length).toBe(0);
|
|
}, 120000);
|
|
|
|
it("should allow hooks to provide custom compaction", async () => {
|
|
const customSummary = "Custom summary from hook";
|
|
|
|
const hook = createHook((event) => {
|
|
if (event.type === "session_before_compact") {
|
|
return {
|
|
compaction: {
|
|
summary: customSummary,
|
|
firstKeptEntryId: event.preparation.firstKeptEntryId,
|
|
tokensBefore: event.preparation.tokensBefore,
|
|
},
|
|
};
|
|
}
|
|
return undefined;
|
|
});
|
|
createSession([hook]);
|
|
|
|
await session.prompt("What is 2+2? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
await session.prompt("What is 3+3? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
const result = await session.compact();
|
|
|
|
expect(result.summary).toBe(customSummary);
|
|
|
|
const compactEvents = capturedEvents.filter((e) => e.type === "session_compact");
|
|
expect(compactEvents.length).toBe(1);
|
|
|
|
const afterEvent = compactEvents[0];
|
|
if (afterEvent.type === "session_compact") {
|
|
expect(afterEvent.compactionEntry.summary).toBe(customSummary);
|
|
expect(afterEvent.fromHook).toBe(true);
|
|
}
|
|
}, 120000);
|
|
|
|
it("should include entries in compact event after compaction is saved", async () => {
|
|
const hook = createHook();
|
|
createSession([hook]);
|
|
|
|
await session.prompt("What is 2+2? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
await session.compact();
|
|
|
|
const compactEvents = capturedEvents.filter((e) => e.type === "session_compact");
|
|
expect(compactEvents.length).toBe(1);
|
|
|
|
const afterEvent = compactEvents[0];
|
|
if (afterEvent.type === "session_compact") {
|
|
// sessionManager is now on ctx, use session.sessionManager directly
|
|
const entries = session.sessionManager.getEntries();
|
|
const hasCompactionEntry = entries.some((e: { type: string }) => e.type === "compaction");
|
|
expect(hasCompactionEntry).toBe(true);
|
|
}
|
|
}, 120000);
|
|
|
|
it("should continue with default compaction if hook throws error", async () => {
|
|
const throwingHook: LoadedHook = {
|
|
path: "throwing-hook",
|
|
resolvedPath: "/test/throwing-hook.ts",
|
|
handlers: new Map<string, ((event: any, ctx: any) => Promise<any>)[]>([
|
|
[
|
|
"session_before_compact",
|
|
[
|
|
async (event: SessionBeforeCompactEvent) => {
|
|
capturedEvents.push(event);
|
|
throw new Error("Hook intentionally throws");
|
|
},
|
|
],
|
|
],
|
|
[
|
|
"session_compact",
|
|
[
|
|
async (event: SessionCompactEvent) => {
|
|
capturedEvents.push(event);
|
|
return undefined;
|
|
},
|
|
],
|
|
],
|
|
]),
|
|
messageRenderers: new Map(),
|
|
commands: new Map(),
|
|
setSendMessageHandler: () => {},
|
|
setAppendEntryHandler: () => {},
|
|
};
|
|
|
|
createSession([throwingHook]);
|
|
|
|
await session.prompt("What is 2+2? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
const result = await session.compact();
|
|
|
|
expect(result.summary).toBeDefined();
|
|
expect(result.summary.length).toBeGreaterThan(0);
|
|
|
|
const compactEvents = capturedEvents.filter((e): e is SessionCompactEvent => e.type === "session_compact");
|
|
expect(compactEvents.length).toBe(1);
|
|
expect(compactEvents[0].fromHook).toBe(false);
|
|
}, 120000);
|
|
|
|
it("should call multiple hooks in order", async () => {
|
|
const callOrder: string[] = [];
|
|
|
|
const hook1: LoadedHook = {
|
|
path: "hook1",
|
|
resolvedPath: "/test/hook1.ts",
|
|
handlers: new Map<string, ((event: any, ctx: any) => Promise<any>)[]>([
|
|
[
|
|
"session_before_compact",
|
|
[
|
|
async () => {
|
|
callOrder.push("hook1-before");
|
|
return undefined;
|
|
},
|
|
],
|
|
],
|
|
[
|
|
"session_compact",
|
|
[
|
|
async () => {
|
|
callOrder.push("hook1-after");
|
|
return undefined;
|
|
},
|
|
],
|
|
],
|
|
]),
|
|
messageRenderers: new Map(),
|
|
commands: new Map(),
|
|
setSendMessageHandler: () => {},
|
|
setAppendEntryHandler: () => {},
|
|
};
|
|
|
|
const hook2: LoadedHook = {
|
|
path: "hook2",
|
|
resolvedPath: "/test/hook2.ts",
|
|
handlers: new Map<string, ((event: any, ctx: any) => Promise<any>)[]>([
|
|
[
|
|
"session_before_compact",
|
|
[
|
|
async () => {
|
|
callOrder.push("hook2-before");
|
|
return undefined;
|
|
},
|
|
],
|
|
],
|
|
[
|
|
"session_compact",
|
|
[
|
|
async () => {
|
|
callOrder.push("hook2-after");
|
|
return undefined;
|
|
},
|
|
],
|
|
],
|
|
]),
|
|
messageRenderers: new Map(),
|
|
commands: new Map(),
|
|
setSendMessageHandler: () => {},
|
|
setAppendEntryHandler: () => {},
|
|
};
|
|
|
|
createSession([hook1, hook2]);
|
|
|
|
await session.prompt("What is 2+2? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
await session.compact();
|
|
|
|
expect(callOrder).toEqual(["hook1-before", "hook2-before", "hook1-after", "hook2-after"]);
|
|
}, 120000);
|
|
|
|
it("should pass correct data in before_compact event", async () => {
|
|
let capturedBeforeEvent: SessionBeforeCompactEvent | null = null;
|
|
|
|
const hook = createHook((event) => {
|
|
capturedBeforeEvent = event;
|
|
return undefined;
|
|
});
|
|
createSession([hook]);
|
|
|
|
await session.prompt("What is 2+2? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
await session.prompt("What is 3+3? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
await session.compact();
|
|
|
|
expect(capturedBeforeEvent).not.toBeNull();
|
|
const event = capturedBeforeEvent!;
|
|
expect(event.preparation.cutPoint).toHaveProperty("firstKeptEntryIndex");
|
|
expect(event.preparation.cutPoint).toHaveProperty("isSplitTurn");
|
|
expect(event.preparation.cutPoint).toHaveProperty("turnStartIndex");
|
|
|
|
expect(Array.isArray(event.preparation.messagesToSummarize)).toBe(true);
|
|
expect(Array.isArray(event.preparation.messagesToKeep)).toBe(true);
|
|
|
|
expect(typeof event.preparation.tokensBefore).toBe("number");
|
|
|
|
expect(event.model).toHaveProperty("provider");
|
|
expect(event.model).toHaveProperty("id");
|
|
|
|
// sessionManager and modelRegistry are now on ctx, not event
|
|
// Verify they're accessible via session
|
|
expect(typeof session.sessionManager.getEntries).toBe("function");
|
|
expect(typeof session.modelRegistry.getApiKey).toBe("function");
|
|
|
|
const entries = session.sessionManager.getEntries();
|
|
expect(Array.isArray(entries)).toBe(true);
|
|
expect(entries.length).toBeGreaterThan(0);
|
|
}, 120000);
|
|
|
|
it("should use hook compaction even with different values", async () => {
|
|
const customSummary = "Custom summary with modified values";
|
|
|
|
const hook = createHook((event) => {
|
|
if (event.type === "session_before_compact") {
|
|
return {
|
|
compaction: {
|
|
summary: customSummary,
|
|
firstKeptEntryId: event.preparation.firstKeptEntryId,
|
|
tokensBefore: 999,
|
|
},
|
|
};
|
|
}
|
|
return undefined;
|
|
});
|
|
createSession([hook]);
|
|
|
|
await session.prompt("What is 2+2? Reply with just the number.");
|
|
await session.agent.waitForIdle();
|
|
|
|
const result = await session.compact();
|
|
|
|
expect(result.summary).toBe(customSummary);
|
|
expect(result.tokensBefore).toBe(999);
|
|
}, 120000);
|
|
});
|