@dxos/client-services 0.4.6-main.9c97a50 → 0.4.6-main.b69a2b5

package/src/packlets/identity/identity-manager.ts

@@ -1,7 +1,6 @@
 //
 // Copyright 2022 DXOS.org
 //
-
 import platform from 'platform';
 
 import { Event } from '@dxos/async';
@@ -20,11 +19,12 @@ import { type IdentityRecord, type SpaceMetadata } from '@dxos/protocols/proto/d
 import {
   AdmittedFeed,
   type DeviceProfileDocument,
+  DeviceType,
   type ProfileDocument,
 } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { Timeframe } from '@dxos/timeframe';
 import { trace as Trace } from '@dxos/tracing';
-import { deferFunction } from '@dxos/util';
+import { isNode, deferFunction } from '@dxos/util';
 
 import { createAuthProvider } from './authenticator';
 import { Identity } from './identity';
@@ -48,10 +48,14 @@ export type JoinIdentityParams = {
    * We will try to catch up to this timeframe before starting the data pipeline.
    */
   controlTimeframe?: Timeframe;
+  // Custom device profile, merged with defaults, to be applied once the identity is accepted.
+  deviceProfile?: DeviceProfileDocument;
 };
 
 export type CreateIdentityOptions = {
   displayName?: string;
+  // device profile for device creating the identity.
+  deviceProfile?: DeviceProfileDocument;
 };
 
 // TODO(dmaretskyi): Rename: represents the peer's state machine.
@@ -89,6 +93,7 @@ export class IdentityManager {
         identityKey: identityRecord.identityKey,
         displayName: this._identity.profileDocument?.displayName,
       });
+
       this.stateUpdate.emit();
     }
     log.trace('dxos.halo.identity-manager.open', trace.end({ id: traceId }));
@@ -98,7 +103,8 @@ export class IdentityManager {
     await this._identity?.close(new Context());
   }
 
-  async createIdentity({ displayName }: CreateIdentityOptions = {}) {
+  async createIdentity({ displayName, deviceProfile }: CreateIdentityOptions = {}) {
+    // TODO(nf): populate using context from ServiceContext?
     invariant(!this._identity, 'Identity already exists.');
     log('creating identity...');
 
@@ -144,11 +150,8 @@ export class IdentityManager {
       // Write device metadata to profile.
       credentials.push(
         await generator.createDeviceProfile({
-          platform: platform.name,
-          platformVersion: platform.version,
-          architecture: typeof platform.os?.architecture === 'number' ? String(platform.os.architecture) : undefined,
-          os: platform.os?.family,
-          osVersion: platform.os?.version,
+          ...this.createDefaultDeviceProfile(),
+          ...deviceProfile,
         }),
       );
       for (const credential of credentials) {
@@ -171,12 +174,42 @@ export class IdentityManager {
     });
     this.stateUpdate.emit();
 
-    log('created identity', { identityKey: identity.identityKey, deviceKey: identity.deviceKey });
+    log('created identity', {
+      identityKey: identity.identityKey,
+      deviceKey: identity.deviceKey,
+      profile: identity.profileDocument,
+    });
     return identity;
   }
 
+  // TODO(nf): receive platform info rather than generating it here.
+  createDefaultDeviceProfile(): DeviceProfileDocument {
+    let type: DeviceType;
+    // TODO(nf): call Platform service instead?
+    if (isNode()) {
+      type = DeviceType.AGENT;
+    } else {
+      if (platform.name?.startsWith('iOS') || platform.name?.startsWith('Android')) {
+        type = DeviceType.MOBILE;
+      } else if ((globalThis as any).__args) {
+        type = DeviceType.NATIVE;
+      } else {
+        type = DeviceType.BROWSER;
+      }
+    }
+
+    return {
+      type,
+      platform: platform.name,
+      platformVersion: platform.version,
+      architecture: typeof platform.os?.architecture === 'number' ? String(platform.os.architecture) : undefined,
+      os: platform.os?.family,
+      osVersion: platform.os?.version,
+    };
+  }
+
   /**
-   * Accept an existing identity. Expects it's device key to be authorized (now or later).
+   * Accept an existing identity. Expects its device key to be authorized (now or later).
    */
   async acceptIdentity(params: JoinIdentityParams) {
     log('accepting identity', { params });
@@ -204,6 +237,10 @@ export class IdentityManager {
       displayName: this._identity.profileDocument?.displayName,
     });
 
+    await this.updateDeviceProfile({
+      ...this.createDefaultDeviceProfile(),
+      ...params.deviceProfile,
+    });
     this.stateUpdate.emit();
     log('accepted identity', { identityKey: identity.identityKey, deviceKey: identity.deviceKey });
     return identity;
@@ -236,7 +273,7 @@ export class IdentityManager {
     // const generator = new CredentialGenerator(this._keyring, this._identity.identityKey, this._identity.deviceKey);
     // const credential = await generator.createDeviceProfile(profile);
 
-    const credential = await this._identity.getIdentityCredentialSigner().createCredential({
+    const credential = await this._identity.getDeviceCredentialSigner().createCredential({
       subject: this._identity.deviceKey,
       assertion: {
         '@type': 'dxos.halo.credentials.DeviceProfile',
@@ -274,7 +311,7 @@ export class IdentityManager {
       },
       identityKey: identityRecord.identityKey,
     });
-    space.setControlFeed(controlFeed);
+    await space.setControlFeed(controlFeed);
     space.setDataFeed(dataFeed);
 
     const identity: Identity = new Identity({
@@ -290,6 +327,7 @@ export class IdentityManager {
       identity.controlPipeline.state.setTargetTimeframe(identityRecord.haloSpace.controlTimeframe);
     }
 
+    identity.stateUpdate.on(() => this.stateUpdate.emit());
     return identity;
   }
 

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

@@ -28,7 +28,7 @@ export class IdentityServiceImpl implements IdentityService {
   ) {}
 
   async createIdentity(request: CreateIdentityRequest): Promise<Identity> {
-    await this._createIdentity(request.profile ?? {});
+    await this._createIdentity({ displayName: request.profile?.displayName, deviceProfile: request.deviceProfile });
     return this._getIdentity()!;
   }
 

package/src/packlets/identity/identity.test.ts

@@ -96,9 +96,9 @@ describe('identity/identity', () => {
       metadataStore,
       snapshotManager: new SnapshotManager(snapshotStore, blobStore, protocol.blobSync),
       snapshotId: undefined,
-    })
-      .setControlFeed(controlFeed)
-      .setDataFeed(dataFeed);
+    });
+    await space.setControlFeed(controlFeed);
+    await space.setDataFeed(dataFeed);
 
     const identity = new Identity({
       signer: keyring,
@@ -209,9 +209,9 @@ describe('identity/identity', () => {
         modelFactory: createDefaultModelFactory(),
         metadataStore,
         snapshotManager: new SnapshotManager(snapshotStore, blobStore, protocol.blobSync),
-      })
-        .setControlFeed(controlFeed)
-        .setDataFeed(dataFeed);
+      });
+      await space.setControlFeed(controlFeed);
+      await space.setDataFeed(dataFeed);
 
       const identity = (identity1 = new Identity({
         signer: keyring,
@@ -300,9 +300,9 @@ describe('identity/identity', () => {
         modelFactory: createDefaultModelFactory(),
         metadataStore,
         snapshotManager: new SnapshotManager(snapshotStore, blobStore, protocol.blobSync),
-      })
-        .setControlFeed(controlFeed)
-        .setDataFeed(dataFeed);
+      });
+      await space.setControlFeed(controlFeed);
+      await space.setDataFeed(dataFeed);
 
       const identity = (identity2 = new Identity({
         signer: keyring,

package/src/packlets/identity/identity.ts

@@ -13,7 +13,6 @@ import {
   ProfileStateMachine,
 } from '@dxos/credentials';
 import { type Signer } from '@dxos/crypto';
-import { failUndefined } from '@dxos/debug';
 import { type Space } from '@dxos/echo-pipeline';
 import { writeMessages } from '@dxos/feed-store';
 import { invariant } from '@dxos/invariant';
@@ -129,14 +128,6 @@ export class Identity {
     return this._deviceStateMachine.deviceCredentialChain;
   }
 
-  getAdmissionCredentials(): DeviceAdmissionRequest {
-    return {
-      deviceKey: this.deviceKey,
-      controlFeedKey: this.space.controlFeedKey ?? failUndefined(),
-      dataFeedKey: this.space.dataFeedKey ?? failUndefined(),
-    };
-  }
-
   /**
    * Issues credentials as identity.
    * Requires identity to be ready.

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

@@ -6,6 +6,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 { DeviceProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
 import {
   type AdmissionRequest,
   type AdmissionResponse,
@@ -62,7 +63,7 @@ export class DeviceInvitationProtocol implements InvitationProtocol {
     return {};
   }
 
-  async createAdmissionRequest(): Promise<AdmissionRequest> {
+  async createAdmissionRequest(deviceProfile?: DeviceProfileDocument): Promise<AdmissionRequest> {
     const deviceKey = await this._keyring.createKey();
     const controlFeedKey = await this._keyring.createKey();
     const dataFeedKey = await this._keyring.createKey();
@@ -72,6 +73,7 @@ export class DeviceInvitationProtocol implements InvitationProtocol {
         deviceKey,
         controlFeedKey,
         dataFeedKey,
+        profile: deviceProfile,
       },
     };
   }
@@ -81,7 +83,7 @@ export class DeviceInvitationProtocol implements InvitationProtocol {
     const { identityKey, haloSpaceKey, genesisFeedKey, controlTimeframe } = response.device;
 
     invariant(request.device);
-    const { deviceKey, controlFeedKey, dataFeedKey } = request.device;
+    const { deviceKey, controlFeedKey, dataFeedKey, profile } = request.device;
 
     // TODO(wittjosiah): When multiple identities are supported, verify identity doesn't already exist before accepting.
 
@@ -93,6 +95,7 @@ export class DeviceInvitationProtocol implements InvitationProtocol {
       controlFeedKey,
       dataFeedKey,
       controlTimeframe,
+      deviceProfile: profile,
     });
 
     return { identityKey };

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

@@ -4,7 +4,7 @@
 
 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 { ProfileDocument, DeviceProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
 import type {
   AdmissionRequest,
   AdmissionResponse,
@@ -54,7 +54,7 @@ export interface InvitationProtocol {
   /**
    * Get key information to send to the host in order to create an admission credential for the guest.
    */
-  createAdmissionRequest(): Promise<AdmissionRequest>;
+  createAdmissionRequest(deviceProfile?: DeviceProfileDocument): Promise<AdmissionRequest>;
 
   /**
    * Redeem the admission credential.

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

@@ -22,6 +22,7 @@ import {
 } from '@dxos/network-manager';
 import { InvalidInvitationExtensionRoleError, trace } from '@dxos/protocols';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
+import { type DeviceProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { AuthenticationResponse } from '@dxos/protocols/proto/dxos/halo/invitations';
 
 import {
@@ -210,10 +211,18 @@ export class InvitationsHandler {
     return observable;
   }
 
-  acceptInvitation(protocol: InvitationProtocol, invitation: Invitation): AuthenticatingInvitation {
+  acceptInvitation(
+    protocol: InvitationProtocol,
+    invitation: Invitation,
+    deviceProfile?: DeviceProfileDocument,
+  ): AuthenticatingInvitation {
     const { timeout = INVITATION_TIMEOUT } = invitation;
     invariant(protocol);
 
+    // TODO(nf): duplicate check in InvitationsService
+    if (deviceProfile) {
+      invariant(invitation.kind === Invitation.Kind.DEVICE, 'deviceProfile provided for non-device invitation');
+    }
     const authenticated = new Trigger<string>();
 
     // TODO(dmaretskyi): Turn into state?
@@ -307,7 +316,7 @@ export class InvitationsHandler {
 
               // 3. Send admission credentials to host (with local space keys).
               log('request admission', { ...protocol.toJSON() });
-              const admissionRequest = await protocol.createAdmissionRequest();
+              const admissionRequest = await protocol.createAdmissionRequest(deviceProfile);
               const admissionResponse = await extension.rpc.InvitationHostService.admit(admissionRequest);
 
               // Remote connection no longer needed.

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

@@ -9,6 +9,7 @@ import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 import {
   type AuthenticationRequest,
+  type AcceptInvitationRequest,
   Invitation,
   type InvitationsService,
   QueryInvitationsResponse,
@@ -72,15 +73,20 @@ export class InvitationsServiceImpl implements InvitationsService {
     });
   }
 
-  acceptInvitation(options: Invitation): Stream<Invitation> {
+  acceptInvitation({ invitation: options, deviceProfile }: AcceptInvitationRequest): Stream<Invitation> {
     let invitation: AuthenticatingInvitation;
 
+    // TODO(nf): duplicate check in InvitationHandler
+    if (deviceProfile) {
+      invariant(options.kind === Invitation.Kind.DEVICE, 'deviceProfile provided for non-device invitation');
+    }
+
     const existingInvitation = this._acceptInvitations.get(options.invitationId);
     if (existingInvitation) {
       invitation = existingInvitation;
     } else {
       const handler = this._getHandler(options);
-      invitation = this._invitationsHandler.acceptInvitation(handler, options);
+      invitation = this._invitationsHandler.acceptInvitation(handler, options, deviceProfile);
       this._acceptInvitations.set(invitation.get().invitationId, invitation);
       this._invitationAccepted.emit(invitation.get());
     }

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, getRawDoc, type DocStructure } from '@dxos/echo-schema';
+import { type TypedObject, base, getRawDoc, type SpaceDoc } from '@dxos/echo-schema';
 import { invariant } from '@dxos/invariant';
 import { PublicKey } from '@dxos/keys';
 import { log } from '@dxos/log';
@@ -348,10 +348,10 @@ export class ClientServicesHost {
 
     const automergeIndex = space.automergeSpaceState.rootUrl;
     invariant(automergeIndex);
-    const document = await this._serviceContext.automergeHost.repo.find<DocStructure>(automergeIndex as any);
+    const document = await this._serviceContext.automergeHost.repo.find<SpaceDoc>(automergeIndex as any);
     await document.whenReady();
 
-    document.change((doc: DocStructure) => {
+    document.change((doc: SpaceDoc) => {
       assignDeep(doc, ['objects', obj[base]._id], getRawDoc(obj).handle.docSync());
     });
 

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

@@ -143,7 +143,7 @@ export class DataSpaceManager {
 
     const automergeRoot = this._automergeHost.repo.create();
     automergeRoot.change((doc: any) => {
-      doc.experimental_spaceKey = spaceKey.toHex();
+      doc.access = { spaceKey: spaceKey.toHex() };
     });
 
     const space = await this._constructSpace(metadata);
@@ -240,8 +240,8 @@ export class DataSpaceManager {
       },
       memberKey: this._signingContext.identityKey,
     });
-    controlFeed && space.setControlFeed(controlFeed);
-    dataFeed && space.setDataFeed(dataFeed);
+    controlFeed && (await space.setControlFeed(controlFeed));
+    dataFeed && (await space.setDataFeed(dataFeed));
 
     const dataSpace = new DataSpace({
       inner: space,

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

@@ -331,7 +331,7 @@ export class DataSpace {
     const credentials: Credential[] = [];
     if (!this.inner.controlFeedKey) {
       const controlFeed = await this._feedStore.openFeed(await this._keyring.createKey(), { writable: true });
-      this.inner.setControlFeed(controlFeed);
+      await this.inner.setControlFeed(controlFeed);
 
       credentials.push(
         await this._signingContext.credentialSigner.createCredential({
@@ -351,7 +351,7 @@ export class DataSpace {
         writable: true,
         sparse: true,
       });
-      this.inner.setDataFeed(dataFeed);
+      await this.inner.setDataFeed(dataFeed);
 
       credentials.push(
         await this._signingContext.credentialSigner.createCredential({
@@ -391,9 +391,9 @@ export class DataSpace {
         }
 
         const doc = handle.docSync() ?? failedInvariant();
-        if (!doc.experimental_spaceKey) {
+        if (!doc.access?.spaceKey) {
           handle.change((doc: any) => {
-            doc.experimental_spaceKey = this.key.toHex();
+            doc.access = { spaceKey: this.key.toHex() };
           });
         }
       } catch (err) {

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

@@ -6,6 +6,7 @@ import { Trigger } from '@dxos/async';
 import { InvitationEncoder, type AuthenticatingInvitation, type CancellableInvitation } from '@dxos/client-protocol';
 import { invariant } from '@dxos/invariant';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
+import { type DeviceProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 import { ServiceContext } from '../services';
 
@@ -21,7 +22,7 @@ export type InvitationHost = {
 };
 
 export type InvitationGuest = {
-  join(invitation: Invitation | string): AuthenticatingInvitation;
+  join(invitation: Invitation | string, deviceProfile?: DeviceProfileDocument): AuthenticatingInvitation;
 };
 
 export type PerformInvitationCallbacks<T> = {
@@ -43,6 +44,7 @@ export type PerformInvitationParams = {
     host?: PerformInvitationCallbacks<CancellableInvitation>;
     guest?: PerformInvitationCallbacks<AuthenticatingInvitation>;
   };
+  guestDeviceProfile?: DeviceProfileDocument;
 };
 
 export type Result = { invitation?: Invitation; error?: Error };
@@ -52,6 +54,7 @@ export const performInvitation = ({
   guest,
   options,
   hooks,
+  guestDeviceProfile,
 }: PerformInvitationParams): [Promise<Result>, Promise<Result>] => {
   const hostComplete = new Trigger<Result>();
   const guestComplete = new Trigger<Result>();
@@ -65,7 +68,7 @@ export const performInvitation = ({
           if (hooks?.host?.onConnecting?.(hostObservable)) {
             break;
           }
-          const guestObservable = acceptInvitation(guest, hostInvitation);
+          const guestObservable = acceptInvitation(guest, hostInvitation, guestDeviceProfile);
           guestObservable.subscribe(
             async (guestInvitation: Invitation) => {
               switch (guestInvitation.state) {
@@ -205,13 +208,14 @@ const createInvitation = (
 const acceptInvitation = (
   guest: ServiceContext | InvitationGuest,
   invitation: Invitation,
+  guestDeviceProfile?: DeviceProfileDocument,
 ): AuthenticatingInvitation => {
   invitation = sanitizeInvitation(invitation);
 
   if (guest instanceof ServiceContext) {
     const guestHandler = guest.getInvitationHandler({ kind: invitation.kind });
-    return guest.invitations.acceptInvitation(guestHandler, invitation);
+    return guest.invitations.acceptInvitation(guestHandler, invitation, guestDeviceProfile);
   }
 
-  return guest.join(invitation);
+  return guest.join(invitation, guestDeviceProfile);
 };

package/src/version.ts

@@ -1 +1 @@
-export const DXOS_VERSION = "0.4.6-main.9c97a50";
+export const DXOS_VERSION = "0.4.6-main.b69a2b5";