@tldraw/sync-core 5.4.0-next.ef99ab47e5ce → 5.5.0-next.6d9e51e9f3f7

package/src/lib/TLSyncStorage.test.ts

@@ -122,6 +122,43 @@ describe('loadSnapshotIntoStorage', () => {
 		expect(storage.getClock()).toBe(5)
 	})
 
+	it('[SL3] does not delete while a key iterator is open (better-sqlite3 rejects that)', () => {
+		const extraPage = makePage('extra', 'Extra')
+		const storage = new InMemorySyncStorage<TLRecord>({
+			snapshot: makeContractSnapshot([...contractRecords, extraPage]),
+		})
+
+		storage.transaction((txn) => {
+			// better-sqlite3 throws on any write while a statement iterator is still open; mimic
+			// that so a delete issued from inside `for (const id of txn.keys())` fails loudly
+			let openIterators = 0
+			const guarded: typeof txn = Object.create(txn, {
+				keys: {
+					value: function* () {
+						openIterators++
+						try {
+							yield* Array.from(txn.keys())
+						} finally {
+							openIterators--
+						}
+					},
+				},
+				delete: {
+					value: (id: string) => {
+						if (openIterators > 0) {
+							throw new Error('This database connection is busy executing a query')
+						}
+						return txn.delete(id)
+					},
+				},
+			})
+			loadSnapshotIntoStorage(guarded, contractSchema, makeContractSnapshot(contractRecords))
+		})
+
+		expect(storage.documents.has(extraPage.id)).toBe(false)
+		expect(storage.tombstones.has(extraPage.id)).toBe(true)
+	})
+
 	it('[SL4] persists the snapshot schema and migrates loaded records to the current version', () => {
 		interface TestRecord extends BaseRecord<'test', RecordId<TestRecord>> {
 			value: number

package/src/lib/TLSyncStorage.ts

@@ -1,6 +1,6 @@
 import { StoreSchema, SynchronousStorage, UnknownRecord } from '@tldraw/store'
+import { TLStoreSnapshot } from '@tldraw/tlschema'
 import { assert, isEqual, objectMapEntriesIterable, objectMapValues } from '@tldraw/utils'
-import { TLStoreSnapshot } from 'tldraw'
 import { diffRecord, NetworkDiff, RecordOpType } from './diff'
 import { RoomSnapshot } from './TLSyncRoom'
 
@@ -205,7 +205,9 @@ export function loadSnapshotIntoStorage<R extends UnknownRecord>(
 		if (isEqual(existing, doc.state)) continue
 		txn.set(doc.state.id, doc.state as R)
 	}
-	for (const id of txn.keys()) {
+	// materialize the keys first: some SQLite drivers (better-sqlite3) refuse writes while a
+	// statement iterator is open, so deleting during `keys()` would throw
+	for (const id of Array.from(txn.keys())) {
 		if (!docIds.has(id)) {
 			txn.delete(id)
 		}