gateway: harden before_reset transcript loading

This commit is contained in:
Vincent Koc
2026-03-09 11:36:14 -07:00
parent 4096a9c6a1
commit 712821e87d
5 changed files with 186 additions and 19 deletions

View File

@@ -55,6 +55,7 @@ export async function emitResetCommandHooks(params: {
sessionKey?: string;
sessionEntry?: HandleCommandsParams["sessionEntry"];
previousSessionEntry?: HandleCommandsParams["previousSessionEntry"];
storePath?: HandleCommandsParams["storePath"];
workspaceDir: string;
}): Promise<void> {
const hookEvent = createInternalHookEvent("command", params.action, params.sessionKey ?? "", {
@@ -95,6 +96,7 @@ export async function emitResetCommandHooks(params: {
previousSessionEntry: params.previousSessionEntry,
workspaceDir: params.workspaceDir,
reason: params.action,
storePath: params.storePath,
});
}
@@ -211,6 +213,7 @@ export async function handleCommands(params: HandleCommandsParams): Promise<Comm
sessionKey: boundAcpKey,
sessionEntry: hookSessionEntry,
previousSessionEntry: hookPreviousSessionEntry,
storePath: params.storePath,
workspaceDir: params.workspaceDir,
});
if (resetTail) {
@@ -250,6 +253,7 @@ export async function handleCommands(params: HandleCommandsParams): Promise<Comm
sessionKey: params.sessionKey,
sessionEntry: params.sessionEntry,
previousSessionEntry: params.previousSessionEntry,
storePath: params.storePath,
workspaceDir: params.workspaceDir,
});
}

View File

@@ -0,0 +1,99 @@
import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import type { HookRunner } from "../../plugins/hooks.js";
const hookRunnerMocks = vi.hoisted(() => ({
hasHooks: vi.fn<HookRunner["hasHooks"]>(),
runBeforeReset: vi.fn<HookRunner["runBeforeReset"]>(),
}));
vi.mock("../../plugins/hook-runner-global.js", () => ({
getGlobalHookRunner: () =>
({
hasHooks: hookRunnerMocks.hasHooks,
runBeforeReset: hookRunnerMocks.runBeforeReset,
}) as unknown as HookRunner,
}));
const { emitBeforeResetPluginHook } = await import("./reset-hooks.js");
describe("emitBeforeResetPluginHook", () => {
let tempDir: string;
let storePath: string;
beforeEach(async () => {
tempDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-before-reset-"));
storePath = path.join(tempDir, "sessions.json");
hookRunnerMocks.hasHooks.mockReset();
hookRunnerMocks.runBeforeReset.mockReset();
hookRunnerMocks.hasHooks.mockImplementation((hookName) => hookName === "before_reset");
hookRunnerMocks.runBeforeReset.mockResolvedValue(undefined);
});
afterEach(async () => {
await fs.rm(tempDir, { recursive: true, force: true });
vi.restoreAllMocks();
});
it("re-resolves transcript paths within the session store directory", async () => {
const transcriptPath = path.join(tempDir, "sess-main.jsonl");
await fs.writeFile(
transcriptPath,
`${JSON.stringify({ type: "message", message: { role: "user", content: "hello" } })}\n`,
"utf-8",
);
const resolvedTranscriptPath = await fs.realpath(transcriptPath).catch(() => transcriptPath);
await emitBeforeResetPluginHook({
sessionKey: "agent:main:main",
previousSessionEntry: {
sessionId: "sess-main",
sessionFile: "../../etc/passwd",
},
workspaceDir: "/tmp/openclaw-workspace",
reason: "new",
storePath,
});
expect(hookRunnerMocks.runBeforeReset).toHaveBeenCalledWith(
expect.objectContaining({
sessionFile: resolvedTranscriptPath,
messages: [{ role: "user", content: "hello" }],
reason: "new",
}),
expect.objectContaining({
agentId: "main",
sessionKey: "agent:main:main",
sessionId: "sess-main",
}),
);
});
it("caps extracted transcript messages to a bounded maximum", async () => {
const transcriptPath = path.join(tempDir, "sess-cap.jsonl");
const lines = Array.from({ length: 1_050 }, (_, index) =>
JSON.stringify({ type: "message", message: { role: "user", content: `m-${index}` } }),
).join("\n");
await fs.writeFile(transcriptPath, `${lines}\n`, "utf-8");
await emitBeforeResetPluginHook({
sessionKey: "agent:main:main",
previousSessionEntry: {
sessionId: "sess-cap",
sessionFile: "sess-cap.jsonl",
},
workspaceDir: "/tmp/openclaw-workspace",
reason: "reset",
storePath,
});
const [event] = hookRunnerMocks.runBeforeReset.mock.calls[0] ?? [];
const messages = event?.messages;
expect(Array.isArray(messages)).toBe(true);
expect(messages).toHaveLength(1_000);
expect(messages?.[0]).toEqual({ role: "user", content: "m-0" });
expect(messages?.at(-1)).toEqual({ role: "user", content: "m-999" });
});
});

View File

@@ -1,4 +1,7 @@
import { createReadStream } from "node:fs";
import fs from "node:fs/promises";
import readline from "node:readline";
import { resolveSessionFilePath, resolveSessionFilePathOptions } from "../../config/sessions.js";
import { logVerbose } from "../../globals.js";
import { getGlobalHookRunner } from "../../plugins/hook-runner-global.js";
import { resolveAgentIdFromSessionKey } from "../../routing/session-key.js";
@@ -8,11 +11,68 @@ type BeforeResetSessionEntry = {
sessionFile?: string;
} | null;
const MAX_BEFORE_RESET_TRANSCRIPT_BYTES = 2 * 1024 * 1024;
const MAX_BEFORE_RESET_TRANSCRIPT_LINES = 10_000;
const MAX_BEFORE_RESET_MESSAGES = 1_000;
async function readBoundedBeforeResetMessages(sessionFile: string): Promise<unknown[]> {
const stat = await fs.stat(sessionFile);
if (stat.size > MAX_BEFORE_RESET_TRANSCRIPT_BYTES) {
logVerbose(
`before_reset: transcript exceeds ${MAX_BEFORE_RESET_TRANSCRIPT_BYTES} bytes; skipping message extraction`,
);
return [];
}
const messages: unknown[] = [];
let lineCount = 0;
let bytesRead = 0;
let truncated = false;
const stream = createReadStream(sessionFile, { encoding: "utf-8" });
const rl = readline.createInterface({ input: stream, crlfDelay: Infinity });
try {
for await (const line of rl) {
lineCount += 1;
bytesRead += Buffer.byteLength(line, "utf-8") + 1;
if (
lineCount > MAX_BEFORE_RESET_TRANSCRIPT_LINES ||
bytesRead > MAX_BEFORE_RESET_TRANSCRIPT_BYTES ||
messages.length >= MAX_BEFORE_RESET_MESSAGES
) {
truncated = true;
break;
}
if (!line.trim()) {
continue;
}
try {
const entry = JSON.parse(line);
if (entry.type === "message" && entry.message) {
messages.push(entry.message);
}
} catch {
// Skip malformed transcript lines.
}
}
} finally {
rl.close();
stream.destroy();
}
if (truncated) {
logVerbose("before_reset: transcript parsing truncated to bounded limits");
}
return messages;
}
export async function emitBeforeResetPluginHook(params: {
sessionKey?: string;
previousSessionEntry?: BeforeResetSessionEntry;
workspaceDir: string;
reason: string;
storePath?: string;
}): Promise<void> {
const hookRunner = getGlobalHookRunner();
if (!hookRunner?.hasHooks("before_reset")) {
@@ -20,34 +80,34 @@ export async function emitBeforeResetPluginHook(params: {
}
const prevEntry = params.previousSessionEntry;
const sessionFile = prevEntry?.sessionFile;
const sessionId = prevEntry?.sessionId;
const agentId = resolveAgentIdFromSessionKey(params.sessionKey);
const pathOpts = resolveSessionFilePathOptions({
agentId,
storePath: params.storePath,
});
let sessionFile: string | undefined;
try {
const messages: unknown[] = [];
if (sessionFile) {
const content = await fs.readFile(sessionFile, "utf-8");
for (const line of content.split("\n")) {
if (!line.trim()) {
continue;
}
try {
const entry = JSON.parse(line);
if (entry.type === "message" && entry.message) {
messages.push(entry.message);
}
} catch {
// Skip malformed transcript lines.
}
let messages: unknown[] = [];
if (sessionId) {
sessionFile = resolveSessionFilePath(sessionId, prevEntry ?? undefined, pathOpts);
try {
messages = await readBoundedBeforeResetMessages(sessionFile);
} catch (err: unknown) {
logVerbose(`before_reset: failed reading transcript messages: ${String(err)}`);
}
} else if (prevEntry?.sessionFile) {
logVerbose("before_reset: session file present without session id; skipping transcript read");
} else {
logVerbose("before_reset: no session file available, firing hook with empty messages");
}
await hookRunner.runBeforeReset(
{ sessionFile, messages, reason: params.reason },
{
agentId: resolveAgentIdFromSessionKey(params.sessionKey),
agentId,
sessionKey: params.sessionKey,
sessionId: prevEntry?.sessionId,
sessionId,
workspaceDir: params.workspaceDir,
},
);

View File

@@ -508,6 +508,7 @@ export const sessionsHandlers: GatewayRequestHandlers = {
previousSessionEntry: entry,
workspaceDir: resolveAgentWorkspaceDir(cfg, target.agentId),
reason: commandReason,
storePath,
});
let oldSessionId: string | undefined;
let oldSessionFile: string | undefined;

View File

@@ -1191,6 +1191,9 @@ describe("gateway server sessions", () => {
test("sessions.reset runs before_reset plugin hooks with gateway session context", async () => {
const { dir } = await createSessionStoreDir();
await writeSingleLineSession(dir, "sess-main", "hello");
const resolvedTranscriptPath = await fs
.realpath(path.join(dir, "sess-main.jsonl"))
.catch(() => path.join(dir, "sess-main.jsonl"));
await writeSessionStore({
entries: {
@@ -1213,7 +1216,7 @@ describe("gateway server sessions", () => {
await vi.waitFor(() => expect(beforeResetHookMocks.runBeforeReset).toHaveBeenCalledTimes(1));
expect(beforeResetHookMocks.runBeforeReset).toHaveBeenCalledWith(
expect.objectContaining({
sessionFile: path.join(dir, "sess-main.jsonl"),
sessionFile: resolvedTranscriptPath,
reason: "new",
}),
expect.objectContaining({