Shared executor should wait behind a lifecycle hook so getExecutor() cannot reopen while a previous handle is still disposing

Griffin Evans committed 4 months ago

Commit d8fe55b1 parent 636e7092 files · +71 −7Browse files

Unified · Split

2 files

apps/local/src/executor.test.ts +54 −0
apps/local/src/executor.ts +17 −7

apps/local/src/executor.test.ts+54−0

@@ -0,0 +1,54 @@
	1	/* oxlint-disable executor/no-try-catch-or-throw -- test boundary: isolate process env and always dispose the shared executor handle */
	2	import { mkdtempSync, rmSync } from "node:fs";
	3	import { tmpdir } from "node:os";
	4	import { join } from "node:path";
	5
	6	import { describe, expect, it } from "@effect/vitest";
	7
	8	import { disposeExecutor, getExecutor, reloadExecutor } from "./executor";
	9
	10	const withIsolatedExecutorDataDir = async (body: () => Promise<void>): Promise<void> => {
	11	const previousDataDir = process.env.EXECUTOR_DATA_DIR;
	12	const previousScopeDir = process.env.EXECUTOR_SCOPE_DIR;
	13	const dataDir = mkdtempSync(join(tmpdir(), "executor-reload-race-"));
	14
	15	process.env.EXECUTOR_DATA_DIR = dataDir;
	16	process.env.EXECUTOR_SCOPE_DIR = dataDir;
	17
	18	try {
	19	await body();
	20	} finally {
	21	await disposeExecutor();
	22	if (previousDataDir === undefined) {
	23	delete process.env.EXECUTOR_DATA_DIR;
	24	} else {
	25	process.env.EXECUTOR_DATA_DIR = previousDataDir;
	26	}
	27	if (previousScopeDir === undefined) {
	28	delete process.env.EXECUTOR_SCOPE_DIR;
	29	} else {
	30	process.env.EXECUTOR_SCOPE_DIR = previousScopeDir;
	31	}
	32	rmSync(dataDir, { recursive: true, force: true });
	33	}
	34	};
	35
	36	describe("reloadExecutor", () => {
	37	it("waits for the previous owned database handle to release before reopening", async () => {
	38	await withIsolatedExecutorDataDir(async () => {
	39	await getExecutor();
	40	const executor = await reloadExecutor();
	41	expect(executor).toBeDefined();
	42	});
	43	});
	44
	45	it("serializes new shared executor opens behind an in-flight dispose", async () => {
	46	await withIsolatedExecutorDataDir(async () => {
	47	await getExecutor();
	48	const disposing = disposeExecutor();
	49	const executor = await getExecutor();
	50	await disposing;
	51	expect(executor).toBeDefined();
	52	});
	53	});
	54	});

apps/local/src/executor.ts+17−7

 export type ExecutorHandle = Awaited<ReturnType<typeof createExecutorHandle>>;
 let sharedHandlePromise: ReturnType<typeof createExecutorHandle> | null = null;
+let sharedHandleLifecycle: Promise<void> = Promise.resolve();
 const loadSharedHandle = () => {
   if (!sharedHandlePromise) {
-    sharedHandlePromise = createExecutorHandle();
+    sharedHandlePromise = sharedHandleLifecycle.then(() => createExecutorHandle());
   }
   return sharedHandlePromise;
 };
   const currentHandlePromise = sharedHandlePromise;
   sharedHandlePromise = null;
-  const handle = currentHandlePromise ? await handleOrNull(currentHandlePromise) : null;
+  const disposeCurrent = async (): Promise<void> => {
-  if (handle) {
+    const handle = currentHandlePromise ? await handleOrNull(currentHandlePromise) : null;
-    await ignorePromiseFailure("disposeExecutor", () => handle.dispose());
+    if (handle) {
-  }
+      await ignorePromiseFailure("disposeExecutor", () => handle.dispose());
+    }
+  };
+  const nextLifecycle = sharedHandleLifecycle.then(disposeCurrent, disposeCurrent);
+  sharedHandleLifecycle = nextLifecycle.then(
+    () => undefined,
+    () => undefined,
+  );
+  await nextLifecycle;
 };
-export const reloadExecutor = () => {
+export const reloadExecutor = async () => {
-  disposeExecutor();
+  await disposeExecutor();
   return getExecutor();
 };