@tldraw/store 4.3.0-canary.da35795ba8e2 → 4.3.0-canary.e1766dd4eab3

package/src/lib/isDev.ts

@@ -0,0 +1,20 @@
+let _isDev = false
+try {
+	_isDev = process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test'
+} catch (_e) {
+	/* noop */
+}
+try {
+	_isDev =
+		_isDev ||
+		(import.meta as any).env.DEV ||
+		(import.meta as any).env.TEST ||
+		(import.meta as any).env.MODE === 'development' ||
+		(import.meta as any).env.MODE === 'test'
+} catch (_e) {
+	/* noop */
+}
+
+export function isDev() {
+	return _isDev
+}

package/src/lib/migrate.ts

@@ -1,6 +1,7 @@
 import { assert, objectMapEntries } from '@tldraw/utils'
 import { UnknownRecord } from './BaseRecord'
 import { SerializedStore } from './Store'
+import { SerializedSchema } from './StoreSchema'
 
 function squashDependsOn(sequence: Array<Migration | StandaloneDependsOn>): Migration[] {
 	const result: Migration[] = []
@@ -219,8 +220,36 @@ export type Migration = {
 				newState: SerializedStore<UnknownRecord>
 			) => void | SerializedStore<UnknownRecord>
 	  }
+	| {
+			readonly scope: 'storage'
+			// eslint-disable-next-line @typescript-eslint/method-signature-style
+			readonly up: (storage: SynchronousRecordStorage<UnknownRecord>) => void
+			readonly down?: never
+	  }
 )
 
+/**
+ * Abstraction over the store that can be used to perform migrations.
+ * @public
+ */
+export interface SynchronousRecordStorage<R extends UnknownRecord> {
+	get(id: string): R | undefined
+	set(id: string, record: R): void
+	delete(id: string): void
+	keys(): Iterable<string>
+	values(): Iterable<R>
+	entries(): Iterable<[string, R]>
+}
+
+/**
+ * Abstraction over the storage that can be used to perform migrations.
+ * @public
+ */
+export interface SynchronousStorage<R extends UnknownRecord> extends SynchronousRecordStorage<R> {
+	getSchema(): SerializedSchema
+	setSchema(schema: SerializedSchema): void
+}
+
 /**
  * Base interface for legacy migration information.
  *

package/src/lib/test/recordStore.test.ts

@@ -883,6 +883,188 @@ describe('snapshots', () => {
 		expect(up).toHaveBeenCalledTimes(1)
 		expect(store2.get(Book.createId('lotr'))!.numPages).toBe(42)
 	})
+
+	it('migrates the snapshot with storage scope', () => {
+		const snapshot1 = store.getStoreSnapshot()
+		const up = vi.fn((storage: any) => {
+			const book = storage.get('book:lotr')
+			storage.set('book:lotr', { ...book, numPages: 42 })
+		})
+
+		expect((snapshot1.store as any)['book:lotr'].numPages).toBe(1000)
+
+		const store2 = new Store({
+			props: {},
+			schema: StoreSchema.create<Book | Author>(
+				{
+					book: Book,
+					author: Author,
+				},
+				{
+					migrations: [
+						createMigrationSequence({
+							sequenceId: 'com.tldraw',
+							retroactive: true,
+							sequence: [
+								{
+									id: `com.tldraw/1`,
+									scope: 'storage',
+									up,
+								},
+							],
+						}),
+					],
+				}
+			),
+		})
+
+		expect(() => {
+			store2.loadStoreSnapshot(snapshot1)
+		}).not.toThrow()
+
+		expect(up).toHaveBeenCalledTimes(1)
+		expect(store2.get(Book.createId('lotr'))!.numPages).toBe(42)
+	})
+
+	it('storage scope migration can delete records', () => {
+		const snapshot1 = store.getStoreSnapshot()
+		const up = vi.fn((storage: any) => {
+			storage.delete('author:mcavoy')
+		})
+
+		expect((snapshot1.store as any)['author:mcavoy']).toBeDefined()
+
+		const store2 = new Store({
+			props: {},
+			schema: StoreSchema.create<Book | Author>(
+				{
+					book: Book,
+					author: Author,
+				},
+				{
+					migrations: [
+						createMigrationSequence({
+							sequenceId: 'com.tldraw',
+							retroactive: true,
+							sequence: [
+								{
+									id: `com.tldraw/1`,
+									scope: 'storage',
+									up,
+								},
+							],
+						}),
+					],
+				}
+			),
+		})
+
+		expect(() => {
+			store2.loadStoreSnapshot(snapshot1)
+		}).not.toThrow()
+
+		expect(up).toHaveBeenCalledTimes(1)
+		expect(store2.get(Author.createId('mcavoy'))).toBeUndefined()
+	})
+
+	it('storage scope migration can iterate records', () => {
+		const snapshot1 = store.getStoreSnapshot()
+		const up = vi.fn((storage: any) => {
+			for (const [id, record] of storage.entries()) {
+				if (record.typeName === 'book') {
+					storage.set(id, { ...record, numPages: record.numPages + 100 })
+				}
+			}
+		})
+
+		expect((snapshot1.store as any)['book:lotr'].numPages).toBe(1000)
+		expect((snapshot1.store as any)['book:hobbit'].numPages).toBe(300)
+
+		const store2 = new Store({
+			props: {},
+			schema: StoreSchema.create<Book | Author>(
+				{
+					book: Book,
+					author: Author,
+				},
+				{
+					migrations: [
+						createMigrationSequence({
+							sequenceId: 'com.tldraw',
+							retroactive: true,
+							sequence: [
+								{
+									id: `com.tldraw/1`,
+									scope: 'storage',
+									up,
+								},
+							],
+						}),
+					],
+				}
+			),
+		})
+
+		expect(() => {
+			store2.loadStoreSnapshot(snapshot1)
+		}).not.toThrow()
+
+		expect(up).toHaveBeenCalledTimes(1)
+		expect(store2.get(Book.createId('lotr'))!.numPages).toBe(1100)
+		expect(store2.get(Book.createId('hobbit'))!.numPages).toBe(400)
+	})
+
+	it('storage scope migration can use values() and keys()', () => {
+		const snapshot1 = store.getStoreSnapshot()
+		const keysCollected: string[] = []
+		const valuesCollected: any[] = []
+
+		const up = vi.fn((storage: any) => {
+			for (const key of storage.keys()) {
+				keysCollected.push(key)
+			}
+			for (const value of storage.values()) {
+				valuesCollected.push(value)
+			}
+		})
+
+		const store2 = new Store({
+			props: {},
+			schema: StoreSchema.create<Book | Author>(
+				{
+					book: Book,
+					author: Author,
+				},
+				{
+					migrations: [
+						createMigrationSequence({
+							sequenceId: 'com.tldraw',
+							retroactive: true,
+							sequence: [
+								{
+									id: `com.tldraw/1`,
+									scope: 'storage',
+									up,
+								},
+							],
+						}),
+					],
+				}
+			),
+		})
+
+		expect(() => {
+			store2.loadStoreSnapshot(snapshot1)
+		}).not.toThrow()
+
+		expect(up).toHaveBeenCalledTimes(1)
+		expect(keysCollected).toContain('book:lotr')
+		expect(keysCollected).toContain('book:hobbit')
+		expect(keysCollected).toContain('author:tolkein')
+		expect(keysCollected).toContain('author:mcavoy')
+		expect(keysCollected).toContain('author:cassidy')
+		expect(valuesCollected.length).toBe(5)
+	})
 })
 
 describe('diffs', () => {