feat(sync): initial @blocksuite/sync

toeverything · Feb 6, 2024 · 608ac18 · 608ac18
1 parent 3b0a5ec
commit 608ac18
Show file tree

Hide file tree

Showing 43 changed files with 1,803 additions and 240 deletions.
diff --git a/.commitlintrc.json b/.commitlintrc.json
@@ -9,6 +9,7 @@
         "edgeless",
         "database",
         "store",
+        "sync",
         "std",
         "presets",
         "playground",

diff --git a/package.json b/package.json
@@ -8,6 +8,7 @@
     "packages/framework/inline",
     "packages/framework/lit",
     "packages/framework/store",
+    "packages/framework/sync",
     "packages/blocks",
     "packages/docs",
     "packages/playground",

diff --git a/packages/blocks/src/_common/configs/quick-action/config.ts b/packages/blocks/src/_common/configs/quick-action/config.ts
@@ -125,58 +125,56 @@ export const quickActionConfig: QuickActionConfig[] = [
 
       const page = host.page;
       const linkedPage = page.workspace.createPage({});
-      linkedPage
-        .load(() => {
-          const pageBlockId = linkedPage.addBlock('affine:page', {
-            title: new page.Text(''),
+      linkedPage.load(() => {
+        const pageBlockId = linkedPage.addBlock('affine:page', {
+          title: new page.Text(''),
+        });
+        linkedPage.addBlock('affine:surface', {}, pageBlockId);
+        const noteId = linkedPage.addBlock('affine:note', {}, pageBlockId);
+
+        const firstBlock = selectedModels[0];
+        assertExists(firstBlock);
+
+        page.addSiblingBlocks(
+          firstBlock,
+          [
+            {
+              flavour: 'affine:embed-linked-doc',
+              pageId: linkedPage.id,
+            },
+          ],
+          'before'
+        );
+
+        if (
+          matchFlavours(firstBlock, ['affine:paragraph']) &&
+          firstBlock.type.match(/^h[1-6]$/)
+        ) {
+          const title = firstBlock.text.toString();
+          linkedPage.workspace.setPageMeta(linkedPage.id, {
+            title,
           });
-          linkedPage.addBlock('affine:surface', {}, pageBlockId);
-          const noteId = linkedPage.addBlock('affine:note', {}, pageBlockId);
-
-          const firstBlock = selectedModels[0];
-          assertExists(firstBlock);
-
-          page.addSiblingBlocks(
-            firstBlock,
-            [
-              {
-                flavour: 'affine:embed-linked-doc',
-                pageId: linkedPage.id,
-              },
-            ],
-            'before'
-          );
 
-          if (
-            matchFlavours(firstBlock, ['affine:paragraph']) &&
-            firstBlock.type.match(/^h[1-6]$/)
-          ) {
-            const title = firstBlock.text.toString();
-            linkedPage.workspace.setPageMeta(linkedPage.id, {
-              title,
-            });
-
-            const pageBlock = linkedPage.getBlockById(pageBlockId);
-            assertExists(pageBlock);
-            linkedPage.updateBlock(pageBlock, {
-              title: new page.Text(title),
-            });
-
-            page.deleteBlock(firstBlock);
-            selectedModels.shift();
-          }
-
-          selectedModels.forEach(model => {
-            const keys = model.keys as (keyof typeof model)[];
-            const values = keys.map(key => model[key]);
-            const blockProps = Object.fromEntries(
-              keys.map((key, i) => [key, values[i]])
-            );
-            linkedPage.addBlock(model.flavour, blockProps, noteId);
-            page.deleteBlock(model);
+          const pageBlock = linkedPage.getBlockById(pageBlockId);
+          assertExists(pageBlock);
+          linkedPage.updateBlock(pageBlock, {
+            title: new page.Text(title),
           });
-        })
-        .catch(console.error);
+
+          page.deleteBlock(firstBlock);
+          selectedModels.shift();
+        }
+
+        selectedModels.forEach(model => {
+          const keys = model.keys as (keyof typeof model)[];
+          const values = keys.map(key => model[key]);
+          const blockProps = Object.fromEntries(
+            keys.map((key, i) => [key, values[i]])
+          );
+          linkedPage.addBlock(model.flavour, blockProps, noteId);
+          page.deleteBlock(model);
+        });
+      });
 
       const linkedDocService = host.spec.getService(
         'affine:embed-linked-doc'

diff --git a/packages/blocks/src/_common/utils/init.ts b/packages/blocks/src/_common/utils/init.ts
@@ -6,21 +6,20 @@ export async function createDefaultPage(
 ) {
   const page = workspace.createPage({ id: options.id });
 
-  await page.load(() => {
-    const title = options.title ?? '';
-    const pageBlockId = page.addBlock('affine:page', {
-      title: new page.Text(title),
-    });
-    workspace.setPageMeta(page.id, {
-      title,
-    });
-    page.addBlock('affine:surface', {}, pageBlockId);
-    const noteId = page.addBlock('affine:note', {}, pageBlockId);
-    page.addBlock('affine:paragraph', {}, noteId);
-    // To make sure the content of new page would not be clear
-    // By undo operation for the first time
-    page.resetHistory();
+  page.load();
+  const title = options.title ?? '';
+  const pageBlockId = page.addBlock('affine:page', {
+    title: new page.Text(title),
   });
+  workspace.setPageMeta(page.id, {
+    title,
+  });
+  page.addBlock('affine:surface', {}, pageBlockId);
+  const noteId = page.addBlock('affine:note', {}, pageBlockId);
+  page.addBlock('affine:paragraph', {}, noteId);
+  // To make sure the content of new page would not be clear
+  // By undo operation for the first time
+  page.resetHistory();
 
   return page;
 }
diff --git a/packages/blocks/src/embed-linked-doc-block/embed-linked-doc-block.ts b/packages/blocks/src/embed-linked-doc-block/embed-linked-doc-block.ts
@@ -114,15 +114,8 @@ export class EmbedLinkedDocBlockComponent extends EmbedBlockElement<
     if (linkedDoc.loaded) {
       onLoad();
     } else {
-      linkedDoc
-        .load()
-        .then(() => onLoad())
-        .catch(e => {
-          console.error(
-            `An error occurred while loading page: ${this.model.pageId}`
-          );
-          console.error(e);
-        });
+      linkedDoc.load();
+      onLoad();
     }
   }
 

diff --git a/packages/framework/global/src/utils/index.ts b/packages/framework/global/src/utils/index.ts
@@ -1,5 +1,6 @@
 export * from './assert.js';
 export * from './disposable.js';
 export * from './function.js';
+export * from './logger.js';
 export * from './slot.js';
 export * from './types.js';
diff --git a/packages/framework/global/src/utils/logger.ts b/packages/framework/global/src/utils/logger.ts
@@ -0,0 +1,28 @@
+export interface Logger {
+  debug: (message: string, ...args: unknown[]) => void;
+  info: (message: string, ...args: unknown[]) => void;
+  warn: (message: string, ...args: unknown[]) => void;
+  error: (message: string, ...args: unknown[]) => void;
+}
+
+export class ConsoleLogger implements Logger {
+  debug(message: string, ...args: unknown[]) {
+    console.debug(message, ...args);
+  }
+  info(message: string, ...args: unknown[]) {
+    console.info(message, ...args);
+  }
+  warn(message: string, ...args: unknown[]) {
+    console.warn(message, ...args);
+  }
+  error(message: string, ...args: unknown[]) {
+    console.error(message, ...args);
+  }
+}
+
+export class NoopLogger implements Logger {
+  debug() {}
+  info() {}
+  warn() {}
+  error() {}
+}
diff --git a/packages/framework/store/package.json b/packages/framework/store/package.json
@@ -17,6 +17,7 @@
   "dependencies": {
     "@blocksuite/global": "workspace:*",
     "@blocksuite/inline": "workspace:*",
+    "@blocksuite/sync": "workspace:*",
     "@types/flexsearch": "^0.7.6",
     "flexsearch": "0.7.43",
     "idb-keyval": "^6.2.1",

diff --git a/packages/framework/store/src/workspace/page.ts b/packages/framework/store/src/workspace/page.ts
@@ -636,18 +636,27 @@ export class Page extends Space<FlatBlockMap> {
     });
   }
 
-  override async load(initFn?: () => Promise<void> | void) {
+  override load(initFn?: () => void): this {
     if (this.ready) {
-      throw new Error('Cannot load page more than once');
+      return this;
     }
 
-    await super.load();
-    this._trySyncFromExistingDoc();
+    super.load();
 
     if (initFn) {
-      await initFn();
+      initFn();
     }
 
+    if ((this.workspace.meta.pages?.length ?? 0) <= 1) {
+      this._handleVersion();
+    }
+
+    this._initYBlocks();
+
+    this._yBlocks.forEach((_, id) => {
+      this._handleYBlockAdd(id);
+    });
+
     this._ready = true;
     this.slots.ready.emit();
 
@@ -792,22 +801,6 @@ export class Page extends Space<FlatBlockMap> {
     }
   }
 
-  private _trySyncFromExistingDoc() {
-    if (this.ready) {
-      throw new Error('Cannot sync from existing doc more than once');
-    }
-
-    if ((this.workspace.meta.pages?.length ?? 0) <= 1) {
-      this._handleVersion();
-    }
-
-    this._initYBlocks();
-
-    this._yBlocks.forEach((_, id) => {
-      this._handleYBlockAdd(id);
-    });
-  }
-
   /** @deprecated use page.load() instead */
   async waitForLoaded() {
     await this.load();

diff --git a/packages/framework/store/src/workspace/space.ts b/packages/framework/store/src/workspace/space.ts
@@ -54,21 +54,9 @@ export class Space<
     return this._ySpaceDoc;
   }
 
-  async load() {
-    if (this.loaded) {
-      return this;
-    }
-
-    const promise = new Promise(resolve => {
-      this._onLoadSlot.once(() => {
-        resolve(undefined);
-      });
-    });
-
+  load() {
     this._ySpaceDoc.load();
 
-    await promise;
-
     return this;
   }
 

diff --git a/packages/framework/store/src/workspace/store.ts b/packages/framework/store/src/workspace/store.ts
@@ -1,3 +1,11 @@
+import { type Logger, NoopLogger } from '@blocksuite/global/utils';
+import {
+  AwarenessEngine,
+  type AwarenessProvider,
+  SyncEngine,
+  type SyncStorage,
+} from '@blocksuite/sync';
+import { MemorySyncStorage } from '@blocksuite/sync/impl/memory.js';
 import { merge } from 'merge';
 import { Awareness } from 'y-protocols/awareness.js';
 
@@ -44,10 +52,15 @@ export interface StoreOptions<
   Flags extends Record<string, unknown> = BlockSuiteFlags,
 > {
   id?: string;
-  awareness?: Awareness<RawAwarenessState<Flags>>;
   idGenerator?: Generator | IdGenerator;
   defaultFlags?: Partial<Flags>;
   blobStorages?: ((id: string) => BlobStorage)[];
+  logger?: Logger;
+  sync?: {
+    primary: SyncStorage;
+    secondary?: SyncStorage[];
+  };
+  awareness?: AwarenessProvider[];
 }
 
 const FLAGS_PRESET = {
@@ -61,21 +74,42 @@ export class Store {
   readonly id: string;
   readonly doc: BlockSuiteDoc;
   readonly spaces = new Map<string, Space>();
+  readonly awareness: AwarenessEngine;
   readonly awarenessStore: AwarenessStore;
+  readonly sync: SyncEngine;
   readonly idGenerator: IdGenerator;
 
   constructor(
-    { id, awareness, idGenerator, defaultFlags }: StoreOptions = {
+    {
+      id,
+      idGenerator,
+      defaultFlags,
+      awareness: awarenessProviders = [],
+      sync = {
+        primary: new MemorySyncStorage(),
+      },
+      logger = new NoopLogger(),
+    }: StoreOptions = {
       id: nanoid(),
     }
   ) {
     this.id = id || '';
     this.doc = new BlockSuiteDoc({ guid: id });
     this.awarenessStore = new AwarenessStore(
       this,
-      awareness ?? new Awareness<RawAwarenessState>(this.doc),
+      new Awareness<RawAwarenessState>(this.doc),
       merge(true, FLAGS_PRESET, defaultFlags)
     );
+    this.awareness = new AwarenessEngine(
+      this.awarenessStore.awareness,
+      awarenessProviders
+    );
+    this.sync = new SyncEngine(
+      this.doc,
+      sync.primary,
+      sync.secondary ?? [],
+      logger
+    );
 
     if (typeof idGenerator === 'function') {
       this.idGenerator = idGenerator;