@dxos/client 2.26.2-dev.96e7d25d → 2.27.1-dev.8a89aadf

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/client",
-  "version": "2.26.2-dev.96e7d25d",
+  "version": "2.27.1-dev.8a89aadf",
   "license": "AGPL-3.0",
   "author": "DXOS.org",
   "main": "dist/src/index.js",
@@ -10,21 +10,21 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/async": "2.26.2-dev.96e7d25d",
-    "@dxos/codec-protobuf": "2.26.2-dev.96e7d25d",
-    "@dxos/config": "2.26.2-dev.96e7d25d",
-    "@dxos/credentials": "2.26.2-dev.96e7d25d",
-    "@dxos/crypto": "2.26.2-dev.96e7d25d",
-    "@dxos/debug": "2.26.2-dev.96e7d25d",
-    "@dxos/echo-db": "2.26.2-dev.96e7d25d",
-    "@dxos/echo-protocol": "2.26.2-dev.96e7d25d",
-    "@dxos/feed-store": "2.26.2-dev.96e7d25d",
-    "@dxos/model-factory": "2.26.2-dev.96e7d25d",
-    "@dxos/network-manager": "2.26.2-dev.96e7d25d",
-    "@dxos/object-model": "2.26.2-dev.96e7d25d",
-    "@dxos/proto": "2.26.2-dev.96e7d25d",
-    "@dxos/rpc": "2.26.2-dev.96e7d25d",
-    "@dxos/util": "2.26.2-dev.96e7d25d",
+    "@dxos/async": "2.27.1-dev.8a89aadf",
+    "@dxos/codec-protobuf": "2.27.1-dev.8a89aadf",
+    "@dxos/config": "2.27.1-dev.8a89aadf",
+    "@dxos/credentials": "2.27.1-dev.8a89aadf",
+    "@dxos/crypto": "2.27.1-dev.8a89aadf",
+    "@dxos/debug": "2.27.1-dev.8a89aadf",
+    "@dxos/echo-db": "2.27.1-dev.8a89aadf",
+    "@dxos/echo-protocol": "2.27.1-dev.8a89aadf",
+    "@dxos/feed-store": "2.27.1-dev.8a89aadf",
+    "@dxos/model-factory": "2.27.1-dev.8a89aadf",
+    "@dxos/network-manager": "2.27.1-dev.8a89aadf",
+    "@dxos/object-model": "2.27.1-dev.8a89aadf",
+    "@dxos/proto": "2.27.1-dev.8a89aadf",
+    "@dxos/rpc": "2.27.1-dev.8a89aadf",
+    "@dxos/util": "2.27.1-dev.8a89aadf",
     "@polkadot/keyring": "6.11.1",
     "@polkadot/util": "6.11.1",
     "@polkadot/util-crypto": "6.11.1",
@@ -41,9 +41,9 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@dxos/random-access-multi-storage": "2.26.2-dev.96e7d25d",
-    "@dxos/testutils": "2.26.1",
-    "@dxos/toolchain-node-library": "2.26.1",
+    "@dxos/random-access-multi-storage": "2.27.1-dev.8a89aadf",
+    "@dxos/testutils": "2.27.0",
+    "@dxos/toolchain-node-library": "2.27.0",
     "@types/debug": "^4.1.7",
     "@types/jest": "^26.0.7",
     "@types/level-js": "~4.0.1",

package/src/client/client.test.ts

@@ -7,7 +7,7 @@ import expect from 'expect';
 import { it as test } from 'mocha';
 
 import { sleep, waitForCondition } from '@dxos/async';
-import { ConfigV1Object } from '@dxos/config';
+import { ConfigObject } from '@dxos/config';
 import { generateSeedPhrase, keyPairFromSeedPhrase } from '@dxos/crypto';
 import { throwUnhandledRejection } from '@dxos/debug';
 import { InvitationDescriptor } from '@dxos/echo-db';
@@ -276,7 +276,7 @@ describe('Client', () => {
   });
 
   test('late-register models after refresh', async () => {
-    const config: ConfigV1Object = {
+    const config: ConfigObject = {
       version: 1,
       runtime: {
         client: {

package/src/client/client.ts

@@ -6,19 +6,17 @@ import assert from 'assert';
 import debug from 'debug';
 
 import { synchronized } from '@dxos/async';
-import { Config, ConfigV1Object } from '@dxos/config';
+import { Config, ConfigObject } from '@dxos/config';
 import { InvalidParameterError, TimeoutError } from '@dxos/debug';
-import { OpenProgress, sortItemsTopologically } from '@dxos/echo-db';
-import { DatabaseSnapshot } from '@dxos/echo-protocol';
+import { OpenProgress } from '@dxos/echo-db';
 import { ModelConstructor } from '@dxos/model-factory';
-import { ValueUtil } from '@dxos/object-model';
 import { RpcPort } from '@dxos/rpc';
 
 import { EchoProxy, HaloProxy } from '../api';
 import { DevtoolsHook } from '../devtools';
 import { ClientServiceProvider, ClientServices, RemoteServiceConnectionTimeout } from '../interfaces';
 import { InvalidConfigurationError } from '../interfaces/errors';
-import { System } from '../proto/gen/dxos/config';
+import { Runtime } from '../proto/gen/dxos/config';
 import { createWindowMessagePort, isNode } from '../util';
 import { ClientServiceHost } from './service-host';
 import { ClientServiceProxy } from './service-proxy';
@@ -27,9 +25,9 @@ const log = debug('dxos:client');
 
 const EXPECTED_CONFIG_VERSION = 1;
 
-export const defaultConfig: ConfigV1Object = { version: 1 };
+export const defaultConfig: ConfigObject = { version: 1 };
 
-export const defaultTestingConfig: ConfigV1Object = {
+export const defaultTestingConfig: ConfigObject = {
   version: 1,
   runtime: {
     services: {
@@ -57,7 +55,7 @@ export class Client {
 
   private readonly _config: Config;
   private readonly _options: ClientOptions;
-  private readonly _mode: System.Mode;
+  private readonly _mode: Runtime.Client.Mode;
   private _serviceProvider!: ClientServiceProvider;
 
   private _halo!: HaloProxy;
@@ -69,7 +67,7 @@ export class Client {
    * Creates the client object based on supplied configuration.
    * Requires initialization after creating by calling `.initialize()`.
    */
-  constructor (config: ConfigV1Object | Config = { version: 1 }, options: ClientOptions = {}) {
+  constructor (config: ConfigObject | Config = { version: 1 }, options: ClientOptions = {}) {
     if (typeof config !== 'object' || config == null) {
       throw new InvalidParameterError('Invalid config.');
     }
@@ -85,8 +83,8 @@ export class Client {
     // TODO(burdon): config.getProperty('system.debug', process.env.DEBUG, '');
     debug.enable(this._config.values.runtime?.system?.debug ?? process.env.DEBUG ?? 'dxos:*:error');
 
-    this._mode = this._config.get('runtime.client.mode', System.Mode.AUTOMATIC)!;
-    log(`mode=${System.Mode[this._mode]}`);
+    this._mode = this._config.get('runtime.client.mode', Runtime.Client.Mode.AUTOMATIC)!;
+    log(`mode=${Runtime.Client.Mode[this._mode]}`);
   }
 
   toString () {
@@ -158,9 +156,9 @@ export class Client {
       throw new TimeoutError(`Initialize timed out after ${t}s.`);
     }, t * 1000);
 
-    if (this._mode === System.Mode.REMOTE) {
+    if (this._mode === Runtime.Client.Mode.REMOTE) {
       await this.initializeRemote(onProgressCallback);
-    } else if (this._mode === System.Mode.LOCAL) {
+    } else if (this._mode === Runtime.Client.Mode.LOCAL) {
       await this.initializeLocal(onProgressCallback);
     } else {
       await this.initializeAuto(onProgressCallback);
@@ -237,115 +235,24 @@ export class Client {
     this._initialized = false;
   }
 
-  /**
-   * This is a minimal solution for party restoration functionality.
-   * It has limitations and hacks:
-   * - We have to treat some models in a special way, this is not a generic solution
-   * - We have to recreate relationship between old IDs in newly created IDs
-   * - This won't work when identities are required, e.g. in chess.
-   * This solution is appropriate only for short term, expected to work only in Teamwork
-   */
-  @synchronized
-  async createPartyFromSnapshot (snapshot: DatabaseSnapshot) {
-    const party = await this.echo.createParty();
-    const items = snapshot.items ?? [];
-
-    // We have a brand new item ids after creation, which breaks the old structure of id-parentId mapping.
-    // That's why we have a mapping of old ids to new ids, to be able to recover the child-parent relations.
-    const oldToNewIdMap = new Map<string, string>();
-
-    for (const item of sortItemsTopologically(items)) {
-      assert(item.itemId);
-      assert(item.modelType);
-      assert(item.model);
-
-      const model = this.echo.modelFactory.getModel(item.modelType);
-      if (!model) {
-        console.warn('No model found in model factory (could need registering first): ', item.modelType);
-        continue;
-      }
-
-      let parentId: string | undefined;
-      if (item.parentId) {
-        parentId = oldToNewIdMap.get(item.parentId);
-        assert(parentId, 'Unable to recreate child-parent relationship - missing map record');
-        const parentItem = await party.database.getItem(parentId);
-        assert(parentItem, 'Unable to recreate child-parent relationship - parent not created');
-      }
-
-      const createdItem = await party.database.createItem({
-        model: model.constructor,
-        type: item.itemType,
-        parent: parentId
-      });
-
-      oldToNewIdMap.set(item.itemId, createdItem.id);
-
-      if (item.model.array) {
-        for (const mutation of item.model.array.mutations || []) {
-          const decodedMutation = model.meta.mutation.decode(mutation.mutation);
-          await (createdItem.model as any).write(decodedMutation);
-        }
-      } else if (item.modelType === 'dxos:model/object') {
-        assert(item?.model?.custom);
-        assert(model.meta.snapshotCodec);
-        assert(createdItem?.model);
-
-        const decodedItemSnapshot = model.meta.snapshotCodec.decode(item.model.custom);
-        const obj: any = {};
-        assert(decodedItemSnapshot.root);
-        ValueUtil.applyValue(obj, 'root', decodedItemSnapshot.root);
-
-        // The planner board models have a structure in the object model, which needs to be recreated on new ids.
-        if (item.itemType === 'dxos.org/type/planner/card' && obj.root.listId) {
-          obj.root.listId = oldToNewIdMap.get(obj.root.listId);
-          assert(obj.root.listId, 'Failed to recreate child-parent structure of a planner card');
-        }
-
-        await createdItem.model.setProperties(obj.root);
-      } else if (item.modelType === 'dxos:model/text') {
-        assert(item?.model?.custom);
-        assert(model.meta.snapshotCodec);
-        assert(createdItem?.model);
-
-        const decodedItemSnapshot = model.meta.snapshotCodec.decode(item.model.custom);
-
-        await createdItem.model.restoreFromSnapshot(decodedItemSnapshot);
-      } else {
-        throw new InvalidParameterError(`Unhandled model type: ${item.modelType}`);
-      }
-    }
-
-    return party;
-  }
-
-  //
-  // ECHO.
-  //
-
   /**
    * Registers a new ECHO model.
    */
-  // TODO(burdon): Expose echo directly?
   registerModel (constructor: ModelConstructor<any>): this {
     this.echo.modelFactory.registerModel(constructor);
     return this;
   }
 
-  //
-  // Deprecated.
-  // TODO(burdon): Separate wrapper for devtools?
-  //
-
   /**
    * Returns devtools context.
    * Used by the DXOS DevTool Extension.
    *
-   * @deprecated Service host implements the devtools service itself. This is left for legacy devtools versions.
+   * This is what gets assigned to `window.__DXOS__` global.
    */
   getDevtoolsContext (): DevtoolsHook {
     const devtoolsContext: DevtoolsHook = {
       client: this,
+      // TODO(dmaretskyi): Is serviceHost needed?
       serviceHost: this._serviceProvider
     };
 

package/src/client/local-client.test.ts

@@ -6,32 +6,18 @@ import expect from 'expect';
 import { it as test } from 'mocha';
 
 import { waitForCondition } from '@dxos/async';
-import { ConfigV1Object } from '@dxos/config';
+import { ConfigObject } from '@dxos/config';
 
 import { Client } from './client';
 
 describe('Client', () => {
   describe('Local-only tests', () => {
-    test.skip('recreating party based on snapshot does not fail', async () => {
-      const client = new Client();
-      await client.initialize();
 
-      await client.halo.createProfile({ username: 'test-user' });
-
-      const party = await client.echo.createParty();
-
-      const recreatedParty = await client.createPartyFromSnapshot(party.database.createSnapshot());
-
-      expect(recreatedParty).toBeDefined();
-      // More extensive tests on actual Teamwork models are in Teamwork repo.
-
-      await client.destroy();
-    });
   });
 
   describe('With persistent storage', () => {
     test('persistent storage', async () => {
-      const config: ConfigV1Object = {
+      const config: ConfigObject = {
         version: 1,
         runtime: {
           client: {

package/src/client/service-host/services/system.ts

@@ -8,13 +8,7 @@ import { CreateServicesOpts } from './interfaces';
 export const createSystemService = ({ config, echo }: CreateServicesOpts): SystemService => {
   return {
     getConfig: async () => {
-      return {
-        ...config.values,
-        build: {
-          ...config.values.build,
-          timestamp: undefined // TODO(rzadp): Substitution did not kick in here?.
-        }
-      };
+      return config.values;
     },
     reset: async () => {
       await echo.reset();

package/src/client/service-host/storage.ts

@@ -9,6 +9,7 @@ import memdown from 'memdown';
 import { defs } from '@dxos/config';
 import { createStorage } from '@dxos/random-access-multi-storage';
 
+import StorageDriver = defs.Runtime.Client.Storage.StorageDriver;
 import { InvalidConfigurationError } from '../../interfaces';
 import { isNode } from '../../util';
 
@@ -16,7 +17,7 @@ export type StorageType = 'ram' | 'idb' | 'chrome' | 'firefox' | 'node';
 export type KeyStorageType = 'ram' | 'leveljs' | 'jsondown';
 
 // TODO(burdon): Factor out.
-export const createStorageObjects = (config: defs.System.Storage, snapshotsEnabled = false) => {
+export const createStorageObjects = (config: defs.Runtime.Client.Storage, snapshotsEnabled = false) => {
   const {
     path = 'dxos/storage', // TODO(burdon): Factor out const.
     storageType,
@@ -24,16 +25,16 @@ export const createStorageObjects = (config: defs.System.Storage, snapshotsEnabl
     persistent = false
   } = config ?? {};
 
-  if (persistent && storageType === defs.System.Storage.StorageDriver.RAM) {
+  if (persistent && storageType === StorageDriver.RAM) {
     throw new InvalidConfigurationError('RAM storage cannot be used in persistent mode.');
   }
-  if (!persistent && (storageType !== undefined && storageType !== defs.System.Storage.StorageDriver.RAM)) {
+  if (!persistent && (storageType !== undefined && storageType !== StorageDriver.RAM)) {
     throw new InvalidConfigurationError('Cannot use a persistent storage in not persistent mode.');
   }
-  if (persistent && keyStorage === defs.System.Storage.StorageDriver.RAM) {
+  if (persistent && keyStorage === StorageDriver.RAM) {
     throw new InvalidConfigurationError('RAM key storage cannot be used in persistent mode.');
   }
-  if (!persistent && (keyStorage !== defs.System.Storage.StorageDriver.RAM && keyStorage !== undefined)) {
+  if (!persistent && (keyStorage !== StorageDriver.RAM && keyStorage !== undefined)) {
     throw new InvalidConfigurationError('Cannot use a persistent key storage in not persistent mode.');
   }
 
@@ -61,24 +62,24 @@ const createKeyStorage = (path: string, type?: KeyStorageType) => {
   }
 };
 
-const toStorageType = (type: defs.System.Storage.StorageDriver | undefined): StorageType | undefined => {
+const toStorageType = (type: StorageDriver | undefined): StorageType | undefined => {
   switch (type) {
     case undefined: return undefined;
-    case defs.System.Storage.StorageDriver.RAM: return 'ram';
-    case defs.System.Storage.StorageDriver.CHROME: return 'chrome';
-    case defs.System.Storage.StorageDriver.FIREFOX: return 'firefox';
-    case defs.System.Storage.StorageDriver.IDB: return 'idb';
-    case defs.System.Storage.StorageDriver.NODE: return 'node';
-    default: throw new Error(`Invalid storage type: ${defs.System.Storage.StorageDriver[type]}`);
+    case StorageDriver.RAM: return 'ram';
+    case StorageDriver.CHROME: return 'chrome';
+    case StorageDriver.FIREFOX: return 'firefox';
+    case StorageDriver.IDB: return 'idb';
+    case StorageDriver.NODE: return 'node';
+    default: throw new Error(`Invalid storage type: ${StorageDriver[type]}`);
   }
 };
 
-const toKeyStorageType = (type: defs.System.Storage.StorageDriver | undefined): KeyStorageType | undefined => {
+const toKeyStorageType = (type: StorageDriver | undefined): KeyStorageType | undefined => {
   switch (type) {
     case undefined: return undefined;
-    case defs.System.Storage.StorageDriver.RAM: return 'ram';
-    case defs.System.Storage.StorageDriver.LEVELJS: return 'leveljs';
-    case defs.System.Storage.StorageDriver.JSONDOWN: return 'jsondown';
-    default: throw new Error(`Invalid key storage type: ${defs.System.Storage.StorageDriver[type]}`);
+    case StorageDriver.RAM: return 'ram';
+    case StorageDriver.LEVELJS: return 'leveljs';
+    case StorageDriver.JSONDOWN: return 'jsondown';
+    default: throw new Error(`Invalid key storage type: ${StorageDriver[type]}`);
   }
 };