@dxos/client-services 0.3.11-main.baa8c4d → 0.3.11-main.bc6b68b

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

@@ -6,6 +6,7 @@ import { expect } from 'chai';
 
 import { asyncChain } from '@dxos/async';
 import { Context } from '@dxos/context';
+import { AlreadyJoinedError } from '@dxos/protocols';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import { describe, test, afterTest } from '@dxos/test';
 
@@ -36,4 +37,17 @@ describe('services/device', () => {
     await Promise.all(performInvitation({ host, guest, options: { kind: Invitation.Kind.DEVICE } }));
     expect(guest.identityManager.identity?.identityKey).to.deep.eq(identity1.identityKey);
   });
+
+  test('invitation when already joined', async () => {
+    const [host, guest] = await asyncChain<ServiceContext>([closeAfterTest])(createPeers(2));
+
+    const identity1 = await host.createIdentity();
+    expect(host.identityManager.identity).to.eq(identity1);
+
+    await Promise.all(performInvitation({ host, guest, options: { kind: Invitation.Kind.DEVICE } }));
+    expect(guest.identityManager.identity?.identityKey).to.deep.eq(identity1.identityKey);
+
+    const [_, result] = performInvitation({ host, guest, options: { kind: Invitation.Kind.DEVICE } });
+    expect((await result).error).to.be.instanceOf(AlreadyJoinedError);
+  });
 });

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

@@ -4,6 +4,7 @@
 
 import { invariant } from '@dxos/invariant';
 import { type Keyring } from '@dxos/keyring';
+import { AlreadyJoinedError } from '@dxos/protocols';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import {
   type AdmissionRequest,
@@ -46,6 +47,17 @@ export class DeviceInvitationProtocol implements InvitationProtocol {
     };
   }
 
+  checkInvitation(invitation: Partial<Invitation>) {
+    try {
+      const identity = this._getIdentity();
+      if (identity) {
+        return new AlreadyJoinedError('Currently only one identity per client is supported.');
+      }
+    } catch {
+      // No identity.
+    }
+  }
+
   createIntroduction(): IntroductionRequest {
     return {};
   }
@@ -71,6 +83,8 @@ export class DeviceInvitationProtocol implements InvitationProtocol {
     invariant(request.device);
     const { deviceKey, controlFeedKey, dataFeedKey } = request.device;
 
+    // TODO(wittjosiah): When multiple identities are supported, verify identity doesn't already exist before accepting.
+
     await this._acceptIdentity({
       identityKey,
       deviceKey,

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/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/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/packlets/vault/iframe-host-runtime.ts

@@ -30,6 +30,8 @@ export type IFrameHostRuntimeParams = {
  *
  * Holds a lock over the client services such that only one instance can run at a time.
  * This should only be used when SharedWorker is not available.
+ *
+ * @deprecated
  */
 export class IFrameHostRuntime {
   private readonly _configProvider: IFrameHostRuntimeParams['config'];

package/src/packlets/vault/index.ts

@@ -3,7 +3,7 @@
 //
 
 export * from './iframe-host-runtime';
-export * from './iframe-proxy-runtime';
+export * from './shared-worker-connection';
 export * from './shell-runtime';
 export * from './worker-runtime';
 export * from './worker-session';

package/src/packlets/vault/{iframe-proxy-runtime.ts → shared-worker-connection.ts}

@@ -20,18 +20,21 @@ import { getAsyncValue, type MaybePromise, type Provider } from '@dxos/util';
 import { ShellRuntimeImpl } from './shell-runtime';
 
 // NOTE: Keep as RpcPorts to avoid dependency on @dxos/rpc-tunnel so we don't depend on browser-specific apis.
-export type IFrameProxyRuntimeParams = {
+export type SharedWorkerConnectionOptions = {
   config: Config | Provider<MaybePromise<Config>>;
   systemPort: RpcPort;
+  /**
+   * @deprecated Only used with iframes.
+   */
   shellPort?: RpcPort;
 };
 
 /**
  * Manages the client connection to the shared worker.
  */
-export class IFrameProxyRuntime {
+export class SharedWorkerConnection {
   private readonly _id = String(Math.floor(Math.random() * 1000000));
-  private readonly _configProvider: IFrameProxyRuntimeParams['config'];
+  private readonly _configProvider: SharedWorkerConnectionOptions['config'];
   private readonly _systemPort: RpcPort;
   private readonly _shellPort?: RpcPort;
   private _release = new Trigger();
@@ -40,7 +43,7 @@ export class IFrameProxyRuntime {
   private _systemRpc!: ProtoRpcPeer<WorkerServiceBundle>;
   private _shellRuntime?: ShellRuntimeImpl;
 
-  constructor({ config, systemPort, shellPort }: IFrameProxyRuntimeParams) {
+  constructor({ config, systemPort, shellPort }: SharedWorkerConnectionOptions) {
     this._configProvider = config;
     this._systemPort = systemPort;
     this._shellPort = shellPort;
@@ -54,7 +57,12 @@ export class IFrameProxyRuntime {
     return this._shellRuntime;
   }
 
-  async open(origin: string) {
+  async open(
+    /**
+     * @deprecated Only used with iframes.
+     */
+    origin: string,
+  ) {
     this._config = await getAsyncValue(this._configProvider);
 
     this._transportService = new SimplePeerTransportService({
@@ -96,7 +104,11 @@ export class IFrameProxyRuntime {
   async close() {
     this._release.wake();
     await this._shellRuntime?.close();
-    await this._systemRpc.rpc.WorkerService.stop();
+    try {
+      await this._systemRpc.rpc.WorkerService.stop();
+    } catch {
+      // If this fails, the worker is probably already gone.
+    }
     await this._systemRpc.close();
   }
 

package/src/packlets/vault/worker-runtime.ts

@@ -18,7 +18,13 @@ import { ClientServicesHost } from '../services';
 export type CreateSessionParams = {
   appPort: RpcPort;
   systemPort: RpcPort;
-  shellPort: RpcPort;
+  shellPort?: RpcPort;
+};
+
+export type WorkerRuntimeCallbacks = {
+  acquireLock: () => Promise<void>;
+  releaseLock: () => void;
+  onReset: () => Promise<void>;
 };
 
 /**
@@ -27,6 +33,8 @@ export type CreateSessionParams = {
  * Tabs make requests to the `ClientServicesHost`, and provide a WebRTC gateway.
  */
 export class WorkerRuntime {
+  private readonly _acquireLock: () => Promise<void>;
+  private readonly _releaseLock: () => void;
   private readonly _transportFactory = new SimplePeerTransportProxyFactory();
   private readonly _ready = new Trigger<Error | undefined>();
   private readonly _sessions = new Set<WorkerSession>();
@@ -34,12 +42,15 @@ export class WorkerRuntime {
   private _sessionForNetworking?: WorkerSession; // TODO(burdon): Expose to client QueryStatusResponse.
   private _config!: Config;
 
-  constructor(private readonly _configProvider: () => MaybePromise<Config>) {
+  constructor(
+    private readonly _configProvider: () => MaybePromise<Config>,
+    { acquireLock, releaseLock, onReset }: WorkerRuntimeCallbacks,
+  ) {
+    this._acquireLock = acquireLock;
+    this._releaseLock = releaseLock;
     this._clientServices = new ClientServicesHost({
       callbacks: {
-        onReset: async () => {
-          self.close();
-        },
+        onReset: async () => onReset(),
       },
     });
   }
@@ -51,6 +62,7 @@ export class WorkerRuntime {
   async start() {
     log('starting...');
     try {
+      await this._acquireLock();
       this._config = await this._configProvider();
       const signals = this._config.get('runtime.services.signaling');
       this._clientServices.initialize({
@@ -71,7 +83,8 @@ export class WorkerRuntime {
   }
 
   async stop() {
-    // TODO(dmaretskyi): Terminate active sessions.
+    // Release the lock to notify remote clients that the worker is terminating.
+    this._releaseLock();
     await this._clientServices.close();
   }
 
@@ -87,10 +100,15 @@ export class WorkerRuntime {
       readySignal: this._ready,
     });
 
-    // When tab is closed.
+    // When tab is closed or client is destroyed.
     session.onClose.set(async () => {
       this._sessions.delete(session);
-      this._reconnectWebrtc();
+      if (this._sessions.size === 0) {
+        // Terminate the worker when all sessions are closed.
+        self.close();
+      } else {
+        this._reconnectWebrtc();
+      }
     });
 
     await session.open();
@@ -100,7 +118,7 @@ export class WorkerRuntime {
   }
 
   /**
-   * Selects one of the existing session fro WebRTC networking.
+   * Selects one of the existing session for WebRTC networking.
    */
   private _reconnectWebrtc() {
     log('reconnecting webrtc...');

package/src/packlets/vault/worker-session.ts

@@ -21,7 +21,8 @@ export type WorkerSessionParams = {
   serviceHost: ClientServicesHost;
   systemPort: RpcPort;
   appPort: RpcPort;
-  shellPort: RpcPort;
+  // TODO(wittjosiah): Remove shellPort.
+  shellPort?: RpcPort;
   readySignal: Trigger<Error | undefined>;
 };
 
@@ -30,7 +31,7 @@ export type WorkerSessionParams = {
  */
 export class WorkerSession {
   private readonly _clientRpc: ClientRpcServer;
-  private readonly _shellClientRpc: ClientRpcServer;
+  private readonly _shellClientRpc?: ClientRpcServer;
   private readonly _iframeRpc: ProtoRpcPeer<IframeServiceBundle>;
   private readonly _startTrigger = new Trigger();
   private readonly _serviceHost: ClientServicesHost;
@@ -74,11 +75,13 @@ export class WorkerSession {
       ...middleware,
     });
 
-    this._shellClientRpc = new ClientRpcServer({
-      serviceRegistry: this._serviceHost.serviceRegistry,
-      port: shellPort,
-      ...middleware,
-    });
+    this._shellClientRpc = shellPort
+      ? new ClientRpcServer({
+          serviceRegistry: this._serviceHost.serviceRegistry,
+          port: shellPort,
+          ...middleware,
+        })
+      : undefined;
 
     this._iframeRpc = createProtoRpcPeer({
       requested: iframeServiceBundle,
@@ -138,7 +141,7 @@ export class WorkerSession {
 
   private async _maybeOpenShell() {
     try {
-      await asyncTimeout(this._shellClientRpc.open(), 1_000);
+      this._shellClientRpc && (await asyncTimeout(this._shellClientRpc.open(), 1_000));
     } catch {
       log.info('No shell connected.');
     }

package/src/version.ts

@@ -1 +1 @@
-export const DXOS_VERSION = "0.3.11-main.baa8c4d";
+export const DXOS_VERSION = "0.3.11-main.bc6b68b";