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 13:15:51 +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,81 @@
+export * from './context';
+export * from './engine';
+export * from './factory';
+export * from './global-schema';
+export * from './list';
+export * from './manager';
+export * from './metadata';
+export * from './service-scope';
+export * from './testing';
+export * from './upgrade';
+export * from './workspace';
+
+import { type ServiceCollection, ServiceProvider } from '../di';
+import { CleanupService } from '../lifecycle';
+import { GlobalCache, GlobalState } from '../storage';
+import {
+  BlockSuiteWorkspaceContext,
+  RootYDocContext,
+  WorkspaceMetadataContext,
+} from './context';
+import {
+  AwarenessEngine,
+  AwarenessProvider,
+  BlobEngine,
+  LocalBlobStorage,
+  LocalSyncStorage,
+  RemoteBlobStorage,
+  RemoteSyncStorage,
+  SyncEngine,
+  WorkspaceEngine,
+} from './engine';
+import { WorkspaceFactory } from './factory';
+import { WorkspaceListProvider, WorkspaceListService } from './list';
+import { WorkspaceManager } from './manager';
+import { WorkspaceScope } from './service-scope';
+import {
+  TestingLocalWorkspaceFactory,
+  TestingLocalWorkspaceListProvider,
+} from './testing';
+import { WorkspaceUpgradeController } from './upgrade';
+import { Workspace } from './workspace';
+
+export function configureWorkspaceServices(services: ServiceCollection) {
+  // global scope
+  services
+    .add(WorkspaceManager, [
+      WorkspaceListService,
+      [WorkspaceFactory],
+      ServiceProvider,
+    ])
+    .add(WorkspaceListService, [[WorkspaceListProvider], GlobalCache]);
+
+  // workspace scope
+  services
+    .scope(WorkspaceScope)
+    .add(CleanupService)
+    .add(Workspace, [
+      WorkspaceMetadataContext,
+      WorkspaceEngine,
+      BlockSuiteWorkspaceContext,
+      WorkspaceUpgradeController,
+      ServiceProvider,
+    ])
+    .add(WorkspaceEngine, [BlobEngine, SyncEngine, AwarenessEngine])
+    .add(AwarenessEngine, [[AwarenessProvider]])
+    .add(BlobEngine, [LocalBlobStorage, [RemoteBlobStorage]])
+    .add(SyncEngine, [RootYDocContext, LocalSyncStorage, [RemoteSyncStorage]])
+    .add(WorkspaceUpgradeController, [
+      BlockSuiteWorkspaceContext,
+      SyncEngine,
+      WorkspaceMetadataContext,
+    ]);
+}
+
+export function configureTestingWorkspaceServices(services: ServiceCollection) {
+  services
+    .addImpl(WorkspaceListProvider, TestingLocalWorkspaceListProvider, [
+      GlobalState,
+    ])
+    .addImpl(WorkspaceFactory, TestingLocalWorkspaceFactory, [GlobalState]);
+}