import crypto from "node:crypto"; import { describe, expect, it } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; import { resolveUserPath } from "../utils.js"; import { createCacheTrace } from "./cache-trace.js"; describe("createCacheTrace", () => { it("returns null when diagnostics cache tracing is disabled", () => { const trace = createCacheTrace({ cfg: {} as OpenClawConfig, env: {}, }); expect(trace).toBeNull(); }); it("honors diagnostics cache trace config and expands file paths", () => { const lines: string[] = []; const trace = createCacheTrace({ cfg: { diagnostics: { cacheTrace: { enabled: true, filePath: "~/.openclaw/logs/cache-trace.jsonl", }, }, }, env: {}, writer: { filePath: "memory", write: (line) => lines.push(line), }, }); expect(trace).not.toBeNull(); expect(trace?.filePath).toBe(resolveUserPath("~/.openclaw/logs/cache-trace.jsonl")); trace?.recordStage("session:loaded", { messages: [], system: "sys", }); expect(lines.length).toBe(1); }); it("records empty prompt/system values when enabled", () => { const lines: string[] = []; const trace = createCacheTrace({ cfg: { diagnostics: { cacheTrace: { enabled: true, includePrompt: true, includeSystem: true, }, }, }, env: {}, writer: { filePath: "memory", write: (line) => lines.push(line), }, }); trace?.recordStage("prompt:before", { prompt: "", system: "" }); const event = JSON.parse(lines[0]?.trim() ?? "{}") as Record; expect(event.prompt).toBe(""); expect(event.system).toBe(""); }); it("respects env overrides for enablement", () => { const lines: string[] = []; const trace = createCacheTrace({ cfg: { diagnostics: { cacheTrace: { enabled: true, }, }, }, env: { OPENCLAW_CACHE_TRACE: "0", }, writer: { filePath: "memory", write: (line) => lines.push(line), }, }); expect(trace).toBeNull(); }); it("sanitizes cache-trace payloads before writing", () => { const lines: string[] = []; const trace = createCacheTrace({ cfg: { diagnostics: { cacheTrace: { enabled: true, }, }, }, env: {}, writer: { filePath: "memory", write: (line) => lines.push(line), }, }); trace?.recordStage("stream:context", { system: { provider: { apiKey: "sk-system-secret", baseUrl: "https://api.example.com" }, }, model: { id: "test-model", apiKey: "sk-model-secret", tokenCount: 8192, }, options: { apiKey: "sk-options-secret", nested: { password: "super-secret-password", safe: "keep-me", tokenCount: 42, }, images: [{ type: "image", mimeType: "image/png", data: "QUJDRA==" }], }, messages: [ { role: "user", token: "message-secret-token", metadata: { secretKey: "message-secret-key", label: "preserve-me", }, content: [ { type: "image", source: { type: "base64", media_type: "image/jpeg", data: "U0VDUkVU" }, }, ], }, ] as unknown as [], }); const event = JSON.parse(lines[0]?.trim() ?? "{}") as Record; expect(event.system).toEqual({ provider: { baseUrl: "https://api.example.com", }, }); expect(event.model).toEqual({ id: "test-model", tokenCount: 8192, }); expect(event.options).toEqual({ nested: { safe: "keep-me", tokenCount: 42, }, images: [ { type: "image", mimeType: "image/png", data: "", bytes: 4, sha256: crypto.createHash("sha256").update("QUJDRA==").digest("hex"), }, ], }); const optionsImages = ( ((event.options as { images?: unknown[] } | undefined)?.images ?? []) as Array< Record > )[0]; expect(optionsImages?.data).toBe(""); expect(optionsImages?.bytes).toBe(4); expect(optionsImages?.sha256).toBe( crypto.createHash("sha256").update("QUJDRA==").digest("hex"), ); const firstMessage = ((event.messages as Array> | undefined) ?? [])[0]; expect(firstMessage).not.toHaveProperty("token"); expect(firstMessage).not.toHaveProperty("metadata.secretKey"); expect(firstMessage).toMatchObject({ role: "user", metadata: { label: "preserve-me", }, }); const source = (((firstMessage?.content as Array> | undefined) ?? [])[0] ?.source ?? {}) as Record; expect(source.data).toBe(""); expect(source.bytes).toBe(6); expect(source.sha256).toBe(crypto.createHash("sha256").update("U0VDUkVU").digest("hex")); }); it("handles circular references in messages without stack overflow", () => { const lines: string[] = []; const trace = createCacheTrace({ cfg: { diagnostics: { cacheTrace: { enabled: true, }, }, }, env: {}, writer: { filePath: "memory", write: (line) => lines.push(line), }, }); const parent: Record = { role: "user", content: "hello" }; const child: Record = { ref: parent }; parent.child = child; // circular reference trace?.recordStage("prompt:images", { messages: [parent] as unknown as [], }); expect(lines.length).toBe(1); const event = JSON.parse(lines[0]?.trim() ?? "{}") as Record; expect(event.messageCount).toBe(1); expect(event.messageFingerprints).toHaveLength(1); }); });