@dxos/echo-db 2.28.17-dev.1adfe6e6 → 2.28.17-dev.e18b5d13

package/src/api/database.ts

@@ -14,13 +14,13 @@ import { DatabaseBackend, DataServiceHost, ItemManager } from '../database';
 import { Entity } from './entity';
 import { Item } from './item';
 import { Link } from './link';
-import { Selection, createSelector, RootFilter } from './selection';
+import { RootFilter, Selection, createSelector } from './selection';
 
 export interface ItemCreationOptions<M extends Model> {
-  model: ModelConstructor<M>
+  model?: ModelConstructor<M>
   type?: ItemType
   parent?: ItemID
-  props?: any // TODO(marik-d): Type this better.
+  props?: any // TODO(marik-d): Type this better. Rename properties?
 }
 
 export interface LinkCreationOptions<M extends Model, L extends Model, R extends Model> {
@@ -47,7 +47,7 @@ export class Database {
   private _state = State.INITIAL;
 
   /**
-   * Creates a new database instance. `database.init()` must be called afterwards to complete the initialization.
+   * Creates a new database instance. `database.initialize()` must be called afterwards to complete the initialization.
    */
   constructor (
     private readonly _modelFactory: ModelFactory,
@@ -79,7 +79,7 @@ export class Database {
   }
 
   @synchronized
-  async init () {
+  async initialize () {
     if (this._state !== State.INITIAL) {
       throw new Error('Invalid state: database was already initialized.');
     }
@@ -101,12 +101,10 @@ export class Database {
   /**
    * Creates a new item with the given queryable type and model.
    */
-  // TODO(burdon): Get modelType from somewhere other than `ObjectModel.meta.type`.
   async createItem <M extends Model<any>> (options: ItemCreationOptions<M>): Promise<Item<M>> {
     this._assertInitialized();
-
     if (!options.model) {
-      throw new TypeError('Missing model class.');
+      options.model = ObjectModel as any as ModelConstructor<M>;
     }
 
     validateModelClass(options.model);
@@ -119,7 +117,10 @@ export class Database {
       throw new TypeError('Optional parent item id must be a string id of an existing item.');
     }
 
-    return this._itemManager.createItem(options.model.meta.type, options.type, options.parent, options.props) as any;
+    // TODO(burdon): Get modelType from somewhere other than `ObjectModel.meta.type`.
+    const item = await this._itemManager.createItem(
+      options.model.meta.type, options.type, options.parent, options.props) as any;
+    return item;
   }
 
   async createLink<M extends Model<any>, S extends Model<any>, T extends Model<any>> (

package/src/api/item.ts

@@ -51,16 +51,17 @@ export class Item<M extends Model | null = Model> extends Entity<M> {
 
   /**
    * Items are constructed by the `Database` object.
-   * @param {ItemID} itemId       - Addressable ID.
-   * @param {ItemType} itemType   - User defined type (DXN).
-   * @param {Model} model         - Data model (provided by `ModelFactory`).
-   * @param [_writeStream]        - Write stream (if not read-only).
-   * @param {Item<any>} [parent]  - Parent Item (if not a root Item).
+   * @param itemManager
+   * @param itemId        Addressable ID.
+   * @param itemType      User defined type (DXN).
+   * @param stateManager  Data model (provided by `ModelFactory`).
+   * @param _writeStream  Write stream (if not read-only).
+   * @param parent        Parent Item (if not a root Item).
    */
   constructor (
     itemManager: ItemManager,
     itemId: ItemID,
-    itemType: ItemType | undefined, // TODO(burdon): Why undefined?
+    itemType: ItemType | undefined, // TODO(burdon): Why allow undefined?
     stateManager: StateManager<NonNullable<M>>,
     private readonly _writeStream?: FeedWriter<EchoEnvelope>,
     parent?: Item<any> | null

package/src/database/data-mirror.test.ts

@@ -60,9 +60,9 @@ describe('DataMirror', () => {
     // Mutate model
     await Promise.all([
       promiseTimeout(mirroredItem!.model.update.waitForCount(1), 1000, new Error('timeout')),
-      item.model.setProperty('foo', 'bar')
+      item.model.set('foo', 'bar')
     ]);
 
-    expect(item.model.getProperty('foo')).toEqual('bar');
+    expect(item.model.get('foo')).toEqual('bar');
   });
 });

package/src/database/item-demuxer.test.ts

@@ -78,7 +78,7 @@ describe('Item demuxer', () => {
       onUpdate();
     });
 
-    await model.setProperty('title', 'Hello');
+    await model.set('title', 'Hello');
 
     //
     // Wait for model mutation to propagate.

package/src/database/item-manager.ts

@@ -154,7 +154,7 @@ export class ItemManager {
     if (initProps) {
       const meta = this._modelFactory.getModelMeta(modelType);
       if (!meta.getInitMutation) {
-        throw new Error('Tried to provide initialization params to a model with no initializer');
+        throw new Error('Tried to provide initialization params to a model with no initializer.');
       }
       mutation = meta.mutation.encode(await meta.getInitMutation(initProps));
     }

package/src/database/testing.ts

@@ -24,7 +24,7 @@ export const createInMemoryDatabase = async (modelFactory: ModelFactory) => {
     PublicKey.random()
   );
 
-  await database.init();
+  await database.initialize();
   return database;
 };
 
@@ -41,6 +41,6 @@ export const createRemoteDatabaseFromDataServiceHost = async (
     new RemoteDatabaseBackend(dataServiceRouter, partyKey),
     PublicKey.random()
   );
-  await frontend.init();
+  await frontend.initialize();
   return frontend;
 };

package/src/echo.test.ts

@@ -211,8 +211,8 @@ describe('ECHO', () => {
 
     const item = await party.database.createItem({ model: ObjectModel, props: { foo: 'bar', baz: 123 } });
 
-    expect(item.model.getProperty('foo')).toEqual('bar');
-    expect(item.model.getProperty('baz')).toEqual(123);
+    expect(item.model.get('foo')).toEqual('bar');
+    expect(item.model.get('baz')).toEqual(123);
   });
 
   test('open and close', async () => {
@@ -510,7 +510,7 @@ describe('ECHO', () => {
 
     await partyA.setTitle('A');
     expect(partyA.title).toBe('A');
-    expect((await partyA.getPropertiesItem()).model.getProperty('title')).toBe('A');
+    expect((await partyA.getPropertiesItem()).model.get('title')).toBe('A');
 
     await partyA.deactivate({ global: true });
     expect(partyA.isOpen).toBe(false);
@@ -522,7 +522,7 @@ describe('ECHO', () => {
     expect(partyA.isActive).toBe(true);
     expect(partyA.title).toBe('A');
 
-    await waitForCondition(async () => (await partyA.getPropertiesItem()).model.getProperty('title') === 'A', 4000);
+    await waitForCondition(async () => (await partyA.getPropertiesItem()).model.get('title') === 'A', 4000);
   });
 
   test('Deactivating and activating party, setting properties after', async () => {
@@ -713,13 +713,13 @@ describe('ECHO', () => {
     await partyA.setTitle('Test');
 
     for (const party of [partyA, partyB, partyC]) {
-      await waitForCondition(async () => (await partyA.getPropertiesItem()).model.getProperty('title') === 'Test', 3000);
+      await waitForCondition(async () => (await partyA.getPropertiesItem()).model.get('title') === 'Test', 3000);
       await waitForCondition(() => party.title === 'Test', 3000);
       expect(party.title).toEqual('Test');
     }
 
     // For the other member of the party, title propagates correctly as well.
-    await waitForCondition(async () => (await partyA.getPropertiesItem()).model.getProperty('title') === 'Test', 3000);
+    await waitForCondition(async () => (await partyA.getPropertiesItem()).model.get('title') === 'Test', 3000);
     await waitForCondition(() => partyD.title === 'Test', 3000);
     expect(partyD.title).toEqual('Test'); // However this does not.
   }).retries(1);

package/src/halo/party-preferences.ts

@@ -70,6 +70,7 @@ export class PartyPreferences {
     }
   }
 
+  // TODO(burdon): Currently HALO Party stores other party titles? Move to local storage.
   getLastKnownTitle () {
     return this._preferences.getGlobalPartyPreference(this._party.key, PARTY_TITLE_PROPERTY);
   }

package/src/halo/preferences.ts

@@ -4,7 +4,7 @@
 
 import assert from 'assert';
 import stableStringify from 'json-stable-stringify';
-import defaultsDeep from 'lodash/defaultsDeep';
+import defaultsDeep from 'lodash.defaultsdeep';
 
 import { Event } from '@dxos/async';
 import { KeyHint } from '@dxos/credentials';
@@ -86,7 +86,7 @@ export class Preferences {
       return null;
     }
     const deviceItems = this._party.database.select({ type: HALO_PARTY_DEVICE_PREFERENCES_TYPE }).query().entities;
-    return deviceItems.find(item => this._deviceKey.equals(item.model.getProperty('publicKey')));
+    return deviceItems.find(item => this._deviceKey.equals(item.model.get('publicKey')));
   }
 
   public getGlobalPartyPreference (partyKey: PublicKey, key: string) {
@@ -116,23 +116,23 @@ export class Preferences {
   // TODO(burdon): DO NOT USE THE PARTY KEY AS A TOP-LEVEL KEY!
   public _getPartyPreference (preferences: Item<any>, partyKey: PublicKey, key: string) {
     const path = partyKey.toHex();
-    const partyPrefs = preferences.model.getProperty(path, {});
+    const partyPrefs = preferences.model.get(path, {});
     return partyPrefs[key];
   }
 
   // TODO(burdon): DO NOT USE THE PARTY KEY AS A TOP-LEVEL KEY!
   public async _setPartyPreference (preferences: Item<any>, party: PartyInternal, key: string, value: any) {
     const path = party.key.toHex();
-    const partyPrefs = preferences.model.getProperty(path, {});
+    const partyPrefs = preferences.model.get(path, {});
     partyPrefs[key] = value;
-    await preferences.model.setProperty(party.key.toHex(), partyPrefs);
+    await preferences.model.set(party.key.toHex(), partyPrefs);
     party.update.emit(); // TODO(burdon): Should subscribe to database changes only?
   }
 
   async recordPartyJoining (joinedParty: JoinedParty) {
     const [partyDesc] = this._party.database
       .select({ type: HALO_PARTY_DESCRIPTOR_TYPE })
-      .filter(partyMarker => joinedParty.partyKey.equals(partyMarker.model.getProperty('publicKey')))
+      .filter(partyMarker => joinedParty.partyKey.equals(partyMarker.model.get('publicKey')))
       .query().entities;
     assert(!partyDesc, `Descriptor already exists for Party: ${joinedParty.partyKey.toHex()}`);
 
@@ -151,8 +151,8 @@ export class Preferences {
     const converter = (partyDesc: Item<any>) => {
       // TODO(burdon): Define type.
       return {
-        partyKey: PublicKey.from(partyDesc.model.getProperty('publicKey')),
-        keyHints: Object.values(partyDesc.model.getProperty('hints')).map((hint: any) => ({
+        partyKey: PublicKey.from(partyDesc.model.get('publicKey')),
+        keyHints: Object.values(partyDesc.model.get('hints')).map((hint: any) => ({
           ...hint,
           publicKey: PublicKey.from(hint.publicKey)
         } as KeyHint))

package/src/metadata/metadata-store.test.ts

@@ -12,7 +12,6 @@ import { MetadataStore } from './metadata-store';
 describe('MetadataStore in-memory', () => {
   it('Creates party and adds feeds to it', async () => {
     const store = new MetadataStore(createRamStorage());
-
     await store.load();
     expect(store.parties?.length).toBe(0);
 
@@ -35,7 +34,6 @@ describe('MetadataStore in-memory', () => {
 
   it('Creates party when adding feed', async () => {
     const store = new MetadataStore(createRamStorage());
-
     await store.load();
 
     const partyKey = PublicKey.random();
@@ -48,7 +46,6 @@ describe('MetadataStore in-memory', () => {
 
   it('Doesn\'t add same feed twice', async () => {
     const store = new MetadataStore(createRamStorage());
-
     await store.load();
 
     const partyKey = PublicKey.random();

package/src/parties/party-core.test.ts

@@ -83,9 +83,9 @@ describe('PartyCore', () => {
     const { party } = await setup();
 
     const item = await party.database.createItem({ model: ObjectModel });
-    await item.model.setProperty('foo', 'bar');
+    await item.model.set('foo', 'bar');
 
-    expect(item.model.getProperty('foo')).toEqual('bar');
+    expect(item.model.get('foo')).toEqual('bar');
   });
 
   test('create item with parent and then reload', async () => {

package/src/parties/party-core.ts

@@ -151,7 +151,7 @@ export class PartyCore {
       this._memberKey
     );
 
-    await this._database.init();
+    await this._database.initialize();
 
     // TODO(burdon): Propagate errors.
     this._subscriptions.push(this._pipeline.errors.on(err => console.error(err)));

package/src/parties/party-internal.ts

@@ -23,7 +23,8 @@ import { PartyCore, PartyOptions } from './party-core';
 import { CONTACT_DEBOUNCE_INTERVAL } from './party-manager';
 
 export const PARTY_ITEM_TYPE = 'dxos:item/party';
-export const PARTY_TITLE_PROPERTY = 'title';
+
+export const PARTY_TITLE_PROPERTY = 'title'; // TODO(burdon): Remove (should not be special).
 
 // TODO(burdon): Factor out public API.
 export interface PartyMember {
@@ -139,7 +140,7 @@ export class PartyInternal {
 
   async setTitle (title: string) {
     const item = await this.getPropertiesItem();
-    await item.model.setProperty(PARTY_TITLE_PROPERTY, title);
+    await item.model.set(PARTY_TITLE_PROPERTY, title);
     await this._preferences?.setLastKnownTitle(title);
   }
 

package/src/parties/party-manager.test.ts

@@ -499,13 +499,13 @@ describe('Party manager', () => {
     const original = await partyManager.createParty();
     const item1 = await original.database.createItem({ model: ObjectModel });
     const item2 = await original.database.createItem({ model: ObjectModel, parent: item1.id, type: 'example' });
-    await item2.model.setProperty('foo', 'bar');
+    await item2.model.set('foo', 'bar');
 
     const clone = await partyManager.cloneParty(original.createSnapshot());
     expect(clone.key.equals(original.key)).toBe(false);
     const item = await clone.database.getItem(item2.id);
     assert(item);
-    expect(item.model.getProperty('foo')).toBe('bar');
+    expect(item.model.get('foo')).toBe('bar');
     expect(item.parent).toBeDefined();
   });
 });

package/src/parties/party-manager.ts

@@ -4,7 +4,7 @@
 
 import assert from 'assert';
 import debug from 'debug';
-import unionWith from 'lodash/unionWith';
+import unionWith from 'lodash.unionwith';
 
 import { Event, synchronized } from '@dxos/async';
 import { KeyHint, KeyType, SecretProvider } from '@dxos/credentials';
@@ -264,12 +264,10 @@ export class PartyManager {
     }
 
     const identity = this._identityProvider();
-
     const item = await party.getPropertiesItem();
-    const currentTitle = item.model.getProperty(PARTY_TITLE_PROPERTY);
+    const currentTitle = item.model.get(PARTY_TITLE_PROPERTY);
     const storedTitle = identity.preferences?.getGlobalPartyPreference(party.key, PARTY_TITLE_PROPERTY);
     if (storedTitle !== currentTitle) {
-      log(`Updating stored name from ${storedTitle} to ${currentTitle} for Party ${party.key.toHex()}`);
       await identity.preferences?.setGlobalPartyPreference(party, PARTY_TITLE_PROPERTY, currentTitle);
     }
   }
@@ -305,12 +303,12 @@ export class PartyManager {
         if (memberInfo && contact.displayName !== memberInfo.displayName) {
           log(`Updating contact ${hexKey} to ${memberInfo.displayName}`);
           contact.displayName = memberInfo.displayName;
-          await contactListItem.model.setProperty(hexKey, memberInfo);
+          await contactListItem.model.set(hexKey, memberInfo);
         }
       } else {
         const displayName = memberInfo?.displayName ?? hexKey;
         log(`Creating contact ${hexKey} to ${displayName}`);
-        await contactListItem.model.setProperty(hexKey, { publicKey, displayName });
+        await contactListItem.model.set(hexKey, { publicKey, displayName });
       }
     }
   }

package/src/snapshots/snapshot.test.ts

@@ -16,9 +16,8 @@ import { ItemDemuxer, ItemManager } from '../database';
 import { createTestInstance } from '../testing';
 
 const log = debug('dxos:snapshot:test');
-debug.enable('dxos:echo-db:*');
+// debug.enable('dxos:echo-db:*');
 
-// TODO(burdon): Remove "foo", etc from tests.
 describe('snapshot', () => {
   test.skip('loading large party', async () => {
     const echo = await createTestInstance({ initialize: true });
@@ -32,9 +31,9 @@ describe('snapshot', () => {
       const item = await party.database.createItem({ model: ObjectModel });
       itemId = item.id;
       for (let i = 0; i < 1_000; i++) {
-        await item.model.setProperty('foo', i);
+        await item.model.set('foo', i);
       }
-      await item.model.setProperty('foo', 'done');
+      await item.model.set('foo', 'done');
 
       await echo.close();
     }
@@ -47,7 +46,7 @@ describe('snapshot', () => {
 
       await waitForCondition(() => {
         const item = party!.database.getItem(itemId);
-        return item!.model.getProperty('foo') === 'done';
+        return item!.model.get('foo') === 'done';
       });
 
       await echo.close();
@@ -61,9 +60,9 @@ describe('snapshot', () => {
     const echo = await createTestInstance({ initialize: true });
     const party = await echo.createParty();
     const item1 = await party.database.createItem({ model: ObjectModel, props: { title: 'Item1 - Creation' } });
-    await item1.model.setProperty('title', 'Item1 - Modified');
+    await item1.model.set('title', 'Item1 - Modified');
     const item2 = await party.database.createItem({ model: ObjectModel, props: { title: 'Item2 - Creation' } });
-    await item2.model.setProperty('title', 'Item2 - Modified');
+    await item2.model.set('title', 'Item2 - Modified');
 
     const link = await party.database.createLink({ source: item1, target: item2 });
 

package/src/testing/testing-factories.ts

@@ -5,6 +5,7 @@
 import assert from 'assert';
 
 import { Model } from '@dxos/model-factory';
+import { ObjectModel } from '@dxos/object-model';
 import { range } from '@dxos/util';
 
 import { Item, ItemCreationOptions } from '../api';
@@ -57,7 +58,7 @@ export const createModelTestBench = async<M extends Model<any>> (
 ): Promise<{ peers: ECHO[], items: WithTestMeta<Item<M>>[] }> => {
   const { peers, parties } = await createParties(options.peerCount ?? 2);
   for (const party of parties) {
-    const { model } = options;
+    const { model = ObjectModel } = options;
     const { modelFactory } = party.testMeta; // TODO(burdon): Remove.
     if (!modelFactory.hasModel(model.meta.type)) {
       modelFactory.registerModel(model);