feat(infra): new workspace infra (#5617)

This PR copying @affine/workspace into common/infra, and adding definitions for services and unit tests.
2026-08-09 05:05:52 +08:00 · 2024-01-30 06:31:23 +00:00
parent 4f7e0d012d
commit 2e71c980cf
37 changed files with 3082 additions and 4 deletions
@@ -0,0 +1,142 @@
+import { Unreachable } from '@affine/env/constant';
+import { WorkspaceFlavour } from '@affine/env/workspace';
+import { Slot } from '@blocksuite/global/utils';
+import type { Workspace as BlockSuiteWorkspace } from '@blocksuite/store';
+import { applyUpdate, Doc as YDoc, encodeStateAsUpdate } from 'yjs';
+
+import { checkWorkspaceCompatibility, MigrationPoint } from '../blocksuite';
+import { forceUpgradePages, upgradeV1ToV2 } from '../blocksuite';
+import { migrateGuidCompatibility } from '../blocksuite';
+import type { SyncEngine } from './engine/sync';
+import type { WorkspaceManager } from './manager';
+import { type WorkspaceMetadata } from './metadata';
+
+export interface WorkspaceUpgradeStatus {
+  needUpgrade: boolean;
+  upgrading: boolean;
+}
+
+export class WorkspaceUpgradeController {
+  _status: Readonly<WorkspaceUpgradeStatus> = {
+    needUpgrade: false,
+    upgrading: false,
+  };
+  readonly onStatusChange = new Slot<WorkspaceUpgradeStatus>();
+
+  get status() {
+    return this._status;
+  }
+
+  set status(value) {
+    if (
+      value.needUpgrade !== this._status.needUpgrade ||
+      value.upgrading !== this._status.upgrading
+    ) {
+      this._status = value;
+      this.onStatusChange.emit(value);
+    }
+  }
+
+  constructor(
+    private readonly blockSuiteWorkspace: BlockSuiteWorkspace,
+    private readonly sync: SyncEngine,
+    private readonly workspaceMetadata: WorkspaceMetadata
+  ) {
+    blockSuiteWorkspace.doc.on('update', () => {
+      this.checkIfNeedUpgrade();
+    });
+  }
+
+  checkIfNeedUpgrade() {
+    const needUpgrade = !!checkWorkspaceCompatibility(
+      this.blockSuiteWorkspace,
+      this.workspaceMetadata.flavour === WorkspaceFlavour.AFFINE_CLOUD
+    );
+    this.status = {
+      ...this.status,
+      needUpgrade,
+    };
+    return needUpgrade;
+  }
+
+  async upgrade(
+    workspaceManager: WorkspaceManager
+  ): Promise<WorkspaceMetadata | null> {
+    if (this.status.upgrading) {
+      return null;
+    }
+
+    this.status = { ...this.status, upgrading: true };
+
+    try {
+      await this.sync.waitForSynced();
+
+      const step = checkWorkspaceCompatibility(
+        this.blockSuiteWorkspace,
+        this.workspaceMetadata.flavour === WorkspaceFlavour.AFFINE_CLOUD
+      );
+
+      if (!step) {
+        return null;
+      }
+
+      // Clone a new doc to prevent change events.
+      const clonedDoc = new YDoc({
+        guid: this.blockSuiteWorkspace.doc.guid,
+      });
+      applyDoc(clonedDoc, this.blockSuiteWorkspace.doc);
+
+      if (step === MigrationPoint.SubDoc) {
+        const newWorkspace = await workspaceManager.createWorkspace(
+          WorkspaceFlavour.LOCAL,
+          async (workspace, blobStorage) => {
+            await upgradeV1ToV2(clonedDoc, workspace.doc);
+            migrateGuidCompatibility(clonedDoc);
+            await forceUpgradePages(
+              workspace.doc,
+              this.blockSuiteWorkspace.schema
+            );
+            const blobList = await this.blockSuiteWorkspace.blob.list();
+
+            for (const blobKey of blobList) {
+              const blob = await this.blockSuiteWorkspace.blob.get(blobKey);
+              if (blob) {
+                await blobStorage.set(blobKey, blob);
+              }
+            }
+          }
+        );
+        await workspaceManager.deleteWorkspace(this.workspaceMetadata);
+        return newWorkspace;
+      } else if (step === MigrationPoint.GuidFix) {
+        migrateGuidCompatibility(clonedDoc);
+        await forceUpgradePages(clonedDoc, this.blockSuiteWorkspace.schema);
+        applyDoc(this.blockSuiteWorkspace.doc, clonedDoc);
+        await this.sync.waitForSynced();
+        return null;
+      } else if (step === MigrationPoint.BlockVersion) {
+        await forceUpgradePages(clonedDoc, this.blockSuiteWorkspace.schema);
+        applyDoc(this.blockSuiteWorkspace.doc, clonedDoc);
+        await this.sync.waitForSynced();
+        return null;
+      } else {
+        throw new Unreachable();
+      }
+    } finally {
+      this.status = { ...this.status, upgrading: false };
+    }
+  }
+}
+
+function applyDoc(target: YDoc, result: YDoc) {
+  applyUpdate(target, encodeStateAsUpdate(result));
+  for (const targetSubDoc of target.subdocs.values()) {
+    const resultSubDocs = Array.from(result.subdocs.values());
+    const resultSubDoc = resultSubDocs.find(
+      item => item.guid === targetSubDoc.guid
+    );
+    if (resultSubDoc) {
+      applyDoc(targetSubDoc, resultSubDoc);
+    }
+  }
+}