mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 22:41:36 +00:00
fix: unify session maintenance and cron run pruning (#13083)
* fix: prune stale session entries, cap entry count, and rotate sessions.json
The sessions.json file grows unbounded over time. Every heartbeat tick (default: 30m)
triggers multiple full rewrites, and session keys from groups, threads, and DMs
accumulate indefinitely with large embedded objects (skillsSnapshot,
systemPromptReport). At >50MB the synchronous JSON parse blocks the event loop,
causing Telegram webhook timeouts and effectively taking the bot down.
Three mitigations, all running inside saveSessionStoreUnlocked() on every write:
1. Prune stale entries: remove entries with updatedAt older than 30 days
(configurable via session.maintenance.pruneDays in openclaw.json)
2. Cap entry count: keep only the 500 most recently updated entries
(configurable via session.maintenance.maxEntries). Entries without updatedAt
are evicted first.
3. File rotation: if the existing sessions.json exceeds 10MB before a write,
rename it to sessions.json.bak.{timestamp} and keep only the 3 most recent
backups (configurable via session.maintenance.rotateBytes).
All three thresholds are configurable under session.maintenance in openclaw.json
with Zod validation. No env vars.
Existing tests updated to use Date.now() instead of epoch-relative timestamps
(1, 2, 3) that would be incorrectly pruned as stale.
27 new tests covering pruning, capping, rotation, and integration scenarios.
* feat: auto-prune expired cron run sessions (#12289)
Add TTL-based reaper for isolated cron run sessions that accumulate
indefinitely in sessions.json.
New config option:
cron.sessionRetention: string | false (default: '24h')
The reaper runs piggy-backed on the cron timer tick, self-throttled
to sweep at most every 5 minutes. It removes session entries matching
the pattern cron:<jobId>:run:<uuid> whose updatedAt + retention < now.
Design follows the Kubernetes ttlSecondsAfterFinished pattern:
- Sessions are persisted normally (observability/debugging)
- A periodic reaper prunes expired entries
- Configurable retention with sensible default
- Set to false to disable pruning entirely
Files changed:
- src/config/types.cron.ts: Add sessionRetention to CronConfig
- src/config/zod-schema.ts: Add Zod validation for sessionRetention
- src/cron/session-reaper.ts: New reaper module (sweepCronRunSessions)
- src/cron/session-reaper.test.ts: 12 tests covering all paths
- src/cron/service/state.ts: Add cronConfig/sessionStorePath to deps
- src/cron/service/timer.ts: Wire reaper into onTimer tick
- src/gateway/server-cron.ts: Pass config and session store path to deps
Closes #12289
* fix: sweep cron session stores per agent
* docs: add changelog for session maintenance (#13083) (thanks @skyfallsin, @Glucksberg)
* fix: add warn-only session maintenance mode
* fix: warn-only maintenance defaults to active session
* fix: deliver maintenance warnings to active session
* docs: add session maintenance examples
* fix: accept duration and size maintenance thresholds
* refactor: share cron run session key check
* fix: format issues and replace defaultRuntime.warn with console.warn
---------
Co-authored-by: Pradeep Elankumaran <pradeepe@gmail.com>
Co-authored-by: Glucksberg <markuscontasul@gmail.com>
Co-authored-by: max <40643627+quotentiroler@users.noreply.github.com>
Co-authored-by: quotentiroler <max.nussbaumer@maxhealth.tech>
This commit is contained in:
committed by
GitHub
parent
0657d7c772
commit
e19a23520c
562
src/config/sessions/store.pruning.test.ts
Normal file
562
src/config/sessions/store.pruning.test.ts
Normal file
@@ -0,0 +1,562 @@
|
||||
import crypto from "node:crypto";
|
||||
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 { SessionEntry } from "./types.js";
|
||||
import {
|
||||
capEntryCount,
|
||||
clearSessionStoreCacheForTest,
|
||||
loadSessionStore,
|
||||
pruneStaleEntries,
|
||||
rotateSessionFile,
|
||||
saveSessionStore,
|
||||
} from "./store.js";
|
||||
|
||||
// Mock loadConfig so resolveMaintenanceConfig() never reads a real openclaw.json.
|
||||
// Unit tests always pass explicit overrides so this mock is inert for them.
|
||||
// Integration tests set return values to control the config.
|
||||
vi.mock("../config.js", () => ({
|
||||
loadConfig: vi.fn().mockReturnValue({}),
|
||||
}));
|
||||
|
||||
const DAY_MS = 24 * 60 * 60 * 1000;
|
||||
|
||||
function makeEntry(updatedAt: number): SessionEntry {
|
||||
return { sessionId: crypto.randomUUID(), updatedAt };
|
||||
}
|
||||
|
||||
function makeStore(entries: Array<[string, SessionEntry]>): Record<string, SessionEntry> {
|
||||
return Object.fromEntries(entries);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Unit tests — each function called with explicit override parameters.
|
||||
// No config loading needed; overrides bypass resolveMaintenanceConfig().
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("pruneStaleEntries", () => {
|
||||
it("removes entries older than maxAgeDays", () => {
|
||||
const now = Date.now();
|
||||
const store = makeStore([
|
||||
["old", makeEntry(now - 31 * DAY_MS)],
|
||||
["fresh", makeEntry(now - 1 * DAY_MS)],
|
||||
]);
|
||||
|
||||
const pruned = pruneStaleEntries(store, 30 * DAY_MS);
|
||||
|
||||
expect(pruned).toBe(1);
|
||||
expect(store.old).toBeUndefined();
|
||||
expect(store.fresh).toBeDefined();
|
||||
});
|
||||
|
||||
it("keeps entries newer than maxAgeDays", () => {
|
||||
const now = Date.now();
|
||||
const store = makeStore([
|
||||
["a", makeEntry(now - 1 * DAY_MS)],
|
||||
["b", makeEntry(now - 6 * DAY_MS)],
|
||||
["c", makeEntry(now)],
|
||||
]);
|
||||
|
||||
const pruned = pruneStaleEntries(store, 7 * DAY_MS);
|
||||
|
||||
expect(pruned).toBe(0);
|
||||
expect(Object.keys(store)).toHaveLength(3);
|
||||
});
|
||||
|
||||
it("keeps entries with no updatedAt", () => {
|
||||
const store: Record<string, SessionEntry> = {
|
||||
noDate: { sessionId: crypto.randomUUID() } as SessionEntry,
|
||||
fresh: makeEntry(Date.now()),
|
||||
};
|
||||
|
||||
const pruned = pruneStaleEntries(store, 1 * DAY_MS);
|
||||
|
||||
expect(pruned).toBe(0);
|
||||
expect(store.noDate).toBeDefined();
|
||||
});
|
||||
|
||||
it("empty store is a no-op", () => {
|
||||
const store: Record<string, SessionEntry> = {};
|
||||
const pruned = pruneStaleEntries(store, 30 * DAY_MS);
|
||||
|
||||
expect(pruned).toBe(0);
|
||||
expect(Object.keys(store)).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("all entries stale results in empty store", () => {
|
||||
const now = Date.now();
|
||||
const store = makeStore([
|
||||
["a", makeEntry(now - 10 * DAY_MS)],
|
||||
["b", makeEntry(now - 20 * DAY_MS)],
|
||||
["c", makeEntry(now - 100 * DAY_MS)],
|
||||
]);
|
||||
|
||||
const pruned = pruneStaleEntries(store, 5 * DAY_MS);
|
||||
|
||||
expect(pruned).toBe(3);
|
||||
expect(Object.keys(store)).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("returns count of pruned entries", () => {
|
||||
const now = Date.now();
|
||||
const store = makeStore([
|
||||
["stale1", makeEntry(now - 15 * DAY_MS)],
|
||||
["stale2", makeEntry(now - 30 * DAY_MS)],
|
||||
["fresh1", makeEntry(now - 5 * DAY_MS)],
|
||||
["fresh2", makeEntry(now)],
|
||||
]);
|
||||
|
||||
const pruned = pruneStaleEntries(store, 10 * DAY_MS);
|
||||
|
||||
expect(pruned).toBe(2);
|
||||
expect(Object.keys(store)).toHaveLength(2);
|
||||
});
|
||||
|
||||
it("entry exactly at the boundary is kept", () => {
|
||||
const now = Date.now();
|
||||
const store = makeStore([["borderline", makeEntry(now - 30 * DAY_MS + 1000)]]);
|
||||
|
||||
const pruned = pruneStaleEntries(store, 30 * DAY_MS);
|
||||
|
||||
expect(pruned).toBe(0);
|
||||
expect(store.borderline).toBeDefined();
|
||||
});
|
||||
|
||||
it("falls back to built-in default (30 days) when no override given", () => {
|
||||
const now = Date.now();
|
||||
const store = makeStore([
|
||||
["old", makeEntry(now - 31 * DAY_MS)],
|
||||
["fresh", makeEntry(now - 29 * DAY_MS)],
|
||||
]);
|
||||
|
||||
// loadConfig mock returns {} → maintenance is undefined → default 30 days
|
||||
const pruned = pruneStaleEntries(store);
|
||||
|
||||
expect(pruned).toBe(1);
|
||||
expect(store.old).toBeUndefined();
|
||||
expect(store.fresh).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe("capEntryCount", () => {
|
||||
it("over limit: keeps N most recent by updatedAt, deletes rest", () => {
|
||||
const now = Date.now();
|
||||
const store = makeStore([
|
||||
["oldest", makeEntry(now - 4 * DAY_MS)],
|
||||
["old", makeEntry(now - 3 * DAY_MS)],
|
||||
["mid", makeEntry(now - 2 * DAY_MS)],
|
||||
["recent", makeEntry(now - 1 * DAY_MS)],
|
||||
["newest", makeEntry(now)],
|
||||
]);
|
||||
|
||||
const evicted = capEntryCount(store, 3);
|
||||
|
||||
expect(evicted).toBe(2);
|
||||
expect(Object.keys(store)).toHaveLength(3);
|
||||
expect(store.newest).toBeDefined();
|
||||
expect(store.recent).toBeDefined();
|
||||
expect(store.mid).toBeDefined();
|
||||
expect(store.oldest).toBeUndefined();
|
||||
expect(store.old).toBeUndefined();
|
||||
});
|
||||
|
||||
it("under limit: no-op", () => {
|
||||
const store = makeStore([
|
||||
["a", makeEntry(Date.now())],
|
||||
["b", makeEntry(Date.now() - DAY_MS)],
|
||||
]);
|
||||
|
||||
const evicted = capEntryCount(store, 10);
|
||||
|
||||
expect(evicted).toBe(0);
|
||||
expect(Object.keys(store)).toHaveLength(2);
|
||||
});
|
||||
|
||||
it("exactly at limit: no-op", () => {
|
||||
const now = Date.now();
|
||||
const store = makeStore([
|
||||
["a", makeEntry(now)],
|
||||
["b", makeEntry(now - DAY_MS)],
|
||||
["c", makeEntry(now - 2 * DAY_MS)],
|
||||
]);
|
||||
|
||||
const evicted = capEntryCount(store, 3);
|
||||
|
||||
expect(evicted).toBe(0);
|
||||
expect(Object.keys(store)).toHaveLength(3);
|
||||
});
|
||||
|
||||
it("entries without updatedAt are evicted first (lowest priority)", () => {
|
||||
const now = Date.now();
|
||||
const store: Record<string, SessionEntry> = {
|
||||
noDate1: { sessionId: crypto.randomUUID() } as SessionEntry,
|
||||
noDate2: { sessionId: crypto.randomUUID() } as SessionEntry,
|
||||
recent: makeEntry(now),
|
||||
older: makeEntry(now - DAY_MS),
|
||||
};
|
||||
|
||||
const evicted = capEntryCount(store, 2);
|
||||
|
||||
expect(evicted).toBe(2);
|
||||
expect(store.recent).toBeDefined();
|
||||
expect(store.older).toBeDefined();
|
||||
expect(store.noDate1).toBeUndefined();
|
||||
expect(store.noDate2).toBeUndefined();
|
||||
});
|
||||
|
||||
it("returns count of evicted entries", () => {
|
||||
const now = Date.now();
|
||||
const store = makeStore([
|
||||
["a", makeEntry(now)],
|
||||
["b", makeEntry(now - DAY_MS)],
|
||||
["c", makeEntry(now - 2 * DAY_MS)],
|
||||
]);
|
||||
|
||||
const evicted = capEntryCount(store, 1);
|
||||
|
||||
expect(evicted).toBe(2);
|
||||
expect(Object.keys(store)).toHaveLength(1);
|
||||
expect(store.a).toBeDefined();
|
||||
});
|
||||
|
||||
it("falls back to built-in default (500) when no override given", () => {
|
||||
const now = Date.now();
|
||||
const entries: Array<[string, SessionEntry]> = [];
|
||||
for (let i = 0; i < 501; i++) {
|
||||
entries.push([`key-${i}`, makeEntry(now - i * 1000)]);
|
||||
}
|
||||
const store = makeStore(entries);
|
||||
|
||||
// loadConfig mock returns {} → maintenance is undefined → default 500
|
||||
const evicted = capEntryCount(store);
|
||||
|
||||
expect(evicted).toBe(1);
|
||||
expect(Object.keys(store)).toHaveLength(500);
|
||||
expect(store["key-0"]).toBeDefined();
|
||||
expect(store["key-500"]).toBeUndefined();
|
||||
});
|
||||
|
||||
it("empty store is a no-op", () => {
|
||||
const store: Record<string, SessionEntry> = {};
|
||||
|
||||
const evicted = capEntryCount(store, 5);
|
||||
|
||||
expect(evicted).toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe("rotateSessionFile", () => {
|
||||
let testDir: string;
|
||||
let storePath: string;
|
||||
|
||||
beforeEach(async () => {
|
||||
testDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-rotate-"));
|
||||
storePath = path.join(testDir, "sessions.json");
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await fs.rm(testDir, { recursive: true, force: true }).catch(() => undefined);
|
||||
});
|
||||
|
||||
it("file under maxBytes: no rotation (returns false)", async () => {
|
||||
await fs.writeFile(storePath, "x".repeat(500), "utf-8");
|
||||
|
||||
const rotated = await rotateSessionFile(storePath, 1000);
|
||||
|
||||
expect(rotated).toBe(false);
|
||||
const content = await fs.readFile(storePath, "utf-8");
|
||||
expect(content).toBe("x".repeat(500));
|
||||
});
|
||||
|
||||
it("file over maxBytes: renamed to .bak.{timestamp}, returns true", async () => {
|
||||
const bigContent = "x".repeat(200);
|
||||
await fs.writeFile(storePath, bigContent, "utf-8");
|
||||
|
||||
const rotated = await rotateSessionFile(storePath, 100);
|
||||
|
||||
expect(rotated).toBe(true);
|
||||
await expect(fs.stat(storePath)).rejects.toThrow();
|
||||
const files = await fs.readdir(testDir);
|
||||
const bakFiles = files.filter((f) => f.startsWith("sessions.json.bak."));
|
||||
expect(bakFiles).toHaveLength(1);
|
||||
const bakContent = await fs.readFile(path.join(testDir, bakFiles[0]), "utf-8");
|
||||
expect(bakContent).toBe(bigContent);
|
||||
});
|
||||
|
||||
it("multiple rotations: only keeps 3 most recent .bak files", async () => {
|
||||
for (let i = 0; i < 5; i++) {
|
||||
await fs.writeFile(storePath, `data-${i}-${"x".repeat(100)}`, "utf-8");
|
||||
await rotateSessionFile(storePath, 50);
|
||||
await new Promise((r) => setTimeout(r, 5));
|
||||
}
|
||||
|
||||
const files = await fs.readdir(testDir);
|
||||
const bakFiles = files.filter((f) => f.startsWith("sessions.json.bak.")).toSorted();
|
||||
|
||||
expect(bakFiles.length).toBeLessThanOrEqual(3);
|
||||
});
|
||||
|
||||
it("non-existent file: no rotation (returns false)", async () => {
|
||||
const missingPath = path.join(testDir, "missing.json");
|
||||
|
||||
const rotated = await rotateSessionFile(missingPath, 100);
|
||||
|
||||
expect(rotated).toBe(false);
|
||||
});
|
||||
|
||||
it("file exactly at maxBytes: no rotation (returns false)", async () => {
|
||||
await fs.writeFile(storePath, "x".repeat(100), "utf-8");
|
||||
|
||||
const rotated = await rotateSessionFile(storePath, 100);
|
||||
|
||||
expect(rotated).toBe(false);
|
||||
});
|
||||
|
||||
it("backup file name includes a timestamp", async () => {
|
||||
await fs.writeFile(storePath, "x".repeat(100), "utf-8");
|
||||
const before = Date.now();
|
||||
|
||||
await rotateSessionFile(storePath, 50);
|
||||
|
||||
const after = Date.now();
|
||||
const files = await fs.readdir(testDir);
|
||||
const bakFiles = files.filter((f) => f.startsWith("sessions.json.bak."));
|
||||
expect(bakFiles).toHaveLength(1);
|
||||
const timestamp = Number(bakFiles[0].replace("sessions.json.bak.", ""));
|
||||
expect(timestamp).toBeGreaterThanOrEqual(before);
|
||||
expect(timestamp).toBeLessThanOrEqual(after);
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Integration tests — exercise saveSessionStore end-to-end.
|
||||
// The file-level vi.mock("../config.js") stubs loadConfig; per-test
|
||||
// mockReturnValue controls what resolveMaintenanceConfig() returns.
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("Integration: saveSessionStore with pruning", () => {
|
||||
let testDir: string;
|
||||
let storePath: string;
|
||||
let savedCacheTtl: string | undefined;
|
||||
let mockLoadConfig: ReturnType<typeof vi.fn>;
|
||||
|
||||
beforeEach(async () => {
|
||||
testDir = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-pruning-integ-"));
|
||||
storePath = path.join(testDir, "sessions.json");
|
||||
savedCacheTtl = process.env.OPENCLAW_SESSION_CACHE_TTL_MS;
|
||||
process.env.OPENCLAW_SESSION_CACHE_TTL_MS = "0";
|
||||
clearSessionStoreCacheForTest();
|
||||
|
||||
const configModule = await import("../config.js");
|
||||
mockLoadConfig = configModule.loadConfig as ReturnType<typeof vi.fn>;
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
vi.restoreAllMocks();
|
||||
await fs.rm(testDir, { recursive: true, force: true }).catch(() => undefined);
|
||||
clearSessionStoreCacheForTest();
|
||||
if (savedCacheTtl === undefined) {
|
||||
delete process.env.OPENCLAW_SESSION_CACHE_TTL_MS;
|
||||
} else {
|
||||
process.env.OPENCLAW_SESSION_CACHE_TTL_MS = savedCacheTtl;
|
||||
}
|
||||
});
|
||||
|
||||
it("saveSessionStore prunes stale entries on write", async () => {
|
||||
mockLoadConfig.mockReturnValue({
|
||||
session: {
|
||||
maintenance: {
|
||||
mode: "enforce",
|
||||
pruneAfter: "7d",
|
||||
maxEntries: 500,
|
||||
rotateBytes: 10_485_760,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const now = Date.now();
|
||||
const store: Record<string, SessionEntry> = {
|
||||
stale: makeEntry(now - 30 * DAY_MS),
|
||||
fresh: makeEntry(now),
|
||||
};
|
||||
|
||||
await saveSessionStore(storePath, store);
|
||||
|
||||
const loaded = loadSessionStore(storePath);
|
||||
expect(loaded.stale).toBeUndefined();
|
||||
expect(loaded.fresh).toBeDefined();
|
||||
});
|
||||
|
||||
it("saveSessionStore caps entries over limit", async () => {
|
||||
mockLoadConfig.mockReturnValue({
|
||||
session: {
|
||||
maintenance: {
|
||||
mode: "enforce",
|
||||
pruneAfter: "30d",
|
||||
maxEntries: 5,
|
||||
rotateBytes: 10_485_760,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const now = Date.now();
|
||||
const store: Record<string, SessionEntry> = {};
|
||||
for (let i = 0; i < 10; i++) {
|
||||
store[`key-${i}`] = makeEntry(now - i * 1000);
|
||||
}
|
||||
|
||||
await saveSessionStore(storePath, store);
|
||||
|
||||
const loaded = loadSessionStore(storePath);
|
||||
expect(Object.keys(loaded)).toHaveLength(5);
|
||||
for (let i = 0; i < 5; i++) {
|
||||
expect(loaded[`key-${i}`]).toBeDefined();
|
||||
}
|
||||
for (let i = 5; i < 10; i++) {
|
||||
expect(loaded[`key-${i}`]).toBeUndefined();
|
||||
}
|
||||
});
|
||||
|
||||
it("saveSessionStore rotates file when over size limit and creates .bak", async () => {
|
||||
mockLoadConfig.mockReturnValue({
|
||||
session: {
|
||||
maintenance: {
|
||||
mode: "enforce",
|
||||
pruneAfter: "30d",
|
||||
maxEntries: 500,
|
||||
rotateBytes: "100b",
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const now = Date.now();
|
||||
const largeStore: Record<string, SessionEntry> = {};
|
||||
for (let i = 0; i < 50; i++) {
|
||||
largeStore[`agent:main:session-${crypto.randomUUID()}`] = makeEntry(now - i * 1000);
|
||||
}
|
||||
await fs.mkdir(path.dirname(storePath), { recursive: true });
|
||||
await fs.writeFile(storePath, JSON.stringify(largeStore, null, 2), "utf-8");
|
||||
|
||||
const statBefore = await fs.stat(storePath);
|
||||
expect(statBefore.size).toBeGreaterThan(100);
|
||||
|
||||
const smallStore: Record<string, SessionEntry> = {
|
||||
only: makeEntry(now),
|
||||
};
|
||||
await saveSessionStore(storePath, smallStore);
|
||||
|
||||
const files = await fs.readdir(testDir);
|
||||
const bakFiles = files.filter((f) => f.startsWith("sessions.json.bak."));
|
||||
expect(bakFiles.length).toBeGreaterThanOrEqual(1);
|
||||
|
||||
const loaded = loadSessionStore(storePath);
|
||||
expect(loaded.only).toBeDefined();
|
||||
});
|
||||
|
||||
it("saveSessionStore applies both pruning and capping together", async () => {
|
||||
mockLoadConfig.mockReturnValue({
|
||||
session: {
|
||||
maintenance: {
|
||||
mode: "enforce",
|
||||
pruneAfter: "10d",
|
||||
maxEntries: 3,
|
||||
rotateBytes: 10_485_760,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const now = Date.now();
|
||||
const store: Record<string, SessionEntry> = {
|
||||
stale1: makeEntry(now - 15 * DAY_MS),
|
||||
stale2: makeEntry(now - 20 * DAY_MS),
|
||||
fresh1: makeEntry(now),
|
||||
fresh2: makeEntry(now - 1 * DAY_MS),
|
||||
fresh3: makeEntry(now - 2 * DAY_MS),
|
||||
fresh4: makeEntry(now - 5 * DAY_MS),
|
||||
};
|
||||
|
||||
await saveSessionStore(storePath, store);
|
||||
|
||||
const loaded = loadSessionStore(storePath);
|
||||
expect(loaded.stale1).toBeUndefined();
|
||||
expect(loaded.stale2).toBeUndefined();
|
||||
expect(Object.keys(loaded).length).toBeLessThanOrEqual(3);
|
||||
expect(loaded.fresh1).toBeDefined();
|
||||
expect(loaded.fresh2).toBeDefined();
|
||||
expect(loaded.fresh3).toBeDefined();
|
||||
expect(loaded.fresh4).toBeUndefined();
|
||||
});
|
||||
|
||||
it("saveSessionStore skips enforcement when maintenance mode is warn", async () => {
|
||||
mockLoadConfig.mockReturnValue({
|
||||
session: {
|
||||
maintenance: {
|
||||
mode: "warn",
|
||||
pruneAfter: "7d",
|
||||
maxEntries: 1,
|
||||
rotateBytes: 10_485_760,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const now = Date.now();
|
||||
const store: Record<string, SessionEntry> = {
|
||||
stale: makeEntry(now - 30 * DAY_MS),
|
||||
fresh: makeEntry(now),
|
||||
};
|
||||
|
||||
await saveSessionStore(storePath, store);
|
||||
|
||||
const loaded = loadSessionStore(storePath);
|
||||
expect(loaded.stale).toBeDefined();
|
||||
expect(loaded.fresh).toBeDefined();
|
||||
expect(Object.keys(loaded)).toHaveLength(2);
|
||||
});
|
||||
|
||||
it("resolveMaintenanceConfig reads from loadConfig().session.maintenance", async () => {
|
||||
mockLoadConfig.mockReturnValue({
|
||||
session: {
|
||||
maintenance: { pruneAfter: "7d", maxEntries: 100, rotateBytes: "5mb" },
|
||||
},
|
||||
});
|
||||
|
||||
const { resolveMaintenanceConfig } = await import("./store.js");
|
||||
const config = resolveMaintenanceConfig();
|
||||
|
||||
expect(config).toEqual({
|
||||
mode: "warn",
|
||||
pruneAfterMs: 7 * DAY_MS,
|
||||
maxEntries: 100,
|
||||
rotateBytes: 5 * 1024 * 1024,
|
||||
});
|
||||
});
|
||||
|
||||
it("resolveMaintenanceConfig uses defaults for missing fields", async () => {
|
||||
mockLoadConfig.mockReturnValue({ session: { maintenance: { pruneAfter: "14d" } } });
|
||||
|
||||
const { resolveMaintenanceConfig } = await import("./store.js");
|
||||
const config = resolveMaintenanceConfig();
|
||||
|
||||
expect(config).toEqual({
|
||||
mode: "warn",
|
||||
pruneAfterMs: 14 * DAY_MS,
|
||||
maxEntries: 500,
|
||||
rotateBytes: 10_485_760,
|
||||
});
|
||||
});
|
||||
|
||||
it("resolveMaintenanceConfig falls back to deprecated pruneDays", async () => {
|
||||
mockLoadConfig.mockReturnValue({ session: { maintenance: { pruneDays: 2 } } });
|
||||
|
||||
const { resolveMaintenanceConfig } = await import("./store.js");
|
||||
const config = resolveMaintenanceConfig();
|
||||
|
||||
expect(config).toEqual({
|
||||
mode: "warn",
|
||||
pruneAfterMs: 2 * DAY_MS,
|
||||
maxEntries: 500,
|
||||
rotateBytes: 10_485_760,
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -3,6 +3,10 @@ import crypto from "node:crypto";
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import type { MsgContext } from "../../auto-reply/templating.js";
|
||||
import type { SessionMaintenanceConfig, SessionMaintenanceMode } from "../types.base.js";
|
||||
import { parseByteSize } from "../../cli/parse-bytes.js";
|
||||
import { parseDurationMs } from "../../cli/parse-duration.js";
|
||||
import { createSubsystemLogger } from "../../logging/subsystem.js";
|
||||
import {
|
||||
deliveryContextFromSession,
|
||||
mergeDeliveryContext,
|
||||
@@ -11,9 +15,12 @@ import {
|
||||
type DeliveryContext,
|
||||
} from "../../utils/delivery-context.js";
|
||||
import { getFileMtimeMs, isCacheEnabled, resolveCacheTtlMs } from "../cache-utils.js";
|
||||
import { loadConfig } from "../config.js";
|
||||
import { deriveSessionMetaPatch } from "./metadata.js";
|
||||
import { mergeSessionEntry, type SessionEntry } from "./types.js";
|
||||
|
||||
const log = createSubsystemLogger("sessions/store");
|
||||
|
||||
// ============================================================================
|
||||
// Session Store Cache with TTL Support
|
||||
// ============================================================================
|
||||
@@ -195,15 +202,300 @@ export function readSessionUpdatedAt(params: {
|
||||
}
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// Session Store Pruning, Capping & File Rotation
|
||||
// ============================================================================
|
||||
|
||||
const DEFAULT_SESSION_PRUNE_AFTER_MS = 30 * 24 * 60 * 60 * 1000;
|
||||
const DEFAULT_SESSION_MAX_ENTRIES = 500;
|
||||
const DEFAULT_SESSION_ROTATE_BYTES = 10_485_760; // 10 MB
|
||||
const DEFAULT_SESSION_MAINTENANCE_MODE: SessionMaintenanceMode = "warn";
|
||||
|
||||
export type SessionMaintenanceWarning = {
|
||||
activeSessionKey: string;
|
||||
activeUpdatedAt?: number;
|
||||
totalEntries: number;
|
||||
pruneAfterMs: number;
|
||||
maxEntries: number;
|
||||
wouldPrune: boolean;
|
||||
wouldCap: boolean;
|
||||
};
|
||||
|
||||
type ResolvedSessionMaintenanceConfig = {
|
||||
mode: SessionMaintenanceMode;
|
||||
pruneAfterMs: number;
|
||||
maxEntries: number;
|
||||
rotateBytes: number;
|
||||
};
|
||||
|
||||
function resolvePruneAfterMs(maintenance?: SessionMaintenanceConfig): number {
|
||||
const raw = maintenance?.pruneAfter ?? maintenance?.pruneDays;
|
||||
if (raw === undefined || raw === null || raw === "") {
|
||||
return DEFAULT_SESSION_PRUNE_AFTER_MS;
|
||||
}
|
||||
try {
|
||||
return parseDurationMs(String(raw).trim(), { defaultUnit: "d" });
|
||||
} catch {
|
||||
return DEFAULT_SESSION_PRUNE_AFTER_MS;
|
||||
}
|
||||
}
|
||||
|
||||
function resolveRotateBytes(maintenance?: SessionMaintenanceConfig): number {
|
||||
const raw = maintenance?.rotateBytes;
|
||||
if (raw === undefined || raw === null || raw === "") {
|
||||
return DEFAULT_SESSION_ROTATE_BYTES;
|
||||
}
|
||||
try {
|
||||
return parseByteSize(String(raw).trim(), { defaultUnit: "b" });
|
||||
} catch {
|
||||
return DEFAULT_SESSION_ROTATE_BYTES;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve maintenance settings from openclaw.json (`session.maintenance`).
|
||||
* Falls back to built-in defaults when config is missing or unset.
|
||||
*/
|
||||
export function resolveMaintenanceConfig(): ResolvedSessionMaintenanceConfig {
|
||||
let maintenance: SessionMaintenanceConfig | undefined;
|
||||
try {
|
||||
maintenance = loadConfig().session?.maintenance;
|
||||
} catch {
|
||||
// Config may not be available (e.g. in tests). Use defaults.
|
||||
}
|
||||
return {
|
||||
mode: maintenance?.mode ?? DEFAULT_SESSION_MAINTENANCE_MODE,
|
||||
pruneAfterMs: resolvePruneAfterMs(maintenance),
|
||||
maxEntries: maintenance?.maxEntries ?? DEFAULT_SESSION_MAX_ENTRIES,
|
||||
rotateBytes: resolveRotateBytes(maintenance),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove entries whose `updatedAt` is older than the configured threshold.
|
||||
* Entries without `updatedAt` are kept (cannot determine staleness).
|
||||
* Mutates `store` in-place.
|
||||
*/
|
||||
export function pruneStaleEntries(
|
||||
store: Record<string, SessionEntry>,
|
||||
overrideMaxAgeMs?: number,
|
||||
opts: { log?: boolean } = {},
|
||||
): number {
|
||||
const maxAgeMs = overrideMaxAgeMs ?? resolveMaintenanceConfig().pruneAfterMs;
|
||||
const cutoffMs = Date.now() - maxAgeMs;
|
||||
let pruned = 0;
|
||||
for (const [key, entry] of Object.entries(store)) {
|
||||
if (entry?.updatedAt != null && entry.updatedAt < cutoffMs) {
|
||||
delete store[key];
|
||||
pruned++;
|
||||
}
|
||||
}
|
||||
if (pruned > 0 && opts.log !== false) {
|
||||
log.info("pruned stale session entries", { pruned, maxAgeMs });
|
||||
}
|
||||
return pruned;
|
||||
}
|
||||
|
||||
/**
|
||||
* Cap the store to the N most recently updated entries.
|
||||
* Entries without `updatedAt` are sorted last (removed first when over limit).
|
||||
* Mutates `store` in-place.
|
||||
*/
|
||||
function getEntryUpdatedAt(entry?: SessionEntry): number {
|
||||
return entry?.updatedAt ?? Number.NEGATIVE_INFINITY;
|
||||
}
|
||||
|
||||
export function getActiveSessionMaintenanceWarning(params: {
|
||||
store: Record<string, SessionEntry>;
|
||||
activeSessionKey: string;
|
||||
pruneAfterMs: number;
|
||||
maxEntries: number;
|
||||
nowMs?: number;
|
||||
}): SessionMaintenanceWarning | null {
|
||||
const activeSessionKey = params.activeSessionKey.trim();
|
||||
if (!activeSessionKey) {
|
||||
return null;
|
||||
}
|
||||
const activeEntry = params.store[activeSessionKey];
|
||||
if (!activeEntry) {
|
||||
return null;
|
||||
}
|
||||
const now = params.nowMs ?? Date.now();
|
||||
const cutoffMs = now - params.pruneAfterMs;
|
||||
const wouldPrune = activeEntry.updatedAt != null ? activeEntry.updatedAt < cutoffMs : false;
|
||||
const keys = Object.keys(params.store);
|
||||
const wouldCap =
|
||||
keys.length > params.maxEntries &&
|
||||
keys
|
||||
.toSorted((a, b) => getEntryUpdatedAt(params.store[b]) - getEntryUpdatedAt(params.store[a]))
|
||||
.slice(params.maxEntries)
|
||||
.includes(activeSessionKey);
|
||||
|
||||
if (!wouldPrune && !wouldCap) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return {
|
||||
activeSessionKey,
|
||||
activeUpdatedAt: activeEntry.updatedAt,
|
||||
totalEntries: keys.length,
|
||||
pruneAfterMs: params.pruneAfterMs,
|
||||
maxEntries: params.maxEntries,
|
||||
wouldPrune,
|
||||
wouldCap,
|
||||
};
|
||||
}
|
||||
|
||||
export function capEntryCount(
|
||||
store: Record<string, SessionEntry>,
|
||||
overrideMax?: number,
|
||||
opts: { log?: boolean } = {},
|
||||
): number {
|
||||
const maxEntries = overrideMax ?? resolveMaintenanceConfig().maxEntries;
|
||||
const keys = Object.keys(store);
|
||||
if (keys.length <= maxEntries) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Sort by updatedAt descending; entries without updatedAt go to the end (removed first).
|
||||
const sorted = keys.toSorted((a, b) => {
|
||||
const aTime = getEntryUpdatedAt(store[a]);
|
||||
const bTime = getEntryUpdatedAt(store[b]);
|
||||
return bTime - aTime;
|
||||
});
|
||||
|
||||
const toRemove = sorted.slice(maxEntries);
|
||||
for (const key of toRemove) {
|
||||
delete store[key];
|
||||
}
|
||||
if (opts.log !== false) {
|
||||
log.info("capped session entry count", { removed: toRemove.length, maxEntries });
|
||||
}
|
||||
return toRemove.length;
|
||||
}
|
||||
|
||||
async function getSessionFileSize(storePath: string): Promise<number | null> {
|
||||
try {
|
||||
const stat = await fs.promises.stat(storePath);
|
||||
return stat.size;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Rotate the sessions file if it exceeds the configured size threshold.
|
||||
* Renames the current file to `sessions.json.bak.{timestamp}` and cleans up
|
||||
* old rotation backups, keeping only the 3 most recent `.bak.*` files.
|
||||
*/
|
||||
export async function rotateSessionFile(
|
||||
storePath: string,
|
||||
overrideBytes?: number,
|
||||
): Promise<boolean> {
|
||||
const maxBytes = overrideBytes ?? resolveMaintenanceConfig().rotateBytes;
|
||||
|
||||
// Check current file size (file may not exist yet).
|
||||
const fileSize = await getSessionFileSize(storePath);
|
||||
if (fileSize == null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (fileSize <= maxBytes) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Rotate: rename current file to .bak.{timestamp}
|
||||
const backupPath = `${storePath}.bak.${Date.now()}`;
|
||||
try {
|
||||
await fs.promises.rename(storePath, backupPath);
|
||||
log.info("rotated session store file", {
|
||||
backupPath: path.basename(backupPath),
|
||||
sizeBytes: fileSize,
|
||||
});
|
||||
} catch {
|
||||
// If rename fails (e.g. file disappeared), skip rotation.
|
||||
return false;
|
||||
}
|
||||
|
||||
// Clean up old backups — keep only the 3 most recent .bak.* files.
|
||||
try {
|
||||
const dir = path.dirname(storePath);
|
||||
const baseName = path.basename(storePath);
|
||||
const files = await fs.promises.readdir(dir);
|
||||
const backups = files
|
||||
.filter((f) => f.startsWith(`${baseName}.bak.`))
|
||||
.toSorted()
|
||||
.toReversed();
|
||||
|
||||
const maxBackups = 3;
|
||||
if (backups.length > maxBackups) {
|
||||
const toDelete = backups.slice(maxBackups);
|
||||
for (const old of toDelete) {
|
||||
await fs.promises.unlink(path.join(dir, old)).catch(() => undefined);
|
||||
}
|
||||
log.info("cleaned up old session store backups", { deleted: toDelete.length });
|
||||
}
|
||||
} catch {
|
||||
// Best-effort cleanup; don't fail the write.
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
type SaveSessionStoreOptions = {
|
||||
/** Skip pruning, capping, and rotation (e.g. during one-time migrations). */
|
||||
skipMaintenance?: boolean;
|
||||
/** Active session key for warn-only maintenance. */
|
||||
activeSessionKey?: string;
|
||||
/** Optional callback for warn-only maintenance. */
|
||||
onWarn?: (warning: SessionMaintenanceWarning) => void | Promise<void>;
|
||||
};
|
||||
|
||||
async function saveSessionStoreUnlocked(
|
||||
storePath: string,
|
||||
store: Record<string, SessionEntry>,
|
||||
opts?: SaveSessionStoreOptions,
|
||||
): Promise<void> {
|
||||
// Invalidate cache on write to ensure consistency
|
||||
invalidateSessionStoreCache(storePath);
|
||||
|
||||
normalizeSessionStore(store);
|
||||
|
||||
if (!opts?.skipMaintenance) {
|
||||
// Resolve maintenance config once (avoids repeated loadConfig() calls).
|
||||
const maintenance = resolveMaintenanceConfig();
|
||||
const shouldWarnOnly = maintenance.mode === "warn";
|
||||
|
||||
if (shouldWarnOnly) {
|
||||
const activeSessionKey = opts?.activeSessionKey?.trim();
|
||||
if (activeSessionKey) {
|
||||
const warning = getActiveSessionMaintenanceWarning({
|
||||
store,
|
||||
activeSessionKey,
|
||||
pruneAfterMs: maintenance.pruneAfterMs,
|
||||
maxEntries: maintenance.maxEntries,
|
||||
});
|
||||
if (warning) {
|
||||
log.warn("session maintenance would evict active session; skipping enforcement", {
|
||||
activeSessionKey: warning.activeSessionKey,
|
||||
wouldPrune: warning.wouldPrune,
|
||||
wouldCap: warning.wouldCap,
|
||||
pruneAfterMs: warning.pruneAfterMs,
|
||||
maxEntries: warning.maxEntries,
|
||||
});
|
||||
await opts?.onWarn?.(warning);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Prune stale entries and cap total count before serializing.
|
||||
pruneStaleEntries(store, maintenance.pruneAfterMs);
|
||||
capEntryCount(store, maintenance.maxEntries);
|
||||
|
||||
// Rotate the on-disk file if it exceeds the size threshold.
|
||||
await rotateSessionFile(storePath, maintenance.rotateBytes);
|
||||
}
|
||||
}
|
||||
|
||||
await fs.promises.mkdir(path.dirname(storePath), { recursive: true });
|
||||
const json = JSON.stringify(store, null, 2);
|
||||
|
||||
@@ -266,21 +558,23 @@ async function saveSessionStoreUnlocked(
|
||||
export async function saveSessionStore(
|
||||
storePath: string,
|
||||
store: Record<string, SessionEntry>,
|
||||
opts?: SaveSessionStoreOptions,
|
||||
): Promise<void> {
|
||||
await withSessionStoreLock(storePath, async () => {
|
||||
await saveSessionStoreUnlocked(storePath, store);
|
||||
await saveSessionStoreUnlocked(storePath, store, opts);
|
||||
});
|
||||
}
|
||||
|
||||
export async function updateSessionStore<T>(
|
||||
storePath: string,
|
||||
mutator: (store: Record<string, SessionEntry>) => Promise<T> | T,
|
||||
opts?: SaveSessionStoreOptions,
|
||||
): Promise<T> {
|
||||
return await withSessionStoreLock(storePath, async () => {
|
||||
// Always re-read inside the lock to avoid clobbering concurrent writers.
|
||||
const store = loadSessionStore(storePath, { skipCache: true });
|
||||
const result = await mutator(store);
|
||||
await saveSessionStoreUnlocked(storePath, store);
|
||||
await saveSessionStoreUnlocked(storePath, store, opts);
|
||||
return result;
|
||||
});
|
||||
}
|
||||
@@ -381,7 +675,7 @@ export async function updateSessionStoreEntry(params: {
|
||||
}
|
||||
const next = mergeSessionEntry(existing, patch);
|
||||
store[sessionKey] = next;
|
||||
await saveSessionStoreUnlocked(storePath, store);
|
||||
await saveSessionStoreUnlocked(storePath, store, { activeSessionKey: sessionKey });
|
||||
return next;
|
||||
});
|
||||
}
|
||||
@@ -395,24 +689,28 @@ export async function recordSessionMetaFromInbound(params: {
|
||||
}): Promise<SessionEntry | null> {
|
||||
const { storePath, sessionKey, ctx } = params;
|
||||
const createIfMissing = params.createIfMissing ?? true;
|
||||
return await updateSessionStore(storePath, (store) => {
|
||||
const existing = store[sessionKey];
|
||||
const patch = deriveSessionMetaPatch({
|
||||
ctx,
|
||||
sessionKey,
|
||||
existing,
|
||||
groupResolution: params.groupResolution,
|
||||
});
|
||||
if (!patch) {
|
||||
return existing ?? null;
|
||||
}
|
||||
if (!existing && !createIfMissing) {
|
||||
return null;
|
||||
}
|
||||
const next = mergeSessionEntry(existing, patch);
|
||||
store[sessionKey] = next;
|
||||
return next;
|
||||
});
|
||||
return await updateSessionStore(
|
||||
storePath,
|
||||
(store) => {
|
||||
const existing = store[sessionKey];
|
||||
const patch = deriveSessionMetaPatch({
|
||||
ctx,
|
||||
sessionKey,
|
||||
existing,
|
||||
groupResolution: params.groupResolution,
|
||||
});
|
||||
if (!patch) {
|
||||
return existing ?? null;
|
||||
}
|
||||
if (!existing && !createIfMissing) {
|
||||
return null;
|
||||
}
|
||||
const next = mergeSessionEntry(existing, patch);
|
||||
store[sessionKey] = next;
|
||||
return next;
|
||||
},
|
||||
{ activeSessionKey: sessionKey },
|
||||
);
|
||||
}
|
||||
|
||||
export async function updateLastRoute(params: {
|
||||
@@ -488,7 +786,7 @@ export async function updateLastRoute(params: {
|
||||
metaPatch ? { ...basePatch, ...metaPatch } : basePatch,
|
||||
);
|
||||
store[sessionKey] = next;
|
||||
await saveSessionStoreUnlocked(storePath, store);
|
||||
await saveSessionStoreUnlocked(storePath, store, { activeSessionKey: sessionKey });
|
||||
return next;
|
||||
});
|
||||
}
|
||||
|
||||
@@ -134,12 +134,16 @@ export async function appendAssistantMessageToSessionTranscript(params: {
|
||||
});
|
||||
|
||||
if (!entry.sessionFile || entry.sessionFile !== sessionFile) {
|
||||
await updateSessionStore(storePath, (current) => {
|
||||
current[sessionKey] = {
|
||||
...entry,
|
||||
sessionFile,
|
||||
};
|
||||
});
|
||||
await updateSessionStore(
|
||||
storePath,
|
||||
(current) => {
|
||||
current[sessionKey] = {
|
||||
...entry,
|
||||
sessionFile,
|
||||
};
|
||||
},
|
||||
{ activeSessionKey: sessionKey },
|
||||
);
|
||||
}
|
||||
|
||||
emitSessionTranscriptUpdate(sessionFile);
|
||||
|
||||
Reference in New Issue
Block a user