File size: 7,040 Bytes
76289e7 | 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 | import { DatabaseSync } from "node:sqlite";
import { expect, it, vi } from "vitest";
import { createDeferred } from "../../test/helpers/promise.js";
import { createEmptyPluginRegistry } from "../plugins/registry-empty.js";
import { PluginRegistryInspectionResources } from "../plugins/registry-inspection-resources.js";
import { retireInspectionInstances } from "../plugins/registry-inspection.test-support.js";
import { withPluginRuntimeRegistryScope } from "../plugins/runtime/gateway-request-scope.js";
import { getAsyncWorkSignal, trackAsyncWork } from "../shared/async-work-scope.js";
import { LegacyContextEngine } from "./legacy.js";
import { registerContextEngineInRegistry, resolveContextEngine } from "./registry.js";
import type { ContextEngine } from "./types.js";
it.each([
"ready",
"pending",
"rejected-factory",
"primary-failure",
"fallback-failure",
"shared",
"legacy",
"unused",
] as const)("releases foreground factory resources after lazy fallback (%s)", async (mode) => {
const registry = createEmptyPluginRegistry();
const resources = new PluginRegistryInspectionResources(retireInspectionInstances);
resources.attach(registry);
const database = new DatabaseSync(":memory:");
let sourceDisposals = 0;
resources.register("fixture", {
id: "native",
dispose() {
sourceDisposals++;
database.close();
},
});
const fallbackStarted = createDeferred();
const fallbackGate = createDeferred();
const cleanupGate = createDeferred();
const factoryFailure = new Error("fallback factory failed");
let rawCleanup: Promise<void> | undefined;
const cleanupReads: number[] = [];
const primaryFailure = new Error("configured cleanup failed");
const fallbackFailure = new Error("fallback cleanup failed");
let primaryDisposals = 0;
let fallbackDisposals = 0;
let fallbackFactories = 0;
let fallbackClosedAfterDisposalStarted: boolean | undefined;
let primaryCalls = 0;
class SelectedEngine extends LegacyContextEngine {
override async assemble(params: Parameters<ContextEngine["assemble"]>[0]) {
if (++primaryCalls === 1 || mode !== "shared") {
throw new Error("configured store unavailable");
}
return await super.assemble(params);
}
async dispose() {
primaryDisposals++;
expect(database.prepare("SELECT 42 AS value").get()?.value).toBe(42);
if (mode === "primary-failure") {
throw primaryFailure;
}
}
}
class FallbackEngine extends LegacyContextEngine {
async dispose() {
fallbackDisposals++;
expect(database.prepare("SELECT 42 AS value").get()?.value).toBe(42);
if (mode === "fallback-failure") {
throw fallbackFailure;
}
}
}
const primary = new SelectedEngine();
registerContextEngineInRegistry(
registry,
"legacy",
async () => {
fallbackFactories++;
getAsyncWorkSignal()?.addEventListener(
"abort",
() => {
fallbackClosedAfterDisposalStarted =
(mode === "shared" ? primaryDisposals : fallbackDisposals) > 0;
},
{ once: true },
);
fallbackStarted.resolve();
if (mode === "rejected-factory") {
rawCleanup = trackAsyncWork(async () => {
await cleanupGate.promise;
cleanupReads.push(Number(database.prepare("SELECT 42 AS value").get()?.value));
});
}
if (mode === "pending" || mode === "rejected-factory") {
await fallbackGate.promise;
}
if (mode === "rejected-factory") {
throw factoryFailure;
}
return mode === "shared"
? primary
: mode === "legacy"
? new LegacyContextEngine()
: new FallbackEngine();
},
"core",
);
const selectedId = `fallback-resources-${mode}`;
registerContextEngineInRegistry(registry, selectedId, () => primary, "plugin:fixture");
const warn = vi.spyOn(console, "error").mockImplementation(() => {});
const params = { sessionId: "fallback-session", messages: [] };
let engine: ContextEngine | undefined;
let operation: Promise<unknown> | undefined;
let cleanup: Promise<void> | undefined;
try {
engine = await withPluginRuntimeRegistryScope(registry, () =>
resolveContextEngine({ plugins: { slots: { contextEngine: selectedId } } }),
);
if (mode !== "unused") {
operation = withPluginRuntimeRegistryScope(registry, () => engine!.assemble(params));
if (mode === "rejected-factory") {
operation = expect(operation).rejects.toThrow("configured store unavailable");
}
await fallbackStarted.promise;
if (mode !== "pending" && mode !== "rejected-factory") {
await operation;
}
}
await resources.release();
let settled = false;
cleanup = Promise.resolve(engine.dispose?.()).finally(() => {
settled = true;
});
const outcome = cleanup.then(
() => undefined,
(error: unknown) => error,
);
if (mode === "pending" || mode === "rejected-factory") {
await new Promise<void>((resolve) => {
setImmediate(resolve);
});
expect.soft(settled).toBe(false);
expect.soft(database.isOpen).toBe(true);
fallbackGate.resolve();
await operation;
if (mode === "rejected-factory") {
await new Promise<void>((resolve) => {
setImmediate(resolve);
});
expect.soft(settled).toBe(false);
expect.soft(database.isOpen).toBe(true);
cleanupGate.resolve();
await rawCleanup;
}
}
expect(await outcome).toBe(
mode === "primary-failure"
? primaryFailure
: mode === "fallback-failure"
? fallbackFailure
: mode === "rejected-factory"
? factoryFailure
: undefined,
);
expect.soft(primaryDisposals).toBe(1);
expect
.soft(fallbackDisposals)
.toBe(
mode === "shared" || mode === "legacy" || mode === "unused" || mode === "rejected-factory"
? 0
: 1,
);
if (mode === "rejected-factory") {
expect(cleanupReads).toEqual([42]);
}
if (mode !== "legacy" && mode !== "unused" && mode !== "rejected-factory") {
expect.soft(fallbackClosedAfterDisposalStarted).toBe(true);
}
expect.soft(sourceDisposals).toBe(1);
expect.soft(database.isOpen).toBe(false);
await Promise.resolve(engine.dispose?.()).catch(() => {});
expect.soft(primaryDisposals).toBe(1);
// A saved ordinary method cannot reopen the lazy factory after its owner closes.
await expect(
withPluginRuntimeRegistryScope(registry, () => engine!.assemble(params)),
).rejects.toThrow();
expect(fallbackFactories).toBe(mode === "unused" ? 0 : 1);
} finally {
fallbackGate.resolve();
cleanupGate.resolve();
await rawCleanup;
await operation?.catch(() => {});
await cleanup?.catch(() => {});
await resources.release();
if (database.isOpen) {
database.close();
}
warn.mockRestore();
}
});
|