migration versioning bootstrap

Author: SandroMaglione

apps/client/src/lib/services/migration.ts

@@ -12,6 +12,9 @@ export class Migration extends Effect.Service<Migration>()("Migration", {
     const temp = yield* TempWorkspace;
     return {
       migrate: temp.getAll.pipe(
+        Effect.tap((workspaces) =>
+          Effect.log(`Migrating ${workspaces.length} workspaces`)
+        ),
         Effect.flatMap((workspaces) =>
           Effect.all(
             workspaces.map((workspace) =>
@@ -38,6 +41,9 @@ export class Migration extends Effect.Service<Migration>()("Migration", {
               })
             )
           )
+        ),
+        Effect.tap(() =>
+          Effect.log("Migration completed successfully for all workspaces")
         )
       ),
     };

apps/client/src/routes/$workspaceId/index.tsx

@@ -64,6 +64,7 @@ function RouteComponent() {
           id: crypto.randomUUID(),
           firstName,
           lastName,
+          age: 10,
         },
       });
     })
@@ -129,6 +130,7 @@ function RouteComponent() {
           <div key={activity.id}>
             <p>First name: {activity.firstName}</p>
             <p>Last name: {activity.lastName}</p>
+            {activity.age && <p>Age: {activity.age}</p>}
           </div>
         ))}
       </div>

apps/client/src/routes/__root.tsx

@@ -2,19 +2,22 @@ import { Outlet, createRootRoute } from "@tanstack/react-router";
 import { Effect } from "effect";
 import { Dexie } from "../lib/dexie";
 import { RuntimeClient } from "../lib/runtime-client";
+import { Migration } from "../lib/services/migration";
 
 export const Route = createRootRoute({
   component: RootComponent,
   loader: () =>
     RuntimeClient.runPromise(
-      Effect.gen(function* () {
-        const { initClient } = yield* Dexie;
-        // const { migrate } = yield* Migration;
-
-        const clientId = yield* initClient;
-        // yield* migrate;
-        return clientId;
-      })
+      Migration.pipe(
+        Effect.flatMap((migration) => migration.migrate),
+        Effect.catchAll((error) => Effect.logError("Migration error", error)),
+        Effect.andThen(
+          Effect.gen(function* () {
+            const { initClient } = yield* Dexie;
+            return yield* initClient;
+          })
+        )
+      )
     ),
 });
 

packages/schema/src/main.ts

@@ -1,8 +1,11 @@
 import { ParseResult, Schema } from "effect";
 import { LoroDoc, LoroList, LoroMap } from "loro-crdt";
-import { ActivitySchema, ActivityV1 } from "./schema";
+import { ActivitySchema, ActivityV1, type ActivityV2 } from "./schema";
 
-export const VERSION = 2;
+const Version = [1, 2, 3] as const;
+export type Version = (typeof Version)[number];
+
+export const VERSION = 3 satisfies Version;
 
 const AnyLoroDocSchema = Schema.instanceOf(LoroDoc);
 
@@ -32,7 +35,7 @@ export class SnapshotSchema extends Schema.Class<SnapshotSchema>(
   };
 }
 
-const migrations: Record<number, (doc: LoroDoc) => LoroDoc> = {
+const migrations = {
   1: (doc) => {
     const metadata = doc.getMap("metadata");
     metadata.set("version", VERSION);
@@ -58,7 +61,24 @@ const migrations: Record<number, (doc: LoroDoc) => LoroDoc> = {
 
     return doc;
   },
-};
+  "3": (doc) => {
+    const metadata = doc.getMap("metadata");
+    metadata.set("version", 3);
+
+    const activity = doc.getList("activity");
+    for (let i = 0; i < activity.length; i++) {
+      const item = activity.get(i) as LoroMap<typeof ActivityV2.Encoded>;
+      const map = new LoroMap();
+      map.set("id", item.get("id"));
+      map.set("firstName", item.get("firstName"));
+      map.set("lastName", item.get("lastName"));
+      map.set("age", undefined);
+      activity.insertContainer(i, map);
+    }
+
+    return doc;
+  },
+} satisfies Record<Version, (doc: LoroDoc) => LoroDoc>;
 
 export const LoroDocMigration = AnyLoroDocSchema.pipe(
   Schema.transformOrFail(AnyLoroDocSchema, {
@@ -69,20 +89,9 @@ export const LoroDocMigration = AnyLoroDocSchema.pipe(
       const currentVersion = metadata.get("version");
 
       if (typeof currentVersion === "number") {
-        for (let version = currentVersion + 1; version <= VERSION; version++) {
-          const migration = migrations[version];
-          if (migration === undefined) {
-            return ParseResult.fail(
-              new ParseResult.Type(
-                ast,
-                from,
-                `Migration from version ${version - 1} to ${version} not found`
-              )
-            );
-          }
-
-          doc.import(migration(doc).export({ mode: "snapshot" }));
-        }
+        Version.forEach((version) => {
+          doc.import(migrations[version](doc).export({ mode: "snapshot" }));
+        });
       } else {
         return ParseResult.fail(
           new ParseResult.Type(ast, from, "Invalid version number in metadata")

packages/schema/src/schema.ts

@@ -1,4 +1,5 @@
 import { Schema } from "effect";
+import type { Version } from "./main";
 
 export class ActivityV1 extends Schema.Class<ActivityV1>("ActivityV1")({
   id: Schema.UUID,
@@ -11,7 +12,15 @@ export class ActivityV2 extends Schema.Class<ActivityV2>("ActivityV2")({
   lastName: Schema.String,
 }) {}
 
+export class ActivityV3 extends Schema.Class<ActivityV3>("ActivityV3")({
+  id: Schema.UUID,
+  firstName: Schema.String,
+  lastName: Schema.String,
+  age: Schema.UndefinedOr(Schema.Number),
+}) {}
+
 export const ActivitySchema = {
   1: ActivityV1,
   2: ActivityV2,
-} as const;
+  3: ActivityV3,
+} as const satisfies Record<Version, Schema.Schema.AnyNoContext>;