@dxos/client 2.31.7-dev.3c7d6556 → 2.31.8-dev.dcd68d50

package/src/api/client.test.ts

@@ -21,6 +21,9 @@ import { clientServiceBundle } from '../services';
 import { Client } from './client';
 
 describe('Client', () => {
+  //
+  // Suite is called for local and remote client configurations.
+  //
   function testSuite (createClient: () => Promise<Client>) {
     describe('initialization', () => {
       test('initialize and destroy', async () => {
@@ -49,10 +52,8 @@ describe('Client', () => {
         afterTest(() => client.destroy());
 
         const profile = await client.halo.createProfile({ username: 'test-user' });
-
         expect(profile).toBeDefined();
         expect(profile?.username).toEqual('test-user');
-
         expect(client.halo.profile).toBeDefined();
       }).timeout(500);
 
@@ -77,10 +78,8 @@ describe('Client', () => {
         const keyPair = keyPairFromSeedPhrase(seedPhrase);
 
         const profile = await client.halo.createProfile({ ...keyPair, username: 'test-user' });
-
         expect(profile).toBeDefined();
         expect(profile?.username).toEqual('test-user');
-
         expect(client.halo.profile).toBeDefined();
 
         const recoveredClient = await createClient();
@@ -119,7 +118,6 @@ describe('Client', () => {
         const invitation = await party.createInvitation();
         invitation.error.on(throwUnhandledRejection);
         const inviteeParty = await invitee.echo.acceptInvitation(invitation.descriptor).getParty();
-
         expect(inviteeParty.key).toEqual(party.key);
 
         const members = party.queryMembers().value;
@@ -289,6 +287,7 @@ describe('Client', () => {
         handlers: hostClient.services,
         port: hostPort
       });
+
       void server.open(); // This blocks until the other client connects.
       afterTest(() => server.close());
 
@@ -296,6 +295,8 @@ describe('Client', () => {
     });
   });
 
+  // TODO(burdon): Factor out tests.
+
   test('late-register models after refresh', async () => {
     const config: ConfigObject = {
       version: 1,
@@ -312,12 +313,14 @@ describe('Client', () => {
     {
       const client = new Client(config);
       await client.initialize();
-      client.registerModel(TestModel);
+      client.echo.registerModel(TestModel);
       // TODO(burdon): Better error if halo is not created.
       await client.halo.createProfile({ username: 'test-user' });
       const party = await client.echo.createParty();
+
       const item = await party.database.createItem({ model: TestModel, type: 'test' });
       await item.model.set('prop', 'value1');
+
       await client.destroy();
     }
 
@@ -327,7 +330,7 @@ describe('Client', () => {
       await waitForCondition(() => !!client.halo.profile);
       await sleep(10); // Make sure all events were processed.
 
-      client.registerModel(TestModel);
+      client.echo.registerModel(TestModel);
 
       const party = client.echo.queryParties().first;
       const result = party.database.select({ type: 'test' }).exec();

package/src/api/client.ts

@@ -58,19 +58,20 @@ export class Client {
 
   private readonly _config: Config;
   private readonly _options: ClientOptions;
-
   private readonly _mode: Runtime.Client.Mode;
+
   private _serviceProvider!: ClientServiceProvider;
   private _halo!: HaloProxy;
   private _echo!: EchoProxy;
-
   private _initialized = false;
 
+  // TODO(burdon): Expose some kind of stable ID (e.g., from HALO).
+
   /**
    * Creates the client object based on supplied configuration.
    * Requires initialization after creating by calling `.initialize()`.
    */
-  // TODO(burdon): Remove or factor out default config?
+  // TODO(burdon): What are the defaults if `{}` is passed?
   constructor (config: ConfigObject | Config = defaultConfig, options: ClientOptions = {}) {
     if (typeof config !== 'object' || config == null) {
       throw new InvalidParameterError('Invalid config.');
@@ -80,12 +81,12 @@ export class Client {
     this._options = options;
 
     if (Object.keys(this._config.values).length > 0 && this._config.values.version !== EXPECTED_CONFIG_VERSION) {
-      throw new InvalidConfigurationError(`Expected config version 1, got ${this._config.values.version}.`);
+      throw new InvalidConfigurationError(
+        `Invalid config version: ${this._config.values.version} !== ${EXPECTED_CONFIG_VERSION}]`);
     }
 
-    // TODO(burdon): Default error level: 'dxos:*:error'
-    // TODO(burdon): config.getProperty('system.debug', process.env.DEBUG, '');
-    debug.enable(this._config.values.runtime?.client?.debug ?? process.env.DEBUG ?? 'dxos:*:error');
+    // TODO(burdon): Library should not set app-level globals.
+    // debug.enable(this._config.values.runtime?.client?.debug ?? process.env.DEBUG ?? 'dxos:*:error');
 
     this._mode = this._config.get('runtime.client.mode', Runtime.Client.Mode.AUTOMATIC)!;
     log(`mode=${Runtime.Client.Mode[this._mode]}`);
@@ -98,7 +99,8 @@ export class Client {
   info () {
     return {
       initialized: this.initialized,
-      echo: this.echo.info()
+      echo: this.echo.info(),
+      halo: this.halo.info()
     };
   }
 
@@ -245,6 +247,7 @@ export class Client {
 
   /**
    * Registers a new ECHO model.
+   * @deprecated
    */
   registerModel (constructor: ModelConstructor<any>): this {
     this._echo.modelFactory.registerModel(constructor);
@@ -254,7 +257,6 @@ export class Client {
   /**
    * Returns devtools context.
    * Used by the DXOS DevTool Extension.
-   *
    * This is what gets assigned to `window.__DXOS__` global.
    */
   getDevtoolsContext (): DevtoolsHook {

package/src/api/proxies/echo-proxy.ts

@@ -9,7 +9,7 @@ import { PublicKey } from '@dxos/crypto';
 import { failUndefined } from '@dxos/debug';
 import { InvitationDescriptor, PARTY_ITEM_TYPE, ResultSet } from '@dxos/echo-db';
 import { PartyKey, PartySnapshot } from '@dxos/echo-protocol';
-import { ModelFactory } from '@dxos/model-factory';
+import { ModelConstructor, ModelFactory } from '@dxos/model-factory';
 import { ObjectModel } from '@dxos/object-model';
 import { ComplexMap, SubscriptionGroup } from '@dxos/util';
 
@@ -33,6 +33,7 @@ export class PartyInvitation extends Invitation<Party> {
 // TODO(burdon): Separate public API form implementation (move comments here).
 export interface Echo {
   info (): { parties: number }
+  registerModel (constructor: ModelConstructor<any>): void
   createParty (): Promise<Party>
   cloneParty (snapshot: PartySnapshot): Promise<Party>
   getParty (partyKey: PartyKey): Party | undefined
@@ -59,6 +60,10 @@ export class EchoProxy implements Echo {
     this._modelFactory.registerModel(ObjectModel); // Register object-model by default.
   }
 
+  toString () {
+    return `EchoProxy(${JSON.stringify(this.info())})`;
+  }
+
   get modelFactory (): ModelFactory {
     return this._modelFactory;
   }
@@ -71,16 +76,18 @@ export class EchoProxy implements Echo {
     throw new Error('Network Manager not available in service proxy.');
   }
 
-  toString () {
-    return `EchoProxy(${JSON.stringify(this.info())})`;
-  }
-
+  // TODO(burdon): Client ID?
   info () {
     return {
       parties: this._parties.size
     };
   }
 
+  registerModel (constructor: ModelConstructor<any>): this {
+    this._modelFactory.registerModel(constructor);
+    return this;
+  }
+
   /**
    * @internal
    */

package/src/api/proxies/halo-proxy.ts

@@ -48,12 +48,12 @@ export class HaloProxy implements Halo {
   private readonly _invitationProxy = new InvitationProxy();
   private readonly _subscriptions = new SubscriptionGroup();
 
+  private readonly _contactsChanged = new Event();
+  public readonly profileChanged = new Event(); // TODO(burdon): Move into Profile object.
+
   private _profile?: Profile;
   private _contacts: PartyMember[] = [];
 
-  private readonly _contactsChanged = new Event();
-  public readonly profileChanged = new Event();
-
   constructor (
     private readonly _serviceProvider: ClientServiceProvider
   ) {}
@@ -74,7 +74,7 @@ export class HaloProxy implements Halo {
 
   /**
    * User profile info.
-  */
+   */
   get profile (): Profile | undefined {
     return this._profile;
   }

package/src/api/proxies/party-proxy.ts

@@ -36,6 +36,7 @@ export interface Party {
   get isOpen (): boolean
   get isActive (): boolean
 
+  // TODO(burdon): Verbs should be on same interface.
   get database (): Database
   get select (): Database['select']
   get reduce (): Database['reduce']
@@ -126,6 +127,7 @@ export class PartyProxy implements Party {
     return this._isActive;
   }
 
+  // TODO(burdon): Invert party/database? (e.g., const db = client.connect()).
   get database (): Database {
     if (!this._database) {
       throw Error('Party not open.');

package/src/devtools/network.ts

@@ -80,6 +80,7 @@ export const getNetworkPeers = (hook: DevtoolsServiceDependencies, request: GetN
   if (!request.topic) {
     throw new Error('Expected a network topic');
   }
+
   const map = hook.networkManager.getSwarmMap(PublicKey.from(request.topic));
   return {
     peers: map?.peers.map(peer => ({

package/src/proto/gen/google/protobuf.ts

@@ -10,6 +10,8 @@ import * as dxos_echo_service from "../dxos/echo/service";
 import * as dxos_echo_snapshot from "../dxos/echo/snapshot";
 import * as dxos_halo_keys from "../dxos/halo/keys";
 import * as dxos_rpc from "../dxos/rpc";
+export interface Empty {
+}
 export interface Any {
     type_url?: string;
     value?: Uint8Array;
@@ -257,5 +259,3 @@ export namespace GeneratedCodeInfo {
         end?: number;
     }
 }
-export interface Empty {
-}

package/src/version.ts

@@ -1 +1 @@
-export const DXOS_VERSION = "2.31.3";
+export const DXOS_VERSION = "2.31.7";