@dxos/client-services 0.8.4-main.ef1bc66f44 → 0.8.4-main.f466a3d56e

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

@@ -24,7 +24,7 @@ import { failedInvariant, invariant } from '@dxos/invariant';
 import { type Keyring } from '@dxos/keyring';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
-import { CancelledError, SystemError } from '@dxos/protocols';
+import { CancelledError, type FeedProtocol, SystemError } from '@dxos/protocols';
 import {
   type CreateEpochRequest,
   type Space as SpaceProto,
@@ -37,6 +37,7 @@ import {
   AdmittedFeed,
   type Credential,
   type Epoch,
+  MembershipPolicy,
   type ProfileDocument,
   SpaceMember,
 } from '@dxos/protocols/proto/dxos/halo/credentials';
@@ -47,7 +48,6 @@ import { trace } from '@dxos/tracing';
 import { type AsyncCallback, CallbackCollection, ComplexSet } from '@dxos/util';
 
 import { TrustedKeySetAuthVerifier } from '../identity';
-
 import { AutomergeSpaceState } from './automerge-space-state';
 import { type SigningContext } from './data-space-manager';
 import { EdgeFeedReplicator } from './edge-feed-replicator';
@@ -83,6 +83,7 @@ export type DataSpaceProps = {
   signingContext: SigningContext;
   callbacks?: DataSpaceCallbacks;
   cache?: SpaceCache;
+  tags?: string[];
   edgeConnection?: EdgeConnection;
   edgeHttpClient?: EdgeHttpClient;
   edgeFeatures?: Runtime.Client.EdgeFeatures;
@@ -120,6 +121,9 @@ export class DataSpace {
 
   private _state = SpaceState.SPACE_CLOSED;
 
+  /** Immutable tags from space metadata, available immediately. */
+  readonly tags: string[];
+
   private _databaseRoot: DatabaseRoot | null = null;
 
   /**
@@ -167,6 +171,7 @@ export class DataSpace {
     });
 
     this._cache = params.cache;
+    this.tags = params.tags ?? [];
 
     if (params.edgeConnection && params.edgeFeatures?.feedReplicator) {
       this._edgeFeedReplicator = new EdgeFeedReplicator({ messenger: params.edgeConnection, spaceId: this.id });
@@ -212,6 +217,11 @@ export class DataSpace {
     return this._cache;
   }
 
+  /** Membership policy from the genesis credential, defaults to INVITE. */
+  get membershipPolicy(): MembershipPolicy {
+    return this._inner.spaceState.genesisCredential ? this._inner.spaceState.membershipPolicy : MembershipPolicy.INVITE;
+  }
+
   get automergeSpaceState() {
     return this._automergeSpaceState;
   }
@@ -229,13 +239,14 @@ export class DataSpace {
   }
 
   @synchronized
-  async open(): Promise<void> {
+  @trace.span({ showInBrowserTimeline: true, op: 'lifecycle' })
+  async open(ctx: Context): Promise<void> {
     if (this._state === SpaceState.SPACE_CLOSED) {
-      await this._open();
+      await this._open(ctx);
     }
   }
 
-  private async _open(): Promise<void> {
+  private async _open(ctx: Context): Promise<void> {
     await this._presence.open();
     await this._gossip.open();
     await this._notarizationPlugin.open();
@@ -247,8 +258,8 @@ export class DataSpace {
       this.inner.protocol.feedAdded.append(this._onFeedAdded);
     }
 
-    await this._inner.open(new Context());
-    await this._inner.startProtocol();
+    await this._inner.open(ctx);
+    await this._inner.startProtocol(ctx);
 
     await this._edgeFeedReplicator?.open();
 
@@ -262,11 +273,12 @@ export class DataSpace {
   }
 
   @synchronized
-  async close(): Promise<void> {
-    await this._close();
+  @trace.span({ showInBrowserTimeline: true, op: 'lifecycle' })
+  async close(ctx: Context): Promise<void> {
+    await this._close(ctx);
   }
 
-  private async _close(): Promise<void> {
+  private async _close(ctx: Context): Promise<void> {
     await this._callbacks.beforeClose?.();
 
     await this.preClose.callSerial();
@@ -284,7 +296,7 @@ export class DataSpace {
 
     await this.authVerifier.close();
 
-    await this._inner.close();
+    await this._inner.close(ctx);
     await this._inner.spaceState.removeCredentialProcessor(this._automergeSpaceState);
     await this._automergeSpaceState.close();
     await this._inner.spaceState.removeCredentialProcessor(this._notarizationPlugin);
@@ -304,12 +316,14 @@ export class DataSpace {
 
   /**
    * Initialize the data pipeline in a separate task.
+   * @param callerCtx - Trace context from the caller (e.g., activate or createSpace) for span parenting.
    */
-  initializeDataPipelineAsync(): void {
+  initializeDataPipelineAsync(callerCtx?: Context): void {
+    const traceCtx = callerCtx ?? this._ctx;
     scheduleTask(this._ctx, async () => {
       try {
         this.metrics.pipelineInitBegin = new Date();
-        await this.initializeDataPipeline();
+        await this.initializeDataPipeline(traceCtx);
       } catch (err) {
         if (err instanceof CancelledError || err instanceof ContextDisposedError) {
           log('data pipeline initialization cancelled', err);
@@ -327,8 +341,8 @@ export class DataSpace {
     });
   }
 
-  @trace.span({ showInBrowserTimeline: true })
-  async initializeDataPipeline(): Promise<void> {
+  @trace.span({ showInBrowserTimeline: true, op: 'lifecycle' })
+  async initializeDataPipeline(ctx: Context): Promise<void> {
     if (this._state !== SpaceState.SPACE_CONTROL_ONLY) {
       throw new SystemError({ message: 'Invalid operation' });
     }
@@ -337,7 +351,7 @@ export class DataSpace {
     log('new state', { state: SpaceState[this._state] });
 
     log('initializing control pipeline');
-    await this._initializeAndReadControlPipeline();
+    await this._initializeAndReadControlPipeline(ctx);
 
     // Allow other tasks to run before loading the data pipeline.
     await sleep(1);
@@ -360,11 +374,19 @@ export class DataSpace {
     yield [this._databaseRoot.documentId, root];
 
     for (const documentUrl of this._databaseRoot.getAllLinkedDocuments()) {
-      const data = await this._echoHost.exportDoc(Context.default(), documentUrl);
+      const data = await this._echoHost.exportDoc(documentUrl);
       yield [documentUrl.replace(/^automerge:/, ''), data];
     }
   }
 
+  /**
+   * Get all feeds and their blocks for this space.
+   * Used for space archive export.
+   */
+  async getAllFeeds(): Promise<Array<{ feedId: string; feedNamespace: string; blocks: FeedProtocol.Block[] }>> {
+    return this._echoHost.getAllFeedsForSpace(this.id);
+  }
+
   private async _enterReadyState(): Promise<void> {
     await this._callbacks.beforeReady?.();
 
@@ -375,10 +397,10 @@ export class DataSpace {
     await this._callbacks.afterReady?.();
   }
 
-  @trace.span({ showInBrowserTimeline: true })
-  private async _initializeAndReadControlPipeline(): Promise<void> {
+  @trace.span({ showInBrowserTimeline: true, op: 'lifecycle' })
+  private async _initializeAndReadControlPipeline(ctx: Context): Promise<void> {
     await this._inner.controlPipeline.state.waitUntilReachedTargetTimeframe({
-      ctx: this._ctx,
+      ctx,
       timeout: 10_000,
       breakOnStall: false,
     });
@@ -465,7 +487,7 @@ export class DataSpace {
   private _onNewAutomergeRoot(rootUrl: string): void {
     log('loading automerge root doc for space', { space: this.key, rootUrl });
 
-    let handle: DocHandle<DatabaseDirectory>;
+    let handle: DocHandle<DatabaseDirectory> | null = null;
 
     // TODO(dmaretskyi): Make this single-threaded (but doc loading should still be parallel to not block epoch processing).
     queueMicrotask(async () => {
@@ -473,21 +495,24 @@ export class DataSpace {
         await warnAfterTimeout(5_000, 'Automerge root doc load timeout (DataSpace)', async () => {
           handle = await cancelWithContext(
             this._ctx,
-            this._echoHost.loadDoc<DatabaseDirectory>(Context.default(), rootUrl as AutomergeUrl, {
+            this._echoHost.loadDoc<DatabaseDirectory>(this._ctx, rootUrl as AutomergeUrl, {
               fetchFromNetwork: true,
             }),
           );
-          await cancelWithContext(this._ctx, handle.whenReady());
         });
         if (this._ctx.disposed) {
           return;
         }
+        if (!handle) {
+          log.warn('automerge root doc not available yet', { space: this.key, rootUrl });
+          return;
+        }
 
         // Ensure only one root is processed at a time.
         using _guard = await this._epochProcessingMutex.acquire();
 
         // Attaching space keys to legacy documents.
-        const doc = handle.doc() ?? failedInvariant();
+        const doc = handle.doc();
         if (!doc.access?.spaceKey) {
           handle.change((doc: any) => {
             doc.access = { spaceKey: this.key.toHex() };
@@ -496,7 +521,7 @@ export class DataSpace {
 
         // TODO(dmaretskyi): Close roots.
         // TODO(dmaretskyi): How do we handle changing to the next EPOCH?
-        const root = await this._echoHost.openSpaceRoot(this.id, handle.url);
+        const root = await this._echoHost.openSpaceRoot(this._ctx, this.id, handle.url);
 
         // NOTE: Make sure this assignment happens synchronously together with the state change.
         this._databaseRoot = root;
@@ -573,25 +598,24 @@ export class DataSpace {
   }
 
   @synchronized
-  async activate(): Promise<void> {
+  async activate(ctx: Context): Promise<void> {
     if (![SpaceState.SPACE_CLOSED, SpaceState.SPACE_INACTIVE].includes(this._state)) {
       return;
     }
 
     await this._metadataStore.setSpaceState(this.key, SpaceState.SPACE_ACTIVE);
-    await this._open();
-    this.initializeDataPipelineAsync();
+    await this._open(ctx);
+    this.initializeDataPipelineAsync(ctx);
   }
 
   @synchronized
-  async deactivate(): Promise<void> {
+  async deactivate(ctx: Context): Promise<void> {
     if (this._state === SpaceState.SPACE_INACTIVE) {
       return;
     }
-    // Unregister from data service.
     await this._metadataStore.setSpaceState(this.key, SpaceState.SPACE_INACTIVE);
     if (this._state !== SpaceState.SPACE_CLOSED) {
-      await this._close();
+      await this._close(ctx);
     }
     this._state = SpaceState.SPACE_INACTIVE;
     log('new state', { state: SpaceState[this._state] });

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

@@ -107,7 +107,7 @@ describe('EdgeFeedReplicator', () => {
     const { feed } = await attachReplicator(messenger);
     await appendMessage(feed);
 
-    sendSpy.mockImplementationOnce(async (request: any) => {
+    sendSpy.mockImplementationOnce(async (_ctx: any, request: any) => {
       sendResponseMessage(request, encodeCbor({ type: 'metadata', feedKey: feed.key.toHex(), length: 0 }));
       return Promise.resolve();
     });

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

@@ -132,7 +132,7 @@ export class EdgeFeedReplicator extends Resource {
 
   private async _replicateFeed(ctx: Context, feed: FeedWrapper<any>): Promise<void> {
     log('replicateFeed', { key: feed.key });
-    await this._sendMessage({
+    await this._sendMessage(ctx, {
       type: 'get-metadata',
       feedKey: feed.key.toHex(),
     });
@@ -142,7 +142,7 @@ export class EdgeFeedReplicator extends Resource {
     });
   }
 
-  private async _sendMessage(message: ProtocolMessage): Promise<void> {
+  private async _sendMessage(ctx: Context, message: ProtocolMessage): Promise<void> {
     if (!this._connectionCtx) {
       log('message dropped because connection was disposed');
       return;
@@ -160,6 +160,7 @@ export class EdgeFeedReplicator extends Resource {
 
     log('send', { type: message.type });
     await this._messenger.send(
+      ctx,
       buf.create(RouterMessageSchema, {
         source: {
           identityKey: this._messenger.identityKey,
@@ -194,7 +195,7 @@ export class EdgeFeedReplicator extends Resource {
           if (message.length > feed.length) {
             log('requesting missing blocks', logMeta);
 
-            await this._sendMessage({
+            await this._sendMessage(this._connectionCtx!, {
               type: 'request',
               feedKey: feedKey.toHex(),
               range: { from: feed.length, to: message.length },
@@ -202,7 +203,7 @@ export class EdgeFeedReplicator extends Resource {
           } else if (message.length < feed.length) {
             log('pushing blocks to remote', logMeta);
 
-            await this._pushBlocks(feed, message.length, feed.length);
+            await this._pushBlocks(this._connectionCtx!, feed, message.length, feed.length);
           }
 
           break;
@@ -229,7 +230,7 @@ export class EdgeFeedReplicator extends Resource {
     });
   }
 
-  private async _pushBlocks(feed: FeedWrapper<any>, from: number, to: number): Promise<void> {
+  private async _pushBlocks(ctx: Context, feed: FeedWrapper<any>, from: number, to: number): Promise<void> {
     log('pushing blocks', { feed: feed.key.toHex(), from, to });
 
     const blocks: FeedBlock[] = await Promise.all(
@@ -247,7 +248,7 @@ export class EdgeFeedReplicator extends Resource {
       }),
     );
 
-    await this._sendMessage({
+    await this._sendMessage(ctx, {
       type: 'data',
       feedKey: feed.key.toHex(),
       blocks,
@@ -283,12 +284,13 @@ export class EdgeFeedReplicator extends Resource {
 
     const remoteLength = this._remoteLength.get(feed.key)!;
     if (remoteLength < feed.length) {
-      await this._pushBlocks(feed, remoteLength, feed.length);
+      await this._pushBlocks(this._connectionCtx!, feed, remoteLength, feed.length);
     }
   }
 
   private _createConnectionContext(): Context {
     const connectionCtx = new Context({
+      parent: this._ctx,
       onError: async (err: any) => {
         if (connectionCtx !== this._connectionCtx) {
           return;

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

@@ -37,7 +37,7 @@ export const runEpochMigration = async (ctx: Context, context: MigrationContext)
   switch (context.migration) {
     case CreateEpochRequest.Migration.INIT_AUTOMERGE: {
       const document = await context.echoHost.createDoc();
-      await context.echoHost.flush();
+      await context.echoHost.flush(ctx);
       return { newRoot: document.url };
     }
     case CreateEpochRequest.Migration.PRUNE_AUTOMERGE_ROOT_HISTORY: {
@@ -47,9 +47,10 @@ export const runEpochMigration = async (ctx: Context, context: MigrationContext)
       const rootHandle = await context.echoHost.loadDoc(ctx, context.currentRoot as AutomergeUrl, {
         timeout: LOAD_DOC_TIMEOUT,
       });
+      invariant(rootHandle, 'Automerge root document must load for history prune migration.');
 
       const newRoot = await context.echoHost.createDoc(rootHandle.doc());
-      await context.echoHost.flush();
+      await context.echoHost.flush(ctx);
       return { newRoot: newRoot.url };
     }
     case CreateEpochRequest.Migration.FRAGMENT_AUTOMERGE_ROOT: {
@@ -63,7 +64,7 @@ export const runEpochMigration = async (ctx: Context, context: MigrationContext)
       invariant(context.newAutomergeRoot);
 
       // Defensive programming - it should be the responsibility of the caller to flush the new root.
-      await context.echoHost.flush();
+      await context.echoHost.flush(ctx);
       return {
         newRoot: context.newAutomergeRoot,
       };

package/src/packlets/spaces/genesis.ts

@@ -6,7 +6,7 @@ import { createCredential } from '@dxos/credentials';
 import { failUndefined } from '@dxos/debug';
 import { type Space } from '@dxos/echo-pipeline';
 import { type Keyring } from '@dxos/keyring';
-import { AdmittedFeed, SpaceMember } from '@dxos/protocols/proto/dxos/halo/credentials';
+import { AdmittedFeed, MembershipPolicy, SpaceMember } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { Timeframe } from '@dxos/timeframe';
 
 import { type SigningContext } from './data-space-manager';
@@ -16,6 +16,8 @@ export const spaceGenesis = async (
   signingContext: SigningContext,
   space: Space,
   automergeRoot?: string,
+  tags?: string[],
+  membershipPolicy?: MembershipPolicy,
 ) => {
   // TODO(dmaretskyi): Find a way to reconcile with credential generator.
   const credentials = [
@@ -26,6 +28,8 @@ export const spaceGenesis = async (
       assertion: {
         '@type': 'dxos.halo.credentials.SpaceGenesis',
         spaceKey: space.key,
+        tags: tags ?? [],
+        membershipPolicy: membershipPolicy ?? MembershipPolicy.INVITE,
       },
     }),
 
@@ -39,6 +43,7 @@ export const spaceGenesis = async (
         role: SpaceMember.Role.OWNER,
         profile: signingContext.getProfile(),
         genesisFeedKey: space.controlFeedKey ?? failUndefined(),
+        tags: tags ?? [],
       },
     }),
 

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

@@ -246,6 +246,7 @@ export class NotarizationPlugin extends Resource implements CredentialProcessor
     scheduleTask(ctx, async () => {
       try {
         await client.notarizeCredentials(
+          ctx,
           this._spaceId,
           { credentials: encodedCredentials },
           { retry: { count: MAX_EDGE_RETRIES, timeout: timeouts.retryTimeout, jitter: timeouts.jitter } },
@@ -302,7 +303,7 @@ export class NotarizationPlugin extends Resource implements CredentialProcessor
   private _notarizePendingEdgeCredentials(client: EdgeHttpClient, writer: FeedWriter<Credential>): void {
     scheduleMicroTask(this._ctx, async () => {
       try {
-        const response = await client.getCredentialsForNotarization(this._spaceId, {
+        const response = await client.getCredentialsForNotarization(this._ctx, this._spaceId, {
           retry: { count: MAX_EDGE_RETRIES },
         });
 

package/src/packlets/spaces/spaces-service.test.ts

@@ -8,10 +8,10 @@ import { Trigger } from '@dxos/async';
 import { Context } from '@dxos/context';
 import { PublicKey } from '@dxos/keys';
 import { type Space, type SpacesService } from '@dxos/protocols/proto/dxos/client/services';
+import { MembershipPolicy } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 import { type ServiceContext } from '../services';
 import { createServiceContext } from '../testing';
-
 import { SpacesServiceImpl } from './spaces-service';
 
 describe('SpacesService', () => {
@@ -21,10 +21,15 @@ describe('SpacesService', () => {
   beforeEach(async () => {
     serviceContext = await createServiceContext();
     await serviceContext.open(new Context());
-    spacesService = new SpacesServiceImpl(serviceContext.identityManager, serviceContext.spaceManager, async () => {
-      await serviceContext.initialized.wait();
-      return serviceContext.dataSpaceManager!;
-    });
+    spacesService = new SpacesServiceImpl(
+      serviceContext.identityManager,
+      serviceContext.spaceManager,
+      serviceContext.echoHost,
+      async () => {
+        await serviceContext.initialized.wait();
+        return serviceContext.dataSpaceManager!;
+      },
+    );
   });
 
   afterEach(async () => {
@@ -33,12 +38,14 @@ describe('SpacesService', () => {
 
   describe('createSpace', () => {
     test('fails if no identity is available', async () => {
-      await expect(spacesService.createSpace()).rejects.toBeInstanceOf(Error);
+      await expect(spacesService.createSpace({ membershipPolicy: MembershipPolicy.INVITE })).rejects.toBeInstanceOf(
+        Error,
+      );
     });
 
     test('creates a new space', async () => {
       await serviceContext.createIdentity();
-      const space = await spacesService.createSpace();
+      const space = await spacesService.createSpace({ membershipPolicy: MembershipPolicy.INVITE });
       expect(space).to.exist;
       expect(space.spaceKey).to.be.instanceof(PublicKey);
     });
@@ -60,9 +67,9 @@ describe('SpacesService', () => {
     test('returns list of existing spaces', async () => {
       await serviceContext.createIdentity();
       const existingSpaces = [
-        await spacesService.createSpace(),
-        await spacesService.createSpace(),
-        await spacesService.createSpace(),
+        await spacesService.createSpace({ membershipPolicy: MembershipPolicy.INVITE }),
+        await spacesService.createSpace({ membershipPolicy: MembershipPolicy.INVITE }),
+        await spacesService.createSpace({ membershipPolicy: MembershipPolicy.INVITE }),
       ];
 
       const query = spacesService.querySpaces();
@@ -88,7 +95,7 @@ describe('SpacesService', () => {
       expect(await result.wait()).to.be.length(0);
 
       result.reset();
-      const space = await spacesService.createSpace();
+      const space = await spacesService.createSpace({ membershipPolicy: MembershipPolicy.INVITE });
       const spaces = await result.wait();
       expect(spaces).to.be.length(1);
       expect(spaces?.[0].spaceKey.equals(space.spaceKey)).to.be.true;