feat: init doc monitor (#3320)

2026-07-19 02:56:23 +08:00 · 2023-07-20 10:44:50 +08:00
parent 27edd7cd93
commit 604b53d9a4
20 changed files with 145 additions and 76 deletions
@@ -0,0 +1,131 @@
+import { isBrowser, isDesktop } from '@affine/env/constant';
+import type { BlockSuiteFeatureFlags } from '@affine/env/global';
+import { WorkspaceFlavour } from '@affine/env/workspace';
+import {
+  createAffineProviders,
+  createLocalProviders,
+} from '@affine/workspace/providers';
+import { __unstableSchemas, AffineSchemas } from '@blocksuite/blocks/models';
+import type { DocProviderCreator, StoreOptions } from '@blocksuite/store';
+import {
+  createIndexeddbStorage,
+  Generator,
+  Workspace,
+} from '@blocksuite/store';
+import { INTERNAL_BLOCKSUITE_HASH_MAP } from '@toeverything/plugin-infra/__internal__/workspace';
+import type { Doc } from 'yjs';
+import type { Transaction } from 'yjs';
+
+import { createStaticStorage } from '../blob/local-static-storage';
+import { createSQLiteStorage } from '../blob/sqlite-blob-storage';
+
+function setEditorFlags(workspace: Workspace) {
+  Object.entries(runtimeConfig.editorFlags).forEach(([key, value]) => {
+    workspace.awarenessStore.setFlag(
+      key as keyof BlockSuiteFeatureFlags,
+      value
+    );
+  });
+  workspace.awarenessStore.setFlag(
+    'enable_bookmark_operation',
+    environment.isDesktop
+  );
+}
+
+type UpdateCallback = (
+  update: Uint8Array,
+  origin: string | number | null,
+  doc: Doc,
+  transaction: Transaction
+) => void;
+
+type SubdocEvent = {
+  loaded: Set<Doc>;
+  removed: Set<Doc>;
+  added: Set<Doc>;
+};
+
+const docUpdateCallbackWeakMap = new WeakMap<Doc, UpdateCallback>();
+
+const createMonitor = (doc: Doc) => {
+  const onUpdate: UpdateCallback = (update, origin) => {
+    if (process.env.NODE_ENV === 'development') {
+      if (typeof origin !== 'string' && typeof origin !== 'number') {
+        console.warn(
+          'origin is not a string or number, this will cause problems in the future',
+          origin
+        );
+      }
+    } else {
+      // todo: add monitor in the future
+    }
+  };
+  docUpdateCallbackWeakMap.set(doc, onUpdate);
+  doc.on('update', onUpdate);
+  const onSubdocs = (event: SubdocEvent) => {
+    event.added.forEach(subdoc => {
+      if (!docUpdateCallbackWeakMap.has(subdoc)) {
+        createMonitor(subdoc);
+      }
+    });
+    event.removed.forEach(subdoc => {
+      if (docUpdateCallbackWeakMap.has(subdoc)) {
+        docUpdateCallbackWeakMap.delete(subdoc);
+      }
+    });
+  };
+  doc.on('subdocs', onSubdocs);
+  doc.on('destroy', () => {
+    docUpdateCallbackWeakMap.delete(doc);
+    doc.off('update', onSubdocs);
+  });
+};
+
+// if not exist, create a new workspace
+export function getOrCreateWorkspace(
+  id: string,
+  flavour: WorkspaceFlavour
+): Workspace {
+  const providerCreators: DocProviderCreator[] = [];
+  if (INTERNAL_BLOCKSUITE_HASH_MAP.has(id)) {
+    return INTERNAL_BLOCKSUITE_HASH_MAP.get(id) as Workspace;
+  }
+  const idGenerator = Generator.NanoID;
+
+  const blobStorages: StoreOptions['blobStorages'] = [];
+
+  if (flavour === WorkspaceFlavour.AFFINE_CLOUD) {
+    if (isBrowser) {
+      blobStorages.push(createIndexeddbStorage);
+      if (isDesktop && runtimeConfig.enableSQLiteProvider) {
+        blobStorages.push(createSQLiteStorage);
+      }
+
+      // todo(JimmFly): add support for cloud storage
+    }
+    providerCreators.push(...createAffineProviders());
+  } else {
+    if (isBrowser) {
+      blobStorages.push(createIndexeddbStorage);
+      if (isDesktop && runtimeConfig.enableSQLiteProvider) {
+        blobStorages.push(createSQLiteStorage);
+      }
+    }
+    providerCreators.push(...createLocalProviders());
+  }
+  blobStorages.push(createStaticStorage);
+
+  const workspace = new Workspace({
+    id,
+    isSSR: !isBrowser,
+    providerCreators: typeof window === 'undefined' ? [] : providerCreators,
+    blobStorages: blobStorages,
+    idGenerator,
+  })
+    .register(AffineSchemas)
+    .register(__unstableSchemas);
+  createMonitor(workspace.doc);
+  setEditorFlags(workspace);
+  INTERNAL_BLOCKSUITE_HASH_MAP.set(id, workspace);
+  return workspace;
+}