Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
Make system refresh epoch tests deterministic (#5772)
Nick Gomez07f04aaa2d77
diff --git a/packages/app/tests/integration/system-refresh-epoch-rotation.test.ts b/packages/app/tests/integration/system-refresh-epoch-rotation.test.tsindex e08e605b9..96afd332f 100644--- a/packages/app/tests/integration/system-refresh-epoch-rotation.test.ts+++ b/packages/app/tests/integration/system-refresh-epoch-rotation.test.ts@@ -1,7 +1,7 @@import './idb-preload';import { writeFileSync } from 'node:fs';import { join } from 'node:path';-import { setTimeout as wait } from 'node:timers/promises';+import type { HocuspocusProvider } from '@hocuspocus/provider';import { afterEach, describe, expect, test, vi } from 'vitest';import { ProviderPool } from '../../src/editor/provider-pool';import { refreshServerInfo } from '../../src/lib/server-info-refresh';@@ -37,60 +37,115 @@ function countRecycleBegins(calls: readonly unknown[][]): number {}).length;}+function nextProviderEvent(+ provider: HocuspocusProvider,+ event: 'synced' | 'disconnect',+): Promise<void> {+ return new Promise((resolve) => {+ const listener = () => {+ provider.off(event, listener);+ resolve();+ };+ provider.on(event, listener);+ });+}++type FirstObserver = 'refresh' | 'subscriber';++const EXPECTED_RECYCLES_BEFORE_REFRESH = {+ refresh: 0,+ subscriber: 1,+} as const satisfies Record<FirstObserver, number>;+describe('__system__ refresh across a server epoch rotation', () => {- test('a refresh that observes the rotated epoch first still recycles the per-doc pool', async () => {- const infoSpy = vi.spyOn(console, 'info').mockImplementation(() => undefined);- cleanups.push(() => {- infoSpy.mockRestore();- });-- let server = await createRestartableServer();- cleanups.push(() => server.shutdown());-- const docName = 'system-refresh-rotation-doc';- writeFileSync(join(server.contentDir, `${docName}.md`), FIXTURE, 'utf-8');-- const pool = new ProviderPool(3, `ws://127.0.0.1:${server.port}/collab`, { storage: null });- cleanups.push(() => pool.dispose());- const firstEpoch = await seedPoolServerInstanceId(server, pool);-- pool.open(docName);- pool.setActive(docName);- await pollUntil(() => pool.getActive()?.provider.isSynced === true, 10_000, 50);- await pollUntil(() => pool.getActive()?.provider.unsyncedChanges === 0, 10_000, 50);- const staleProvider = pool.getActive()?.provider;- if (!staleProvider) throw new Error('expected an active provider before the restart');-- const systemSub = attachSystemDocSubscriber(pool, server.port);- cleanups.push(() => systemSub.dispose());- await wait(200);-- server = await server.killAndRestartOnSamePort({ downtimeMs: 300 });- cleanups.unshift(() => server.shutdown());-- const recyclesBeforeRefresh = countRecycleBegins(infoSpy.mock.calls);-- await refreshServerInfo(pool, `http://127.0.0.1:${server.port}`);- const recyclesAfterRefresh = countRecycleBegins(infoSpy.mock.calls);-- expect(recyclesAfterRefresh).toBeGreaterThan(recyclesBeforeRefresh);-- const secondEpoch = await pool.whenServerInstanceKnown();- expect(secondEpoch).not.toBe(firstEpoch);-- await pool.awaitMismatchSettled();- await pollUntil(- () => {- const entry = pool.entries.get(docName);- return entry !== undefined && entry.provider !== staleProvider;- },- 10_000,- 50,- );- expect(pool.entries.get(docName)?.provider).not.toBe(staleProvider);-- await pollUntil(() => pool.getActive()?.provider.isSynced === true, 15_000, 50);- const body = pool.getActive()?.provider.document.getText('source').toString() ?? '';- expect(body).toContain('Body paragraph that must survive the recycle.');- }, 60_000);+ for (const { name, firstObserver } of [+ {+ name: 'a refresh that observes the rotated epoch first still recycles the per-doc pool',+ firstObserver: 'refresh',+ },+ {+ name: 'a refresh after the subscriber observes the rotated epoch does not recycle twice',+ firstObserver: 'subscriber',+ },+ ] as const satisfies ReadonlyArray<{ name: string; firstObserver: FirstObserver }>) {+ test(name, async () => {+ const infoSpy = vi.spyOn(console, 'info').mockImplementation(() => undefined);+ cleanups.push(() => {+ infoSpy.mockRestore();+ });++ let server = await createRestartableServer();+ cleanups.push(() => server.shutdown());++ const docName = 'system-refresh-rotation-doc';+ writeFileSync(join(server.contentDir, `${docName}.md`), FIXTURE, 'utf-8');++ const pool = new ProviderPool(3, `ws://127.0.0.1:${server.port}/collab`, { storage: null });+ cleanups.push(() => pool.dispose());+ const firstEpoch = await seedPoolServerInstanceId(server, pool);++ pool.open(docName);+ pool.setActive(docName);+ await pollUntil(() => pool.getActive()?.provider.isSynced === true, 10_000, 50);+ await pollUntil(() => pool.getActive()?.provider.unsyncedChanges === 0, 10_000, 50);+ const staleProvider = pool.getActive()?.provider;+ if (!staleProvider) throw new Error('expected an active provider before the restart');++ const systemSub = attachSystemDocSubscriber(pool, server.port);+ cleanups.push(() => systemSub.dispose());+ await nextProviderEvent(systemSub.provider, 'synced');++ await Promise.all(+ [staleProvider, systemSub.provider].map(async (provider) => {+ const disconnected = nextProviderEvent(provider, 'disconnect');+ provider.disconnect();+ await disconnected;+ }),+ );++ const reconnectSystem = async () => {+ const synced = nextProviderEvent(systemSub.provider, 'synced');+ await systemSub.provider.connect();+ await synced;+ await systemSub.whenRefreshed();+ };++ server = await server.killAndRestartOnSamePort({ downtimeMs: 0 });+ cleanups.unshift(() => server.shutdown());++ if (firstObserver === 'subscriber') await reconnectSystem();++ const recyclesBeforeRefresh = countRecycleBegins(infoSpy.mock.calls);++ expect(recyclesBeforeRefresh).toBe(EXPECTED_RECYCLES_BEFORE_REFRESH[firstObserver]);++ await refreshServerInfo(pool, `http://127.0.0.1:${server.port}`);+ const recyclesAfterRefresh = countRecycleBegins(infoSpy.mock.calls);++ expect(recyclesAfterRefresh).toBe(1);+ if (firstObserver === 'refresh') {+ expect(recyclesAfterRefresh).toBeGreaterThan(recyclesBeforeRefresh);+ await reconnectSystem();+ }++ const secondEpoch = await pool.whenServerInstanceKnown();+ expect(secondEpoch).not.toBe(firstEpoch);++ await pool.awaitMismatchSettled();+ await pollUntil(+ () => {+ const entry = pool.entries.get(docName);+ return entry !== undefined && entry.provider !== staleProvider;+ },+ 10_000,+ 50,+ );+ expect(pool.entries.get(docName)?.provider).not.toBe(staleProvider);++ await pollUntil(() => pool.getActive()?.provider.isSynced === true, 15_000, 50);+ const body = pool.getActive()?.provider.document.getText('source').toString() ?? '';+ expect(body).toBe(FIXTURE);+ expect(countRecycleBegins(infoSpy.mock.calls)).toBe(1);+ }, 60_000);+ }});diff --git a/packages/app/tests/integration/test-harness.ts b/packages/app/tests/integration/test-harness.tsindex c60cd145f..006e42c5c 100644--- a/packages/app/tests/integration/test-harness.ts+++ b/packages/app/tests/integration/test-harness.ts@@ -1198,6 +1198,8 @@ export async function createInspectableServer(}interface SystemDocSubscriberHandle {+ provider: HocuspocusProvider;+ whenRefreshed: () => Promise<void>;dispose: () => Promise<void>;}@@ -1230,14 +1232,17 @@ export function attachSystemDocSubscriber(},});+ let pendingRefresh = Promise.resolve();const onReconnectSynced = createSyncedReconnectGate(() => {- void refreshServerInfo(pool, baseUrl);+ pendingRefresh = refreshServerInfo(pool, baseUrl);});provider.on('synced', () => {onReconnectSynced();});return {+ provider,+ whenRefreshed: () => pendingRefresh,dispose: async () => {provider.destroy();doc.destroy();