refactor: move local workspace CRUD (#1778)

apps/web/src/blocksuite/index.ts

@@ -1,12 +1,13 @@
 import { config } from '@affine/env';
+import {
+  createIndexedDBProvider,
+  createLocalProviders,
+} from '@affine/workspace/providers';
+import { createBroadCastChannelProvider } from '@affine/workspace/providers';
 import type { Provider } from '@affine/workspace/type';
 
 import type { BlockSuiteWorkspace } from '../shared';
-import {
-  createAffineWebSocketProvider,
-  createBroadCastChannelProvider,
-  createIndexedDBProvider,
-} from './providers';
+import { createAffineWebSocketProvider } from './providers';
 import { createAffineDownloadProvider } from './providers/affine';
 
 export const createAffineProviders = (
@@ -24,15 +25,4 @@ export const createAffineProviders = (
   ).filter(v => Boolean(v));
 };
 
-export const createLocalProviders = (
-  blockSuiteWorkspace: BlockSuiteWorkspace
-): Provider[] => {
-  return (
-    [
-      config.enableBroadCastChannelProvider &&
-        createBroadCastChannelProvider(blockSuiteWorkspace),
-      config.enableIndexedDBProvider &&
-        createIndexedDBProvider(blockSuiteWorkspace),
-    ] as any[]
-  ).filter(v => Boolean(v));
-};
+export { createLocalProviders };

apps/web/src/blocksuite/providers/broad-cast-channel/index.ts

@@ -1,119 +0,0 @@
-import type { BroadCastChannelProvider } from '@affine/workspace/type';
-import { assertExists } from '@blocksuite/store';
-import type { Awareness } from 'y-protocols/awareness';
-import {
-  applyAwarenessUpdate,
-  encodeAwarenessUpdate,
-} from 'y-protocols/awareness';
-
-import { BlockSuiteWorkspace } from '../../../shared';
-import { providerLogger } from '../../logger';
-import type {
-  AwarenessChanges,
-  BroadcastChannelMessageEvent,
-  TypedBroadcastChannel,
-} from './type';
-import { getClients } from './type';
-
-export const createBroadCastChannelProvider = (
-  blockSuiteWorkspace: BlockSuiteWorkspace
-): BroadCastChannelProvider => {
-  const Y = BlockSuiteWorkspace.Y;
-  const doc = blockSuiteWorkspace.doc;
-  const awareness = blockSuiteWorkspace.awarenessStore
-    .awareness as unknown as Awareness;
-  let broadcastChannel: TypedBroadcastChannel | null = null;
-  const handleBroadcastChannelMessage = (
-    event: BroadcastChannelMessageEvent
-  ) => {
-    const [eventName] = event.data;
-    switch (eventName) {
-      case 'doc:diff': {
-        const [, diff, clientId] = event.data;
-        const update = Y.encodeStateAsUpdate(doc, diff);
-        broadcastChannel!.postMessage(['doc:update', update, clientId]);
-        break;
-      }
-      case 'doc:update': {
-        const [, update, clientId] = event.data;
-        if (!clientId || clientId === awareness.clientID) {
-          Y.applyUpdate(doc, update, broadcastChannel);
-        }
-        break;
-      }
-      case 'awareness:query': {
-        const [, clientId] = event.data;
-        const clients = getClients(awareness);
-        const update = encodeAwarenessUpdate(awareness, clients);
-        broadcastChannel!.postMessage(['awareness:update', update, clientId]);
-        break;
-      }
-      case 'awareness:update': {
-        const [, update, clientId] = event.data;
-        if (!clientId || clientId === awareness.clientID) {
-          applyAwarenessUpdate(awareness, update, broadcastChannel);
-        }
-        break;
-      }
-    }
-  };
-  const handleDocUpdate = (updateV1: Uint8Array, origin: any) => {
-    if (origin === broadcastChannel) {
-      // not self update, ignore
-      return;
-    }
-    broadcastChannel?.postMessage(['doc:update', updateV1]);
-  };
-  const handleAwarenessUpdate = (changes: AwarenessChanges, origin: any) => {
-    if (origin === broadcastChannel) {
-      return;
-    }
-    const changedClients = Object.values(changes).reduce((res, cur) => [
-      ...res,
-      ...cur,
-    ]);
-    const update = encodeAwarenessUpdate(awareness, changedClients);
-    broadcastChannel?.postMessage(['awareness:update', update]);
-  };
-  return {
-    flavour: 'broadcast-channel',
-    background: false,
-    connect: () => {
-      assertExists(blockSuiteWorkspace.id);
-      broadcastChannel = Object.assign(
-        new BroadcastChannel(blockSuiteWorkspace.id),
-        {
-          onmessage: handleBroadcastChannelMessage,
-        }
-      );
-      providerLogger.info('connect broadcast channel', blockSuiteWorkspace.id);
-      const docDiff = Y.encodeStateVector(doc);
-      broadcastChannel.postMessage(['doc:diff', docDiff, awareness.clientID]);
-      const docUpdateV2 = Y.encodeStateAsUpdate(doc);
-      broadcastChannel.postMessage(['doc:update', docUpdateV2]);
-      broadcastChannel.postMessage(['awareness:query', awareness.clientID]);
-      const awarenessUpdate = encodeAwarenessUpdate(awareness, [
-        awareness.clientID,
-      ]);
-      broadcastChannel.postMessage(['awareness:update', awarenessUpdate]);
-      doc.on('update', handleDocUpdate);
-      awareness.on('update', handleAwarenessUpdate);
-    },
-    disconnect: () => {
-      assertExists(broadcastChannel);
-      providerLogger.info(
-        'disconnect broadcast channel',
-        blockSuiteWorkspace.id
-      );
-      doc.off('update', handleDocUpdate);
-      awareness.off('update', handleAwarenessUpdate);
-      broadcastChannel.close();
-    },
-    cleanup: () => {
-      assertExists(broadcastChannel);
-      doc.off('update', handleDocUpdate);
-      awareness.off('update', handleAwarenessUpdate);
-      broadcastChannel.close();
-    },
-  };
-};

apps/web/src/blocksuite/providers/broad-cast-channel/type.ts

@@ -1,86 +0,0 @@
-import type { Awareness as YAwareness } from 'y-protocols/awareness';
-
-export type ClientId = YAwareness['clientID'];
-// eslint-disable-next-line @typescript-eslint/ban-types
-export type DefaultClientData = {};
-
-type EventHandler = (...args: any[]) => void;
-export type DefaultEvents = {
-  [eventName: string]: EventHandler;
-};
-
-type EventNameWithScope<
-  Scope extends string,
-  Type extends string = string
-> = `${Scope}:${Type}`;
-
-type DataScope = 'data';
-type RoomScope = 'room';
-
-type YDocScope = 'doc';
-type AwarenessScope = 'awareness';
-type ObservableScope = YDocScope | AwarenessScope;
-type ObservableEventName = EventNameWithScope<ObservableScope>;
-
-type ValidEventScope = DataScope | RoomScope | ObservableScope;
-
-type ValidateEvents<
-  Events extends DefaultEvents & {
-    [EventName in keyof Events]: EventName extends EventNameWithScope<
-      infer EventScope
-    >
-      ? EventScope extends ValidEventScope
-        ? Events[EventName]
-        : never
-      : Events[EventName];
-  }
-> = Events;
-
-export type DefaultServerToClientEvents<
-  ClientData extends DefaultClientData = DefaultClientData
-> = ValidateEvents<{
-  ['data:update']: (data: ClientData) => void;
-  ['doc:diff']: (diff: ArrayBuffer) => void;
-  ['doc:update']: (update: ArrayBuffer) => void;
-  ['awareness:update']: (update: ArrayBuffer) => void;
-}>;
-
-export type ServerToClientEvents<
-  ClientData extends DefaultClientData = DefaultClientData
-> = DefaultServerToClientEvents<ClientData>;
-
-export type DefaultClientToServerEvents = ValidateEvents<{
-  ['room:close']: () => void;
-  ['doc:diff']: (diff: Uint8Array) => void;
-  ['doc:update']: (update: Uint8Array, callback?: () => void) => void;
-  ['awareness:update']: (update: Uint8Array) => void;
-}>;
-
-export type ClientToServerEvents = DefaultClientToServerEvents;
-
-type ClientToServerEventNames = keyof ClientToServerEvents;
-
-export type BroadcastChannelMessageData<
-  EventName extends ClientToServerEventNames = ClientToServerEventNames
-> =
-  | (EventName extends ObservableEventName
-      ? [eventName: EventName, payload: Uint8Array, clientId?: ClientId]
-      : never)
-  | [eventName: `${AwarenessScope}:query`, clientId: ClientId];
-
-export type BroadcastChannelMessageEvent =
-  MessageEvent<BroadcastChannelMessageData>;
-
-export type AwarenessChanges = Record<
-  'added' | 'updated' | 'removed',
-  ClientId[]
->;
-
-export interface TypedBroadcastChannel extends BroadcastChannel {
-  onmessage: ((event: BroadcastChannelMessageEvent) => void) | null;
-  postMessage: (message: BroadcastChannelMessageData) => void;
-}
-
-export const getClients = (awareness: YAwareness): ClientId[] => [
-  ...awareness.getStates().keys(),
-];

apps/web/src/blocksuite/providers/index.ts

@@ -1,15 +1,10 @@
 import { KeckProvider } from '@affine/workspace/affine/keck';
 import { getLoginStorage } from '@affine/workspace/affine/login';
-import type {
-  AffineWebSocketProvider,
-  LocalIndexedDBProvider,
-} from '@affine/workspace/type';
+import type { AffineWebSocketProvider } from '@affine/workspace/type';
 import { assertExists } from '@blocksuite/store';
-import { IndexeddbPersistence } from 'y-indexeddb';
 
 import type { BlockSuiteWorkspace } from '../../shared';
 import { providerLogger } from '../logger';
-import { createBroadCastChannelProvider } from './broad-cast-channel';
 
 const createAffineWebSocketProvider = (
   blockSuiteWorkspace: BlockSuiteWorkspace
@@ -52,46 +47,4 @@ const createAffineWebSocketProvider = (
   };
 };
 
-const createIndexedDBProvider = (
-  blockSuiteWorkspace: BlockSuiteWorkspace
-): LocalIndexedDBProvider => {
-  let indexeddbProvider: IndexeddbPersistence | null = null;
-  const callbacks = new Set<() => void>();
-  return {
-    flavour: 'local-indexeddb',
-    callbacks,
-    // fixme: remove background long polling
-    background: true,
-    cleanup: () => {
-      assertExists(indexeddbProvider);
-      indexeddbProvider.clearData();
-      callbacks.clear();
-      indexeddbProvider = null;
-    },
-    connect: () => {
-      providerLogger.info('connect indexeddb provider', blockSuiteWorkspace.id);
-      indexeddbProvider = new IndexeddbPersistence(
-        blockSuiteWorkspace.id,
-        blockSuiteWorkspace.doc
-      );
-      indexeddbProvider.whenSynced.then(() => {
-        callbacks.forEach(cb => cb());
-      });
-    },
-    disconnect: () => {
-      assertExists(indexeddbProvider);
-      providerLogger.info(
-        'disconnect indexeddb provider',
-        blockSuiteWorkspace.id
-      );
-      indexeddbProvider.destroy();
-      indexeddbProvider = null;
-    },
-  };
-};
-
-export {
-  createAffineWebSocketProvider,
-  createBroadCastChannelProvider,
-  createIndexedDBProvider,
-};
+export { createAffineWebSocketProvider };

apps/web/src/pages/_debug/broadcast.dev.tsx

@@ -1,5 +1,6 @@
 import { Button } from '@affine/component';
 import { DebugLogger } from '@affine/debug';
+import { createBroadCastChannelProvider } from '@affine/workspace/providers';
 import type { BroadCastChannelProvider } from '@affine/workspace/type';
 import { createEmptyBlockSuiteWorkspace } from '@affine/workspace/utils';
 import { nanoid } from '@blocksuite/store';
@@ -7,7 +8,6 @@ import { Typography } from '@mui/material';
 import type React from 'react';
 import { useEffect, useMemo, useState } from 'react';
 
-import { createBroadCastChannelProvider } from '../../blocksuite/providers';
 import PageList from '../../components/blocksuite/block-suite-page-list/page-list';
 import { StyledPage, StyledWrapper } from '../../layouts/styles';
 import { toast } from '../../utils';

apps/web/src/plugins/local/index.tsx

@@ -1,97 +1,18 @@
-import type { LocalWorkspace } from '@affine/workspace/type';
+import { CRUD } from '@affine/workspace/local/crud';
 import { LoadPriority, WorkspaceFlavour } from '@affine/workspace/type';
-import { createEmptyBlockSuiteWorkspace } from '@affine/workspace/utils';
-import { nanoid } from '@blocksuite/store';
-import { createJSONStorage } from 'jotai/utils';
 import React from 'react';
-import { IndexeddbPersistence } from 'y-indexeddb';
-import { z } from 'zod';
 
-import { createLocalProviders } from '../../blocksuite';
 import { PageNotFoundError } from '../../components/affine/affine-error-eoundary';
 import { WorkspaceSettingDetail } from '../../components/affine/workspace-setting-detail';
 import { BlockSuitePageList } from '../../components/blocksuite/block-suite-page-list';
 import { PageDetailEditor } from '../../components/page-detail-editor';
-import { BlockSuiteWorkspace } from '../../shared';
 import { initPage } from '../../utils';
 import type { WorkspacePlugin } from '..';
 
-const getStorage = () => createJSONStorage(() => localStorage);
-
-export const kStoreKey = 'affine-local-workspace';
-const schema = z.array(z.string());
-
 export const LocalPlugin: WorkspacePlugin<WorkspaceFlavour.LOCAL> = {
   flavour: WorkspaceFlavour.LOCAL,
   loadPriority: LoadPriority.LOW,
-  CRUD: {
-    get: async workspaceId => {
-      const storage = getStorage();
-      !Array.isArray(storage.getItem(kStoreKey)) &&
-        storage.setItem(kStoreKey, []);
-      const data = storage.getItem(kStoreKey) as z.infer<typeof schema>;
-      const id = data.find(id => id === workspaceId);
-      if (!id) {
-        return null;
-      }
-      const blockSuiteWorkspace = createEmptyBlockSuiteWorkspace(
-        id,
-        (_: string) => undefined
-      );
-      const workspace: LocalWorkspace = {
-        id,
-        flavour: WorkspaceFlavour.LOCAL,
-        blockSuiteWorkspace: blockSuiteWorkspace,
-        providers: [...createLocalProviders(blockSuiteWorkspace)],
-      };
-      return workspace;
-    },
-    create: async ({ doc }) => {
-      const storage = getStorage();
-      !Array.isArray(storage.getItem(kStoreKey)) &&
-        storage.setItem(kStoreKey, []);
-      const data = storage.getItem(kStoreKey) as z.infer<typeof schema>;
-      const binary = BlockSuiteWorkspace.Y.encodeStateAsUpdateV2(doc);
-      const id = nanoid();
-      const blockSuiteWorkspace = createEmptyBlockSuiteWorkspace(
-        id,
-        (_: string) => undefined
-      );
-      BlockSuiteWorkspace.Y.applyUpdateV2(blockSuiteWorkspace.doc, binary);
-      const persistence = new IndexeddbPersistence(id, blockSuiteWorkspace.doc);
-      await persistence.whenSynced.then(() => {
-        persistence.destroy();
-      });
-      storage.setItem(kStoreKey, [...data, id]);
-      console.log('create', id, storage.getItem(kStoreKey));
-      return id;
-    },
-    delete: async workspace => {
-      const storage = getStorage();
-      !Array.isArray(storage.getItem(kStoreKey)) &&
-        storage.setItem(kStoreKey, []);
-      const data = storage.getItem(kStoreKey) as z.infer<typeof schema>;
-      const idx = data.findIndex(id => id === workspace.id);
-      if (idx === -1) {
-        throw new Error('workspace not found');
-      }
-      data.splice(idx, 1);
-      storage.setItem(kStoreKey, [...data]);
-    },
-    list: async () => {
-      const storage = getStorage();
-      !Array.isArray(storage.getItem(kStoreKey)) &&
-        storage.setItem(kStoreKey, []);
-      const data = (
-        await Promise.all(
-          (storage.getItem(kStoreKey) as z.infer<typeof schema>).map(id =>
-            LocalPlugin.CRUD.get(id)
-          )
-        )
-      ).filter(item => item !== null) as LocalWorkspace[];
-      return data;
-    },
-  },
+  CRUD,
   UI: {
     PageDetail: ({ currentWorkspace, currentPageId }) => {
       const page = currentWorkspace.blockSuiteWorkspace.getPage(currentPageId);