@dxos/echo-atom 0.8.4-main.6fa680abb7 → 0.8.4-main.74a063c4e0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-atom",
-  "version": "0.8.4-main.6fa680abb7",
+  "version": "0.8.4-main.74a063c4e0",
   "description": "Effect Atom wrappers for ECHO objects with explicit subscriptions.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -29,18 +29,19 @@
   ],
   "dependencies": {
     "@effect-atom/atom": "^0.5.1",
-    "@dxos/echo-db": "0.8.4-main.6fa680abb7",
-    "@dxos/echo": "0.8.4-main.6fa680abb7",
-    "@dxos/invariant": "0.8.4-main.6fa680abb7",
-    "@dxos/util": "0.8.4-main.6fa680abb7"
+    "@dxos/echo": "0.8.4-main.74a063c4e0",
+    "@dxos/echo-db": "0.8.4-main.74a063c4e0",
+    "@dxos/invariant": "0.8.4-main.74a063c4e0",
+    "@dxos/util": "0.8.4-main.74a063c4e0"
   },
   "devDependencies": {
-    "effect": "3.19.16",
-    "@dxos/test-utils": "0.8.4-main.6fa680abb7",
-    "@dxos/random": "0.8.4-main.6fa680abb7"
+    "effect": "3.20.0",
+    "@dxos/random": "0.8.4-main.74a063c4e0",
+    "@dxos/context": "0.8.4-main.74a063c4e0",
+    "@dxos/test-utils": "0.8.4-main.74a063c4e0"
   },
   "peerDependencies": {
-    "effect": "3.19.16"
+    "effect": "3.20.0"
   },
   "publishConfig": {
     "access": "public"

package/src/atom.test.ts

@@ -6,9 +6,9 @@ import * as Registry from '@effect-atom/atom/Registry';
 import { afterEach, beforeEach, describe, expect, test } from 'vitest';
 
 import { Obj, Ref } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
 import { createObject } from '@dxos/echo-db';
 import { EchoTestBuilder } from '@dxos/echo-db/testing';
+import { TestSchema } from '@dxos/echo/testing';
 
 import * as AtomObj from './atom';
 
@@ -73,8 +73,8 @@ describe('Echo Atom - Basic Functionality', () => {
     );
 
     // Mutate object via Obj.change.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     // Subscription should have fired: immediate + update.
@@ -105,8 +105,8 @@ describe('Echo Atom - Basic Functionality', () => {
     );
 
     // Update through Obj.change.
-    Obj.change(obj, (o) => {
-      o.title = (o.title ?? '') + ' Updated';
+    Obj.change(obj, (obj) => {
+      obj.title = (obj.title ?? '') + ' Updated';
     });
 
     // Subscription should have fired: immediate + update.
@@ -140,8 +140,8 @@ describe('Echo Atom - Basic Functionality', () => {
     expect(propertyUpdateCount).toBe(1);
 
     // Mutate the standalone object.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated Standalone';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated Standalone';
     });
 
     // Both atoms should have received updates.
@@ -244,8 +244,8 @@ describe('Echo Atom - Referential Equality', () => {
     expect(updateCount).toBe(1);
 
     // Mutate the object.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     // The subscription should still work.
@@ -276,8 +276,8 @@ describe('Echo Atom - Referential Equality', () => {
     expect(updateCount).toBe(1);
 
     // Mutate the specific property.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     // The subscription should still work.
@@ -357,7 +357,7 @@ describe('AtomObj.makeWithReactive', () => {
           tasks: [Ref.make(task)],
         }),
       );
-      await db.flush({ indexes: true });
+      await db.flush();
 
       const ref = person.tasks![0];
       const registry = Registry.make();
@@ -381,7 +381,7 @@ describe('AtomObj.makeWithReactive', () => {
           tasks: [Ref.make(task)],
         }),
       );
-      await db.flush({ indexes: true });
+      await db.flush();
 
       const ref = person.tasks![0];
       const registry = Registry.make();
@@ -390,7 +390,7 @@ describe('AtomObj.makeWithReactive', () => {
       expect(registry.get(atom)).toBe(task);
 
       db.remove(task);
-      await db.flush({ indexes: true });
+      await db.flush();
 
       expect(registry.get(atom)).toBeUndefined();
     });

package/src/atom.ts

@@ -161,7 +161,6 @@ export function makeProperty<T extends Obj.Unknown, K extends keyof T>(
   }
 
   assertArgument(Obj.isObject(obj), 'obj', 'Object must be a reactive object');
-  assertArgument(key in obj, 'key', 'Property must exist on object');
   return propertyFamily(obj)(key);
 }
 

package/src/batching.test.ts

@@ -6,8 +6,8 @@ import * as Registry from '@effect-atom/atom/Registry';
 import { describe, expect, test } from 'vitest';
 
 import { Obj } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
 import { createObject } from '@dxos/echo-db';
+import { TestSchema } from '@dxos/echo/testing';
 
 import * as AtomObj from './atom';
 
@@ -34,10 +34,10 @@ describe('Echo Atom - Batch Updates', () => {
     expect(initialCount).toBe(1); // Verify immediate update fired.
 
     // Make multiple updates to the same object in a single Obj.change call.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated1';
-      o.email = 'updated@example.com';
-      o.username = 'updated';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated1';
+      obj.email = 'updated@example.com';
+      obj.username = 'updated';
     });
 
     // Should have fired once for initial + once for the Obj.change (not once per property update).
@@ -72,14 +72,14 @@ describe('Echo Atom - Batch Updates', () => {
     expect(initialCount).toBe(1);
 
     // Make multiple separate Obj.change calls.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated1';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated1';
     });
-    Obj.change(obj, (o) => {
-      o.email = 'updated@example.com';
+    Obj.change(obj, (obj) => {
+      obj.email = 'updated@example.com';
     });
-    Obj.change(obj, (o) => {
-      o.username = 'updated';
+    Obj.change(obj, (obj) => {
+      obj.username = 'updated';
     });
 
     // Should have fired once for initial + once per Obj.change call.
@@ -114,10 +114,10 @@ describe('Echo Atom - Batch Updates', () => {
     expect(initialCount).toBe(1);
 
     // Make multiple updates to the same property in a single Obj.change call.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated1';
-      o.name = 'Updated2';
-      o.name = 'Updated3';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated1';
+      obj.name = 'Updated2';
+      obj.name = 'Updated3';
     });
 
     // Should have fired once for initial + once for the Obj.change (not once per assignment).

package/src/query-atom.test.ts

@@ -6,11 +6,12 @@ import * as Registry from '@effect-atom/atom/Registry';
 import * as Schema from 'effect/Schema';
 import { afterEach, beforeEach, describe, expect, test } from 'vitest';
 
+import { sleep } from '@dxos/async';
 import { Obj, type QueryResult, Type } from '@dxos/echo';
 import { Filter, Query } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
-import { type EchoDatabase } from '@dxos/echo-db';
+import { type EchoDatabase, RuntimeSchemaRegistry } from '@dxos/echo-db';
 import { EchoTestBuilder } from '@dxos/echo-db/testing';
+import { TestSchema } from '@dxos/echo/testing';
 import { SpaceId } from '@dxos/keys';
 
 import * as AtomQuery from './query-atom';
@@ -48,7 +49,7 @@ describe('AtomQuery', () => {
   test('creates atom with initial results', async () => {
     db.add(Obj.make(TestItem, { name: 'Object 1', value: 100 }));
     db.add(Obj.make(TestItem, { name: 'Object 2', value: 100 }));
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const queryResult: QueryResult.QueryResult<TestItem> = db.query(
       Query.select(Filter.type(TestItem, { value: 100 })),
@@ -64,7 +65,7 @@ describe('AtomQuery', () => {
 
   test('registry.subscribe fires on QueryResult changes', async () => {
     db.add(Obj.make(TestItem, { name: 'Initial', value: 200 }));
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const queryResult: QueryResult.QueryResult<TestItem> = db.query(
       Query.select(Filter.type(TestItem, { value: 200 })),
@@ -87,7 +88,7 @@ describe('AtomQuery', () => {
 
     // Add a new object that matches the query.
     db.add(Obj.make(TestItem, { name: 'New Object', value: 200 }));
-    await db.flush({ indexes: true, updates: true });
+    await db.flush({ updates: true });
 
     // Subscription should have fired.
     expect(updateCount).toBeGreaterThan(0);
@@ -97,7 +98,7 @@ describe('AtomQuery', () => {
   test('registry.subscribe fires when objects are removed', async () => {
     const obj1 = db.add(Obj.make(TestItem, { name: 'Object 1', value: 300 }));
     db.add(Obj.make(TestItem, { name: 'Object 2', value: 300 }));
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const queryResult: QueryResult.QueryResult<TestItem> = db.query(
       Query.select(Filter.type(TestItem, { value: 300 })),
@@ -120,7 +121,7 @@ describe('AtomQuery', () => {
 
     // Remove an object.
     db.remove(obj1);
-    await db.flush({ indexes: true, updates: true });
+    await db.flush({ updates: true });
 
     // Subscription should have fired.
     expect(updateCount).toBeGreaterThan(0);
@@ -130,7 +131,7 @@ describe('AtomQuery', () => {
 
   test('unsubscribing from registry stops receiving updates', async () => {
     db.add(Obj.make(TestItem, { name: 'Initial', value: 400 }));
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const queryResult: QueryResult.QueryResult<TestItem> = db.query(
       Query.select(Filter.type(TestItem, { value: 400 })),
@@ -151,7 +152,7 @@ describe('AtomQuery', () => {
 
     // Add object and verify subscription fires.
     db.add(Obj.make(TestItem, { name: 'Object 2', value: 400 }));
-    await db.flush({ indexes: true, updates: true });
+    await db.flush({ updates: true });
     const countAfterFirstAdd = updateCount;
     expect(countAfterFirstAdd).toBeGreaterThan(0);
 
@@ -160,7 +161,7 @@ describe('AtomQuery', () => {
 
     // Add another object.
     db.add(Obj.make(TestItem, { name: 'Object 3', value: 400 }));
-    await db.flush({ indexes: true, updates: true });
+    await db.flush({ updates: true });
 
     // Update count should not have changed after unsubscribe.
     expect(updateCount).toBe(countAfterFirstAdd);
@@ -180,7 +181,7 @@ describe('AtomQuery', () => {
 
   test('multiple atoms from same query share underlying subscription', async () => {
     db.add(Obj.make(TestItem, { name: 'Object', value: 500 }));
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const queryResult: QueryResult.QueryResult<TestItem> = db.query(
       Query.select(Filter.type(TestItem, { value: 500 })),
@@ -261,3 +262,127 @@ describe('AtomQuery with queues', () => {
     expect(results[0].name).toEqual('jane');
   });
 });
+
+const SchemaA = Schema.Struct({
+  name: Schema.String,
+}).pipe(
+  Type.object({
+    typename: 'com.example.type.a',
+    version: '0.1.0',
+  }),
+);
+
+const SchemaB = Schema.Struct({
+  value: Schema.Number,
+}).pipe(
+  Type.object({
+    typename: 'com.example.type.b',
+    version: '0.1.0',
+  }),
+);
+
+describe('AtomQuery.fromQuery with schema registry', () => {
+  let schemaRegistry: RuntimeSchemaRegistry;
+  let registry: Registry.Registry;
+
+  beforeEach(() => {
+    schemaRegistry = new RuntimeSchemaRegistry([]);
+    registry = Registry.make();
+  });
+
+  test('creates atom with initial results from schema query', async ({ expect }) => {
+    await schemaRegistry.register([SchemaA]);
+
+    const queryResult = schemaRegistry.query();
+    const atom = AtomQuery.fromQuery(queryResult);
+    const results = registry.get(atom);
+
+    expect(results).toHaveLength(1);
+    expect(Type.getTypename(results[0])).toBe('com.example.type.a');
+  });
+
+  test('atom updates when new schemas are registered', async ({ expect }) => {
+    await schemaRegistry.register([SchemaA]);
+
+    const queryResult = schemaRegistry.query();
+    const atom = AtomQuery.fromQuery(queryResult);
+
+    // Get initial results and subscribe.
+    const initialResults = registry.get(atom);
+    expect(initialResults).toHaveLength(1);
+
+    let updateCount = 0;
+    let latestResults: Type.AnyEntity[] = [];
+    registry.subscribe(atom, () => {
+      updateCount++;
+      latestResults = registry.get(atom);
+    });
+
+    // Allow reactive query to start (deferred via queueMicrotask).
+    await sleep(10);
+
+    // Register a new schema.
+    await schemaRegistry.register([SchemaB]);
+
+    expect(updateCount).toBeGreaterThan(0);
+    expect(latestResults).toHaveLength(2);
+    expect(latestResults.map(Type.getTypename).sort()).toEqual(['com.example.type.a', 'com.example.type.b']);
+  });
+
+  test('atom works with empty initial results', ({ expect }) => {
+    const queryResult = schemaRegistry.query();
+    const atom = AtomQuery.fromQuery(queryResult);
+    const results = registry.get(atom);
+
+    expect(results).toHaveLength(0);
+  });
+
+  test('atom with filtered query only reflects matching schemas', async ({ expect }) => {
+    const queryResult = schemaRegistry.query({ typename: 'com.example.type.a' });
+    const atom = AtomQuery.fromQuery(queryResult);
+
+    // Get initial (empty) results and subscribe.
+    const initialResults = registry.get(atom);
+    expect(initialResults).toHaveLength(0);
+
+    let latestResults: Type.AnyEntity[] = [];
+    registry.subscribe(atom, () => {
+      latestResults = registry.get(atom);
+    });
+
+    await sleep(10);
+
+    // Register non-matching schema.
+    await schemaRegistry.register([SchemaB]);
+    // Results updated but still empty for this filter.
+    expect(latestResults).toHaveLength(0);
+
+    // Register matching schema.
+    await schemaRegistry.register([SchemaA]);
+    expect(latestResults).toHaveLength(1);
+    expect(Type.getTypename(latestResults[0])).toBe('com.example.type.a');
+  });
+
+  test('unsubscribing from atom stops updates', async ({ expect }) => {
+    const queryResult = schemaRegistry.query();
+    const atom = AtomQuery.fromQuery(queryResult);
+
+    registry.get(atom);
+
+    let updateCount = 0;
+    const unsubscribe = registry.subscribe(atom, () => {
+      updateCount++;
+    });
+
+    await sleep(10);
+
+    await schemaRegistry.register([SchemaA]);
+    const countAfterFirst = updateCount;
+    expect(countAfterFirst).toBeGreaterThan(0);
+
+    unsubscribe();
+
+    await schemaRegistry.register([SchemaB]);
+    expect(updateCount).toBe(countAfterFirst);
+  });
+});

package/src/query-atom.ts

@@ -8,7 +8,7 @@ import { DXN, Database, type Entity, type Filter, Query, type QueryResult } from
 import { WeakDictionary } from '@dxos/util';
 
 /**
- * Create a self-updating atom from an existing QueryResult.
+ * Create a self-updating atom from any QueryResult (e.g. schema registry queries).
  * Internally subscribes to queryResult and uses get.setSelf to update.
  * Cleanup is handled via get.addFinalizer.
  *
@@ -17,18 +17,13 @@ import { WeakDictionary } from '@dxos/util';
  * @param queryResult - The QueryResult to wrap.
  * @returns An atom that automatically updates when query results change.
  */
-export const fromQuery = <T extends Entity.Unknown>(queryResult: QueryResult.QueryResult<T>): Atom.Atom<T[]> =>
+export const fromQuery = <T>(queryResult: QueryResult.QueryResult<T>): Atom.Atom<T[]> =>
   Atom.make((get) => {
-    // TODO(wittjosiah): Consider subscribing to individual objects here as well, and grabbing their snapshots.
-    // Subscribe to QueryResult changes.
     const unsubscribe = queryResult.subscribe(() => {
-      get.setSelf(queryResult.results);
+      get.setSelf(queryResult.runSync());
     });
-
-    // Register cleanup for when atom is no longer used.
     get.addFinalizer(unsubscribe);
-
-    return queryResult.results;
+    return queryResult.runSync();
   });
 
 // Registry: key → Queryable (WeakRef with auto-cleanup when GC'd).

package/src/reactivity.test.ts

@@ -6,8 +6,8 @@ import * as Registry from '@effect-atom/atom/Registry';
 import { describe, expect, test } from 'vitest';
 
 import { Obj } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
 import { createObject } from '@dxos/echo-db';
+import { TestSchema } from '@dxos/echo/testing';
 import { arrayMove } from '@dxos/util';
 
 import * as AtomObj from './atom';
@@ -29,8 +29,8 @@ describe('Echo Atom - Reactivity', () => {
     registry.subscribe(atom, () => {});
 
     // Update the object via Obj.change.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     const updatedSnapshot = registry.get(atom);
@@ -51,8 +51,8 @@ describe('Echo Atom - Reactivity', () => {
     registry.subscribe(atom, () => {});
 
     // Update the property via Obj.change.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated';
     });
 
     expect(registry.get(atom)).toBe('Updated');
@@ -83,8 +83,8 @@ describe('Echo Atom - Reactivity', () => {
     });
 
     // Update only email property via Obj.change.
-    Obj.change(obj, (o) => {
-      o.email = 'updated@example.com';
+    Obj.change(obj, (obj) => {
+      obj.email = 'updated@example.com';
     });
 
     // Name atom should NOT have changed.
@@ -110,9 +110,9 @@ describe('Echo Atom - Reactivity', () => {
     registry.subscribe(emailAtom, () => {});
 
     // Update multiple properties via Obj.change.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
-      o.email = 'updated@example.com';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated';
+      obj.email = 'updated@example.com';
     });
 
     expect(registry.get(nameAtom)).toBe('Updated');
@@ -141,11 +141,11 @@ describe('Echo Atom - Reactivity', () => {
     expect(initialCount).toBe(1);
 
     // Update object via Obj.change.
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated';
     });
-    Obj.change(obj, (o) => {
-      o.email = 'updated@example.com';
+    Obj.change(obj, (obj) => {
+      obj.email = 'updated@example.com';
     });
 
     // Updates fire through Obj.subscribe (one per Obj.change call).
@@ -167,8 +167,8 @@ describe('Echo Atom - Reactivity', () => {
     });
 
     actions.push('before');
-    Obj.change(obj, (o) => {
-      o.name = 'Updated';
+    Obj.change(obj, (obj) => {
+      obj.name = 'Updated';
     });
     actions.push('after');
 
@@ -191,8 +191,8 @@ describe('Echo Atom - Reactivity', () => {
     });
 
     actions.push('before');
-    Obj.change(obj, (o) => {
-      o.stringArray!.splice(1, 1);
+    Obj.change(obj, (obj) => {
+      obj.stringArray!.splice(1, 1);
     });
     actions.push('after');
 

package/src/ref-atom.test.ts

@@ -6,9 +6,9 @@ import * as Registry from '@effect-atom/atom/Registry';
 import { afterEach, beforeEach, describe, expect, test } from 'vitest';
 
 import { Obj, Ref } from '@dxos/echo';
-import { TestSchema } from '@dxos/echo/testing';
 import { type EchoDatabase } from '@dxos/echo-db';
 import { EchoTestBuilder } from '@dxos/echo-db/testing';
+import { TestSchema } from '@dxos/echo/testing';
 
 import * as AtomRef from './ref-atom';
 
@@ -33,7 +33,7 @@ describe('AtomRef - Basic Functionality', () => {
 
     const targetObj = Obj.make(TestSchema.Person, { name: 'Target', username: 'target', email: 'target@example.com' });
     db.add(targetObj);
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const ref = Ref.make(targetObj);
     const atom = AtomRef.make(ref);
@@ -48,7 +48,7 @@ describe('AtomRef - Basic Functionality', () => {
 
     const targetObj = Obj.make(TestSchema.Person, { name: 'Target', username: 'target', email: 'target@example.com' });
     db.add(targetObj);
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const ref = Ref.make(targetObj);
     const atom = AtomRef.make(ref);
@@ -60,8 +60,8 @@ describe('AtomRef - Basic Functionality', () => {
     expect(updateCount).toBe(1);
 
     // Mutate target - ref atom does NOT react to this.
-    Obj.change(targetObj, (o) => {
-      o.name = 'Updated';
+    Obj.change(targetObj, (obj) => {
+      obj.name = 'Updated';
     });
 
     // Update count should still be 1 - ref atom doesn't subscribe to target changes.
@@ -90,7 +90,7 @@ describe('AtomRef - Referential Equality', () => {
 
     const targetObj = Obj.make(TestSchema.Person, { name: 'Target', username: 'target', email: 'target@example.com' });
     db.add(targetObj);
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const ref = Ref.make(targetObj);
 
@@ -116,7 +116,7 @@ describe('AtomRef - Referential Equality', () => {
     });
     db.add(targetObj1);
     db.add(targetObj2);
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const ref1 = Ref.make(targetObj1);
     const ref2 = Ref.make(targetObj2);
@@ -133,7 +133,7 @@ describe('AtomRef - Referential Equality', () => {
 
     const targetObj = Obj.make(TestSchema.Person, { name: 'Target', username: 'target', email: 'target@example.com' });
     db.add(targetObj);
-    await db.flush({ indexes: true });
+    await db.flush();
 
     // Create two separate refs to the same target.
     const ref1 = Ref.make(targetObj);
@@ -158,7 +158,7 @@ describe('AtomRef - Referential Equality', () => {
 
     const targetObj = Obj.make(TestSchema.Person, { name: 'Target', username: 'target', email: 'target@example.com' });
     db.add(targetObj);
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const ref = Ref.make(targetObj);
 
@@ -197,7 +197,7 @@ describe('AtomRef - Expando Objects', () => {
   test('works with Expando objects', async () => {
     const targetObj = Obj.make(TestSchema.Expando, { name: 'Expando Target', value: 42 });
     db.add(targetObj);
-    await db.flush({ indexes: true });
+    await db.flush();
 
     const ref = Ref.make(targetObj);
     const atom = AtomRef.make(ref);