@tldraw/sync-core 5.5.0-canary.fa8dc460ac73 → 5.5.0-canary.fdb2d37fcb2a

package/src/lib/ClientWebSocketAdapter.test.ts

@@ -1,4 +1,4 @@
-import { warnOnce } from '@tldraw/utils'
+import { promiseWithResolve, warnOnce } from '@tldraw/utils'
 import { TLRecord, sleep } from 'tldraw'
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 
@@ -73,24 +73,38 @@ describe('ClientWebSocketAdapter', () => {
 		connectedServerSocket = socket
 	})
 
+	// Bound per test on an OS-assigned port. A fixed port raced against the previous test's
+	// server, which closes asynchronously, and intermittently failed with EADDRINUSE.
+	let port: number
+
 	let consoleWarnSpy: ReturnType<typeof vi.spyOn>
-	beforeEach(() => {
+	beforeEach(async () => {
 		consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
-		adapter = new ClientWebSocketAdapter(() => 'ws://localhost:2233')
-		wsServer = new WebSocketServer({ port: 2233 })
+		wsServer = new WebSocketServer({ port: 0 })
+		// Attach before the adapter exists: the server is already listening by the time the
+		// adapter is constructed, so a handler added afterwards can miss the first connection.
 		wsServer.on('connection', connectMock as any)
+		await new Promise<void>((resolve, reject) => {
+			wsServer.once('listening', resolve)
+			wsServer.once('error', reject)
+		})
+		port = (wsServer.address() as { port: number }).port
+		adapter = new ClientWebSocketAdapter(() => `ws://localhost:${port}`)
 	})
 
 	afterEach(() => {
 		consoleWarnSpy.mockRestore()
 		adapter.close()
+		// Not awaited: the next test binds its own OS-assigned port, so a server still closing
+		// here can't collide with it. Awaiting would deliver in-flight messages to the socket
+		// adapter.close() just orphaned.
 		wsServer.close()
 		connectMock.mockClear()
 	})
 
 	describe('connection and initial state (CW1, CW2)', () => {
 		it('[CW2] starts with connectionStatus offline while the internal status is initial', () => {
-			const newAdapter = new ClientWebSocketAdapter(() => 'ws://localhost:2233')
+			const newAdapter = new ClientWebSocketAdapter(() => `ws://localhost:${port}`)
 			try {
 				expect(newAdapter._connectionStatus.get()).toBe('initial')
 				expect(newAdapter.connectionStatus).toBe('offline')
@@ -113,7 +127,7 @@ describe('ClientWebSocketAdapter', () => {
 			let uriCallCount = 0
 			const dynamicAdapter = new ClientWebSocketAdapter(() => {
 				uriCallCount++
-				return `ws://localhost:2233?attempt=${uriCallCount}`
+				return `ws://localhost:${port}?attempt=${uriCallCount}`
 			})
 			try {
 				await waitFor(() => dynamicAdapter._ws?.readyState === WebSocket.OPEN)
@@ -143,7 +157,7 @@ describe('ClientWebSocketAdapter', () => {
 				// no socket can be created until the promise resolves
 				expect(asyncAdapter._ws).toBeNull()
 
-				resolveUri!('ws://localhost:2233')
+				resolveUri!(`ws://localhost:${port}`)
 
 				await waitFor(() => asyncAdapter._ws?.readyState === WebSocket.OPEN)
 				expect(asyncAdapter.connectionStatus).toBe('online')
@@ -301,7 +315,7 @@ describe('ClientWebSocketAdapter', () => {
 
 	describe('URI conversion (CW1)', () => {
 		it('[CW1] converts http URIs to ws and connects', async () => {
-			const httpAdapter = new ClientWebSocketAdapter(() => 'http://localhost:2233')
+			const httpAdapter = new ClientWebSocketAdapter(() => `http://localhost:${port}`)
 			try {
 				await waitFor(() => httpAdapter._ws?.readyState === WebSocket.OPEN)
 				expect(httpAdapter._ws!.url).toMatch(/^ws:\/\//)
@@ -312,7 +326,7 @@ describe('ClientWebSocketAdapter', () => {
 		})
 
 		it('[CW1] converts https URIs to wss', async () => {
-			const httpsAdapter = new ClientWebSocketAdapter(() => 'https://localhost:2233')
+			const httpsAdapter = new ClientWebSocketAdapter(() => `https://localhost:${port}`)
 			try {
 				await waitFor(() => httpsAdapter._ws !== null)
 				expect(httpsAdapter._ws!.url).toMatch(/^wss:\/\//)
@@ -527,6 +541,46 @@ describe('ClientWebSocketAdapter', () => {
 			adapter.close()
 			expect(() => adapter.close()).not.toThrow()
 		})
+
+		it('[CW9][RM5] closing immediately does not start another getUri call', async () => {
+			const getUri = vi.fn(() => `ws://localhost:${port}`)
+			const testAdapter = new ClientWebSocketAdapter(getUri)
+			testAdapter.close()
+			const callsAtClose = getUri.mock.calls.length
+
+			await vi.advanceTimersByTimeAsync(INACTIVE_MAX_DELAY)
+
+			expect(getUri).toHaveBeenCalledTimes(callsAtClose)
+			expect(testAdapter._ws).toBeNull()
+		})
+
+		it('[CW9][RM5] close reports offline without notifying listeners or reconnecting', async () => {
+			let uriCallCount = 0
+			const testAdapter = new ClientWebSocketAdapter(() => {
+				uriCallCount++
+				return `ws://localhost:${port}`
+			})
+			const onStatusChange = vi.fn()
+			testAdapter.onStatusChange(onStatusChange)
+			await waitFor(() => testAdapter._ws?.readyState === WebSocket.OPEN)
+			const callsBeforeClose = uriCallCount
+			onStatusChange.mockClear()
+
+			testAdapter.close()
+			expect(testAdapter.connectionStatus).toBe('offline')
+			// let the socket's own close event land, then run out any (leaked) reconnect timer
+			vi.useRealTimers()
+			await sleep(50)
+			vi.useFakeTimers()
+			vi.advanceTimersByTime(INACTIVE_MAX_DELAY)
+			vi.useRealTimers()
+			await sleep(20)
+			vi.useFakeTimers()
+
+			expect(onStatusChange).not.toHaveBeenCalled()
+			expect(uriCallCount).toBe(callsBeforeClose)
+			expect(testAdapter._ws).toBeNull()
+		})
 	})
 
 	describe('orphaned sockets (CW10)', () => {
@@ -566,17 +620,26 @@ describe('ReconnectManager', () => {
 		connectedServerSocket = socket
 	})
 
+	// See the note on the other suite's port: bound per test on an OS-assigned port.
+	let port: number
+
 	let consoleWarnSpy: ReturnType<typeof vi.spyOn>
-	beforeEach(() => {
+	beforeEach(async () => {
 		consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
-		adapter = new ClientWebSocketAdapter(() => 'ws://localhost:2234')
-		wsServer = new WebSocketServer({ port: 2234 })
+		wsServer = new WebSocketServer({ port: 0 })
 		wsServer.on('connection', connectMock as any)
+		await new Promise<void>((resolve, reject) => {
+			wsServer.once('listening', resolve)
+			wsServer.once('error', reject)
+		})
+		port = (wsServer.address() as { port: number }).port
+		adapter = new ClientWebSocketAdapter(() => `ws://localhost:${port}`)
 	})
 
 	afterEach(() => {
 		consoleWarnSpy.mockRestore()
 		adapter.close()
+		// Not awaited - see the note on the other suite's teardown.
 		wsServer.close()
 		connectMock.mockClear()
 	})
@@ -591,7 +654,7 @@ describe('ReconnectManager', () => {
 	})
 
 	it('[RM1] reconnection delays back off exponentially, bounded by the active delays', () => {
-		const testAdapter = new ClientWebSocketAdapter(() => 'ws://localhost:2234')
+		const testAdapter = new ClientWebSocketAdapter(() => `ws://localhost:${port}`)
 		try {
 			const manager = testAdapter._reconnectManager
 			// make every disconnected() call take the "attempt now" branch
@@ -616,7 +679,7 @@ describe('ReconnectManager', () => {
 
 	it('[RM1] uses the inactive delay bounds when the tab is hidden', () => {
 		const hiddenMock = vi.spyOn(document, 'hidden', 'get').mockReturnValue(true)
-		const testAdapter = new ClientWebSocketAdapter(() => 'ws://localhost:2234')
+		const testAdapter = new ClientWebSocketAdapter(() => `ws://localhost:${port}`)
 		try {
 			const manager = testAdapter._reconnectManager
 			;(manager as any).lastAttemptStart = Date.now() - 1_000_000
@@ -710,7 +773,7 @@ describe('ReconnectManager', () => {
 		// it's necessary to close the socket, as otherwise the websocket might stay half-open
 		connectedServerSocket.close()
 		wsServer.close()
-		await waitFor(() => adapter._ws?.readyState !== WebSocket.OPEN)
+		await waitFor(() => adapter.connectionStatus === 'offline')
 		expect(adapter._reconnectManager.intendedDelay).toBeGreaterThanOrEqual(INACTIVE_MIN_DELAY)
 
 		hiddenMock.mockReturnValue(false)
@@ -776,8 +839,34 @@ describe('ReconnectManager', () => {
 		expect(adapter._ws).toBeNull()
 	})
 
+	it.each(['throws', 'rejects'])(
+		'[RM1][CW1] getUri that %s is retried on the backoff instead of stranding the connection',
+		async (failure) => {
+			const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
+			let attempts = 0
+			const testAdapter = new ClientWebSocketAdapter(() => {
+				attempts++
+				if (attempts < 3) {
+					const error = new Error('token endpoint unavailable')
+					if (failure === 'throws') throw error
+					return Promise.reject(error)
+				}
+				return `ws://localhost:${port}`
+			})
+			try {
+				await waitFor(() => testAdapter._ws?.readyState === WebSocket.OPEN)
+				expect(attempts).toBe(3)
+				expect(consoleErrorSpy).toHaveBeenCalledTimes(2)
+				expect(testAdapter.connectionStatus).toBe('online')
+			} finally {
+				testAdapter.close()
+				consoleErrorSpy.mockRestore()
+			}
+		}
+	)
+
 	it('[RM5] close cancels timers and removes the reconnect event listeners', () => {
-		const testAdapter = new ClientWebSocketAdapter(() => 'ws://localhost:2234')
+		const testAdapter = new ClientWebSocketAdapter(() => `ws://localhost:${port}`)
 		const manager = testAdapter._reconnectManager
 
 		testAdapter.close()
@@ -794,3 +883,61 @@ describe('ReconnectManager', () => {
 		expect(() => manager.close()).not.toThrow()
 	})
 })
+
+describe('URI failure boundaries', () => {
+	// These tests never open a real socket - the adapter is closed first, or the socket is a
+	// mock - so the URI only has to parse. No server, hence no port to bind.
+	const UNUSED_URI = 'ws://localhost:1'
+
+	it.each(['resolves', 'rejects'])('ignores getUri that %s after close', async (outcome) => {
+		const uri = promiseWithResolve<string>()
+		const getUri = vi.fn(() => uri)
+		const testAdapter = new ClientWebSocketAdapter(getUri)
+		const onStatusChange = vi.fn()
+		testAdapter.onStatusChange(onStatusChange)
+		const consoleError = vi.spyOn(console, 'error').mockImplementation(() => {})
+		try {
+			await Promise.resolve()
+			testAdapter.close()
+			if (outcome === 'resolves') uri.resolve(UNUSED_URI)
+			else uri.reject(new Error('token endpoint unavailable'))
+			await vi.advanceTimersByTimeAsync(INACTIVE_MAX_DELAY)
+
+			expect(getUri).toHaveBeenCalledTimes(1)
+			expect(testAdapter._ws).toBeNull()
+			expect(testAdapter.connectionStatus).toBe('offline')
+			expect(onStatusChange).not.toHaveBeenCalled()
+			expect(consoleError).not.toHaveBeenCalled()
+		} finally {
+			testAdapter.close()
+			consoleError.mockRestore()
+		}
+	})
+
+	it.each([
+		{ uri: 'not a URL', openSocket: false, error: 'Invalid URL' },
+		{
+			uri: UNUSED_URI,
+			openSocket: true,
+			error: 'There should be no connection attempts while already connected',
+		},
+	])('does not treat $error as a getUri failure', async ({ uri, openSocket, error }) => {
+		let nextUri: string | Promise<string> = new Promise(() => {})
+		const testAdapter = new ClientWebSocketAdapter(() => nextUri)
+		const consoleError = vi.spyOn(console, 'error').mockImplementation(() => {})
+		try {
+			await Promise.resolve()
+			nextUri = uri
+			if (openSocket) testAdapter._ws = mockSocket(WebSocket.OPEN)
+
+			const manager = testAdapter._reconnectManager as unknown as {
+				scheduleAttempt(): Promise<void>
+			}
+			await expect(manager.scheduleAttempt()).rejects.toThrow(error)
+			expect(consoleError).not.toHaveBeenCalled()
+		} finally {
+			testAdapter.close()
+			consoleError.mockRestore()
+		}
+	})
+})

package/src/lib/ClientWebSocketAdapter.ts

@@ -93,8 +93,13 @@ export class ClientWebSocketAdapter implements TLPersistentClientSocket<
 	close() {
 		this.isDisposed = true
 		this._reconnectManager.close()
+		// orphan the socket before closing it (as _closeSocket does) so its onclose can't run
+		// _handleDisconnect after disposal — that would notify listeners and schedule a reconnect
+		const ws = this._ws
+		this._ws = null
 		//  WebSocket.close() is idempotent
-		this._ws?.close()
+		ws?.close()
+		this._connectionStatus.set('offline')
 	}
 
 	/**
@@ -240,8 +245,6 @@ export class ClientWebSocketAdapter implements TLPersistentClientSocket<
 		this._handleDisconnect('manual')
 	}
 
-	// TLPersistentClientSocket stuff
-
 	_connectionStatus: Atom<TLPersistentClientSocketStatus | 'initial'> = atom(
 		'websocket connection status',
 		'initial'
@@ -513,21 +516,33 @@ export class ReconnectManager {
 		}
 	}
 
-	private scheduleAttempt() {
+	private async scheduleAttempt() {
 		assert(this.state === 'pendingAttempt')
+		if (this.isDisposed) return
 		debug('scheduling a connection attempt')
-		Promise.resolve(this.getUri()).then((uri) => {
-			// this can happen if the promise gets resolved too late
+
+		let uri: string
+		try {
+			uri = await this.getUri()
+		} catch (error) {
+			// A failed auth-token fetch must retry instead of leaving us with no socket or timer.
 			if (this.state !== 'pendingAttempt' || this.isDisposed) return
-			assert(
-				this.socketAdapter._ws?.readyState !== WebSocket.OPEN,
-				'There should be no connection attempts while already connected'
-			)
+			console.error('Failed to get the websocket URI, retrying', error)
+			this.state = 'delay'
+			this.reconnectTimeout = setTimeout(() => this.disconnected(), this.intendedDelay)
+			return
+		}
 
-			this.lastAttemptStart = Date.now()
-			this.socketAdapter._setNewSocket(new WebSocket(httpToWs(uri)))
-			this.state = 'pendingAttemptResult'
-		})
+		// this can happen if the promise gets resolved too late
+		if (this.state !== 'pendingAttempt' || this.isDisposed) return
+		assert(
+			this.socketAdapter._ws?.readyState !== WebSocket.OPEN,
+			'There should be no connection attempts while already connected'
+		)
+
+		this.lastAttemptStart = Date.now()
+		this.socketAdapter._setNewSocket(new WebSocket(httpToWs(uri)))
+		this.state = 'pendingAttemptResult'
 	}
 
 	private getMaxDelay() {
@@ -641,6 +656,7 @@ export class ReconnectManager {
 		debug('ReconnectManager.disconnected')
 		// This either means we're freshly disconnected, or the last connection attempt failed;
 		// either way, time to try again.
+		if (this.isDisposed) return
 
 		// Guard against delayed notifications and recheck synchronously
 		if (

package/src/lib/TLSocketRoom.ts

@@ -273,13 +273,16 @@ export class TLSocketRoom<R extends UnknownRecord = UnknownRecord, SessionMeta =
 				})
 			)
 		}
+		// The default logger belongs to both layers: TLSyncRoom is where authorizer throws are
+		// logged, and a host that passes no `log` would otherwise never see them.
+		this.log = 'log' in opts ? opts.log : { error: console.error }
 		this.room = new TLSyncRoom<R, SessionMeta>({
 			onPresenceChange: opts.onPresenceChange,
 			onCommittedChanges: opts.onCommittedChanges,
 			objectTypes: opts.objectTypes,
 			authorizeRecord: opts.authorizeRecord,
 			schema: opts.schema ?? (createTLSchema() as any),
-			log: opts.log,
+			log: this.log,
 			storage,
 			clientTimeout: opts.clientTimeout,
 		})
@@ -295,7 +298,6 @@ export class TLSocketRoom<R extends UnknownRecord = UnknownRecord, SessionMeta =
 				})
 			}
 		})
-		this.log = 'log' in opts ? opts.log : { error: console.error }
 	}
 
 	/**
@@ -854,12 +856,11 @@ export class TLSocketRoom<R extends UnknownRecord = UnknownRecord, SessionMeta =
 		if (this.isClosed()) {
 			throw new Error('Cannot update store on a closed room')
 		}
+		// read through the transaction rather than getSnapshot(): the document snapshot excludes the
+		// object-store lane, which would make object-lane records invisible (and undeletable) here
+		const records = this.storage.transaction((txn) => Object.fromEntries(txn.entries())).result
 		// eslint-disable-next-line @typescript-eslint/no-deprecated
-		const ctx = new StoreUpdateContext<R>(
-			// eslint-disable-next-line @typescript-eslint/no-deprecated
-			Object.fromEntries(this.getCurrentSnapshot().documents.map((d) => [d.state.id, d.state])),
-			this.room.schema
-		)
+		const ctx = new StoreUpdateContext<R>(records, this.room.schema)
 		try {
 			await updater(ctx)
 		} finally {

package/src/test/TLSocketRoom.test.ts

@@ -210,6 +210,45 @@ describe('28. TLSocketRoom (SR)', () => {
 			consoleSpy.mockRestore()
 		})
 
+		it('[SR3] the default logger also reaches TLSyncRoom, so authorizer failures are reported', () => {
+			const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
+			try {
+				const room = new TLSocketRoom({
+					authorizeRecord: {
+						page: () => {
+							throw new Error('authorizer exploded')
+						},
+					},
+				})
+				const socket = createMockSocket()
+				connectSession(room, 'test-session', socket)
+
+				const pageId = PageRecordType.createId('new-page')
+				room.handleSocketMessage(
+					'test-session',
+					JSON.stringify({
+						type: 'push',
+						clientClock: 1,
+						diff: {
+							[pageId]: [
+								RecordOpType.Put,
+								PageRecordType.create({ id: pageId, name: 'New Page', index: 'a2' as any }),
+							],
+						},
+					})
+				)
+
+				// the authorizer threw, and the host heard about it without passing a logger
+				expect(room.getRecord(pageId)).toBeUndefined()
+				expect(consoleSpy).toHaveBeenCalledWith(
+					'record authorizer threw; rejecting the write',
+					expect.objectContaining({ message: 'authorizer exploded' })
+				)
+			} finally {
+				consoleSpy.mockRestore()
+			}
+		})
+
 		it('[SR3] uses custom logger when provided', () => {
 			const mockLog: TLSyncLog = {
 				warn: vi.fn(),

package/src/test/objectStore.test.ts

@@ -8,6 +8,7 @@ import {
 	TLSocketServerSentEvent,
 	getTlsyncProtocolVersion,
 } from '../lib/protocol'
+import { TLSocketRoom } from '../lib/TLSocketRoom'
 import { TLSyncErrorCloseEventCode, TLSyncErrorCloseEventReason } from '../lib/TLSyncClient'
 import { RoomSnapshot, TLRoomSocket, TLSyncRoom } from '../lib/TLSyncRoom'
 
@@ -354,6 +355,40 @@ describe('object store lane', () => {
 			const connectMsg = late.__messages.find((m: any) => m.type === 'connect') as any
 			expect(Object.keys(connectMsg.diff).sort()).toEqual([doc.id, note.id].sort())
 		})
+
+		it('[US1][US3] updateStore sees and can delete object-lane records', async () => {
+			// eslint-disable-next-line @typescript-eslint/no-deprecated
+			const socketRoom = new TLSocketRoom<R, void>({
+				schema,
+				storage: new InMemorySyncStorage<R>({
+					snapshot: { documents: [], clock: 0, documentClock: 0, schema: schema.serialize() },
+					objectTypes: ['note'],
+				}),
+				objectTypes: ['note'],
+			})
+			disposables.push(() => socketRoom.close())
+			const doc = Doc.create({ title: 'canvas' })
+			const note = Note.create({ text: 'annotation' })
+			socketRoom.storage.transaction((txn) => {
+				txn.set(doc.id, doc)
+				txn.set(note.id, note)
+			})
+
+			// the update context reads both lanes, not just the document snapshot
+			// eslint-disable-next-line @typescript-eslint/no-deprecated
+			await socketRoom.updateStore((store) => {
+				expect(store.get(note.id)).toEqual(note)
+				expect(
+					store
+						.getAll()
+						.map((r) => r.id)
+						.sort()
+				).toEqual([doc.id, note.id].sort())
+				store.delete(note.id)
+			})
+			expect(socketRoom.getRecord(note.id)).toBeUndefined()
+			expect(socketRoom.getRecord(doc.id)).toEqual(doc)
+		})
 	})
 
 	describe('connect message', () => {