@dxos/client-services 0.5.9-main.bdf733d → 0.5.9-main.bf3bb8f

package/src/packlets/identity/identity.ts

@@ -16,7 +16,7 @@ import { type Signer } from '@dxos/crypto';
 import { type Space } from '@dxos/echo-pipeline';
 import { writeMessages } from '@dxos/feed-store';
 import { invariant } from '@dxos/invariant';
-import { PublicKey } from '@dxos/keys';
+import { PublicKey, type SpaceId } from '@dxos/keys';
 import { log } from '@dxos/log';
 import { type FeedMessage } from '@dxos/protocols/proto/dxos/echo/feed';
 import {
@@ -26,10 +26,12 @@ import {
 } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { type DeviceAdmissionRequest } from '@dxos/protocols/proto/dxos/halo/invitations';
 import { type Presence } from '@dxos/teleport-extension-gossip';
+import { Timeframe } from '@dxos/timeframe';
 import { trace } from '@dxos/tracing';
 import { type ComplexMap, ComplexSet } from '@dxos/util';
 
 import { TrustedKeySetAuthVerifier } from './authenticator';
+import { DefaultSpaceStateMachine } from './default-space-state-machine';
 
 export type IdentityParams = {
   identityKey: PublicKey;
@@ -49,6 +51,7 @@ export class Identity {
   private readonly _presence?: Presence;
   private readonly _deviceStateMachine: DeviceStateMachine;
   private readonly _profileStateMachine: ProfileStateMachine;
+  private readonly _defaultSpaceStateMachine: DefaultSpaceStateMachine;
   public readonly authVerifier: TrustedKeySetAuthVerifier;
 
   public readonly identityKey: PublicKey;
@@ -75,6 +78,10 @@ export class Identity {
       identityKey: this.identityKey,
       onUpdate: () => this.stateUpdate.emit(),
     });
+    this._defaultSpaceStateMachine = new DefaultSpaceStateMachine({
+      identityKey: this.identityKey,
+      onUpdate: () => this.stateUpdate.emit(),
+    });
 
     this.authVerifier = new TrustedKeySetAuthVerifier({
       trustedKeysProvider: () => new ComplexSet(PublicKey.hash, this.authorizedDeviceKeys.keys()),
@@ -88,17 +95,24 @@ export class Identity {
     return this._deviceStateMachine.authorizedDeviceKeys;
   }
 
+  get defaultSpaceId(): SpaceId | undefined {
+    return this._defaultSpaceStateMachine.spaceId;
+  }
+
   @trace.span()
   async open(ctx: Context) {
+    await this._presence?.open();
     await this.space.spaceState.addCredentialProcessor(this._deviceStateMachine);
     await this.space.spaceState.addCredentialProcessor(this._profileStateMachine);
+    await this.space.spaceState.addCredentialProcessor(this._defaultSpaceStateMachine);
     await this.space.open(ctx);
   }
 
   @trace.span()
   async close(ctx: Context) {
-    await this._presence?.destroy();
+    await this._presence?.close();
     await this.authVerifier.close();
+    await this.space.spaceState.removeCredentialProcessor(this._defaultSpaceStateMachine);
     await this.space.spaceState.removeCredentialProcessor(this._profileStateMachine);
     await this.space.spaceState.removeCredentialProcessor(this._deviceStateMachine);
     await this.space.close();
@@ -157,6 +171,15 @@ export class Identity {
     return createCredentialSignerWithKey(this._signer, this.deviceKey);
   }
 
+  async updateDefaultSpace(spaceId: SpaceId) {
+    const credential = await this.getDeviceCredentialSigner().createCredential({
+      subject: this.identityKey,
+      assertion: { '@type': 'dxos.halo.credentials.DefaultSpace', spaceId },
+    });
+    const receipt = await this.controlPipeline.writer.write({ credential: { credential } });
+    await this.controlPipeline.state.waitUntilTimeframe(new Timeframe([[receipt.feedKey, receipt.seq]]));
+  }
+
   async admitDevice({ deviceKey, controlFeedKey, dataFeedKey }: DeviceAdmissionRequest) {
     log('Admitting device:', {
       identityKey: this.identityKey,

package/src/packlets/invitations/invitations-handler.ts

@@ -435,11 +435,19 @@ export class InvitationsHandler {
   }
 
   private _logStateUpdate(invitation: Invitation, actor: any, newState: Invitation.State) {
-    log('invitation state update', {
-      actor: actor?.constructor.name,
-      newState: stateToString(newState),
-      oldState: stateToString(invitation.state),
-    });
+    if (this._isNotTerminal(newState)) {
+      log('invitation state update', {
+        actor: actor?.constructor.name,
+        newState: stateToString(newState),
+        oldState: stateToString(invitation.state),
+      });
+    } else {
+      log.info('invitation state update', {
+        actor: actor?.constructor.name,
+        newState: stateToString(newState),
+        oldState: stateToString(invitation.state),
+      });
+    }
   }
 
   private _isNotTerminal(currentState: Invitation.State): boolean {

package/src/packlets/invitations/space-invitation-protocol.ts

@@ -3,7 +3,6 @@
 //
 
 import {
-  createAdmissionCredentials,
   createCancelDelegatedSpaceInvitationCredential,
   createDelegatedSpaceInvitationCredential,
   getCredentialAssertion,
@@ -21,7 +20,6 @@ import {
   SpaceNotFoundError,
 } from '@dxos/protocols';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
-import { type FeedMessage } from '@dxos/protocols/proto/dxos/echo/feed';
 import { SpaceMember, type ProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
 import {
   type AdmissionRequest,
@@ -73,41 +71,22 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
     request: AdmissionRequest,
     guestProfile?: ProfileDocument | undefined,
   ): Promise<AdmissionResponse> {
-    invariant(this._spaceKey);
-    const space = this._spaceManager.spaces.get(this._spaceKey);
-    invariant(space);
-
-    invariant(request.space);
-    const { identityKey, deviceKey } = request.space;
+    invariant(this._spaceKey && request.space);
+    log('writing guest credentials', { host: this._signingContext.deviceKey, guest: request.space.deviceKey });
 
-    if (space.inner.spaceState.getMemberRole(identityKey) !== SpaceMember.Role.REMOVED) {
-      throw new AlreadyJoinedError();
-    }
-
-    log('writing guest credentials', { host: this._signingContext.deviceKey, guest: deviceKey });
-    // TODO(burdon): Check if already admitted.
-    const credentials: FeedMessage.Payload[] = await createAdmissionCredentials(
-      this._signingContext.credentialSigner,
-      identityKey,
-      space.key,
-      space.inner.genesisFeedKey,
-      invitation.role ?? SpaceMember.Role.ADMIN,
-      space.inner.spaceState.membershipChainHeads,
-      guestProfile,
-      invitation.delegationCredentialId,
-    );
-
-    // TODO(dmaretskyi): Refactor.
-    invariant(credentials[0].credential);
-    const spaceMemberCredential = credentials[0].credential.credential;
-    invariant(getCredentialAssertion(spaceMemberCredential)['@type'] === 'dxos.halo.credentials.SpaceMember');
-
-    await writeMessages(space.inner.controlPipeline.writer, credentials);
+    const spaceMemberCredential = await this._spaceManager.admitMember({
+      spaceKey: this._spaceKey,
+      identityKey: request.space.identityKey,
+      role: invitation.role ?? SpaceMember.Role.ADMIN,
+      profile: guestProfile,
+      delegationCredentialId: invitation.delegationCredentialId,
+    });
 
+    const space = this._spaceManager.spaces.get(this._spaceKey);
     return {
       space: {
         credential: spaceMemberCredential,
-        controlTimeframe: space.inner.controlPipeline.state.timeframe,
+        controlTimeframe: space?.inner.controlPipeline.state.timeframe,
       },
     };
   }

package/src/packlets/services/service-context.ts

@@ -120,10 +120,7 @@ export class ServiceContext extends Resource {
       this._runtimeParams as IdentityManagerRuntimeParams,
     );
 
-    this.echoHost = new EchoHost({
-      kv: this.level,
-      storage: this.storage,
-    });
+    this.echoHost = new EchoHost({ kv: this.level });
 
     this.invitations = new InvitationsHandler(this.networkManager, _runtimeParams?.invitationConnectionDefaultParams);
     this.invitationsManager = new InvitationsManager(

package/src/packlets/services/service-host.ts

@@ -3,11 +3,9 @@
 //
 
 import { Event, synchronized } from '@dxos/async';
-import { clientServiceBundle, defaultKey, type ClientServices, PropertiesType } from '@dxos/client-protocol';
+import { clientServiceBundle, type ClientServices } from '@dxos/client-protocol';
 import { type Config } from '@dxos/config';
 import { Context } from '@dxos/context';
-import { type ObjectStructure, encodeReference, type SpaceDoc } from '@dxos/echo-protocol';
-import { getTypeReference } from '@dxos/echo-schema';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { type LevelDB } from '@dxos/kv-store';
@@ -18,7 +16,6 @@ import { trace } from '@dxos/protocols';
 import { SystemStatus } from '@dxos/protocols/proto/dxos/client/services';
 import { type Storage } from '@dxos/random-access-storage';
 import { TRACE_PROCESSOR, trace as Trace } from '@dxos/tracing';
-import { assignDeep } from '@dxos/util';
 import { WebsocketRpcClient } from '@dxos/websocket-rpc';
 
 import { ServiceContext, type ServiceContextRuntimeParams } from './service-context';
@@ -31,6 +28,7 @@ import {
   createDiagnostics,
 } from '../diagnostics';
 import { IdentityServiceImpl, type CreateIdentityOptions } from '../identity';
+import { ContactsServiceImpl } from '../identity/contacts-service';
 import { InvitationsServiceImpl } from '../invitations';
 import { Lock, type ResourceLock } from '../locks';
 import { LoggingServiceImpl } from '../logging';
@@ -86,7 +84,7 @@ export class ClientServicesHost {
   private _devtoolsProxy?: WebsocketRpcClient<{}, ClientServices>;
 
   private _serviceContext!: ServiceContext;
-  private readonly _runtimeParams?: ServiceContextRuntimeParams;
+  private readonly _runtimeParams: ServiceContextRuntimeParams;
   private diagnosticsBroadcastHandler: CollectDiagnosticsBroadcastHandler;
 
   @Trace.info()
@@ -109,7 +107,7 @@ export class ClientServicesHost {
     this._storage = storage;
     this._level = level;
     this._callbacks = callbacks;
-    this._runtimeParams = runtimeParams;
+    this._runtimeParams = runtimeParams ?? {};
 
     if (config) {
       this.initialize({ config, transportFactory, signalManager });
@@ -254,14 +252,26 @@ export class ClientServicesHost {
       this._runtimeParams,
     );
 
+    const dataSpaceManagerProvider = async () => {
+      await this._serviceContext.initialized.wait();
+      return this._serviceContext.dataSpaceManager!;
+    };
+
+    const identityService = new IdentityServiceImpl(
+      this._serviceContext.identityManager,
+      this._serviceContext.keyring,
+      () => this._serviceContext.dataSpaceManager!,
+      (params) => this._createIdentity(params),
+      (profile) => this._serviceContext.broadcastProfileUpdate(profile),
+    );
+
     this._serviceRegistry.setServices({
       SystemService: this._systemService,
-
-      IdentityService: new IdentityServiceImpl(
-        (params) => this._createIdentity(params),
+      IdentityService: identityService,
+      ContactsService: new ContactsServiceImpl(
         this._serviceContext.identityManager,
-        this._serviceContext.keyring,
-        (profile) => this._serviceContext.broadcastProfileUpdate(profile),
+        this._serviceContext.spaceManager,
+        dataSpaceManagerProvider,
       ),
 
       InvitationsService: new InvitationsServiceImpl(this._serviceContext.invitationsManager),
@@ -271,10 +281,7 @@ export class ClientServicesHost {
       SpacesService: new SpacesServiceImpl(
         this._serviceContext.identityManager,
         this._serviceContext.spaceManager,
-        async () => {
-          await this._serviceContext.initialized.wait();
-          return this._serviceContext.dataSpaceManager!;
-        },
+        dataSpaceManagerProvider,
       ),
 
       DataService: this._serviceContext.echoHost.dataService,
@@ -294,6 +301,7 @@ export class ClientServicesHost {
     });
 
     await this._serviceContext.open(ctx);
+    await identityService.open();
 
     const devtoolsProxy = this._config?.get('runtime.client.devtoolsProxy');
     if (devtoolsProxy) {
@@ -349,34 +357,7 @@ export class ClientServicesHost {
 
   private async _createIdentity(params: CreateIdentityOptions) {
     const identity = await this._serviceContext.createIdentity(params);
-
-    // Setup default space.
     await this._serviceContext.initialized.wait();
-    const space = await this._serviceContext.dataSpaceManager!.createSpace();
-
-    const automergeIndex = space.automergeSpaceState.rootUrl;
-    invariant(automergeIndex);
-    const document = this._serviceContext.echoHost.automergeRepo.find<SpaceDoc>(automergeIndex as any);
-    await document.whenReady();
-
-    // TODO(dmaretskyi): Better API for low-level data access.
-    const properties: ObjectStructure = {
-      system: {
-        type: encodeReference(getTypeReference(PropertiesType)!),
-      },
-      data: {
-        [defaultKey]: identity.identityKey.toHex(),
-      },
-      meta: {
-        keys: [],
-      },
-    };
-    const propertiesId = PublicKey.random().toHex();
-    document.change((doc: SpaceDoc) => {
-      assignDeep(doc, ['objects', propertiesId], properties);
-    });
-
-    await this._serviceContext.echoHost.flush();
     return identity;
   }
 }

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

@@ -3,10 +3,11 @@
 //
 
 import { Event } from '@dxos/async';
+import { Resource, type Context } from '@dxos/context';
 import { type CredentialProcessor, type SpecificCredential, checkCredentialType } from '@dxos/credentials';
 import { type Credential, type Epoch } from '@dxos/protocols/proto/dxos/halo/credentials';
 
-export class AutomergeSpaceState implements CredentialProcessor {
+export class AutomergeSpaceState extends Resource implements CredentialProcessor {
   public rootUrl: string | undefined = undefined;
   public lastEpoch: SpecificCredential<Epoch> | undefined = undefined;
 
@@ -14,7 +15,15 @@ export class AutomergeSpaceState implements CredentialProcessor {
 
   private _isProcessingRootDocs = false;
 
-  constructor(private readonly _onNewRoot: (rootUrl: string) => void) {}
+  constructor(private readonly _onNewRoot: (rootUrl: string) => void) {
+    super();
+  }
+
+  protected override async _open(ctx: Context): Promise<void> {}
+
+  protected override async _close(ctx: Context): Promise<void> {
+    this._isProcessingRootDocs = false;
+  }
 
   async processCredential(credential: Credential) {
     if (!checkCredentialType(credential, 'dxos.halo.credentials.Epoch')) {

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

@@ -12,7 +12,7 @@ import { log } from '@dxos/log';
 import { SpaceState } from '@dxos/protocols/proto/dxos/client/services';
 import { describe, openAndClose, test } from '@dxos/test';
 
-import { TestBuilder } from '../testing';
+import { TestBuilder, type TestPeer } from '../testing';
 
 describe('DataSpaceManager', () => {
   test('create space', async () => {
@@ -168,5 +168,50 @@ describe('DataSpaceManager', () => {
         500,
       );
     });
+
+    test('activate opens a lazily loaded space', async () => {
+      const builder = new TestBuilder();
+
+      const peer = builder.createPeer();
+      await peer.createIdentity();
+      await openAndClose(peer.echoHost, peer.dataSpaceManager);
+
+      await peer.dataSpaceManager.createSpace();
+      await reloadDataSpaces(peer);
+
+      const space = getFirstSpace(peer);
+      expect(space.state).to.equal(SpaceState.CLOSED);
+      await space.activate();
+      await asyncTimeout(
+        space.stateUpdate.waitForCondition(() => space.state === SpaceState.READY),
+        500,
+      );
+    });
+
+    test('deactivate lazily loaded space ', async () => {
+      const builder = new TestBuilder();
+
+      const peer = builder.createPeer();
+      await peer.createIdentity();
+      await openAndClose(peer.echoHost, peer.dataSpaceManager);
+
+      await peer.dataSpaceManager.createSpace();
+      await reloadDataSpaces(peer);
+
+      await getFirstSpace(peer).deactivate();
+
+      await reloadDataSpaces(peer);
+
+      expect(getFirstSpace(peer).state).to.eq(SpaceState.INACTIVE);
+    });
   });
+
+  const reloadDataSpaces = async (peer: TestPeer) => {
+    await peer.dataSpaceManager.close();
+    await peer.dataSpaceManager.open();
+  };
+
+  const getFirstSpace = (peer: TestPeer) => {
+    return Array.from(peer.dataSpaceManager.spaces.values())[0];
+  };
 });