@dxos/client-services 0.8.1 → 0.8.2-main.10c050d

package/src/packlets/spaces/automerge-space-state.ts

@@ -25,7 +25,7 @@ export class AutomergeSpaceState extends Resource implements CredentialProcessor
     this._isProcessingRootDocs = false;
   }
 
-  async processCredential(credential: Credential) {
+  async processCredential(credential: Credential): Promise<void> {
     if (!checkCredentialType(credential, 'dxos.halo.credentials.Epoch')) {
       return;
     }
@@ -42,7 +42,7 @@ export class AutomergeSpaceState extends Resource implements CredentialProcessor
     this.onNewEpoch.emit(credential);
   }
 
-  startProcessingRootDocs() {
+  startProcessingRootDocs(): void {
     if (this._isProcessingRootDocs) {
       return;
     }
@@ -53,7 +53,7 @@ export class AutomergeSpaceState extends Resource implements CredentialProcessor
     this._isProcessingRootDocs = true;
   }
 
-  async ensureEpochInitialized() {
+  async ensureEpochInitialized(): Promise<void> {
     await this.onNewEpoch.waitForCondition(() => !!this.lastEpoch);
   }
 }

package/src/packlets/spaces/data-space-manager.ts

@@ -2,14 +2,10 @@
 // Copyright 2022 DXOS.org
 //
 
+import { type Doc } from '@automerge/automerge';
+import { interpretAsDocumentId, type AutomergeUrl, type DocHandle, type DocumentId } from '@automerge/automerge-repo';
+
 import { Event, synchronized, trackLeaks } from '@dxos/async';
-import { type Doc } from '@dxos/automerge/automerge';
-import {
-  interpretAsDocumentId,
-  type AutomergeUrl,
-  type DocHandle,
-  type DocumentId,
-} from '@dxos/automerge/automerge-repo';
 import { PropertiesType, TYPE_PROPERTIES } from '@dxos/client-protocol';
 import { Context, LifecycleState, Resource, cancelWithContext } from '@dxos/context';
 import {
@@ -32,15 +28,16 @@ import {
   type SpaceManager,
   type SpaceProtocol,
   type SpaceProtocolSession,
+  FIND_PARAMS,
 } from '@dxos/echo-pipeline';
 import {
   SpaceDocVersion,
   createIdFromSpaceKey,
   encodeReference,
   type ObjectStructure,
-  type SpaceDoc,
+  type DatabaseDirectory,
 } from '@dxos/echo-protocol';
-import { createObjectId, getTypeReference } from '@dxos/echo-schema';
+import { ObjectId, getTypeReference } from '@dxos/echo-schema';
 import type { EdgeConnection, EdgeHttpClient } from '@dxos/edge-client';
 import { writeMessages, type FeedStore } from '@dxos/feed-store';
 import { assertArgument, assertState, failedInvariant, invariant } from '@dxos/invariant';
@@ -177,24 +174,29 @@ export class DataSpaceManager extends Resource {
       id: 'spaces',
       name: 'Spaces',
       fetch: async () => {
-        return Array.from(this._spaces.values()).map((space) => {
-          const rootUrl = space.automergeSpaceState.rootUrl;
-          const rootHandle = rootUrl ? this._echoHost.automergeRepo.find(rootUrl as AutomergeUrl) : undefined;
-          const rootDoc = rootHandle?.docSync() as Doc<SpaceDoc> | undefined;
-
-          const properties = rootDoc && findInlineObjectOfType(rootDoc, TYPE_PROPERTIES);
-
-          return {
-            key: space.key.toHex(),
-            state: SpaceState[space.state],
-            name: properties?.[1].data.name ?? null,
-            inlineObjects: rootDoc ? Object.keys(rootDoc.objects ?? {}).length : null,
-            linkedObjects: rootDoc ? Object.keys(rootDoc.links ?? {}).length : null,
-            credentials: space.inner.spaceState.credentials.length,
-            members: space.inner.spaceState.members.size,
-            rootUrl,
-          };
-        });
+        return Promise.all(
+          Array.from(this._spaces.values()).map(async (space) => {
+            const rootUrl = space.automergeSpaceState.rootUrl;
+            const rootHandle = rootUrl
+              ? await this._echoHost.automergeRepo.find<Doc<DatabaseDirectory>>(rootUrl as AutomergeUrl, FIND_PARAMS)
+              : undefined;
+            await rootHandle?.whenReady();
+            const rootDoc = rootHandle?.doc();
+
+            const properties = rootDoc && findInlineObjectOfType(rootDoc, TYPE_PROPERTIES);
+
+            return {
+              key: space.key.toHex(),
+              state: SpaceState[space.state],
+              name: properties?.[1].data.name ?? null,
+              inlineObjects: rootDoc ? Object.keys(rootDoc.objects ?? {}).length : null,
+              linkedObjects: rootDoc ? Object.keys(rootDoc.links ?? {}).length : null,
+              credentials: space.inner.spaceState.credentials.length,
+              members: space.inner.spaceState.members.size,
+              rootUrl,
+            };
+          }),
+        );
       },
     });
   }
@@ -209,7 +211,7 @@ export class DataSpaceManager extends Resource {
   }
 
   @synchronized
-  protected override async _open() {
+  protected override async _open(): Promise<void> {
     log('open');
     log.trace('dxos.echo.data-space-manager.open', Trace.begin({ id: this._instanceId }));
     log('metadata loaded', { spaces: this._metadataStore.spaces.length });
@@ -229,7 +231,7 @@ export class DataSpaceManager extends Resource {
   }
 
   @synchronized
-  protected override async _close() {
+  protected override async _close(): Promise<void> {
     log('close');
     for (const space of this._spaces.values()) {
       await space.close();
@@ -241,7 +243,7 @@ export class DataSpaceManager extends Resource {
    * Creates a new space writing the genesis credentials to the control feed.
    */
   @synchronized
-  async createSpace(options: CreateSpaceOptions = {}) {
+  async createSpace(options: CreateSpaceOptions = {}): Promise<DataSpace> {
     assertArgument(!!options.rootUrl === !!options.documents, 'root url must be required when providing documents');
 
     assertState(this._lifecycleState === LifecycleState.OPEN, 'Not open.');
@@ -283,7 +285,7 @@ export class DataSpaceManager extends Resource {
     let root: DatabaseRoot;
     if (options.rootUrl) {
       const newRootDocId = documentIdMapping[interpretAsDocumentId(options.rootUrl)] ?? failedInvariant();
-      const rootDocHandle = await this._echoHost.loadDoc<SpaceDoc>(Context.default(), newRootDocId);
+      const rootDocHandle = await this._echoHost.loadDoc<DatabaseDirectory>(Context.default(), newRootDocId);
       DatabaseRoot.mapLinks(rootDocHandle, documentIdMapping);
 
       root = await this._echoHost.openSpaceRoot(spaceId, `automerge:${newRootDocId}` as AutomergeUrl);
@@ -319,7 +321,11 @@ export class DataSpaceManager extends Resource {
     }
     switch (space.databaseRoot.getVersion()) {
       case SpaceDocVersion.CURRENT: {
-        const [_, properties] = findInlineObjectOfType(space.databaseRoot.docSync()!, TYPE_PROPERTIES) ?? [];
+        if (!space.databaseRoot.handle.isReady()) {
+          log.warn('waiting for space root to be ready', { spaceId: space.id });
+          await space.databaseRoot.handle.whenReady();
+        }
+        const [_, properties] = findInlineObjectOfType(space.databaseRoot.doc()!, TYPE_PROPERTIES) ?? [];
         return properties?.data?.[DEFAULT_SPACE_KEY] === this._signingContext.identityKey.toHex();
       }
       case SpaceDocVersion.LEGACY: {
@@ -332,7 +338,7 @@ export class DataSpaceManager extends Resource {
     }
   }
 
-  async createDefaultSpace() {
+  async createDefaultSpace(): Promise<DataSpace> {
     const space = await this.createSpace();
     const document = await this._getSpaceRootDocument(space);
 
@@ -349,8 +355,8 @@ export class DataSpaceManager extends Resource {
       },
     };
 
-    const propertiesId = createObjectId();
-    document.change((doc: SpaceDoc) => {
+    const propertiesId = ObjectId.random();
+    document.change((doc: DatabaseDirectory) => {
       setDeep(doc, ['objects', propertiesId], properties);
     });
 
@@ -358,10 +364,10 @@ export class DataSpaceManager extends Resource {
     return space;
   }
 
-  private async _getSpaceRootDocument(space: DataSpace): Promise<DocHandle<SpaceDoc>> {
+  private async _getSpaceRootDocument(space: DataSpace): Promise<DocHandle<DatabaseDirectory>> {
     const automergeIndex = space.automergeSpaceState.rootUrl;
     invariant(automergeIndex);
-    const document = this._echoHost.automergeRepo.find<SpaceDoc>(automergeIndex as any);
+    const document = await this._echoHost.automergeRepo.find<DatabaseDirectory>(automergeIndex as any, FIND_PARAMS);
     await document.whenReady();
     return document;
   }
@@ -423,7 +429,7 @@ export class DataSpaceManager extends Resource {
    * Used by invitation handler.
    * TODO(dmaretskyi): Consider removing.
    */
-  async waitUntilSpaceReady(spaceKey: PublicKey) {
+  async waitUntilSpaceReady(spaceKey: PublicKey): Promise<void> {
     await cancelWithContext(
       this._ctx,
       this.updated.waitForCondition(() => {
@@ -447,7 +453,7 @@ export class DataSpaceManager extends Resource {
     });
   }
 
-  async setSpaceEdgeReplicationSetting(spaceKey: PublicKey, setting: EdgeReplicationSetting) {
+  async setSpaceEdgeReplicationSetting(spaceKey: PublicKey, setting: EdgeReplicationSetting): Promise<void> {
     const space = this._spaces.get(spaceKey);
     invariant(space, 'Space not found.');
 
@@ -467,7 +473,7 @@ export class DataSpaceManager extends Resource {
     space.stateUpdate.emit();
   }
 
-  private async _constructSpace(metadata: SpaceMetadata) {
+  private async _constructSpace(metadata: SpaceMetadata): Promise<DataSpace> {
     log('construct space', { metadata });
     const gossip = new Gossip({
       localPeerId: this._signingContext.deviceKey,
@@ -591,7 +597,7 @@ export class DataSpaceManager extends Resource {
     return dataSpace;
   }
 
-  private async _connectEchoMeshReplicator(space: Space, session: Teleport) {
+  private async _connectEchoMeshReplicator(space: Space, session: Teleport): Promise<void> {
     const replicator = this._meshReplicator;
     if (!replicator) {
       log.warn('p2p automerge replication disabled', { space: space.key });

package/src/packlets/spaces/data-space.ts

@@ -2,8 +2,10 @@
 // Copyright 2022 DXOS.org
 //
 
+import { save } from '@automerge/automerge';
+import { type DocHandle } from '@automerge/automerge-repo';
+
 import { Event, Mutex, scheduleTask, sleep, synchronized, trackLeaks } from '@dxos/async';
-import { save } from '@dxos/automerge/automerge';
 import { AUTH_TIMEOUT } from '@dxos/client-protocol';
 import { Context, ContextDisposedError, cancelWithContext } from '@dxos/context';
 import type { SpecificCredential } from '@dxos/credentials';
@@ -14,8 +16,9 @@ import {
   createMappedFeedWriter,
   type MetadataStore,
   type Space,
+  FIND_PARAMS,
 } from '@dxos/echo-pipeline';
-import { SpaceDocVersion, type SpaceDoc } from '@dxos/echo-protocol';
+import { SpaceDocVersion, type DatabaseDirectory } from '@dxos/echo-protocol';
 import type { EdgeConnection, EdgeHttpClient } from '@dxos/edge-client';
 import { type FeedStore, type FeedWrapper } from '@dxos/feed-store';
 import { failedInvariant, invariant } from '@dxos/invariant';
@@ -226,13 +229,13 @@ export class DataSpace {
   }
 
   @synchronized
-  async open() {
+  async open(): Promise<void> {
     if (this._state === SpaceState.SPACE_CLOSED) {
       await this._open();
     }
   }
 
-  private async _open() {
+  private async _open(): Promise<void> {
     await this._presence.open();
     await this._gossip.open();
     await this._notarizationPlugin.open();
@@ -259,11 +262,11 @@ export class DataSpace {
   }
 
   @synchronized
-  async close() {
+  async close(): Promise<void> {
     await this._close();
   }
 
-  private async _close() {
+  private async _close(): Promise<void> {
     await this._callbacks.beforeClose?.();
 
     await this.preClose.callSerial();
@@ -291,18 +294,18 @@ export class DataSpace {
     await this._gossip.close();
   }
 
-  async postMessage(channel: string, message: any) {
+  async postMessage(channel: string, message: any): Promise<void> {
     return this._gossip.postMessage(channel, message);
   }
 
-  listen(channel: string, callback: (message: GossipMessage) => void) {
+  listen(channel: string, callback: (message: GossipMessage) => void): { unsubscribe: () => void } {
     return this._gossip.listen(channel, callback);
   }
 
   /**
    * Initialize the data pipeline in a separate task.
    */
-  initializeDataPipelineAsync() {
+  initializeDataPipelineAsync(): void {
     scheduleTask(this._ctx, async () => {
       try {
         this.metrics.pipelineInitBegin = new Date();
@@ -325,7 +328,7 @@ export class DataSpace {
   }
 
   @trace.span({ showInBrowserTimeline: true })
-  async initializeDataPipeline() {
+  async initializeDataPipeline(): Promise<void> {
     if (this._state !== SpaceState.SPACE_CONTROL_ONLY) {
       throw new SystemError('Invalid operation');
     }
@@ -352,7 +355,7 @@ export class DataSpace {
 
   async *getAllDocuments(): AsyncIterable<[string, Uint8Array]> {
     invariant(this._databaseRoot, 'Space is not ready');
-    const doc = this._databaseRoot.docSync() ?? failedInvariant();
+    const doc = this._databaseRoot.doc() ?? failedInvariant();
     const root = save(doc);
     yield [this._databaseRoot.documentId, root];
 
@@ -362,7 +365,7 @@ export class DataSpace {
     }
   }
 
-  private async _enterReadyState() {
+  private async _enterReadyState(): Promise<void> {
     await this._callbacks.beforeReady?.();
 
     this._state = SpaceState.SPACE_READY;
@@ -373,7 +376,7 @@ export class DataSpace {
   }
 
   @trace.span({ showInBrowserTimeline: true })
-  private async _initializeAndReadControlPipeline() {
+  private async _initializeAndReadControlPipeline(): Promise<void> {
     await this._inner.controlPipeline.state.waitUntilReachedTargetTimeframe({
       ctx: this._ctx,
       timeout: 10_000,
@@ -399,7 +402,7 @@ export class DataSpace {
   }
 
   @timed(10_000)
-  private async _createWritableFeeds() {
+  private async _createWritableFeeds(): Promise<void> {
     const credentials: Credential[] = [];
     if (!this.inner.controlFeedKey) {
       const controlFeed = await this._feedStore.openFeed(await this._keyring.createKey(), { writable: true });
@@ -456,15 +459,19 @@ export class DataSpace {
     }
   }
 
-  private _onNewAutomergeRoot(rootUrl: string) {
+  private _onNewAutomergeRoot(rootUrl: string): void {
     log('loading automerge root doc for space', { space: this.key, rootUrl });
 
-    const handle = this._echoHost.automergeRepo.find<SpaceDoc>(rootUrl as any);
+    let handle: DocHandle<DatabaseDirectory>;
 
     // TODO(dmaretskyi): Make this single-threaded (but doc loading should still be parallel to not block epoch processing).
     queueMicrotask(async () => {
       try {
         await warnAfterTimeout(5_000, 'Automerge root doc load timeout (DataSpace)', async () => {
+          handle = await cancelWithContext(
+            this._ctx,
+            this._echoHost.automergeRepo.find<DatabaseDirectory>(rootUrl as any, FIND_PARAMS),
+          );
           await cancelWithContext(this._ctx, handle.whenReady());
         });
         if (this._ctx.disposed) {
@@ -475,7 +482,7 @@ export class DataSpace {
         using _guard = await this._epochProcessingMutex.acquire();
 
         // Attaching space keys to legacy documents.
-        const doc = handle.docSync() ?? failedInvariant();
+        const doc = handle.doc() ?? failedInvariant();
         if (!doc.access?.spaceKey) {
           handle.change((doc: any) => {
             doc.access = { spaceKey: this.key.toHex() };
@@ -506,7 +513,7 @@ export class DataSpace {
   }
 
   // TODO(dmaretskyi): Use profile from signing context.
-  async updateOwnProfile(profile: ProfileDocument) {
+  async updateOwnProfile(profile: ProfileDocument): Promise<void> {
     const credential = await this._signingContext.credentialSigner.createCredential({
       subject: this._signingContext.identityKey,
       assertion: {
@@ -561,7 +568,7 @@ export class DataSpace {
   }
 
   @synchronized
-  async activate() {
+  async activate(): Promise<void> {
     if (![SpaceState.SPACE_CLOSED, SpaceState.SPACE_INACTIVE].includes(this._state)) {
       return;
     }
@@ -572,7 +579,7 @@ export class DataSpace {
   }
 
   @synchronized
-  async deactivate() {
+  async deactivate(): Promise<void> {
     if (this._state === SpaceState.SPACE_INACTIVE) {
       return;
     }

package/src/packlets/spaces/edge-feed-replicator.test.ts

@@ -14,6 +14,7 @@ import { createTestEdgeWsServer } from '@dxos/edge-client/testing';
 import { FeedFactory, FeedStore, type FeedWrapper } from '@dxos/feed-store';
 import { Keyring } from '@dxos/keyring';
 import { SpaceId } from '@dxos/keys';
+import { EdgeStatus } from '@dxos/protocols/proto/dxos/client/services';
 import { type FeedMessage } from '@dxos/protocols/proto/dxos/echo/feed';
 import { createStorage } from '@dxos/random-access-storage';
 import { openAndClose } from '@dxos/test-utils';
@@ -44,7 +45,7 @@ describe('EdgeFeedReplicator', () => {
     const { endpoint, admitConnection, messageSink } = await createEdge();
     const { messenger } = await createClient(endpoint);
     admitConnection.wake();
-    await expect.poll(() => messenger.isConnected).toBeTruthy();
+    await expect.poll(() => messenger.status).toBe(EdgeStatus.CONNECTED);
 
     await attachReplicator(messenger);
     await expect.poll(() => messageSink.length).toEqual(1);

package/src/packlets/spaces/edge-feed-replicator.ts

@@ -19,6 +19,7 @@ import {
   type Message as RouterMessage,
 } from '@dxos/protocols/buf/dxos/edge/messenger_pb';
 import type { FeedBlock, ProtocolMessage } from '@dxos/protocols/feed-replication';
+import { EdgeStatus } from '@dxos/protocols/proto/dxos/client/services';
 import { ComplexMap, arrayToBuffer, bufferToArray, defaultMap, rangeFromTo } from '@dxos/util';
 
 export type EdgeFeedReplicatorParams = {
@@ -84,9 +85,9 @@ export class EdgeFeedReplicator extends Resource {
     );
   }
 
-  private async _handleReconnect() {
+  private async _handleReconnect(): Promise<void> {
     await this._resetConnection();
-    if (this._messenger.isConnected) {
+    if (this._messenger.status === EdgeStatus.CONNECTED) {
       this._startReplication();
     }
   }
@@ -96,7 +97,7 @@ export class EdgeFeedReplicator extends Resource {
     await this._resetConnection();
   }
 
-  private _startReplication() {
+  private _startReplication(): void {
     this._connected = true;
     const connectionCtx = this._createConnectionContext();
     this._connectionCtx = connectionCtx;
@@ -108,7 +109,7 @@ export class EdgeFeedReplicator extends Resource {
     });
   }
 
-  private async _resetConnection() {
+  private async _resetConnection(): Promise<void> {
     log('resetConnection');
     this._connected = false;
     await this._connectionCtx?.dispose();
@@ -116,7 +117,7 @@ export class EdgeFeedReplicator extends Resource {
     this._remoteLength.clear();
   }
 
-  async addFeed(feed: FeedWrapper<any>) {
+  async addFeed(feed: FeedWrapper<any>): Promise<void> {
     log('addFeed', { key: feed.key, connected: this._connected, hasConnectionCtx: !!this._connectionCtx });
     this._feeds.set(feed.key, feed);
 
@@ -125,11 +126,11 @@ export class EdgeFeedReplicator extends Resource {
     }
   }
 
-  private _getPushMutex(key: PublicKey) {
+  private _getPushMutex(key: PublicKey): Mutex {
     return defaultMap(this._pushMutex, key, () => new Mutex());
   }
 
-  private async _replicateFeed(ctx: Context, feed: FeedWrapper<any>) {
+  private async _replicateFeed(ctx: Context, feed: FeedWrapper<any>): Promise<void> {
     log('replicateFeed', { key: feed.key });
     await this._sendMessage({
       type: 'get-metadata',
@@ -141,7 +142,7 @@ export class EdgeFeedReplicator extends Resource {
     });
   }
 
-  private async _sendMessage(message: ProtocolMessage) {
+  private async _sendMessage(message: ProtocolMessage): Promise<void> {
     if (!this._connectionCtx) {
       log('message dropped because connection was disposed');
       return;
@@ -170,7 +171,7 @@ export class EdgeFeedReplicator extends Resource {
     );
   }
 
-  private _onMessage(message: ProtocolMessage) {
+  private _onMessage(message: ProtocolMessage): void {
     if (!this._connectionCtx) {
       log.warn('received message after connection context was disposed');
       return;
@@ -228,7 +229,7 @@ export class EdgeFeedReplicator extends Resource {
     });
   }
 
-  private async _pushBlocks(feed: FeedWrapper<any>, from: number, to: number) {
+  private async _pushBlocks(feed: FeedWrapper<any>, from: number, to: number): Promise<void> {
     log('pushing blocks', { feed: feed.key.toHex(), from, to });
 
     const blocks: FeedBlock[] = await Promise.all(
@@ -254,7 +255,7 @@ export class EdgeFeedReplicator extends Resource {
     this._remoteLength.set(feed.key, to);
   }
 
-  private async _integrateBlocks(feed: FeedWrapper<any>, blocks: FeedBlock[]) {
+  private async _integrateBlocks(feed: FeedWrapper<any>, blocks: FeedBlock[]): Promise<void> {
     log('integrating blocks', { feed: feed.key.toHex(), blocks: blocks.length });
 
     for (const block of blocks) {
@@ -272,7 +273,7 @@ export class EdgeFeedReplicator extends Resource {
     }
   }
 
-  private async _pushBlocksIfNeeded(feed: FeedWrapper<any>) {
+  private async _pushBlocksIfNeeded(feed: FeedWrapper<any>): Promise<void> {
     using _ = await this._getPushMutex(feed.key).acquire();
 
     if (!this._remoteLength.has(feed.key)) {
@@ -286,7 +287,7 @@ export class EdgeFeedReplicator extends Resource {
     }
   }
 
-  private _createConnectionContext() {
+  private _createConnectionContext(): Context {
     const connectionCtx = new Context({
       onError: async (err: any) => {
         if (connectionCtx !== this._connectionCtx) {

package/src/packlets/spaces/epoch-migrations.ts

@@ -2,7 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-import type { AutomergeUrl } from '@dxos/automerge/automerge-repo';
+import type { AutomergeUrl } from '@automerge/automerge-repo';
+
 import { type Context } from '@dxos/context';
 import { type EchoHost } from '@dxos/echo-pipeline';
 import { invariant } from '@dxos/invariant';
@@ -47,7 +48,7 @@ export const runEpochMigration = async (ctx: Context, context: MigrationContext)
         timeout: LOAD_DOC_TIMEOUT,
       });
 
-      const newRoot = context.echoHost.createDoc(rootHandle.docSync());
+      const newRoot = context.echoHost.createDoc(rootHandle.doc());
       await context.echoHost.flush();
       return { newRoot: newRoot.url };
     }

package/src/packlets/spaces/notarization-plugin.test.ts

@@ -30,7 +30,7 @@ class TestAgent extends TestPeer {
     });
   }
 
-  enableWriting() {
+  enableWriting(): void {
     this.notarizationPlugin.setWriter(this.feed);
   }