File size: 12,059 Bytes
eb3f11e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 | import { AsyncLocalStorage } from "node:async_hooks";
import path from "node:path";
import { DatabaseSync } from "node:sqlite";
import { expect, it, vi } from "vitest";
import type { ContextEngine } from "../../context-engine/types.js";
import { resetCommandQueueStateForTest } from "../../process/command-queue.test-support.js";
import {
markGatewayRestartDraining,
resetGatewayWorkAdmission,
} from "../../process/gateway-work-admission.js";
import {
AsyncWorkScope,
getAsyncWorkSignal,
trackAsyncWork,
} from "../../shared/async-work-scope.js";
import { createDeferredCore } from "../../shared/deferred.js";
import {
resetTaskFlowRegistryForTests,
resetTaskRegistryForTests,
} from "../../tasks/task-runtime.test-helpers.js";
import { withStateDirEnv } from "../../test-helpers/state-dir-env.js";
import {
runContextEngineMaintenance,
waitForDeferredTurnMaintenanceForSession,
} from "./context-engine-maintenance.js";
const unchanged = { changed: false, bytesFreed: 0, rewrittenEntries: 0 };
function engine(maintain: NonNullable<ContextEngine["maintain"]>): ContextEngine {
return {
info: { id: "resource-test", name: "Resource test", turnMaintenanceMode: "background" },
ingest: async () => ({ ingested: false }),
assemble: async ({ messages }) => ({ messages, estimatedTokens: 0 }),
compact: async () => ({ ok: true, compacted: false }),
maintain,
};
}
it("keeps SIGTERM cancellation attached through actual engine disposal", async () => {
await withResources(async (db, schedule) => {
const context = new AsyncLocalStorage<string>();
const entered = createDeferredCore();
const release = createDeferredCore();
const cancelled = vi.fn();
const disposed = vi.fn();
const keepTestProcessAlive = () => {};
process.on("SIGTERM", keepTestProcessAlive);
let lifecycleSignal: AbortSignal | undefined;
const contextEngine = engine(async ({ abortSignal }) => {
lifecycleSignal = abortSignal;
return unchanged;
});
contextEngine.dispose = async () => {
const signal = getAsyncWorkSignal();
if (!signal) {
throw new Error("expected disposer work signal");
}
signal.addEventListener("abort", () => cancelled(context.getStore(), signal.reason), {
once: true,
});
entered.resolve();
await release.promise;
disposed(db.prepare("SELECT value FROM probe").get()?.value);
};
try {
await context.run("disposer", () => schedule(contextEngine));
await entered.promise;
context.run("unrelated", () => process.emit("SIGTERM", "SIGTERM"));
expect(lifecycleSignal?.aborted).toBe(true);
expect(cancelled).toHaveBeenCalledExactlyOnceWith("disposer", lifecycleSignal?.reason);
release.resolve();
await waitForDeferredTurnMaintenanceForSession("agent:main:maintenance-resources");
expect(disposed).toHaveBeenCalledExactlyOnceWith(42);
} finally {
release.resolve();
await waitForDeferredTurnMaintenanceForSession("agent:main:maintenance-resources");
process.off("SIGTERM", keepTestProcessAlive);
}
});
});
async function withResources(
run: (
db: DatabaseSync,
schedule: (contextEngine: ContextEngine) => Promise<void>,
) => Promise<void>,
) {
await withStateDirEnv("openclaw-maintenance-resources-", async ({ stateDir }) => {
resetCommandQueueStateForTest();
resetTaskRegistryForTests({ persist: false });
resetTaskFlowRegistryForTests({ persist: false });
const db = new DatabaseSync(path.join(stateDir, "registration.sqlite"));
db.exec("CREATE TABLE probe(value INTEGER); INSERT INTO probe VALUES (42)");
const pending: Promise<void>[] = [];
const schedule = async (contextEngine: ContextEngine) => {
await runContextEngineMaintenance({
contextEngine,
sessionId: "resources",
sessionKey: "agent:main:maintenance-resources",
sessionFile: path.join(stateDir, "session.jsonl"),
reason: "turn",
disposeDeferredContextEngineAfterMaintenance: true,
onDeferredMaintenance: (promise) => {
pending.push(promise);
},
});
};
try {
await run(db, schedule);
} finally {
await Promise.allSettled(pending);
db.close();
resetCommandQueueStateForTest();
resetTaskRegistryForTests({ persist: false });
resetTaskFlowRegistryForTests({ persist: false });
}
});
}
it.each(["maintenance", "disposal"] as const)(
"joins actual %s descendants before maintenance completion",
async (phase) => {
await withStateDirEnv("openclaw-maintenance-tail-", async ({ stateDir }) => {
resetCommandQueueStateForTest();
resetTaskRegistryForTests({ persist: false });
resetTaskFlowRegistryForTests({ persist: false });
const db = new DatabaseSync(path.join(stateDir, "registration.sqlite"));
db.exec("CREATE TABLE probe(value INTEGER); INSERT INTO probe VALUES (42)");
const release = createDeferredCore();
const entered = createDeferredCore();
let tail: Promise<unknown> | undefined;
let completion: Promise<void> | undefined;
let returned = false;
const startTail = () => {
tail = trackAsyncWork(async () => {
entered.resolve();
await release.promise;
return db.prepare("SELECT value FROM probe").get()?.value;
});
void tail.catch(() => {});
};
const contextEngine = engine(async () => {
if (phase === "maintenance") {
startTail();
}
return unchanged;
});
const dispose = vi.fn(async () => {
if (phase === "disposal") {
startTail();
}
});
contextEngine.dispose = dispose;
try {
await runContextEngineMaintenance({
contextEngine,
sessionId: "tail",
sessionKey: "agent:main:maintenance-tail",
sessionFile: path.join(stateDir, "session.jsonl"),
reason: "turn",
disposeDeferredContextEngineAfterMaintenance: true,
onDeferredMaintenance: (promise) => {
completion = promise.then(() => {
returned = true;
db.close();
});
},
});
await entered.promise;
await new Promise<void>((resolve) => {
setImmediate(resolve);
});
expect.soft(returned).toBe(false);
if (phase === "maintenance") {
expect.soft(dispose).not.toHaveBeenCalled();
}
release.resolve();
await expect(tail).resolves.toBe(42);
await completion;
expect(dispose).toHaveBeenCalledOnce();
} finally {
release.resolve();
await Promise.allSettled([...(tail ? [tail] : []), ...(completion ? [completion] : [])]);
if (!returned) {
db.close();
}
resetCommandQueueStateForTest();
resetTaskRegistryForTests({ persist: false });
resetTaskFlowRegistryForTests({ persist: false });
}
});
},
);
it("joins disposal of a superseded queued engine before reporting the active maintenance settled", async () => {
await withResources(async (db, schedule) => {
const context = new AsyncLocalStorage<string>();
const contexts: Array<string | undefined> = [];
const releaseActive = createDeferredCore();
const activeStarted = createDeferredCore();
const releaseDisposal = createDeferredCore();
const disposalStarted = createDeferredCore();
const finalRan = createDeferredCore();
const disposed = vi.fn();
const active = engine(async () => {
contexts.push(context.getStore());
activeStarted.resolve();
await releaseActive.promise;
return unchanged;
});
const superseded = engine(async () => unchanged);
superseded.dispose = async () => {
contexts.push(context.getStore());
disposalStarted.resolve();
await releaseDisposal.promise;
disposed(db.prepare("SELECT value FROM probe").get()?.value);
};
const latest = engine(async () => {
contexts.push(context.getStore());
finalRan.resolve();
return unchanged;
});
let allSettled = false;
let joined: Promise<void> | undefined;
try {
await context.run("active", () => schedule(active));
await activeStarted.promise;
await context.run("superseded", () => schedule(superseded));
await context.run("latest", () => schedule(latest));
await disposalStarted.promise;
joined = waitForDeferredTurnMaintenanceForSession("agent:main:maintenance-resources").then(
() => {
allSettled = true;
},
);
releaseActive.resolve();
await finalRan.promise;
await new Promise<void>((resolve) => {
setImmediate(resolve);
});
expect.soft(allSettled).toBe(false);
releaseDisposal.resolve();
await joined;
expect(disposed).toHaveBeenCalledExactlyOnceWith(42);
expect(contexts).toEqual(["active", "superseded", "latest"]);
} finally {
releaseActive.resolve();
releaseDisposal.resolve();
await joined;
}
});
});
it.each(["parent completion", "gateway restart"] as const)(
"keeps accepted maintenance independent of %s",
async (mode) => {
await withResources(async (db, schedule) => {
const parent = new AsyncWorkScope();
const context = new AsyncLocalStorage<string>();
const entered = createDeferredCore();
const release = createDeferredCore();
const cancelled = vi.fn();
let tail: Promise<unknown> | undefined;
let maintenanceSignal: AbortSignal | undefined;
let parentClosed = false;
let closing: Promise<void> | undefined;
let cancellationCheckpoint: Promise<void> | undefined;
let checkpointPassed = false;
try {
await context.run("admitted", () =>
parent.track(() =>
schedule(
engine(async ({ abortSignal }) => {
maintenanceSignal = abortSignal;
const signal = getAsyncWorkSignal();
if (!signal) {
throw new Error("expected maintenance work cancellation");
}
signal.addEventListener(
"abort",
() => {
cancelled(context.getStore(), signal.reason);
cancellationCheckpoint = waitForDeferredTurnMaintenanceForSession(
"agent:main:maintenance-resources",
).then(() => {
checkpointPassed = true;
});
},
{ once: true },
);
tail = trackAsyncWork(async () => {
entered.resolve();
await release.promise;
return db.prepare("SELECT value FROM probe").get()?.value;
});
return unchanged;
}),
),
),
);
await entered.promise;
closing = context
.run("unrelated", () => parent.drain())
.then(() => {
parentClosed = true;
});
await vi.waitFor(() => expect(parentClosed).toBe(true));
expect.soft(maintenanceSignal?.aborted).toBe(false);
expect.soft(cancelled).not.toHaveBeenCalled();
if (mode === "gateway restart") {
context.run("unrelated", () => markGatewayRestartDraining());
expect(maintenanceSignal?.aborted).toBe(true);
expect(cancelled).toHaveBeenCalledExactlyOnceWith("admitted", maintenanceSignal?.reason);
await vi.waitFor(() => expect(checkpointPassed).toBe(true));
}
release.resolve();
await expect(tail).resolves.toBe(42);
} finally {
release.resolve();
await tail;
await closing;
await parent.drain();
await cancellationCheckpoint;
resetGatewayWorkAdmission();
}
});
},
);
|