refactor(y-indexeddb): move migrate function separate (#2086)

2026-08-01 17:39:55 +08:00 · 2023-04-22 17:25:25 -05:00
parent bf83bfcf63
commit 74e21311dc
3 changed files with 128 additions and 116 deletions
@@ -1,9 +1,131 @@
 import { openDB } from 'idb';
+import type { IDBPDatabase } from 'idb/build/entry';
 import { mergeUpdates } from 'yjs';

-import type { BlockSuiteBinaryDB, UpdateMessage } from './shared';
+import type { BlockSuiteBinaryDB, OldYjsDB, UpdateMessage } from './shared';
 import { dbVersion, DEFAULT_DB_NAME, upgradeDB } from './shared';

+let allDb: IDBDatabaseInfo[];
+
+async function databaseExists(name: string): Promise<boolean> {
+  return new Promise(resolve => {
+    const req = indexedDB.open(name);
+    let existed = true;
+    req.onsuccess = function () {
+      req.result.close();
+      if (!existed) {
+        indexedDB.deleteDatabase(name);
+      }
+      resolve(existed);
+    };
+    req.onupgradeneeded = function () {
+      existed = false;
+    };
+  });
+}
+
+/**
+ * try to migrate the old database to the new database
+ * this function will be removed in the future
+ * since we don't need to support the old database
+ */
+export async function tryMigrate(
+  db: IDBPDatabase<BlockSuiteBinaryDB>,
+  id: string,
+  dbName = DEFAULT_DB_NAME
+) {
+  do {
+    if (!allDb || localStorage.getItem(`${dbName}-migration`) !== 'true') {
+      try {
+        allDb = await indexedDB.databases();
+      } catch {
+        // in firefox, `indexedDB.databases` is not existed
+        if (await databaseExists(id)) {
+          await openDB<IDBPDatabase<OldYjsDB>>(id, 1).then(async oldDB => {
+            if (!oldDB.objectStoreNames.contains('updates')) {
+              return;
+            }
+            const t = oldDB
+              .transaction('updates', 'readonly')
+              .objectStore('updates');
+            const updates = await t.getAll();
+            if (
+              !Array.isArray(updates) ||
+              !updates.every(update => update instanceof Uint8Array)
+            ) {
+              return;
+            }
+            const update = mergeUpdates(updates);
+            const workspaceTransaction = db
+              .transaction('workspace', 'readwrite')
+              .objectStore('workspace');
+            const data = await workspaceTransaction.get(id);
+            if (!data) {
+              console.log('upgrading the database');
+              await workspaceTransaction.put({
+                id,
+                updates: [
+                  {
+                    timestamp: Date.now(),
+                    update,
+                  },
+                ],
+              });
+            }
+          });
+          break;
+        }
+      }
+      // run the migration
+      await Promise.all(
+        allDb.map(meta => {
+          if (meta.name && meta.version === 1) {
+            const name = meta.name;
+            const version = meta.version;
+            return openDB<IDBPDatabase<OldYjsDB>>(name, version).then(
+              async oldDB => {
+                if (!oldDB.objectStoreNames.contains('updates')) {
+                  return;
+                }
+                const t = oldDB
+                  .transaction('updates', 'readonly')
+                  .objectStore('updates');
+                const updates = await t.getAll();
+                if (
+                  !Array.isArray(updates) ||
+                  !updates.every(update => update instanceof Uint8Array)
+                ) {
+                  return;
+                }
+                const update = mergeUpdates(updates);
+                const workspaceTransaction = db
+                  .transaction('workspace', 'readwrite')
+                  .objectStore('workspace');
+                const data = await workspaceTransaction.get(name);
+                if (!data) {
+                  console.log('upgrading the database');
+                  await workspaceTransaction.put({
+                    id: name,
+                    updates: [
+                      {
+                        timestamp: Date.now(),
+                        update,
+                      },
+                    ],
+                  });
+                }
+              }
+            );
+          }
+        })
+      );
+      localStorage.setItem(`${dbName}-migration`, 'true');
+      break;
+    }
+    // eslint-disable-next-line no-constant-condition
+  } while (false);
+}
+
 export async function downloadBinary(
  id: string,
  dbName = DEFAULT_DB_NAME