@dxos/client-services 0.1.9 → 0.1.11

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

@@ -12,7 +12,7 @@ import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 import {
   AuthenticatingInvitationObservable,
   AuthenticatingInvitationProvider,
-  InvitationObservable,
+  CancellableInvitationObservable,
   InvitationObservableProvider,
   InvitationsService
 } from './invitations';
@@ -34,7 +34,7 @@ export abstract class AbstractInvitationsProxy<T = void> implements InvitationsP
 
   abstract getInvitationOptions(context: T): Invitation;
 
-  createInvitation(context: T, options?: InvitationsOptions): InvitationObservable {
+  createInvitation(context: T, options?: InvitationsOptions): CancellableInvitationObservable {
     let invitationId: string;
     const observable = new InvitationObservableProvider(async () => {
       if (invitationId) {

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

@@ -43,8 +43,8 @@ export abstract class AbstractInvitationsService<T = void> implements Invitation
       log('stream opened', this.getLoggingContext());
 
       let invitationId: string;
-      const { type } = invitation;
-      const observable = invitationsHandler.createInvitation(context, { type });
+      const { type, swarmKey } = invitation;
+      const observable = invitationsHandler.createInvitation(context, { type, swarmKey });
       observable.subscribe({
         onConnecting: (invitation) => {
           assert(invitation.invitationId);

package/src/packlets/invitations/invitations.ts

@@ -8,7 +8,6 @@ import {
   AsyncEvents,
   CancellableObservable,
   CancellableObservableEvents,
-  Observable,
   CancellableObservableProvider
 } from '@dxos/async';
 import type { Stream } from '@dxos/codec-protobuf';
@@ -43,13 +42,13 @@ export interface InvitationEvents extends AsyncEvents, CancellableObservableEven
  * Base class for all invitation observables and providers.
  * Observable that supports inspection of the current value.
  */
-export interface InvitationObservable extends CancellableObservable<InvitationEvents> {
+export interface CancellableInvitationObservable extends CancellableObservable<InvitationEvents> {
   get invitation(): Invitation | undefined;
 }
 
 export class InvitationObservableProvider
   extends CancellableObservableProvider<InvitationEvents>
-  implements InvitationObservable
+  implements CancellableInvitationObservable
 {
   private _invitation?: Invitation;
 
@@ -62,11 +61,6 @@ export class InvitationObservableProvider
   }
 }
 
-/**
- * Cancelable observer.
- */
-export type CancellableInvitationObservable = InvitationObservable;
-
 /**
  * Cancelable observer that relays authentication requests.
  */
@@ -96,11 +90,12 @@ export class AuthenticatingInvitationProvider
 }
 
 /**
- * Util to wrap observable with promise.
+ * Testing util to wrap non-authenticating observable with promise.
+ * Don't use this in production code.
  * @deprecated
  */
-// TODO(burdon): Replace with ObservableInvitationProvider.
-export const invitationObservable = async (observable: Observable<InvitationEvents>): Promise<Invitation> => {
+// TODO(burdon): Throw error if auth requested.
+export const wrapObservable = async (observable: CancellableInvitationObservable): Promise<Invitation> => {
   return new Promise((resolve, reject) => {
     const unsubscribe = observable.subscribe({
       onSuccess: (invitation: Invitation) => {

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

@@ -14,11 +14,12 @@ import { createProtocolFactory, NetworkManager, StarTopology, SwarmConnection }
 import { createRpcPlugin, RpcPlugin } from '@dxos/protocol-plugin-rpc';
 import { schema } from '@dxos/protocols';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
+import { ProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { createProtoRpcPeer } from '@dxos/rpc';
 
 import {
   AuthenticatingInvitationProvider,
-  InvitationObservable,
+  CancellableInvitationObservable,
   InvitationObservableProvider,
   AUTHENTICATION_CODE_LENGTH,
   INVITATION_TIMEOUT,
@@ -42,16 +43,16 @@ export class SpaceInvitationsHandler extends AbstractInvitationsHandler<Space> {
   /**
    * Creates an invitation and listens for a join request from the invited (guest) peer.
    */
-  createInvitation(space: Space, options?: InvitationsOptions): InvitationObservable {
+  createInvitation(space: Space, options?: InvitationsOptions): CancellableInvitationObservable {
     let swarmConnection: SwarmConnection | undefined;
-    const { type, timeout = INVITATION_TIMEOUT } = options ?? {};
+    const { type, timeout = INVITATION_TIMEOUT, swarmKey } = options ?? {};
     assert(type !== Invitation.Type.OFFLINE);
     assert(space);
 
     const invitation: Invitation = {
       type,
       invitationId: PublicKey.random().toHex(),
-      swarmKey: PublicKey.random(),
+      swarmKey: swarmKey ?? PublicKey.random(),
       spaceKey: space.key,
       authenticationCode: generatePasscode(AUTHENTICATION_CODE_LENGTH)
     };
@@ -64,19 +65,25 @@ export class SpaceInvitationsHandler extends AbstractInvitationsHandler<Space> {
     let authenticationCode: string;
     const complete = new Trigger<PublicKey>();
     const plugin = new RpcPlugin(async (port) => {
+      let guestProfile: ProfileDocument | undefined;
+
       const peer = createProtoRpcPeer({
         exposed: {
           SpaceHostService: schema.getService('dxos.halo.invitations.SpaceHostService')
         },
         handlers: {
           SpaceHostService: {
-            requestAdmission: async () => {
+            requestAdmission: async ({ profile }) => {
               log('responding with admission offer', {
+                guestProfile: profile,
                 host: this._signingContext.deviceKey,
                 spaceKey: space.key
               });
 
+              guestProfile = profile;
+
               // TODO(burdon): Is this the right place to set this state?
+              // TODO(dmaretskyi): Should we expose guest's profile in this callback?
               observable.callback.onAuthenticating?.(invitation);
               return {
                 spaceKey: space.key,
@@ -97,6 +104,8 @@ export class SpaceInvitationsHandler extends AbstractInvitationsHandler<Space> {
                     invitation.authenticationCode === undefined ||
                     authenticationCode !== invitation.authenticationCode
                   ) {
+                    invitation.authenticationCode &&
+                      log.error('bad auth code', { code: authenticationCode, expected: invitation.authenticationCode });
                     throw new Error('authentication code not set');
                   }
                 }
@@ -111,7 +120,8 @@ export class SpaceInvitationsHandler extends AbstractInvitationsHandler<Space> {
                     deviceKey,
                     space.key,
                     controlFeedKey,
-                    dataFeedKey
+                    dataFeedKey,
+                    guestProfile
                   )
                 );
 
@@ -150,7 +160,7 @@ export class SpaceInvitationsHandler extends AbstractInvitationsHandler<Space> {
     setTimeout(async () => {
       const topic = invitation.swarmKey!;
       const peerId = PublicKey.random(); // Use anonymous key.
-      swarmConnection = await this._networkManager.openSwarmConnection({
+      swarmConnection = await this._networkManager.joinSwarm({
         topic,
         peerId: topic,
         protocol: createProtocolFactory(topic, peerId, [plugin]),
@@ -206,7 +216,9 @@ export class SpaceInvitationsHandler extends AbstractInvitationsHandler<Space> {
 
         // 1. Send request.
         log('sending admission request', { guest: this._signingContext.deviceKey });
-        const { spaceKey, genesisFeedKey } = await peer.rpc.SpaceHostService.requestAdmission();
+        const { spaceKey, genesisFeedKey } = await peer.rpc.SpaceHostService.requestAdmission({
+          profile: this._signingContext.profile
+        });
 
         // 2. Get authentication code.
         // TODO(burdon): Test timeout (options for timeouts at different steps).
@@ -248,7 +260,7 @@ export class SpaceInvitationsHandler extends AbstractInvitationsHandler<Space> {
       assert(invitation.swarmKey);
       const topic = invitation.swarmKey;
       const peerId = PublicKey.random(); // Use anonymous key.
-      swarmConnection = await this._networkManager.openSwarmConnection({
+      swarmConnection = await this._networkManager.joinSwarm({
         topic,
         peerId: PublicKey.random(),
         protocol: createProtocolFactory(topic, peerId, [plugin]),

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

@@ -21,12 +21,13 @@ import { NetworkManager } from '@dxos/network-manager';
 import type { FeedMessage } from '@dxos/protocols/proto/dxos/echo/feed';
 import { Storage } from '@dxos/random-access-storage';
 
-import { IdentityManager } from '../identity';
+import { CreateIdentityOptions, IdentityManager } from '../identity';
 import { HaloInvitationsHandler, SpaceInvitationsHandler } from '../invitations';
 
 /**
  * Shared backend for all client services.
  */
+
 // TODO(burdon): Rename/break-up into smaller components. And/or make members private.
 export class ServiceContext {
   public readonly initialized = new Trigger();
@@ -87,13 +88,21 @@ export class ServiceContext {
     await this.identityManager.close();
     await this.spaceManager?.close();
     await this.feedStore.close();
-    await this.networkManager.destroy(); // TODO(burdon): Close.
+    await this.networkManager.close();
     this.dataServiceSubscriptions.clear();
     log('closed');
   }
 
-  async createIdentity() {
-    const identity = await this.identityManager.createIdentity();
+  async reset() {
+    log('resetting...');
+    await this.close();
+    await this.storage.reset();
+    log('reset');
+  }
+
+  async createIdentity(params: CreateIdentityOptions = {}) {
+    const identity = await this.identityManager.createIdentity(params);
+
     this.dataServiceSubscriptions.registerSpace(identity.haloSpaceKey, identity.haloDatabase.createDataServiceHost());
     await this._initialize();
     return identity;
@@ -107,7 +116,8 @@ export class ServiceContext {
       credentialAuthenticator: MOCK_AUTH_VERIFIER,
       credentialSigner: identity.getIdentityCredentialSigner(),
       identityKey: identity.identityKey,
-      deviceKey: identity.deviceKey
+      deviceKey: identity.deviceKey,
+      profile: identity.profileDocument
     };
 
     // Create in constructor (avoid all of these private variables).

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

@@ -21,25 +21,28 @@ import { ServiceContext } from './service-context';
 import { ClientServicesProvider, ClientServices, clientServiceBundle } from './service-definitions';
 import { ServiceRegistry } from './service-registry';
 
-type ClientServicesHostParams = {
-  config: Config;
-  modelFactory?: ModelFactory;
-  networkManager: NetworkManager;
-};
-
 // TODO(burdon): Factor out to spaces.
 // TODO(burdon): Defaults (with TextModel).
 export const createDefaultModelFactory = () => {
   return new ModelFactory().registerModel(ObjectModel).registerModel(TextModel);
 };
 
+type ClientServicesHostParams = {
+  config: Config;
+  modelFactory?: ModelFactory;
+  networkManager: NetworkManager;
+};
+
 /**
  * Remote service implementation.
  */
-// TODO(burdon): Reconcile Host/Backend, etc.
 export class ClientServicesHost implements ClientServicesProvider {
-  private readonly _serviceContext: ServiceContext;
-  private readonly _serviceRegistry: ServiceRegistry<ClientServices>;
+  private _serviceContext!: ServiceContext;
+  private _serviceRegistry!: ServiceRegistry<ClientServices>;
+
+  private readonly _config: Config;
+  private readonly _modelFactory: ModelFactory;
+  private readonly _networkManager: NetworkManager;
 
   constructor({
     config,
@@ -47,11 +50,42 @@ export class ClientServicesHost implements ClientServicesProvider {
     // TODO(burdon): Create ApolloLink abstraction (see Client).
     networkManager
   }: ClientServicesHostParams) {
+    this._config = config;
+    this._modelFactory = modelFactory;
+    this._networkManager = networkManager;
+  }
+
+  get descriptors() {
+    return this._serviceRegistry.descriptors;
+  }
+
+  get services() {
+    return this._serviceRegistry.services;
+  }
+
+  async open() {
+    await this._initialize();
+    const deviceKey = this._serviceContext.identityManager.identity?.deviceKey;
+    log('opening...', { deviceKey });
+    await this._initialize();
+    await this._serviceContext.open();
+    log('opened', { deviceKey });
+  }
+
+  async close() {
+    const deviceKey = this._serviceContext.identityManager.identity?.deviceKey;
+    log('closing...', { deviceKey });
+    await this._serviceContext.close();
+    log('closed', { deviceKey });
+  }
+
+  // TODO(burdon): Move into open.
+  async _initialize() {
     // TODO(dmaretskyi): Remove keyStorage.
-    const { storage } = createStorageObjects(config.get('runtime.client.storage', {})!);
+    const { storage } = createStorageObjects(this._config.get('runtime.client.storage', {})!);
 
     // TODO(burdon): Break into components.
-    this._serviceContext = new ServiceContext(storage, networkManager, modelFactory);
+    this._serviceContext = new ServiceContext(storage, this._networkManager, this._modelFactory);
 
     // TODO(burdon): Start to think of DMG (dynamic services).
     this._serviceRegistry = new ServiceRegistry<ClientServices>(clientServiceBundle, {
@@ -75,35 +109,13 @@ export class ClientServicesHost implements ClientServicesProvider {
       // TODO(burdon): Move to new protobuf definitions.
       ProfileService: new ProfileServiceImpl(this._serviceContext),
       SpaceService: new SpaceServiceImpl(this._serviceContext),
-      SystemService: new SystemServiceImpl(config),
-      TracingService: new TracingServiceImpl(config),
+      SystemService: new SystemServiceImpl(this._config, this._serviceContext),
+      TracingService: new TracingServiceImpl(this._config),
       DevtoolsHost: new DevtoolsServiceImpl({
         events: new DevtoolsHostEvents(),
-        config,
+        config: this._config,
         context: this._serviceContext
       })
     });
   }
-
-  get descriptors() {
-    return this._serviceRegistry.descriptors;
-  }
-
-  get services() {
-    return this._serviceRegistry.services;
-  }
-
-  async open() {
-    const deviceKey = this._serviceContext.identityManager.identity?.deviceKey;
-    log('opening...', { deviceKey });
-    await this._serviceContext.open();
-    log('opened', { deviceKey });
-  }
-
-  async close() {
-    const deviceKey = this._serviceContext.identityManager.identity?.deviceKey;
-    log('closing...', { deviceKey });
-    await this._serviceContext.close();
-    log('closed', { deviceKey });
-  }
 }

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

@@ -3,9 +3,9 @@
 //
 
 import { asyncTimeout } from '@dxos/async';
+import { RemoteServiceConnectionTimeout } from '@dxos/errors';
 import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
 
-import { RemoteServiceConnectionTimeout } from '../../errors';
 import { ClientServicesProvider, ClientServices, clientServiceBundle } from './service-definitions';
 
 /**

package/src/packlets/storage/storage.ts

@@ -6,12 +6,12 @@ import jsondown from 'jsondown'; // TODO(burdon): Uses custom implementation.
 import leveljs from 'level-js';
 import memdown from 'memdown';
 
+import { InvalidConfigError } from '@dxos/errors';
 import { Runtime } from '@dxos/protocols/proto/dxos/config';
 import { createStorage, StorageType } from '@dxos/random-access-storage';
 import { isNode } from '@dxos/util';
 
 import StorageDriver = Runtime.Client.Storage.StorageDriver;
-import { InvalidConfigurationError } from '../../errors';
 
 export type KeyStorageType = 'ram' | 'leveljs' | 'jsondown';
 
@@ -25,16 +25,16 @@ export const createStorageObjects = (config: Runtime.Client.Storage) => {
   } = config ?? {};
 
   if (persistent && storageType === StorageDriver.RAM) {
-    throw new InvalidConfigurationError('RAM storage cannot be used in persistent mode.');
+    throw new InvalidConfigError('RAM storage cannot be used in persistent mode.');
   }
   if (!persistent && storageType !== undefined && storageType !== StorageDriver.RAM) {
-    throw new InvalidConfigurationError('Cannot use a persistent storage in not persistent mode.');
+    throw new InvalidConfigError('Cannot use a persistent storage in not persistent mode.');
   }
   if (persistent && keyStorage === StorageDriver.RAM) {
-    throw new InvalidConfigurationError('RAM key storage cannot be used in persistent mode.');
+    throw new InvalidConfigError('RAM key storage cannot be used in persistent mode.');
   }
   if (!persistent && keyStorage !== StorageDriver.RAM && keyStorage !== undefined) {
-    throw new InvalidConfigurationError('Cannot use a persistent key storage in not persistent mode.');
+    throw new InvalidConfigError('Cannot use a persistent key storage in not persistent mode.');
   }
 
   return {
@@ -58,7 +58,7 @@ const createKeyStorage = (path: string, type?: KeyStorageType) => {
     case 'ram':
       return memdown();
     default:
-      throw new InvalidConfigurationError(`Invalid key storage type: ${defaultedType}`);
+      throw new InvalidConfigError(`Invalid key storage type: ${defaultedType}`);
   }
 };
 

package/src/packlets/testing/test-builder.ts

@@ -61,7 +61,7 @@ export const createIdentity = async (peer: ServiceContext) => {
   return peer;
 };
 
-// TODO(wittjosiah): Factor out to client-testing?
+// TODO(burdon): Remove @dxos/client-testing.
 // TODO(burdon): Create builder and make configurable.
 export const syncItems = async (space1: ISpace, space2: ISpace) => {
   {

package/testing.d.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+/**
+ * Enable testing imports:
+ * ```tsc
+ * import { ... } from '@dxos/client-services/testing';
+ * ```
+ */
+export * from './dist/src/packlets/testing';

package/testing.js

@@ -0,0 +1,5 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+module.exports = require('./dist/src/packlets/testing/index.js');

package/dist/src/errors.d.ts

@@ -1,8 +0,0 @@
-import { DXOSError } from '@dxos/debug';
-export declare class InvalidConfigurationError extends DXOSError {
-    constructor(message: string);
-}
-export declare class RemoteServiceConnectionTimeout extends DXOSError {
-    constructor(message?: string);
-}
-//# sourceMappingURL=errors.d.ts.map

package/dist/src/errors.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAIxC,qBAAa,yBAA0B,SAAQ,SAAS;gBAC1C,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,8BAA+B,SAAQ,SAAS;gBAC/C,OAAO,CAAC,EAAE,MAAM;CAG7B"}

package/dist/src/errors.js

@@ -1,21 +0,0 @@
-"use strict";
-//
-// Copyright 2021 DXOS.org
-//
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteServiceConnectionTimeout = exports.InvalidConfigurationError = void 0;
-const debug_1 = require("@dxos/debug");
-// TODO(burdon): Consolidate with @dxos/echo-db.
-class InvalidConfigurationError extends debug_1.DXOSError {
-    constructor(message) {
-        super('INVALID_CONFIGURATION', message);
-    }
-}
-exports.InvalidConfigurationError = InvalidConfigurationError;
-class RemoteServiceConnectionTimeout extends debug_1.DXOSError {
-    constructor(message) {
-        super('REMOTE_SERVICE_CONNECTION_TIMEOUT', message);
-    }
-}
-exports.RemoteServiceConnectionTimeout = RemoteServiceConnectionTimeout;
-//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;AAEF,uCAAwC;AAExC,gDAAgD;AAEhD,MAAa,yBAA0B,SAAQ,iBAAS;IACtD,YAAY,OAAe;QACzB,KAAK,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;CACF;AAJD,8DAIC;AAED,MAAa,8BAA+B,SAAQ,iBAAS;IAC3D,YAAY,OAAgB;QAC1B,KAAK,CAAC,mCAAmC,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;CACF;AAJD,wEAIC"}

package/src/errors.ts

@@ -1,19 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-import { DXOSError } from '@dxos/debug';
-
-// TODO(burdon): Consolidate with @dxos/echo-db.
-
-export class InvalidConfigurationError extends DXOSError {
-  constructor(message: string) {
-    super('INVALID_CONFIGURATION', message);
-  }
-}
-
-export class RemoteServiceConnectionTimeout extends DXOSError {
-  constructor(message?: string) {
-    super('REMOTE_SERVICE_CONNECTION_TIMEOUT', message);
-  }
-}