@dxos/echo-db 2.28.3-dev.e4579238 → 2.28.4-dev.424a2abb

package/src/{database → api}/database.ts

@@ -10,14 +10,11 @@ import { ItemID, ItemType } from '@dxos/echo-protocol';
 import { Model, ModelConstructor, ModelFactory, validateModelClass } from '@dxos/model-factory';
 import { ObjectModel } from '@dxos/object-model';
 
-import { Selection } from '.';
-import { DataServiceHost } from './data-service-host';
-import { DatabaseBackend } from './database-backend';
+import { DatabaseBackend, DataServiceHost, ItemManager } from '../database';
 import { Entity } from './entity';
 import { Item } from './item';
-import { ItemManager } from './item-manager';
 import { Link } from './link';
-import { createSelector, RootFilter } from './selection';
+import { Selection, createSelector, RootFilter } from './selection';
 
 export interface ItemCreationOptions<M extends Model> {
   model: ModelConstructor<M>
@@ -161,14 +158,10 @@ export class Database {
    * Waits for item matching the filter to be present and returns it.
    */
   async waitForItem<T extends Model<any>> (filter: RootFilter): Promise<Item<T>> {
-    const query = this.select(filter).query();
-    await query.update.waitForCondition(() => {
-      const { result } = query;
-      return Array.isArray(result) ? result.length > 0 : result !== undefined;
-    });
-
-    const item = Array.isArray(query.result) ? query.result[0] : query.result;
-    assert(item, 'Race condition detected');
+    const result = this.select(filter).query();
+    await result.update.waitForCondition(() => result.entities.length > 0);
+    const item = result.expectOne();
+    assert(item, 'Possible condition detected.');
     return item as Item<T>;
   }
 
@@ -192,7 +185,7 @@ export class Database {
    * @param filter
    */
   reduce<R> (result: R, filter?: RootFilter): Selection<Item<any>, R> {
-    return createSelector(
+    return createSelector<R>(
       () => this._itemManager.items,
       () => this._itemManager.debouncedUpdate,
       this,

package/src/{database → api}/entity.ts

@@ -7,7 +7,7 @@ import { ItemID, ItemType } from '@dxos/echo-protocol';
 import { Model, ModelMeta, StateManager } from '@dxos/model-factory';
 import { SubscriptionGroup } from '@dxos/util';
 
-import { ItemManager } from './item-manager';
+import { ItemManager } from '../database';
 
 /**
  * Base class for all ECHO entitities.

package/src/api/index.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+export * from './database';
+export * from './entity';
+export * from './item';
+export * from './link';
+export * from './result-set';
+export * from './selection';

package/src/{database → api}/item.ts

@@ -7,8 +7,8 @@ import debug from 'debug';
 import { EchoEnvelope, ItemID, ItemMutation, ItemType, FeedWriter } from '@dxos/echo-protocol';
 import { Model, StateManager } from '@dxos/model-factory';
 
+import { ItemManager } from '../database';
 import { Entity } from './entity';
-import { ItemManager } from './item-manager';
 import type { Link } from './link';
 import { Selection, createItemSelector } from './selection';
 

package/src/{database → api}/link.ts

@@ -7,9 +7,9 @@ import assert from 'assert';
 import { ItemID, ItemType } from '@dxos/echo-protocol';
 import { Model, StateManager } from '@dxos/model-factory';
 
+import { ItemManager } from '../database';
 import { Entity } from './entity';
 import { Item } from './item';
-import { ItemManager } from './item-manager';
 
 export interface LinkData {
   sourceId: ItemID

package/src/{database → api}/selection.test.ts

@@ -11,10 +11,10 @@ import { ItemID, ItemType } from '@dxos/echo-protocol';
 import { ModelFactory } from '@dxos/model-factory';
 import { ObjectModel } from '@dxos/object-model';
 
-import { Entity, RootFilter } from '.';
+import { Entity } from './entity';
 import { Item } from './item';
 import { Link } from './link';
-import { createSelector } from './selection';
+import { RootFilter, createSelector } from './selection';
 
 // Use to prevent ultra-long diffs.
 const ids = (entities: Entity[]) => entities.map(entity => entity.id);
@@ -40,9 +40,11 @@ const createLink = (id: ItemID, type: ItemType, source: Item<any>, target: Item<
   return link;
 };
 
-const createRootSelector = (filter?: RootFilter) => createSelector<void>(() => items, () => new Event(), null as any, filter, undefined);
+const createRootSelector = (filter?: RootFilter) =>
+  createSelector<void>(() => items, () => new Event(), null as any, filter, undefined);
 
-const createReducer = <R>(result: R) => createSelector<R>(() => items, () => new Event(), null as any, undefined, result);
+const createReducer = <R>(result: R) =>
+  createSelector<R>(() => items, () => new Event(), null as any, undefined, result);
 
 // TODO(burdon): Use more complex data set (org, person, project, task).
 
@@ -89,33 +91,33 @@ describe('Selection', () => {
     test('all', () => {
       expect(
         createRootSelector()
-          .query().result
+          .query().entities
       ).toHaveLength(items.length);
     });
 
     test('by id', () => {
       expect(
         createRootSelector({ id: org1.id })
-          .query().result
+          .query().entities
       ).toEqual([org1]);
 
       expect(
         createRootSelector({ id: org2.id })
-          .query().result
+          .query().entities
       ).toEqual([org2]);
     });
 
     test('single type', () => {
       expect(
         createRootSelector({ type: ITEM_PROJECT })
-          .query().result
+          .query().entities
       ).toHaveLength(3);
     });
 
     test('multiple types', () => {
       expect(
         createRootSelector({ type: [ITEM_ORG, ITEM_PROJECT] })
-          .query().result
+          .query().entities
       ).toHaveLength(5);
     });
   });
@@ -125,7 +127,7 @@ describe('Selection', () => {
       expect(
         createRootSelector()
           .filter({ type: 'dxos:type.invalid' })
-          .query().result
+          .query().entities
       ).toHaveLength(0);
     });
 
@@ -133,7 +135,7 @@ describe('Selection', () => {
       expect(
         createRootSelector()
           .filter({ type: ITEM_PROJECT })
-          .query().result
+          .query().entities
       ).toHaveLength(3);
     });
 
@@ -141,7 +143,7 @@ describe('Selection', () => {
       expect(
         createRootSelector()
           .filter({ type: [ITEM_ORG, ITEM_PROJECT] })
-          .query().result
+          .query().entities
       ).toHaveLength(5);
     });
 
@@ -149,7 +151,7 @@ describe('Selection', () => {
       expect(
         createRootSelector()
           .filter(item => item.type === ITEM_ORG)
-          .query().result
+          .query().entities
       ).toHaveLength(2);
     });
   });
@@ -160,7 +162,7 @@ describe('Selection', () => {
         createRootSelector()
           .filter({ type: ITEM_ORG })
           .children({ type: ITEM_PROJECT })
-          .query().result
+          .query().entities
       )).toStrictEqual(ids([
         project1,
         project2,
@@ -172,7 +174,7 @@ describe('Selection', () => {
       expect(ids(
         createRootSelector({ id: org1.id })
           .children()
-          .query().result
+          .query().entities
       )).toStrictEqual(ids([
         project1,
         project2,
@@ -188,7 +190,7 @@ describe('Selection', () => {
         createRootSelector()
           .filter({ type: ITEM_PROJECT })
           .parent()
-          .query().result
+          .query().entities
       )).toStrictEqual(ids([
         org1,
         org2
@@ -199,7 +201,7 @@ describe('Selection', () => {
       expect(ids(
         createRootSelector({ id: project1.id })
           .parent()
-          .query().result
+          .query().entities
       )).toStrictEqual(ids([
         org1
       ]));
@@ -209,7 +211,7 @@ describe('Selection', () => {
       expect(
         createRootSelector({ id: org1.id })
           .parent()
-          .query().result
+          .query().entities
       ).toEqual([]);
     });
   });
@@ -220,7 +222,7 @@ describe('Selection', () => {
         createRootSelector({ id: project1.id })
           .links()
           .target()
-          .query().result
+          .query().entities
       )).toStrictEqual(ids([
         person1,
         person2
@@ -231,7 +233,7 @@ describe('Selection', () => {
       expect(
         createRootSelector({ type: ITEM_PROJECT })
           .links()
-          .query().result
+          .query().entities
       ).toHaveLength(links.length);
     });
 
@@ -240,7 +242,7 @@ describe('Selection', () => {
         createRootSelector({ type: ITEM_PERSON })
           .refs()
           .source()
-          .query().result
+          .query().entities
       )).toStrictEqual(ids([
         project1,
         project2
@@ -270,9 +272,8 @@ describe('Selection', () => {
           return { ...rest, numLinks: numLinks + links.length, stage: 'c' };
         })
         .target()
-        .query(); // TODO(burdon): Different verb? (exec?)
+        .query();
 
-      expect(ids(query.result)).toStrictEqual(ids([person1, person2, person3]));
       expect(query.value).toEqual({ numItems: 5, numLinks: 4, stage: 'c' });
     });
   });

package/src/{database → api}/selection.ts

@@ -70,7 +70,7 @@ export type SelectionRoot = Database | Entity;
 /**
  * Returned from each stage of the visitor.
  */
-export type SelectionContext<T extends Entity, R> = [entities: T[], result: R]
+export type SelectionContext<T extends Entity, R> = [entities: T[], result?: R]
 
 /**
  * Visitor callback.
@@ -79,19 +79,18 @@ export type SelectionContext<T extends Entity, R> = [entities: T[], result: R]
  */
 export type Callable<T extends Entity, R> = (entities: T[], result: R) => R
 
-const dedupe = <T>(values: T[]) => Array.from(new Set(values));
-
 /**
  * Factory for selector that provides a root set of items.
  * @param itemsProvider
  * @param updateEventProvider
  * @param root
+ * @param filter
  * @param value Initial reducer value.
  */
 export const createSelector = <R>(
   // Provider is called each time the query is executed.
   itemsProvider: () => Item[],
-  // TODO(burdon): Why is this a provider?
+  // TODO(burdon): Replace with direct event handler.
   updateEventProvider: () => Event<Entity[]>,
   root: SelectionRoot,
   filter: RootFilter | undefined,
@@ -106,7 +105,7 @@ export const createSelector = <R>(
     return [items, value];
   };
 
-  return new Selection(visitor, updateEventProvider(), root);
+  return new Selection(visitor, updateEventProvider(), root, value !== undefined);
 };
 
 /**
@@ -119,7 +118,7 @@ export const createItemSelector = <R>(
   root: Item<any>,
   update: Event<Entity[]>,
   value: R
-): Selection<Item<any>, R> => new Selection(() => [[root], value], update, root);
+): Selection<Item<any>, R> => new Selection(() => [[root], value], update, root, value !== undefined);
 
 /**
  * Selections are used to construct database subscriptions.
@@ -135,11 +134,13 @@ export class Selection<T extends Entity<any>, R = void> {
    * @param _visitor Executes the query.
    * @param _update The unfiltered update event.
    * @param _root The root of the selection. Must be a stable reference.
+   * @param _reducer
    */
   constructor (
     private readonly _visitor: (options: QueryOptions) => SelectionContext<T, R>,
     private readonly _update: Event<Entity[]>,
-    private readonly _root: SelectionRoot
+    private readonly _root: SelectionRoot,
+    private readonly _reducer = false
   ) {}
 
   /**
@@ -148,14 +149,15 @@ export class Selection<T extends Entity<any>, R = void> {
   private _createSubSelection<U extends Entity> (
     map: (context: SelectionContext<T, R>, options: QueryOptions) => SelectionContext<U, R>
   ): Selection<U, R> {
-    return new Selection(options => map(this._visitor(options), options), this._update, this._root);
+    return new Selection(options => map(this._visitor(options), options), this._update, this._root, this._reducer);
   }
 
   /**
    * Finish the selection and return the result.
    */
+  // TODO(burdon): Rename exec.
   query (options: QueryOptions = {}): SelectionResult<T, R> {
-    return new SelectionResult<T, R>(() => this._visitor(options), this._update, this._root);
+    return new SelectionResult<T, R>(() => this._visitor(options), this._update, this._root, this._reducer);
   }
 
   /**
@@ -262,69 +264,96 @@ export class SelectionResult<T extends Entity, R = any> {
    * Fired when there are updates in the selection.
    * Only update that are relevant to the selection cause the update.
    */
-  readonly update = new Event<T[]>();
+  readonly update = new Event<SelectionResult<T>>(); // TODO(burdon): Result result object.
 
-  private _lastResult: SelectionContext<T, R>;
+  private _lastResult: SelectionContext<T, R> = [[]];
 
   constructor (
     private readonly _execute: () => SelectionContext<T, R>,
     private readonly _update: Event<Entity[]>,
-    private readonly _root: SelectionRoot
+    private readonly _root: SelectionRoot,
+    private readonly _reducer: boolean
   ) {
-    this._lastResult = this._execute();
-
-    // TODO(burdon): Query updates are based on
-
-    // TODO(burdon): Every update should update reducer.
+    this.refresh();
 
     // Re-run if deps change.
-    // TODO(burdon): Explain this.
-    // TODO(burdon): Should also fire if entities have been REMOVED from the set?
     this.update.addEffect(() => _update.on(currentEntities => {
-      const result = this._execute();
-      const [entities] = result;
-      const set = new Set([...entities, ...this._lastResult[0]]);
-      this._lastResult = result;
+      const [previousEntities] = this._lastResult;
 
-      if (currentEntities.some(entity => set.has(entity as any))) {
-        this.update.emit(entities);
+      this.refresh();
+
+      // Filters mutation events only if selection (since we can't reason about deps of call methods).
+      const set = new Set([...previousEntities, ...this._lastResult![0]]);
+      if (this._reducer || currentEntities.some(entity => set.has(entity as any))) {
+        this.update.emit(this);
       }
     }));
   }
 
   /**
-   * Get the result of this select.
+   * Re-run query.
    */
-  // TODO(burdon): Rename entities.
-  // TODO(burdon): Don't trigger execute in getter (provide refresh method).
-  get result (): T[] {
-    const [entities] = this._execute();
-    return dedupe(entities);
+  refresh () {
+    const [entities, result] = this._execute();
+    this._lastResult = [dedupe(entities), result];
+    return this;
   }
 
-  // TODO(burdon): Better name for reducer result? Just return value directly?
-  get value (): R {
-    const [, value] = this._execute();
-    return value!;
+  /**
+   * The root of the selection. Either a database or an item. Must be a stable reference.
+   */
+  get root (): SelectionRoot {
+    return this._root;
   }
 
   /**
-   * If the result contains exatly one entity, returns it, errors otherwise.
+   * @deprecated
    */
-  expectOne (): T {
-    const res = this.result;
-    assert(res.length === 1, 'Expected one result, got ' + res.length);
-    return res[0];
+  // TODO(burdon): Remove.
+  // get result () {
+  //   return this.entities;
+  // }
+
+  /**
+   * Get the result of this selection.
+   */
+  get entities (): T[] {
+    if (!this._lastResult) {
+      this.refresh();
+    }
+
+    const [entities] = this._lastResult!;
+    return entities;
   }
 
   /**
-   * The root of the selection. Either a database or an item. Must be a stable reference.
+   * Returns the selection or reducer result.
    */
-  get root (): SelectionRoot {
-    return this._root;
+  get value (): R extends void ? T[] : R {
+    if (!this._lastResult) {
+      this.refresh();
+    }
+
+    const [entities, value] = this._lastResult!;
+    return (this._reducer ? value : entities) as any;
+  }
+
+  /**
+   * Return the first element if the set has exactly one element.
+   */
+  expectOne (): T {
+    const entities = this.entities;
+    assert(entities.length === 1, `Expected one result; got ${entities.length}`);
+    return entities[0];
   }
 }
 
+//
+// Utils
+//
+
+const dedupe = <T>(values: T[]) => Array.from(new Set(values));
+
 const coerceToId = (item: Item | ItemID): ItemID => {
   if (typeof item === 'string') {
     return item;

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

@@ -11,10 +11,10 @@ import { EchoEnvelope, MockFeedWriter, Timeframe } from '@dxos/echo-protocol';
 import { ModelFactory } from '@dxos/model-factory';
 import { ObjectModel } from '@dxos/object-model';
 
+import { Item } from '../api';
 import { DataMirror } from './data-mirror';
 import { DataServiceHost } from './data-service-host';
 import { DataServiceRouter } from './data-service-router';
-import { Item } from './item';
 import { ItemDemuxer } from './item-demuxer';
 import { ItemManager } from './item-manager';
 

package/src/database/data-mirror.ts

@@ -10,7 +10,7 @@ import { failUndefined } from '@dxos/debug';
 import { DataService } from '@dxos/echo-protocol';
 import { Model } from '@dxos/model-factory';
 
-import { Entity } from './entity';
+import { Entity } from '../api';
 import { ItemManager } from './item-manager';
 
 const log = debug('dxos:echo-db:data-mirror');

package/src/database/data-service-host.ts

@@ -18,11 +18,10 @@ import {
   SubscribeEntityStreamResponse
 } from '@dxos/echo-protocol';
 
+import { Item, Link } from '../api';
 import { EntityNotFoundError } from '../errors';
-import { Item } from './item';
 import { ItemDemuxer } from './item-demuxer';
 import { ItemManager } from './item-manager';
-import { Link } from './link';
 
 const log = debug('dxos:echo-db:data-service-host');
 

package/src/database/index.ts

@@ -2,13 +2,11 @@
 // Copyright 2020 DXOS.org
 //
 
-export * from './database';
+export * from './data-mirror';
+export * from './data-service-host';
+export * from './data-service-router';
 export * from './database-backend';
-export * from './entity';
-export * from './item';
-export * from './link';
 export * from './item-demuxer';
 export * from './item-manager';
-export * from './timeframe-clock';
-export * from './selection';
 export * from './testing';
+export * from './timeframe-clock';

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

@@ -14,7 +14,7 @@ import { createTransform } from '@dxos/feed-store';
 import { ModelFactory, TestModel } from '@dxos/model-factory';
 import { ObjectModel } from '@dxos/object-model';
 
-import { Item } from './item';
+import { Item } from '../api';
 import { ItemDemuxer } from './item-demuxer';
 import { ItemManager } from './item-manager';
 

package/src/database/item-demuxer.ts

@@ -7,15 +7,12 @@ import debug from 'debug';
 
 import { Event } from '@dxos/async';
 import { failUndefined } from '@dxos/debug';
-import {
-  DatabaseSnapshot, IEchoStream, ItemID, ItemSnapshot
-} from '@dxos/echo-protocol';
+import { DatabaseSnapshot, IEchoStream, ItemID, ItemSnapshot } from '@dxos/echo-protocol';
 import { createWritable } from '@dxos/feed-store';
 import { Model, ModelFactory, ModelMessage } from '@dxos/model-factory';
 import { jsonReplacer } from '@dxos/util';
 
-import { Entity } from './entity';
-import { Item } from './item';
+import { Entity, Item } from '../api';
 import { ItemManager, ModelConstructionOptions } from './item-manager';
 
 const log = debug('dxos:echo-db:item-demuxer');
@@ -93,7 +90,7 @@ export class ItemDemuxer {
         const item = this._itemManager.getItem(itemId);
         assert(item);
 
-        item._processMutation(itemMutation, itemId => this._itemManager.getItem(itemId));
+        item._processMutation(itemMutation, (itemId: ItemID) => this._itemManager.getItem(itemId));
       }
 
       //

package/src/database/item-manager.ts

@@ -11,10 +11,8 @@ import { timed } from '@dxos/debug';
 import { EchoEnvelope, FeedWriter, ItemID, ItemType, mapFeedWriter, ModelSnapshot } from '@dxos/echo-protocol';
 import { Model, ModelFactory, ModelMessage, ModelType, StateManager } from '@dxos/model-factory';
 
+import { Entity, Item, Link } from '../api';
 import { UnknownModelError } from '../errors';
-import { Entity } from './entity';
-import { Item } from './item';
-import { Link } from './link';
 
 const log = debug('dxos:echo-db:item-manager');
 

package/src/database/testing.ts

@@ -8,9 +8,9 @@ import { PublicKey } from '@dxos/crypto';
 import { EchoEnvelope, MockFeedWriter, Timeframe } from '@dxos/echo-protocol';
 import { ModelFactory } from '@dxos/model-factory';
 
+import { Database } from '../api';
 import { DataServiceHost } from './data-service-host';
 import { DataServiceRouter } from './data-service-router';
-import { Database } from './database';
 import { FeedDatabaseBackend, RemoteDatabaseBackend } from './database-backend';
 
 export const createInMemoryDatabase = async (modelFactory: ModelFactory) => {