Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

Make shadow fixture loss waits event-driven (#6631)

Nick Gomezb9be6b8260b3
diff --git a/knip.config.ts b/knip.config.ts
index e43118957..eb9727af8 100644
--- a/knip.config.ts
+++ b/knip.config.ts
@@ -155,11 +155,15 @@ export default {
'src/shadow-fixture-launch.test-helper.mjs',
],
project: 'src/**',
- ignoreDependencies: ['@types/shell-quote'],
+ ignoreDependencies: [
+ '@types/shell-quote',
+ ],
},
'packages/cli': {
entry: ['src/**/*.test.ts', 'scripts/*.ts', 'tests/**/*.ts', 'src/parse-worker.ts'],
- ignoreDependencies: ['yjs'],
+ ignoreDependencies: [
+ 'yjs',
+ ],
},
'packages/desktop': {
entry: [
diff --git a/packages/app/tests/integration/bug3-source-mode-writeback.test.ts b/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
index a50b00123..4549c74b3 100644
--- a/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
+++ b/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
@@ -1,3 +1,4 @@
+
import { readFileSync } from 'node:fs';
import { join } from 'node:path';
import { setTimeout as wait } from 'node:timers/promises';
diff --git a/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts b/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
index 6fcdc23f2..4fc2c11f9 100644
--- a/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
+++ b/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { normalizeBridge } from '@inkeep/open-knowledge-core';
import { updateYFragment } from '@tiptap/y-tiptap';
diff --git a/packages/app/tests/integration/interior-edit-freshness.test.ts b/packages/app/tests/integration/interior-edit-freshness.test.ts
index 40b5cdfd6..9f2f6feb6 100644
--- a/packages/app/tests/integration/interior-edit-freshness.test.ts
+++ b/packages/app/tests/integration/interior-edit-freshness.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts b/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
index 93666af70..2a085742b 100644
--- a/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
+++ b/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/producer-guard-wiring.test.ts b/packages/app/tests/integration/producer-guard-wiring.test.ts
index 867598d34..878d5196b 100644
--- a/packages/app/tests/integration/producer-guard-wiring.test.ts
+++ b/packages/app/tests/integration/producer-guard-wiring.test.ts
@@ -1,3 +1,4 @@
+
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts b/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
index 0970ac12f..4ada3cf26 100644
--- a/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
+++ b/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
@@ -1,3 +1,4 @@
+
import { randomUUID } from 'node:crypto';
import { afterEach, describe, expect, test } from 'vitest';
import { agentWriteMd, createTestServer, type TestServer } from './test-harness';
diff --git a/packages/app/tests/integration/qa-045-restore-after-gc.test.ts b/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
index b632185e1..cbe2b705f 100644
--- a/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
+++ b/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
@@ -1,3 +1,4 @@
+
import { execFileSync } from 'node:child_process';
import { randomUUID } from 'node:crypto';
import { join } from 'node:path';
diff --git a/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts b/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
index c530ce4ba..89bc9b4d9 100644
--- a/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
+++ b/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
@@ -1,3 +1,4 @@
+
import { randomUUID } from 'node:crypto';
import { afterAll, afterEach, beforeAll, describe, expect, test } from 'vitest';
import type * as Y from 'yjs';
diff --git a/packages/app/tests/integration/undo-after-rollback.test.ts b/packages/app/tests/integration/undo-after-rollback.test.ts
index d3767adc9..a78aeb0e4 100644
--- a/packages/app/tests/integration/undo-after-rollback.test.ts
+++ b/packages/app/tests/integration/undo-after-rollback.test.ts
@@ -1,3 +1,4 @@
+
import { ROLLBACK_ORIGIN } from '@inkeep/open-knowledge-server';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
import * as Y from 'yjs';
diff --git a/packages/app/tests/integration/undo-recycle-reset.test.ts b/packages/app/tests/integration/undo-recycle-reset.test.ts
index b076f955c..e7cc69c3f 100644
--- a/packages/app/tests/integration/undo-recycle-reset.test.ts
+++ b/packages/app/tests/integration/undo-recycle-reset.test.ts
@@ -1,3 +1,4 @@
+
import { writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { setTimeout as wait } from 'node:timers/promises';
diff --git a/packages/app/tests/integration/undo-rederive-survival.test.ts b/packages/app/tests/integration/undo-rederive-survival.test.ts
index 7935e35f8..9ddcd0730 100644
--- a/packages/app/tests/integration/undo-rederive-survival.test.ts
+++ b/packages/app/tests/integration/undo-rederive-survival.test.ts
@@ -1,3 +1,4 @@
+
import { prependFrontmatter } from '@inkeep/open-knowledge-core';
import { Plugin, PluginKey } from '@tiptap/pm/state';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
diff --git a/packages/core/src/bridge/compose.ts b/packages/core/src/bridge/compose.ts
index f4cc8a286..2a597ec3d 100644
--- a/packages/core/src/bridge/compose.ts
+++ b/packages/core/src/bridge/compose.ts
@@ -1,3 +1,4 @@
+
import { prependFrontmatter, stripFrontmatter } from '../extensions/frontmatter.ts';
export type ComposeAdjustment = 'none' | 'body' | 'frontmatter' | 'unresolved';
diff --git a/packages/core/src/bridge/doc-boundary-space.ts b/packages/core/src/bridge/doc-boundary-space.ts
index e7e63f43d..ffd8fce06 100644
--- a/packages/core/src/bridge/doc-boundary-space.ts
+++ b/packages/core/src/bridge/doc-boundary-space.ts
@@ -1,3 +1,4 @@
+
import { FRONTMATTER_RE, stripFrontmatter } from '../extensions/frontmatter.ts';
import { carriedEdgeEmpties, type DocEdgeEmpties } from '../markdown/doc-edge-blank-runs.ts';
diff --git a/packages/core/src/markdown/comment-promoter.ts b/packages/core/src/markdown/comment-promoter.ts
index fc267cbea..fb0ba5a7c 100644
--- a/packages/core/src/markdown/comment-promoter.ts
+++ b/packages/core/src/markdown/comment-promoter.ts
@@ -1,3 +1,4 @@
+
import type { Nodes, Paragraph, PhrasingContent, Root, RootContent, Text } from 'mdast';
import { SKIP, visit } from 'unist-util-visit';
import type { VFile } from 'vfile';
diff --git a/packages/core/src/markdown/merged-walker.ts b/packages/core/src/markdown/merged-walker.ts
index 861003fb4..ae8cb390b 100644
--- a/packages/core/src/markdown/merged-walker.ts
+++ b/packages/core/src/markdown/merged-walker.ts
@@ -1,3 +1,4 @@
+
import type { Nodes, Parent, Root } from 'mdast';
import { SKIP, visit } from 'unist-util-visit';
import type { VFile } from 'vfile';
diff --git a/packages/core/src/markdown/safe-url.ts b/packages/core/src/markdown/safe-url.ts
index 4d3250d3a..8be632ba4 100644
--- a/packages/core/src/markdown/safe-url.ts
+++ b/packages/core/src/markdown/safe-url.ts
@@ -1,3 +1,4 @@
+
export const SAFE_URL_SCHEMES = ['https', 'http', 'mailto', 'tel', 'ftp', 'sms'] as const;
const SCHEME_ALT = SAFE_URL_SCHEMES.map((s) => `${s}:`).join('|');
diff --git a/packages/server/src/shadow-fixture-owner.test-helper.mjs b/packages/server/src/shadow-fixture-owner.test-helper.mjs
index 38f5ad3b0..06ffd031f 100644
--- a/packages/server/src/shadow-fixture-owner.test-helper.mjs
+++ b/packages/server/src/shadow-fixture-owner.test-helper.mjs
@@ -31,6 +31,7 @@ let deadline;
let cleanupPromise;
let runner;
let runnerExit;
+let workerLossRequested = false;
let stopping = false;
function bindCompilerOwner(owner, child, terminate) {
@@ -249,12 +250,13 @@ async function cleanup(reason) {
.filter(Boolean)
.map((line) => JSON.parse(line))
: [];
+ const workerLossObserved =
+ runtimes.some((row) => row.workerExit !== undefined && row.code !== 0) &&
+ runtimes.some((row) => row.terminateRequested !== undefined);
rmSync(workDir, { recursive: true, force: true });
const receipt = {
reason:
- reason === 'runner closed' &&
- runtimes.some((row) => row.workerExit !== undefined && row.code !== 0) &&
- runtimes.some((row) => row.terminateRequested !== undefined)
+ reason === 'runner closed' && (workerLossRequested || workerLossObserved)
? 'test worker lost'
: reason,
trigger: reason,
@@ -283,6 +285,7 @@ async function cleanup(reason) {
function start(value) {
if (config) throw new Error('fixture owner already started');
config = { runId: randomUUID(), autoCleanup: true, maxLifetimeMs: 540_000, ...value };
+ workerLossRequested = false;
mkdirSync(config.resultDir, { recursive: true });
workDir = realpathSync(mkdtempSync(join(config.scratchRoot ?? tmpdir(), 'ok-shadow-owned-')));
transport = join(workDir, 'transport');
@@ -310,6 +313,7 @@ function start(value) {
TEMP: workDir,
OK_SHADOW_OWNER_TRANSPORT: transport,
OK_SHADOW_OWNER_RUN_ID: config.runId,
+ ...(config.readinessGate ? { OK_SHADOW_READINESS_GATE: '1' } : {}),
},
stdio: ['ignore', 'pipe', 'pipe', 'ipc'],
},
@@ -342,8 +346,15 @@ process.on('message', (message) => {
if (message.type === 'start') start(message.config);
else if (message.type === 'release') void cleanup('normal release');
else if (message.type === 'lose-runner') signal(runner, 'SIGKILL');
- else if (message.type === 'lose-worker') runner.child.send({ type: 'lose-worker' });
- else if (message.type === 'hold-git')
+ else if (message.type === 'release-readiness') runner.child.send({ type: 'release-readiness' });
+ else if (message.type === 'lose-worker') {
+ workerLossRequested = true;
+ if (config.dropWorkerLossRequest) {
+ record({ type: 'worker-loss-requested', target: 'runner', delivered: false });
+ } else {
+ runner.child.send({ type: 'lose-worker' });
+ }
+ } else if (message.type === 'hold-git')
acquire(
'held-native-git',
'git',
diff --git a/packages/server/src/shadow-fixture-preload.test-helper.cjs b/packages/server/src/shadow-fixture-preload.test-helper.cjs
index 90e9e0e12..e3d04ca13 100644
--- a/packages/server/src/shadow-fixture-preload.test-helper.cjs
+++ b/packages/server/src/shadow-fixture-preload.test-helper.cjs
@@ -18,9 +18,16 @@ const runId = process.env.OK_SHADOW_OWNER_RUN_ID;
const clock = new Int32Array(new SharedArrayBuffer(4));
const NativeChildProcess = cp.ChildProcess;
const environmentKey = 'ok-shadow-fixture-environment';
+const readinessGate = process.env.OK_SHADOW_READINESS_GATE === '1';
const baseline = threads.isMainThread
? { ...process.env }
: threads.getEnvironmentData(environmentKey);
+const readinessSignal =
+ readinessGate && threads.isMainThread ? new Int32Array(new SharedArrayBuffer(4)) : undefined;
+if (readinessGate && !threads.isMainThread) {
+ const shared = threads.workerData?.__okShadowReadinessSignal;
+ if (shared) Atomics.wait(new Int32Array(shared), 0, 0);
+}
function environmentFor(env) {
return {
@@ -184,8 +191,12 @@ if (transport) {
threads.Worker = class extends NativeWorker {
constructor(filename, options) {
const execArgv = options?.execArgv ?? process.execArgv;
+ const workerData = readinessSignal
+ ? { ...options?.workerData, __okShadowReadinessSignal: readinessSignal.buffer }
+ : options?.workerData;
super(filename, {
...options,
+ ...(readinessSignal ? { workerData } : {}),
execArgv: execArgv.includes(__filename)
? execArgv
: ['--require', __filename, ...execArgv],
@@ -204,6 +215,11 @@ if (transport) {
}
};
process.on('message', (message) => {
+ if (message.type === 'release-readiness' && readinessSignal) {
+ Atomics.store(readinessSignal, 0, 1);
+ Atomics.notify(readinessSignal, 0);
+ return;
+ }
if (message.type !== 'lose-worker') return;
for (const worker of workers) {
appendFileSync(
diff --git a/packages/server/src/shadow-fixture-safety.test.ts b/packages/server/src/shadow-fixture-safety.test.ts
index a5928dd80..ce9b7bb86 100644
--- a/packages/server/src/shadow-fixture-safety.test.ts
+++ b/packages/server/src/shadow-fixture-safety.test.ts
@@ -102,6 +102,52 @@ function pendingFence(resultDir: string): string | undefined {
return undefined;
}
+function waitForOwnerEvent(owner: ReturnType<typeof fork>, resultDir: string, type: string) {
+ const find = () => events(resultDir).find((row) => row.type === type);
+ const existing = find();
+ if (existing) return Promise.resolve(existing);
+ return new Promise((resolve, reject) => {
+ let settled = false;
+ const finish = (callback: () => void) => {
+ if (settled) return;
+ settled = true;
+ owner.off('message', onMessage);
+ owner.off('exit', onExit);
+ owner.off('disconnect', onDisconnect);
+ callback();
+ };
+ const onMessage = (message: { type?: string; row?: { type?: string } }) => {
+ if (message.type === 'event' && message.row?.type === type)
+ finish(() => resolve(message.row));
+ };
+ const onExit = (code: number | null, signal: string | null) =>
+ finish(() =>
+ reject(
+ new Error(
+ `owner exited before ${type}: code=${code ?? 'null'} signal=${signal ?? 'null'} observed=${
+ [...new Set(events(resultDir).map((row) => row.type))].join(',') || 'none'
+ }`,
+ ),
+ ),
+ );
+ const onDisconnect = () =>
+ finish(() =>
+ reject(
+ new Error(
+ `owner disconnected before ${type}: observed=${
+ [...new Set(events(resultDir).map((row) => row.type))].join(',') || 'none'
+ }`,
+ ),
+ ),
+ );
+ owner.on('message', onMessage);
+ owner.once('exit', onExit);
+ owner.once('disconnect', onDisconnect);
+ const observed = find();
+ if (observed) finish(() => resolve(observed));
+ });
+}
+
test('native Git acquisitions preserve synchronous results under a live owner', async (context) => {
const { resultDir, closed } = createOwner(context);
await expect
@@ -297,9 +343,11 @@ test('the frozen shadow fixture is reclaimed after abrupt test-worker loss', asy
'--no-file-parallelism',
'--reporter=verbose',
],
- { holdCapture: true },
+ { holdCapture: true, readinessGate: true },
);
- await expect.poll(() => pendingFence(resultDir), { timeout: 10_000, interval: 10 }).toBeDefined();
+ await waitForOwnerEvent(owner, resultDir, 'worker-start');
+ owner.send({ type: 'release-readiness' });
+ await waitForOwnerEvent(owner, resultDir, 'capture-held');
const fence = pendingFence(resultDir);
expect(fence).toBeDefined();
if (!fence) throw new Error('pending fence disappeared before the owner-loss observation');
@@ -307,9 +355,6 @@ test('the frozen shadow fixture is reclaimed after abrupt test-worker loss', asy
const before = events(resultDir);
expect(before.some((row) => row.type === 'worker-start')).toBe(true);
expect(before.some((row) => row.type === 'spawn' && row.args?.includes('write-tree'))).toBe(true);
- await expect
- .poll(() => events(resultDir).some((row) => row.type === 'capture-held'), { timeout: 3_000 })
- .toBe(true);
owner.send({ type: 'lose-worker' });
await expect
.poll(() => existsSync(join(resultDir, 'cleanup.json')), { timeout: 5_000 })
@@ -317,6 +362,14 @@ test('the frozen shadow fixture is reclaimed after abrupt test-worker loss', asy
await closed;
const receipt = JSON.parse(readFileSync(join(resultDir, 'cleanup.json'), 'utf8'));
expect(receipt.reason).toBe('test worker lost');
+ expect(receipt.trigger, `runnerExit=${JSON.stringify(receipt.runnerExit)}`).toBe(
+ 'test worker lost',
+ );
+ expect(
+ receipt.runtimes.some(
+ (row: { terminateRequested?: number }) => row.terminateRequested !== undefined,
+ ),
+ ).toBe(true);
expect(
receipt.runtimes.some(
(row: { workerExit?: number; code: number }) =>
@@ -328,6 +381,70 @@ test('the frozen shadow fixture is reclaimed after abrupt test-worker loss', asy
expect(existsSync(fence)).toBe(false);
});
+test('runner close after a worker-loss request is attributed to the requested worker loss', async (context) => {
+ const { resultDir, closed, owner } = createOwner(
+ context,
+ [
+ VITEST,
+ 'run',
+ 'src/shadow-settle-fence.test.ts',
+ '--pool=threads',
+ '--maxWorkers=1',
+ '--no-file-parallelism',
+ '--reporter=verbose',
+ ],
+ { holdCapture: true, readinessGate: true, dropWorkerLossRequest: true },
+ );
+ await waitForOwnerEvent(owner, resultDir, 'worker-start');
+ owner.send({ type: 'release-readiness' });
+ await waitForOwnerEvent(owner, resultDir, 'capture-held');
+ const fence = pendingFence(resultDir);
+ expect(fence).toBeDefined();
+ if (!fence) throw new Error('pending fence disappeared before the runner-loss observation');
+ owner.send({ type: 'lose-worker' });
+ await expect
+ .poll(
+ () =>
+ events(resultDir).some(
+ (row) => row.type === 'worker-loss-requested' && row.delivered === false,
+ ),
+ { timeout: 3_000 },
+ )
+ .toBe(true);
+ owner.send({ type: 'lose-runner' });
+ await expect
+ .poll(() => existsSync(join(resultDir, 'cleanup.json')), { timeout: 5_000 })
+ .toBe(true);
+ await closed;
+ const receipt = JSON.parse(readFileSync(join(resultDir, 'cleanup.json'), 'utf8'));
+ expect(receipt.reason).toBe('test worker lost');
+ expect(receipt.trigger).toBe('runner closed');
+ expect(receipt.runnerExit).toEqual({ code: null, signal: 'SIGKILL' });
+ expect(
+ receipt.events.some(
+ (row: { type: string; delivered?: boolean }) =>
+ row.type === 'worker-loss-requested' && row.delivered === false,
+ ),
+ ).toBe(true);
+ expect(
+ receipt.runtimes.some(
+ (row: { threadId?: number; execArgv?: string[] }) =>
+ row.execArgv !== undefined && row.threadId !== undefined && row.threadId !== 0,
+ ),
+ ).toBe(true);
+ expect(
+ receipt.runtimes.some((row: { workerExit?: number }) => row.workerExit !== undefined),
+ ).toBe(false);
+ expect(
+ receipt.runtimes.some(
+ (row: { terminateRequested?: number }) => row.terminateRequested !== undefined,
+ ),
+ ).toBe(false);
+ expect(receipt.children.every((child: { close: unknown }) => child.close)).toBe(true);
+ expect(receipt.workDirAbsent).toBe(true);
+ expect(existsSync(fence)).toBe(false);
+});
+
test('the frozen shadow fixture and live native Git are reclaimed after abrupt runner loss', async (context) => {
const { resultDir, closed, owner } = createOwner(
context,
@@ -340,9 +457,11 @@ test('the frozen shadow fixture and live native Git are reclaimed after abrupt r
'--no-file-parallelism',
'--reporter=verbose',
],
- { holdCapture: true },
+ { holdCapture: true, readinessGate: true },
);
- await expect.poll(() => pendingFence(resultDir), { timeout: 10_000, interval: 10 }).toBeDefined();
+ await waitForOwnerEvent(owner, resultDir, 'worker-start');
+ owner.send({ type: 'release-readiness' });
+ await waitForOwnerEvent(owner, resultDir, 'capture-held');
const fence = pendingFence(resultDir);
expect(fence).toBeDefined();
if (!fence) throw new Error('pending fence disappeared before the runner-loss observation');