|
| 1 | +import { describe, it, expect, mock, afterEach } from 'bun:test'; |
| 2 | +import { tmpdir } from 'node:os'; |
| 3 | +import { join } from 'node:path'; |
| 4 | +import { randomBytes } from 'node:crypto'; |
| 5 | +import { readFile, unlink } from 'node:fs/promises'; |
| 6 | +import { SessionManager } from '../session-manager.js'; |
| 7 | + |
| 8 | +/** |
| 9 | + * `openRoom` orchestration (provider sync, sync timeout, awareness presence) and |
| 10 | + * the `save()` room-guard run against a live Yjs WebSocket server in production, |
| 11 | + * but the orchestration itself is socket-independent. Following the repo's collab |
| 12 | + * test idiom (createProviderStub in Editor.replace-file.test.ts), we inject a stub |
| 13 | + * provider so the logic is exercised without a server. The real socket transport |
| 14 | + * is the only part left to the end-to-end check in the PR description. |
| 15 | + */ |
| 16 | + |
| 17 | +type ProviderEvent = 'sync' | 'synced'; |
| 18 | +type SyncHandler = (synced?: boolean) => void; |
| 19 | + |
| 20 | +/** |
| 21 | + * Provider stub mirroring the repo's collab test idiom (`createProviderStub` in |
| 22 | + * `Editor.replace-file.test.ts`): inert `on()`/`off()` that only register/deregister, |
| 23 | + * an explicit `emit()` the test drives by hand, and `synced`/`isSynced` fields. This is |
| 24 | + * what lets the suite exercise the real sync contract — the prior stub auto-emitted |
| 25 | + * `sync(true)` from inside `on()` and exposed no `synced`/`isSynced`, so it could only |
| 26 | + * test the one event shape and silently passed regardless of how the wait was wired. |
| 27 | + * |
| 28 | + * `synced: true` seeds an already-synced provider (pooled/reused) so openRoom's |
| 29 | + * already-synced precheck resolves with no emit. |
| 30 | + */ |
| 31 | +function providerStub({ synced = false }: { synced?: boolean } = {}) { |
| 32 | + const listeners: Record<ProviderEvent, Set<SyncHandler>> = { |
| 33 | + sync: new Set(), |
| 34 | + synced: new Set(), |
| 35 | + }; |
| 36 | + const setLocalStateField = mock((_field: string, _value: unknown) => {}); |
| 37 | + const destroy = mock(() => {}); |
| 38 | + |
| 39 | + const provider = { |
| 40 | + awareness: { |
| 41 | + setLocalStateField, |
| 42 | + getStates: () => new Map(), |
| 43 | + on() {}, |
| 44 | + off() {}, |
| 45 | + }, |
| 46 | + synced, |
| 47 | + isSynced: synced, |
| 48 | + on(event: ProviderEvent, handler: SyncHandler) { |
| 49 | + listeners[event]?.add(handler); |
| 50 | + }, |
| 51 | + off(event: ProviderEvent, handler: SyncHandler) { |
| 52 | + listeners[event]?.delete(handler); |
| 53 | + }, |
| 54 | + emit(event: ProviderEvent, value?: boolean) { |
| 55 | + for (const handler of listeners[event]) handler(value); |
| 56 | + }, |
| 57 | + destroy, |
| 58 | + }; |
| 59 | + |
| 60 | + return provider; |
| 61 | +} |
| 62 | + |
| 63 | +/** Flush microtasks so openRoom reaches its suspended sync await and wires listeners. */ |
| 64 | +const tick = () => new Promise<void>((r) => setTimeout(r, 0)); |
| 65 | + |
| 66 | +describe('superdoc_attach openRoom orchestration (stubbed provider)', () => { |
| 67 | + const sm = new SessionManager(); |
| 68 | + const opened: string[] = []; |
| 69 | + const tempFiles: string[] = []; |
| 70 | + |
| 71 | + afterEach(async () => { |
| 72 | + for (const id of opened.splice(0)) await sm.close(id).catch(() => {}); |
| 73 | + for (const f of tempFiles.splice(0)) await unlink(f).catch(() => {}); |
| 74 | + }); |
| 75 | + |
| 76 | + type Stub = ReturnType<typeof providerStub>; |
| 77 | + type AttachUser = { id?: string; name?: string; email?: string }; |
| 78 | + |
| 79 | + /** |
| 80 | + * Kick off openRoom, let it reach its suspended sync await and wire the provider |
| 81 | + * listener, then drive the provider to synced. `drive` defaults to the `sync(true)` |
| 82 | + * edge; pass a custom driver to exercise the `synced` (no-arg) path. |
| 83 | + */ |
| 84 | + async function attach( |
| 85 | + documentId: string, |
| 86 | + stub: Stub, |
| 87 | + { user, drive = (s: Stub) => s.emit('sync', true) }: { user?: AttachUser; drive?: (s: Stub) => void } = {}, |
| 88 | + ) { |
| 89 | + const p = sm.openRoom('ws://test/doc', documentId, undefined, user, { |
| 90 | + createProvider: () => stub as unknown as never, |
| 91 | + }); |
| 92 | + await tick(); |
| 93 | + drive(stub); |
| 94 | + return p; |
| 95 | + } |
| 96 | + |
| 97 | + it('returns a registered room session once the provider syncs', async () => { |
| 98 | + const stub = providerStub(); |
| 99 | + const session = await attach('room-sync', stub); |
| 100 | + opened.push(session.id); |
| 101 | + |
| 102 | + expect(session.id).toMatch(/^room-/); |
| 103 | + expect(session.filePath).toBeNull(); |
| 104 | + expect(sm.list().some((s) => s.id === session.id)).toBe(true); |
| 105 | + }); |
| 106 | + |
| 107 | + it('returns immediately when the provider is already synced before attach', async () => { |
| 108 | + // Pooled/reused providers can be synced when handed to openRoom — no `sync`/`synced` |
| 109 | + // re-emit follows. The bespoke wait would hang here until a spurious timeout; the |
| 110 | + // helper's already-synced precheck resolves with no event. No emit is driven. |
| 111 | + const stub = providerStub({ synced: true }); |
| 112 | + const session = await sm.openRoom('ws://test/doc', 'room-presynced', undefined, undefined, { |
| 113 | + createProvider: () => stub as unknown as never, |
| 114 | + }); |
| 115 | + opened.push(session.id); |
| 116 | + |
| 117 | + expect(session.id).toMatch(/^room-/); |
| 118 | + expect(sm.list().some((s) => s.id === session.id)).toBe(true); |
| 119 | + expect(stub.destroy).not.toHaveBeenCalled(); |
| 120 | + }); |
| 121 | + |
| 122 | + it('resolves when the provider emits a no-arg synced event without a sync edge', async () => { |
| 123 | + // Some providers emit only `synced` (no boolean), never `sync(boolean)`. The prior |
| 124 | + // `sync`-only wait never resolved for these — this case is what makes the suite catch |
| 125 | + // that regression. The helper listens to `synced` too. |
| 126 | + const stub = providerStub(); |
| 127 | + const session = await attach('room-synced-only', stub, { drive: (s) => s.emit('synced') }); |
| 128 | + opened.push(session.id); |
| 129 | + |
| 130 | + expect(session.id).toMatch(/^room-/); |
| 131 | + expect(sm.list().some((s) => s.id === session.id)).toBe(true); |
| 132 | + }); |
| 133 | + |
| 134 | + it('broadcasts awareness presence when a user is supplied', async () => { |
| 135 | + const stub = providerStub(); |
| 136 | + const user = { id: 'reviewer-1', name: 'Reviewer', email: 'reviewer@example.com' }; |
| 137 | + const session = await attach('room-presence', stub, { user }); |
| 138 | + opened.push(session.id); |
| 139 | + |
| 140 | + expect(stub.awareness.setLocalStateField).toHaveBeenCalledWith('user', user); |
| 141 | + }); |
| 142 | + |
| 143 | + it('does not touch awareness when no user is supplied', async () => { |
| 144 | + const stub = providerStub(); |
| 145 | + const session = await attach('room-nopresence', stub); |
| 146 | + opened.push(session.id); |
| 147 | + |
| 148 | + expect(stub.awareness.setLocalStateField).not.toHaveBeenCalled(); |
| 149 | + }); |
| 150 | + |
| 151 | + it('rejects and tears down the provider when initial sync times out', async () => { |
| 152 | + // Never synced, never emits — openRoom's own timeout fires. |
| 153 | + const stub = providerStub(); |
| 154 | + await expect( |
| 155 | + sm.openRoom('ws://test/doc', 'room-timeout', undefined, undefined, { |
| 156 | + createProvider: () => stub as unknown as never, |
| 157 | + syncTimeoutMs: 10, |
| 158 | + }), |
| 159 | + ).rejects.toThrow(/sync timeout/); |
| 160 | + |
| 161 | + expect(stub.destroy).toHaveBeenCalled(); |
| 162 | + }); |
| 163 | + |
| 164 | + it('refuses to save a room session without an explicit output path', async () => { |
| 165 | + const stub = providerStub(); |
| 166 | + const session = await attach('room-save-guard', stub); |
| 167 | + opened.push(session.id); |
| 168 | + |
| 169 | + await expect(sm.save(session.id)).rejects.toThrow(/without specifying an output path/); |
| 170 | + }); |
| 171 | + |
| 172 | + it('saves a room session to an explicit output path', async () => { |
| 173 | + const stub = providerStub(); |
| 174 | + const session = await attach('room-save-ok', stub); |
| 175 | + opened.push(session.id); |
| 176 | + |
| 177 | + const out = join(tmpdir(), `mcp-collab-${randomBytes(6).toString('hex')}.docx`); |
| 178 | + tempFiles.push(out); |
| 179 | + |
| 180 | + const result = await sm.save(session.id, out); |
| 181 | + expect(result.path).toBe(out); |
| 182 | + expect(result.byteLength).toBeGreaterThan(0); |
| 183 | + |
| 184 | + const bytes = await readFile(out); |
| 185 | + expect(bytes[0]).toBe(0x50); // 'P' — PK zip magic |
| 186 | + expect(bytes[1]).toBe(0x4b); // 'K' |
| 187 | + }); |
| 188 | +}); |
0 commit comments