@dxos/client-services 0.3.11-main.dafb7f2 → 0.3.11-main.df1e30a

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

@@ -2,24 +2,62 @@
 // Copyright 2023 DXOS.org
 //
 
-import { type Invitation } from '@dxos/protocols/proto/dxos/client/services';
-import { type ProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
-import {
-  type AdmissionRequest,
-  type AdmissionResponse,
-  type IntroductionRequest,
+import type { ApiError } from '@dxos/protocols';
+import type { Invitation } from '@dxos/protocols/proto/dxos/client/services';
+import type { ProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
+import type {
+  AdmissionRequest,
+  AdmissionResponse,
+  IntroductionRequest,
 } from '@dxos/protocols/proto/dxos/halo/invitations';
 
 export interface InvitationProtocol {
+  //
   // Debugging
+  //
+
+  /**
+   * Protocol-specific debug info to include in logs.
+   */
   toJSON(): object;
 
+  //
   // Host
+  //
+
+  /**
+   * Protocol-specific information to include in the invitation.
+   */
   getInvitationContext(): Partial<Invitation> & Pick<Invitation, 'kind'>;
+
+  /**
+   * Once authentication is successful, the host can admit the guest to the requested resource.
+   */
   admit(request: AdmissionRequest, guestProfile?: ProfileDocument): Promise<AdmissionResponse>;
 
+  //
   // Guest
+  //
+
+  /**
+   * Check if the invitation is valid.
+   *
+   * For example, the guest may already be a member of the space.
+   */
+  checkInvitation(invitation: Partial<Invitation>): ApiError | undefined;
+
+  /**
+   * Get profile information to send to the host to identify the guest.
+   */
   createIntroduction(): IntroductionRequest;
+
+  /**
+   * Get key information to send to the host in order to create an admission credential for the guest.
+   */
   createAdmissionRequest(): Promise<AdmissionRequest>;
+
+  /**
+   * Redeem the admission credential.
+   */
   accept(response: AdmissionResponse, request: AdmissionRequest): Promise<Partial<Invitation>>;
 }

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

@@ -303,9 +303,6 @@ export class InvitationsHandler {
                     }
                   }
                 }
-              } else {
-                // Notify that introduction is complete even if auth is not required.
-                setState({ state: Invitation.State.READY_FOR_AUTHENTICATION });
               }
 
               // 3. Send admission credentials to host (with local space keys).
@@ -321,7 +318,7 @@ export class InvitationsHandler {
 
               // 5. Success.
               log('admitted by host', { ...protocol.toJSON() });
-              setState({ ...result, state: Invitation.State.SUCCESS });
+              setState({ ...result, target: invitation.target, state: Invitation.State.SUCCESS });
               log.trace('dxos.sdk.invitations-handler.guest.onOpen', trace.end({ id: traceId }));
             } catch (err: any) {
               if (err instanceof TimeoutError) {
@@ -355,20 +352,25 @@ export class InvitationsHandler {
     };
 
     scheduleTask(ctx, async () => {
-      invariant(invitation.swarmKey);
-      const topic = invitation.swarmKey;
-      const swarmConnection = await this._networkManager.joinSwarm({
-        topic,
-        peerId: PublicKey.random(),
-        protocolProvider: createTeleportProtocolFactory(async (teleport) => {
-          teleport.addExtension('dxos.halo.invitations', createExtension());
-        }),
-        topology: new StarTopology(topic),
-        label: 'invitation guest',
-      });
-      ctx.onDispose(() => swarmConnection.close());
-
-      setState({ state: Invitation.State.CONNECTING });
+      const error = protocol.checkInvitation(invitation);
+      if (error) {
+        stream.error(error);
+      } else {
+        invariant(invitation.swarmKey);
+        const topic = invitation.swarmKey;
+        const swarmConnection = await this._networkManager.joinSwarm({
+          topic,
+          peerId: PublicKey.random(),
+          protocolProvider: createTeleportProtocolFactory(async (teleport) => {
+            teleport.addExtension('dxos.halo.invitations', createExtension());
+          }),
+          topology: new StarTopology(topic),
+          label: 'invitation guest',
+        });
+        ctx.onDispose(() => swarmConnection.close());
+
+        setState({ state: Invitation.State.CONNECTING });
+      }
     });
 
     const observable = new AuthenticatingInvitation({

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

@@ -7,6 +7,7 @@ import { expect } from 'chai';
 import { asyncChain, Trigger } from '@dxos/async';
 import { raise } from '@dxos/debug';
 import { testLocalDatabase } from '@dxos/echo-pipeline/testing';
+import { AlreadyJoinedError } from '@dxos/protocols';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import { afterTest, describe, test } from '@dxos/test';
 
@@ -71,6 +72,33 @@ describe('services/space-invitations-protocol', () => {
     }
   });
 
+  test('invitation when already joined', async () => {
+    const [host, guest] = await asyncChain<ServiceContext>([createIdentity, closeAfterTest])(createPeers(2));
+
+    const space1 = await host.dataSpaceManager!.createSpace();
+    const spaceKey = space1.key;
+
+    await Promise.all(performInvitation({ host, guest, options: { kind: Invitation.Kind.SPACE, spaceKey } }));
+
+    {
+      const space1 = host.dataSpaceManager!.spaces.get(spaceKey)!;
+      const space2 = guest.dataSpaceManager!.spaces.get(spaceKey)!;
+      expect(space1).not.to.be.undefined;
+      expect(space2).not.to.be.undefined;
+
+      await host.dataSpaceManager?.waitUntilSpaceReady(space1.key);
+      await guest.dataSpaceManager?.waitUntilSpaceReady(space2.key);
+    }
+
+    const [_, guestResult] = performInvitation({
+      host,
+      guest,
+      options: { kind: Invitation.Kind.SPACE, spaceKey },
+    });
+
+    expect((await guestResult).error).to.be.instanceOf(AlreadyJoinedError);
+  });
+
   test('creates and accepts invitation with retry', async () => {
     const [host, guest] = await asyncChain<ServiceContext>([createIdentity, closeAfterTest])(createPeers(2));
 

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

@@ -8,6 +8,7 @@ import { invariant } from '@dxos/invariant';
 import { type Keyring } from '@dxos/keyring';
 import { type PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
+import { AlreadyJoinedError } from '@dxos/protocols';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import { type FeedMessage } from '@dxos/protocols/proto/dxos/echo/feed';
 import { type ProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
@@ -76,6 +77,12 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
     };
   }
 
+  checkInvitation(invitation: Partial<Invitation>) {
+    if (invitation.spaceKey && this._spaceManager.spaces.has(invitation.spaceKey)) {
+      return new AlreadyJoinedError('Already joined space.');
+    }
+  }
+
   createIntroduction(): IntroductionRequest {
     return {
       profile: this._signingContext.getProfile(),
@@ -104,6 +111,10 @@ export class SpaceInvitationProtocol implements InvitationProtocol {
     invariant(assertion['@type'] === 'dxos.halo.credentials.SpaceMember', 'Invalid credential');
     invariant(credential.subject.id.equals(this._signingContext.identityKey));
 
+    if (this._spaceManager.spaces.has(assertion.spaceKey)) {
+      throw new AlreadyJoinedError('Already joined space.');
+    }
+
     // Create local space.
     await this._spaceManager.acceptSpace({
       spaceKey: assertion.spaceKey,

package/src/packlets/services/diagnostics.ts

@@ -48,6 +48,7 @@ export type Diagnostics = {
   swarms?: SwarmInfo[];
   feeds?: Partial<SubscribeToFeedsResponse.Feed>[];
   metrics?: Metrics;
+  storage?: { file: string; count: number }[];
 };
 
 // TODO(burdon): Normalize for ECHO/HALO.
@@ -95,6 +96,23 @@ export const createDiagnostics = async (
     }).catch(() => undefined);
   }
 
+  if (typeof navigator !== 'undefined' && navigator.storage) {
+    const map = new Map();
+    const dir = await navigator.storage.getDirectory();
+    for await (const filename of (dir as any)?.keys()) {
+      const idx = filename.indexOf('-', filename.indexOf('-') + 1);
+      if (idx === -1) {
+        continue;
+      }
+
+      map.set(filename.slice(0, idx), (map.get(filename.slice(0, idx)) ?? 0) + 1);
+    }
+
+    diagnostics.storage = Array.from(map.entries())
+      .sort((a, b) => b[1] - a[1])
+      .map(([file, count]) => ({ file, count }));
+  }
+
   const identity = serviceContext.identityManager.identity;
   if (identity) {
     // Identity.

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

@@ -8,7 +8,7 @@ import { type Config } from '@dxos/config';
 import { Context } from '@dxos/context';
 import { DocumentModel } from '@dxos/document-model';
 import { DataServiceImpl } from '@dxos/echo-pipeline';
-import { type TypedObject, base } from '@dxos/echo-schema';
+import { type TypedObject, base, getRawDoc } from '@dxos/echo-schema';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
@@ -28,7 +28,7 @@ import { ServiceContext } from './service-context';
 import { ServiceRegistry } from './service-registry';
 import { DevicesServiceImpl } from '../devices';
 import { DevtoolsServiceImpl, DevtoolsHostEvents } from '../devtools';
-import { type CreateIdentityOptions, IdentityServiceImpl } from '../identity';
+import { IdentityServiceImpl, type CreateIdentityOptions } from '../identity';
 import { InvitationsServiceImpl } from '../invitations';
 import { Lock, type ResourceLock } from '../locks';
 import { LoggingServiceImpl } from '../logging';
@@ -260,7 +260,7 @@ export class ClientServicesHost {
       SystemService: this._systemService,
 
       IdentityService: new IdentityServiceImpl(
-        (params) => this._createIdentity(params),
+        (params, useAutomerge) => this._createIdentity(params, useAutomerge),
         this._serviceContext.identityManager,
         this._serviceContext.keyring,
         (profile) => this._serviceContext.broadcastProfileUpdate(profile),
@@ -351,21 +351,36 @@ export class ClientServicesHost {
     await this._callbacks?.onReset?.();
   }
 
-  private async _createIdentity(params?: CreateIdentityOptions) {
+  private async _createIdentity(params: CreateIdentityOptions, useAutomerge: boolean) {
     const identity = await this._serviceContext.createIdentity(params);
 
     // Setup default space.
     await this._serviceContext.initialized.wait();
     const space = await this._serviceContext.dataSpaceManager!.createSpace();
-    const obj: TypedObject = new Properties(undefined, { automerge: false });
+
+    const obj: TypedObject = new Properties(undefined, { automerge: useAutomerge });
     obj[defaultKey] = identity.identityKey.toHex();
-    await this._serviceRegistry.services.DataService!.write({
-      spaceKey: space.key,
-      batch: {
-        objects: [createGenesisMutationFromTypedObject(obj)],
-      },
-    });
-    await this._serviceRegistry.services.DataService!.flush({ spaceKey: space.key });
+
+    if (!useAutomerge) {
+      await this._serviceRegistry.services.DataService!.write({
+        spaceKey: space.key,
+        batch: {
+          objects: [createGenesisMutationFromTypedObject(obj)],
+        },
+      });
+      await this._serviceRegistry.services.DataService!.flush({ spaceKey: space.key });
+    } else {
+      // TODO(dmaretskyi): Refactor this.
+      const automergeIndex = space.automergeSpaceState.rootUrl;
+      invariant(automergeIndex);
+      const document = await this._serviceContext.automergeHost.repo.find(automergeIndex as any);
+      await document.whenReady();
+
+      document.change((doc: any) => {
+        doc.objects ??= {};
+        doc.objects[obj[base]._id] = getRawDoc(obj).handle.docSync();
+      });
+    }
 
     return identity;
   }

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

@@ -9,6 +9,8 @@ export class AutomergeSpaceState implements CredentialProcessor {
   public rootUrl: string | undefined = undefined;
   public lastEpoch: SpecificCredential<Epoch> | undefined = undefined;
 
+  constructor(private readonly _onNewRoot: (rootUrl: string) => void) {}
+
   async processCredential(credential: Credential) {
     if (!checkCredentialType(credential, 'dxos.halo.credentials.Epoch')) {
       return;
@@ -17,6 +19,8 @@ export class AutomergeSpaceState implements CredentialProcessor {
     this.lastEpoch = credential;
     if (credential.subject.assertion.automergeRoot) {
       this.rootUrl = credential.subject.assertion.automergeRoot;
+
+      this._onNewRoot(this.rootUrl);
     }
   }
 }

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

@@ -143,6 +143,9 @@ export class DataSpaceManager {
     const space = await this._constructSpace(metadata);
 
     const automergeRoot = this._automergeHost.repo.create();
+    automergeRoot.change((doc: any) => {
+      doc.experimental_spaceKey = spaceKey.toHex();
+    });
 
     const credentials = await spaceGenesis(this._keyring, this._signingContext, space.inner, automergeRoot.url);
     await this._metadataStore.addSpace(metadata);
@@ -222,12 +225,13 @@ export class DataSpaceManager {
         credentialProvider: createAuthProvider(this._signingContext.credentialSigner),
         credentialAuthenticator: deferFunction(() => dataSpace.authVerifier.verifier),
       },
-      onNetworkConnection: (session) => {
+      onAuthorizedConnection: (session) => {
         session.addExtension(
           'dxos.mesh.teleport.gossip',
           gossip.createExtension({ remotePeerId: session.remotePeerId }),
         );
         session.addExtension('dxos.mesh.teleport.notarization', dataSpace.notarizationPlugin.createExtension());
+        this._automergeHost.authorizeDevice(space.key, session.remotePeerId);
         session.addExtension('dxos.mesh.teleport.automerge', this._automergeHost.createExtension());
       },
       onAuthFailure: () => {

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

@@ -15,6 +15,7 @@ import {
   type AutomergeHost,
 } from '@dxos/echo-pipeline';
 import { type FeedStore } from '@dxos/feed-store';
+import { failedInvariant } from '@dxos/invariant';
 import { type Keyring } from '@dxos/keyring';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
@@ -92,7 +93,7 @@ export class DataSpace {
   private readonly _automergeHost: AutomergeHost;
 
   // TODO(dmaretskyi): Move into Space?
-  private readonly _automergeSpaceState = new AutomergeSpaceState();
+  private readonly _automergeSpaceState = new AutomergeSpaceState((rootUrl) => this._onNewAutomergeRoot(rootUrl));
 
   private _state = SpaceState.CLOSED;
 
@@ -363,6 +364,25 @@ export class DataSpace {
     }
   }
 
+  private _onNewAutomergeRoot(rootUrl: string) {
+    log.info('loading automerge root doc for space', { space: this.key, rootUrl });
+    const handle = this._automergeHost.repo.find(rootUrl as any);
+
+    queueMicrotask(async () => {
+      try {
+        await handle.whenReady();
+        const doc = handle.docSync() ?? failedInvariant();
+        if (!doc.experimental_spaceKey) {
+          handle.change((doc: any) => {
+            doc.experimental_spaceKey = this.key.toHex();
+          });
+        }
+      } catch (err) {
+        log.warn('error loading automerge root doc', { space: this.key, rootUrl, err });
+      }
+    });
+  }
+
   // TODO(dmaretskyi): Use profile from signing context.
   async updateOwnProfile(profile: ProfileDocument) {
     const credential = await this._signingContext.credentialSigner.createCredential({

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

@@ -41,7 +41,7 @@ export class SpacesServiceImpl implements SpacesService {
 
   async createSpace(): Promise<Space> {
     if (!this._identityManager.identity) {
-      throw new Error('This device has no HALO identity available. See https://docs.dxos.org/guide/halo');
+      throw new Error('This device has no HALO identity available. See https://docs.dxos.org/guide/platform/halo');
     }
 
     const dataSpaceManager = await this._getDataSpaceManager();

package/src/packlets/testing/invitation-utils.ts

@@ -3,7 +3,7 @@
 //
 
 import { Trigger } from '@dxos/async';
-import { type AuthenticatingInvitation, type CancellableInvitation } from '@dxos/client-protocol';
+import { InvitationEncoder, type AuthenticatingInvitation, type CancellableInvitation } from '@dxos/client-protocol';
 import { invariant } from '@dxos/invariant';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 
@@ -13,15 +13,7 @@ import { ServiceContext } from '../services';
  * Strip secrets from invitation before giving it to the peer.
  */
 export const sanitizeInvitation = (invitation: Invitation): Invitation => {
-  return {
-    invitationId: invitation.invitationId,
-    type: invitation.type,
-    kind: invitation.kind,
-    authMethod: invitation.authMethod,
-    swarmKey: invitation.swarmKey,
-    state: invitation.state,
-    timeout: invitation.timeout,
-  };
+  return InvitationEncoder.decode(InvitationEncoder.encode(invitation));
 };
 
 export type InvitationHost = {

package/src/version.ts

@@ -1 +1 @@
-export const DXOS_VERSION = "0.3.11-main.dafb7f2";
+export const DXOS_VERSION = "0.3.11-main.df1e30a";