[tweak] migrate store snapshot arguments (#1659)

This PR updates the `migrateStoreSnapshot` method in @tldraw/store

### Change Type

- [x] `major` — Breaking change

### Test Plan

- [x] Unit Tests

packages/editor/src/lib/utils/sync/TLLocalSyncClient.ts

@@ -181,10 +181,10 @@ export class TLLocalSyncClient {
 				const documentSnapshot = Object.fromEntries(data.records.map((r) => [r.id, r]))
 				const sessionStateSnapshot =
 					data.sessionStateSnapshot ?? extractSessionStateFromLegacySnapshot(documentSnapshot)
-				const migrationResult = this.store.schema.migrateStoreSnapshot(
+				const migrationResult = this.store.schema.migrateStoreSnapshot({
-					documentSnapshot,
+					store: documentSnapshot,
-					data.schema ?? this.store.schema.serializeEarliestVersion()
+					schema: data.schema ?? this.store.schema.serializeEarliestVersion(),
-				)
+				})
 
 				if (migrationResult.type === 'error') {
 					console.error('failed to migrate store', migrationResult)

packages/file-format/src/lib/file.ts

@@ -122,7 +122,7 @@ export function parseTldrawJsonFile({
 	let migrationResult: MigrationResult<SerializedStore<TLRecord>>
 	try {
 		const storeSnapshot = Object.fromEntries(data.records.map((r) => [r.id, r as TLRecord]))
-		migrationResult = schema.migrateStoreSnapshot(storeSnapshot, data.schema)
+		migrationResult = schema.migrateStoreSnapshot({ store: storeSnapshot, schema: data.schema })
 	} catch (e) {
 		// junk data in the migration
 		return Result.err({ type: 'invalidRecords', cause: e })

packages/store/api-report.md

@@ -304,7 +304,7 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
     // (undocumented)
     migratePersistedRecord(record: R, persistedSchema: SerializedSchema, direction?: 'down' | 'up'): MigrationResult<R>;
     // (undocumented)
-    migrateStoreSnapshot(storeSnapshot: SerializedStore<R>, persistedSchema: SerializedSchema): MigrationResult<SerializedStore<R>>;
+    migrateStoreSnapshot(snapshot: StoreSnapshot<R>): MigrationResult<SerializedStore<R>>;
     // (undocumented)
     serialize(): SerializedSchema;
     // (undocumented)

packages/store/src/lib/Store.ts

@@ -551,7 +551,7 @@ export class Store<R extends UnknownRecord = UnknownRecord, Props = unknown> {
 	 * @public
 	 */
 	loadSnapshot(snapshot: StoreSnapshot<R>): void {
-		const migrationResult = this.schema.migrateStoreSnapshot(snapshot.store, snapshot.schema)
+		const migrationResult = this.schema.migrateStoreSnapshot(snapshot)
 
 		if (migrationResult.type === 'error') {
 			throw new Error(`Failed to migrate snapshot: ${migrationResult.reason}`)

packages/store/src/lib/StoreSchema.ts

@@ -1,7 +1,7 @@
 import { getOwnProperty, objectMapValues } from '@tldraw/utils'
 import { IdOf, UnknownRecord } from './BaseRecord'
 import { RecordType } from './RecordType'
-import { SerializedStore, Store } from './Store'
+import { SerializedStore, Store, StoreSnapshot } from './Store'
 import {
 	MigrationFailureReason,
 	MigrationResult,
@@ -188,17 +188,14 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 		return { type: 'success', value: result.value }
 	}
 
-	migrateStoreSnapshot(
+	migrateStoreSnapshot(snapshot: StoreSnapshot<R>): MigrationResult<SerializedStore<R>> {
-		storeSnapshot: SerializedStore<R>,
-		persistedSchema: SerializedSchema
-	): MigrationResult<SerializedStore<R>> {
 		const migrations = this.options.snapshotMigrations
 		if (!migrations) {
-			return { type: 'success', value: storeSnapshot }
+			return { type: 'success', value: snapshot.store }
 		}
 		// apply store migrations first
 		const ourStoreVersion = migrations.currentVersion
-		const persistedStoreVersion = persistedSchema.storeVersion ?? 0
+		const persistedStoreVersion = snapshot.schema.storeVersion ?? 0
 
 		if (ourStoreVersion < persistedStoreVersion) {
 			return { type: 'error', reason: MigrationFailureReason.TargetVersionTooOld }
@@ -206,7 +203,7 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 
 		if (ourStoreVersion > persistedStoreVersion) {
 			const result = migrate<SerializedStore<R>>({
-				value: storeSnapshot,
+				value: snapshot.store,
 				migrations,
 				fromVersion: persistedStoreVersion,
 				toVersion: ourStoreVersion,
@@ -215,12 +212,12 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 			if (result.type === 'error') {
 				return result
 			}
-			storeSnapshot = result.value
+			snapshot.store = result.value
 		}
 
 		const updated: R[] = []
-		for (const r of objectMapValues(storeSnapshot)) {
+		for (const r of objectMapValues(snapshot.store)) {
-			const result = this.migratePersistedRecord(r, persistedSchema)
+			const result = this.migratePersistedRecord(r, snapshot.schema)
 			if (result.type === 'error') {
 				return result
 			} else if (result.value && result.value !== r) {
@@ -228,12 +225,12 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 			}
 		}
 		if (updated.length) {
-			storeSnapshot = { ...storeSnapshot }
+			snapshot.store = { ...snapshot.store }
 			for (const r of updated) {
-				storeSnapshot[r.id as IdOf<R>] = r
+				snapshot.store[r.id as IdOf<R>] = r
 			}
 		}
-		return { type: 'success', value: storeSnapshot }
+		return { type: 'success', value: snapshot.store }
 	}
 
 	/** @internal */

packages/store/src/lib/test/migrate.test.ts

@@ -305,7 +305,7 @@ test('subtype versions in the future fail', () => {
 })
 
 test('migrating a whole store snapshot works', () => {
-	const snapshot: SerializedStore<any> = {
+	const serializedStore: SerializedStore<any> = {
 		'user-1': {
 			id: 'user-1',
 			typeName: 'user',
@@ -329,7 +329,10 @@ test('migrating a whole store snapshot works', () => {
 		},
 	}
 
-	const result = testSchemaV1.migrateStoreSnapshot(snapshot, serializedV0Schenma)
+	const result = testSchemaV1.migrateStoreSnapshot({
+		store: serializedStore,
+		schema: serializedV0Schenma,
+	})
 
 	if (result.type !== 'success') {
 		console.error(result)