@dxos/client-services 0.1.10 → 0.1.12

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

@@ -18,7 +18,7 @@ import { createProtoRpcPeer } from '@dxos/rpc';
 import { IdentityManager } from '../identity';
 import {
   AuthenticatingInvitationProvider,
-  InvitationObservable,
+  CancellableInvitationObservable,
   InvitationObservableProvider,
   AUTHENTICATION_CODE_LENGTH,
   INVITATION_TIMEOUT,
@@ -42,7 +42,7 @@ export class HaloInvitationsHandler extends AbstractInvitationsHandler {
   /**
    * Creates an invitation and listens for a join request from the invited (guest) peer.
    */
-  createInvitation(context: void, options?: InvitationsOptions): InvitationObservable {
+  createInvitation(context: void, options?: InvitationsOptions): CancellableInvitationObservable {
     let swarmConnection: SwarmConnection | undefined;
     const { type, timeout = INVITATION_TIMEOUT, swarmKey } = options ?? {};
     assert(type !== Invitation.Type.OFFLINE);

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

@@ -6,7 +6,7 @@ import { PublicKey } from '@dxos/keys';
 import { NetworkManager } from '@dxos/network-manager';
 import { Invitation } from '@dxos/protocols/proto/dxos/client/services';
 
-import { AuthenticatingInvitationObservable, InvitationObservable } from './invitations';
+import { AuthenticatingInvitationObservable, CancellableInvitationObservable } from './invitations';
 
 export type InvitationsOptions = {
   type?: Invitation.Type;
@@ -43,7 +43,7 @@ export type InvitationsOptions = {
  *  ```
  */
 export interface InvitationsHandler<T = void> {
-  createInvitation(context: T, options?: InvitationsOptions): InvitationObservable;
+  createInvitation(context: T, options?: InvitationsOptions): CancellableInvitationObservable;
   acceptInvitation(invitation: Invitation, options?: InvitationsOptions): AuthenticatingInvitationObservable;
 }
 
@@ -57,6 +57,6 @@ export abstract class AbstractInvitationsHandler<T = void> implements Invitation
     protected readonly _networkManager: NetworkManager
   ) {}
 
-  abstract createInvitation(context: T, options?: InvitationsOptions): InvitationObservable;
+  abstract createInvitation(context: T, options?: InvitationsOptions): CancellableInvitationObservable;
   abstract acceptInvitation(invitation: Invitation, options?: InvitationsOptions): AuthenticatingInvitationObservable;
 }

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.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

@@ -19,7 +19,7 @@ import { createProtoRpcPeer } from '@dxos/rpc';
 
 import {
   AuthenticatingInvitationProvider,
-  InvitationObservable,
+  CancellableInvitationObservable,
   InvitationObservableProvider,
   AUTHENTICATION_CODE_LENGTH,
   INVITATION_TIMEOUT,
@@ -43,7 +43,7 @@ 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, swarmKey } = options ?? {};
     assert(type !== Invitation.Type.OFFLINE);
@@ -104,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');
                   }
                 }

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

@@ -27,6 +27,7 @@ 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();
@@ -92,8 +93,12 @@ export class ServiceContext {
     log('closed');
   }
 
-  // TODO(burdon): Rename.
-  async destroy() {}
+  async reset() {
+    log('resetting...');
+    await this.close();
+    await this.storage.reset();
+    log('reset');
+  }
 
   async createIdentity(params: CreateIdentityOptions = {}) {
     const identity = await this.identityManager.createIdentity(params);

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

@@ -37,8 +37,12 @@ type ClientServicesHostParams = {
  * Remote service implementation.
  */
 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,
@@ -46,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, {
@@ -74,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/src/packlets/vault/worker-session.ts

@@ -2,13 +2,15 @@
 // Copyright 2022 DXOS.org
 //
 
+import assert from 'assert';
+
 import { Trigger } from '@dxos/async';
 import { log } from '@dxos/log';
 import { BridgeService } from '@dxos/protocols/proto/dxos/mesh/bridge';
 import { createProtoRpcPeer, ProtoRpcPeer, RpcPort } from '@dxos/rpc';
 import { Callback } from '@dxos/util';
 
-import { clientServiceBundle, ClientServicesHost } from '../services';
+import { clientServiceBundle, ClientServices, ClientServicesHost } from '../services';
 import { IframeServiceBundle, iframeServiceBundle, workerServiceBundle } from './services';
 
 export type WorkerSessionParams = {
@@ -25,8 +27,8 @@ export type WorkerSessionParams = {
  * Represents a tab connection within the worker.
  */
 export class WorkerSession {
-  private readonly _clientRpc: ProtoRpcPeer<{}>;
-  private readonly _systemRpc: ProtoRpcPeer<IframeServiceBundle>;
+  private readonly _clientRpc: ProtoRpcPeer<ClientServices>;
+  private readonly _iframeRpc: ProtoRpcPeer<IframeServiceBundle>;
   private readonly _startTrigger = new Trigger();
   private readonly _getServices: () => Promise<ClientServicesHost>;
   private readonly _options: NonNullable<WorkerSessionParams['options']>;
@@ -42,9 +44,11 @@ export class WorkerSession {
     systemPort,
     appPort,
     options = {
-      heartbeatInterval: 1000
+      heartbeatInterval: 1_000
     }
   }: WorkerSessionParams) {
+    assert(options);
+    assert(getServices);
     this._options = options;
     this._getServices = getServices;
 
@@ -65,7 +69,7 @@ export class WorkerSession {
       port: appPort
     });
 
-    this._systemRpc = createProtoRpcPeer({
+    this._iframeRpc = createProtoRpcPeer({
       requested: iframeServiceBundle,
       exposed: workerServiceBundle,
       handlers: {
@@ -90,17 +94,20 @@ export class WorkerSession {
       timeout: 200
     });
 
-    this.bridgeService = this._systemRpc.rpc.BridgeService;
+    this.bridgeService = this._iframeRpc.rpc.BridgeService;
   }
 
   async open() {
-    await Promise.all([this._clientRpc.open(), this._systemRpc.open()]);
+    await Promise.all([this._clientRpc.open(), this._iframeRpc.open()]);
 
     await this._startTrigger.wait({ timeout: 3_000 });
 
+    // Detect if bridge is present.
+    // TODO(burdon): Add heartbeat to client's System service.
+    //  How do we detect if the client's tab closed?
     this._heartbeatTimer = setInterval(async () => {
       try {
-        await this._systemRpc.rpc.IframeService.heartbeat();
+        await this._iframeRpc.rpc.IframeService.heartbeat();
       } catch (err) {
         try {
           await this.close();
@@ -122,6 +129,6 @@ export class WorkerSession {
       clearInterval(this._heartbeatTimer);
     }
 
-    await Promise.all([this._clientRpc.close(), this._systemRpc.close()]);
+    await Promise.all([this._clientRpc.close(), this._iframeRpc.close()]);
   }
 }

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);
-  }
-}