File size: 20,490 Bytes
fc93158 | 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 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | import type { AgentMessage } from "@mariozechner/pi-agent-core";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { compactEmbeddedPiSessionDirect } from "../agents/pi-embedded-runner/compact.runtime.js";
// ---------------------------------------------------------------------------
// We dynamically import the registry so we can get a fresh module per test
// group when needed. For most groups we use the shared singleton directly.
// ---------------------------------------------------------------------------
import { LegacyContextEngine, registerLegacyContextEngine } from "./legacy.js";
import {
registerContextEngine,
getContextEngineFactory,
listContextEngineIds,
resolveContextEngine,
} from "./registry.js";
import type {
ContextEngine,
ContextEngineInfo,
AssembleResult,
CompactResult,
IngestResult,
} from "./types.js";
vi.mock("../agents/pi-embedded-runner/compact.runtime.js", () => ({
compactEmbeddedPiSessionDirect: vi.fn(async () => ({
ok: true,
compacted: false,
reason: "mock compaction",
result: {
summary: "",
firstKeptEntryId: "",
tokensBefore: 0,
tokensAfter: 0,
details: undefined,
},
})),
}));
const mockedCompactEmbeddedPiSessionDirect = vi.mocked(compactEmbeddedPiSessionDirect);
// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------
/** Build a config object with a contextEngine slot for testing. */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function configWithSlot(engineId: string): any {
return { plugins: { slots: { contextEngine: engineId } } };
}
function makeMockMessage(role: "user" | "assistant" = "user", text = "hello"): AgentMessage {
return { role, content: text, timestamp: Date.now() } as AgentMessage;
}
/** A minimal mock engine that satisfies the ContextEngine interface. */
class MockContextEngine implements ContextEngine {
readonly info: ContextEngineInfo = {
id: "mock",
name: "Mock Engine",
version: "0.0.1",
};
async ingest(_params: {
sessionId: string;
sessionKey?: string;
message: AgentMessage;
isHeartbeat?: boolean;
}): Promise<IngestResult> {
return { ingested: true };
}
async assemble(params: {
sessionId: string;
sessionKey?: string;
messages: AgentMessage[];
tokenBudget?: number;
}): Promise<AssembleResult> {
return {
messages: params.messages,
estimatedTokens: 42,
systemPromptAddition: "mock system addition",
};
}
async compact(_params: {
sessionId: string;
sessionKey?: string;
sessionFile: string;
tokenBudget?: number;
compactionTarget?: "budget" | "threshold";
customInstructions?: string;
runtimeContext?: Record<string, unknown>;
}): Promise<CompactResult> {
return {
ok: true,
compacted: true,
reason: "mock compaction",
result: {
summary: "mock summary",
tokensBefore: 100,
tokensAfter: 50,
},
};
}
async dispose(): Promise<void> {
// no-op
}
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// 1. Engine contract tests
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe("Engine contract tests", () => {
beforeEach(() => {
mockedCompactEmbeddedPiSessionDirect.mockClear();
});
it("a mock engine implementing ContextEngine can be registered and resolved", async () => {
const factory = () => new MockContextEngine();
registerContextEngine("mock", factory);
const resolved = getContextEngineFactory("mock");
expect(resolved).toBe(factory);
const engine = await resolved!();
expect(engine).toBeInstanceOf(MockContextEngine);
expect(engine.info.id).toBe("mock");
});
it("ingest() returns IngestResult with ingested boolean", async () => {
const engine = new MockContextEngine();
const result = await engine.ingest({
sessionId: "s1",
message: makeMockMessage(),
});
expect(result).toHaveProperty("ingested");
expect(typeof result.ingested).toBe("boolean");
expect(result.ingested).toBe(true);
});
it("assemble() returns AssembleResult with messages array and estimatedTokens", async () => {
const engine = new MockContextEngine();
const msgs = [makeMockMessage(), makeMockMessage("assistant", "world")];
const result = await engine.assemble({
sessionId: "s1",
messages: msgs,
});
expect(Array.isArray(result.messages)).toBe(true);
expect(result.messages).toHaveLength(2);
expect(typeof result.estimatedTokens).toBe("number");
expect(result.estimatedTokens).toBe(42);
expect(result.systemPromptAddition).toBe("mock system addition");
});
it("compact() returns CompactResult with ok, compacted, reason, result fields", async () => {
const engine = new MockContextEngine();
const result = await engine.compact({
sessionId: "s1",
sessionFile: "/tmp/session.json",
});
expect(typeof result.ok).toBe("boolean");
expect(typeof result.compacted).toBe("boolean");
expect(result.ok).toBe(true);
expect(result.compacted).toBe(true);
expect(result.reason).toBe("mock compaction");
expect(result.result).toBeDefined();
expect(result.result!.summary).toBe("mock summary");
expect(result.result!.tokensBefore).toBe(100);
expect(result.result!.tokensAfter).toBe(50);
});
it("dispose() is callable (optional method)", async () => {
const engine = new MockContextEngine();
// Should complete without error
await expect(engine.dispose()).resolves.toBeUndefined();
});
it("legacy compact preserves runtimeContext currentTokenCount when top-level value is absent", async () => {
const engine = new LegacyContextEngine();
await engine.compact({
sessionId: "s1",
sessionFile: "/tmp/session.json",
runtimeContext: {
workspaceDir: "/tmp/workspace",
currentTokenCount: 277403,
},
});
expect(mockedCompactEmbeddedPiSessionDirect).toHaveBeenCalledWith(
expect.objectContaining({
currentTokenCount: 277403,
}),
);
});
});
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// 2. Registry tests
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe("Registry tests", () => {
it("registerContextEngine() stores a factory", () => {
const factory = () => new MockContextEngine();
registerContextEngine("reg-test-1", factory);
expect(getContextEngineFactory("reg-test-1")).toBe(factory);
});
it("getContextEngineFactory() returns the factory", () => {
const factory = () => new MockContextEngine();
registerContextEngine("reg-test-2", factory);
const retrieved = getContextEngineFactory("reg-test-2");
expect(retrieved).toBe(factory);
expect(typeof retrieved).toBe("function");
});
it("listContextEngineIds() returns all registered ids", () => {
// Ensure at least our test entries exist
registerContextEngine("reg-test-a", () => new MockContextEngine());
registerContextEngine("reg-test-b", () => new MockContextEngine());
const ids = listContextEngineIds();
expect(ids).toContain("reg-test-a");
expect(ids).toContain("reg-test-b");
expect(Array.isArray(ids)).toBe(true);
});
it("registering the same id overwrites the previous factory", () => {
const factory1 = () => new MockContextEngine();
const factory2 = () => new MockContextEngine();
registerContextEngine("reg-overwrite", factory1);
expect(getContextEngineFactory("reg-overwrite")).toBe(factory1);
registerContextEngine("reg-overwrite", factory2);
expect(getContextEngineFactory("reg-overwrite")).toBe(factory2);
expect(getContextEngineFactory("reg-overwrite")).not.toBe(factory1);
});
it("shares registered engines across duplicate module copies", async () => {
const registryUrl = new URL("./registry.ts", import.meta.url).href;
const suffix = Date.now().toString(36);
const first = await import(/* @vite-ignore */ `${registryUrl}?copy=${suffix}-a`);
const second = await import(/* @vite-ignore */ `${registryUrl}?copy=${suffix}-b`);
const engineId = `dup-copy-${suffix}`;
const factory = () => new MockContextEngine();
first.registerContextEngine(engineId, factory);
expect(second.getContextEngineFactory(engineId)).toBe(factory);
});
});
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// 3. Default engine selection
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe("Default engine selection", () => {
// Ensure both legacy and a custom test engine are registered before these tests.
beforeEach(() => {
// Registration is idempotent (Map.set), so calling again is safe.
registerLegacyContextEngine();
// Register a lightweight custom stub so we don't need external resources.
registerContextEngine("test-engine", () => {
const engine: ContextEngine = {
info: { id: "test-engine", name: "Custom Test Engine", version: "0.0.0" },
async ingest() {
return { ingested: true };
},
async assemble({ messages }) {
return { messages, estimatedTokens: 0 };
},
async compact() {
return { ok: true, compacted: false };
},
};
return engine;
});
});
it("resolveContextEngine() with no config returns the default ('legacy') engine", async () => {
const engine = await resolveContextEngine();
expect(engine.info.id).toBe("legacy");
});
it("resolveContextEngine() with config contextEngine='legacy' returns legacy engine", async () => {
const engine = await resolveContextEngine(configWithSlot("legacy"));
expect(engine.info.id).toBe("legacy");
});
it("resolveContextEngine() with config contextEngine='test-engine' returns the custom engine", async () => {
const engine = await resolveContextEngine(configWithSlot("test-engine"));
expect(engine.info.id).toBe("test-engine");
});
});
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// 4. Invalid engine fallback
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe("Invalid engine fallback", () => {
it("resolveContextEngine() with config pointing to unregistered engine throws with helpful error", async () => {
await expect(resolveContextEngine(configWithSlot("nonexistent-engine"))).rejects.toThrow(
/nonexistent-engine/,
);
});
it("error message includes the requested id and available ids", async () => {
// Ensure at least legacy is registered so we see it in the available list
registerLegacyContextEngine();
try {
await resolveContextEngine(configWithSlot("does-not-exist"));
// Should not reach here
expect.unreachable("Expected resolveContextEngine to throw");
} catch (err: unknown) {
const message = err instanceof Error ? err.message : String(err);
expect(message).toContain("does-not-exist");
expect(message).toContain("not registered");
// Should mention available engines
expect(message).toMatch(/Available engines:/);
// At least "legacy" should be listed as available
expect(message).toContain("legacy");
}
});
});
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// 5. LegacyContextEngine parity
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe("LegacyContextEngine parity", () => {
it("ingest() returns { ingested: false } (no-op)", async () => {
const engine = new LegacyContextEngine();
const result = await engine.ingest({
sessionId: "s1",
message: makeMockMessage(),
});
expect(result).toEqual({ ingested: false });
});
it("assemble() returns messages as-is (pass-through)", async () => {
const engine = new LegacyContextEngine();
const messages = [
makeMockMessage("user", "first"),
makeMockMessage("assistant", "second"),
makeMockMessage("user", "third"),
];
const result = await engine.assemble({
sessionId: "s1",
messages,
});
// Messages should be the exact same array reference (pass-through)
expect(result.messages).toBe(messages);
expect(result.messages).toHaveLength(3);
expect(result.estimatedTokens).toBe(0);
expect(result.systemPromptAddition).toBeUndefined();
});
it("dispose() completes without error", async () => {
const engine = new LegacyContextEngine();
await expect(engine.dispose()).resolves.toBeUndefined();
});
});
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// 6. Initialization guard
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe("Initialization guard", () => {
it("ensureContextEnginesInitialized() is idempotent (calling twice does not throw)", async () => {
const { ensureContextEnginesInitialized } = await import("./init.js");
expect(() => ensureContextEnginesInitialized()).not.toThrow();
expect(() => ensureContextEnginesInitialized()).not.toThrow();
});
it("after init, 'legacy' engine is registered", async () => {
const { ensureContextEnginesInitialized } = await import("./init.js");
ensureContextEnginesInitialized();
const ids = listContextEngineIds();
expect(ids).toContain("legacy");
});
});
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// 7. Bundle chunk isolation (#40096)
//
// Published builds may split the context-engine registry across multiple
// output chunks. The Symbol.for() keyed global ensures that a plugin
// calling registerContextEngine() from chunk A is visible to
// resolveContextEngine() imported from chunk B.
//
// These tests exercise the invariant that failed in 2026.3.7 when
// lossless-claw registered successfully but resolution could not find it.
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
describe("Bundle chunk isolation (#40096)", () => {
it("Symbol.for key is stable across independently loaded modules", async () => {
// Simulate two distinct bundle chunks by loading the registry module
// twice with different query strings (forces separate module instances
// in Vite/esbuild but shares globalThis).
const ts = Date.now().toString(36);
const registryUrl = new URL("./registry.ts", import.meta.url).href;
const chunkA = await import(/* @vite-ignore */ `${registryUrl}?chunk=a-${ts}`);
const chunkB = await import(/* @vite-ignore */ `${registryUrl}?chunk=b-${ts}`);
// Chunk A registers an engine
const engineId = `cross-chunk-${ts}`;
chunkA.registerContextEngine(engineId, () => new MockContextEngine());
// Chunk B must see it
expect(chunkB.getContextEngineFactory(engineId)).toBeDefined();
expect(chunkB.listContextEngineIds()).toContain(engineId);
});
it("resolveContextEngine from chunk B finds engine registered in chunk A", async () => {
const ts = Date.now().toString(36);
const registryUrl = new URL("./registry.ts", import.meta.url).href;
const chunkA = await import(/* @vite-ignore */ `${registryUrl}?chunk=resolve-a-${ts}`);
const chunkB = await import(/* @vite-ignore */ `${registryUrl}?chunk=resolve-b-${ts}`);
const engineId = `resolve-cross-${ts}`;
chunkA.registerContextEngine(engineId, () => ({
info: { id: engineId, name: "Cross-chunk Engine", version: "0.0.1" },
async ingest() {
return { ingested: true };
},
async assemble({ messages }: { messages: AgentMessage[] }) {
return { messages, estimatedTokens: 0 };
},
async compact() {
return { ok: true, compacted: false };
},
}));
// Resolve from chunk B using a config that points to this engine
const engine = await chunkB.resolveContextEngine(configWithSlot(engineId));
expect(engine.info.id).toBe(engineId);
});
it("plugin-sdk export path shares the same global registry", async () => {
// The plugin-sdk re-exports registerContextEngine. Verify the
// re-export writes to the same global symbol as the direct import.
const ts = Date.now().toString(36);
const engineId = `sdk-path-${ts}`;
// Direct registry import
registerContextEngine(engineId, () => new MockContextEngine());
// Plugin-sdk import (different chunk path in the published bundle)
const sdkUrl = new URL("../plugin-sdk/index.ts", import.meta.url).href;
const sdk = await import(/* @vite-ignore */ `${sdkUrl}?sdk-${ts}`);
// The SDK export should see the engine we just registered
const factory = getContextEngineFactory(engineId);
expect(factory).toBeDefined();
// And registering from the SDK path should be visible from the direct path
const sdkEngineId = `sdk-registered-${ts}`;
sdk.registerContextEngine(sdkEngineId, () => new MockContextEngine());
expect(getContextEngineFactory(sdkEngineId)).toBeDefined();
});
it("concurrent registration from multiple chunks does not lose entries", async () => {
const ts = Date.now().toString(36);
const registryUrl = new URL("./registry.ts", import.meta.url).href;
let releaseRegistrations: (() => void) | undefined;
const registrationStart = new Promise<void>((resolve) => {
releaseRegistrations = resolve;
});
// Load 5 "chunks" in parallel
const chunks = await Promise.all(
Array.from(
{ length: 5 },
(_, i) => import(/* @vite-ignore */ `${registryUrl}?concurrent-${ts}-${i}`),
),
);
const ids = chunks.map((_, i) => `concurrent-${ts}-${i}`);
const registrationTasks = chunks.map(async (chunk, i) => {
const id = `concurrent-${ts}-${i}`;
await registrationStart;
chunk.registerContextEngine(id, () => new MockContextEngine());
});
releaseRegistrations?.();
await Promise.all(registrationTasks);
// All 5 engines must be visible from any chunk
const allIds = chunks[0].listContextEngineIds();
for (const id of ids) {
expect(allIds).toContain(id);
}
});
});
|