@dxos/echo-atom 0.8.4-main.3eb6e50203 → 0.8.4-main.40e3dcdf1b

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-atom",
-  "version": "0.8.4-main.3eb6e50203",
+  "version": "0.8.4-main.40e3dcdf1b",
   "description": "Effect Atom wrappers for ECHO objects with explicit subscriptions.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -29,17 +29,15 @@
   ],
   "dependencies": {
     "@effect-atom/atom": "^0.5.1",
-    "lodash.isequal": "^4.5.0",
-    "@dxos/echo": "0.8.4-main.3eb6e50203",
-    "@dxos/echo-db": "0.8.4-main.3eb6e50203",
-    "@dxos/invariant": "0.8.4-main.3eb6e50203",
-    "@dxos/util": "0.8.4-main.3eb6e50203"
+    "@dxos/echo": "0.8.4-main.40e3dcdf1b",
+    "@dxos/echo-db": "0.8.4-main.40e3dcdf1b",
+    "@dxos/invariant": "0.8.4-main.40e3dcdf1b",
+    "@dxos/util": "0.8.4-main.40e3dcdf1b"
   },
   "devDependencies": {
-    "@types/lodash.isequal": "^4.5.0",
     "effect": "3.19.16",
-    "@dxos/test-utils": "0.8.4-main.3eb6e50203",
-    "@dxos/random": "0.8.4-main.3eb6e50203"
+    "@dxos/random": "0.8.4-main.40e3dcdf1b",
+    "@dxos/test-utils": "0.8.4-main.40e3dcdf1b"
   },
   "peerDependencies": {
     "effect": "3.19.16"

package/src/atom.test.ts

@@ -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

@@ -7,9 +7,8 @@ import * as Result from '@effect-atom/atom/Result';
 import * as Effect from 'effect/Effect';
 import * as Function from 'effect/Function';
 import * as Option from 'effect/Option';
-import isEqual from 'lodash.isequal';
 
-import { Obj, Ref } from '@dxos/echo';
+import { type Entity, Obj, Ref, Relation } from '@dxos/echo';
 import { assertArgument } from '@dxos/invariant';
 
 import { loadRefTarget } from './ref-utils';
@@ -27,7 +26,7 @@ const objectFamily = Atom.family(<T extends Obj.Unknown>(obj: T): Atom.Atom<Obj.
     get.addFinalizer(() => unsubscribe());
 
     return Obj.getSnapshot(obj);
-  });
+  }).pipe(Atom.keepAlive);
 });
 
 /**
@@ -52,7 +51,7 @@ const refFamily = Atom.family(<T extends Obj.Unknown>(ref: Ref.Ref<T>): Atom.Ato
     });
 
     return loadRefTarget(ref, get, setupTargetSubscription);
-  });
+  }).pipe(Atom.keepAlive);
 });
 
 /**
@@ -84,7 +83,7 @@ const propertyFamily = Atom.family(<T extends Obj.Unknown>(obj: T) =>
 
       const unsubscribe = Obj.subscribe(obj, () => {
         const newValue = obj[key];
-        if (!isEqual(previousSnapshot, newValue)) {
+        if (previousSnapshot !== newValue) {
           previousSnapshot = snapshotForComparison(newValue);
           // Return a snapshot copy so React sees a new reference.
           get.setSelf(snapshotForComparison(newValue));
@@ -95,7 +94,7 @@ const propertyFamily = Atom.family(<T extends Obj.Unknown>(obj: T) =>
 
       // Return a snapshot copy so React sees a new reference.
       return snapshotForComparison(obj[key]);
-    });
+    }).pipe(Atom.keepAlive);
   }),
 );
 
@@ -111,27 +110,30 @@ const propertyFamily = Atom.family(<T extends Obj.Unknown>(obj: T) =>
  * @returns An atom that returns the object snapshot (plain data). Returns undefined only for refs (async loading) or undefined input.
  */
 export function make<T extends Obj.Unknown>(obj: T): Atom.Atom<Obj.Snapshot<T>>;
+export function make<T extends Relation.Unknown>(relation: T): Atom.Atom<Relation.Snapshot<T>>;
+export function make<T extends Entity.Unknown>(entity: T): Atom.Atom<Entity.Snapshot>;
 export function make<T extends Obj.Unknown>(ref: Ref.Ref<T>): Atom.Atom<Obj.Snapshot<T> | undefined>;
 export function make<T extends Obj.Unknown>(
   objOrRef: T | Ref.Ref<T> | undefined,
 ): Atom.Atom<Obj.Snapshot<T> | undefined>;
-export function make<T extends Obj.Unknown>(
+export function make<T extends Entity.Unknown>(
   objOrRef: T | Ref.Ref<T> | undefined,
-): Atom.Atom<Obj.Snapshot<T> | undefined> {
+): Atom.Atom<Entity.Snapshot | undefined> {
   if (objOrRef === undefined) {
-    return Atom.make<Obj.Snapshot<T> | undefined>(() => undefined);
+    return Atom.make<Entity.Snapshot | undefined>(() => undefined);
   }
 
   // Handle Ref inputs.
   if (Ref.isRef(objOrRef)) {
-    return refFamily(objOrRef as Ref.Ref<T>);
+    return refFamily(objOrRef as any);
   }
 
   // At this point, objOrRef is definitely T (not a Ref).
   const obj = objOrRef as T;
-  assertArgument(Obj.isObject(obj), 'obj', 'Object must be a reactive object');
+  assertArgument(Obj.isObject(obj) || Relation.isRelation(obj), 'obj', 'Object must be a reactive object');
 
-  return objectFamily(obj);
+  // TODO(dmaretskyi): Fix echo types during review.
+  return objectFamily(obj as any);
 }
 
 /**
@@ -176,7 +178,7 @@ const objectWithReactiveFamily = Atom.family(<T extends Obj.Unknown>(obj: T): At
     get.addFinalizer(() => unsubscribe());
 
     return obj;
-  });
+  }).pipe(Atom.keepAlive);
 });
 
 /**

package/src/query-atom.test.ts

@@ -7,8 +7,9 @@ import * as Schema from 'effect/Schema';
 import { afterEach, beforeEach, describe, expect, test } from 'vitest';
 
 import { Obj, type QueryResult, Type } from '@dxos/echo';
+import { Filter, Query } from '@dxos/echo';
 import { TestSchema } from '@dxos/echo/testing';
-import { type EchoDatabase, Filter, Query } from '@dxos/echo-db';
+import { type EchoDatabase } from '@dxos/echo-db';
 import { EchoTestBuilder } from '@dxos/echo-db/testing';
 import { SpaceId } from '@dxos/keys';
 
@@ -22,7 +23,7 @@ const TestItem = Schema.Struct({
   value: Schema.Number,
 }).pipe(
   Type.object({
-    typename: 'example.com/type/TestItem',
+    typename: 'com.example.type.test-item',
     version: '0.1.0',
   }),
 );
@@ -47,7 +48,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 })),
@@ -63,7 +64,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 })),
@@ -86,7 +87,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);
@@ -96,7 +97,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 })),
@@ -119,7 +120,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);
@@ -129,7 +130,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 })),
@@ -150,7 +151,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);
 
@@ -159,7 +160,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);
@@ -179,7 +180,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 })),

package/src/query-atom.ts

@@ -37,7 +37,7 @@ const queryableRegistry = new WeakDictionary<string, Database.Queryable>();
 // Key separator that won't appear in identifiers (DXN strings use colons).
 const KEY_SEPARATOR = '~';
 
-// Atom.family keyed by "identifier\0serializedAST".
+// Atom.family keyed by "identifier~serializedAST".
 const queryFamily = Atom.family((key: string) => {
   // Parse key outside Atom.make - runs once per key.
   const separatorIndex = key.indexOf(KEY_SEPARATOR);

package/src/reactivity.test.ts

@@ -8,6 +8,7 @@ import { describe, expect, test } from 'vitest';
 import { Obj } from '@dxos/echo';
 import { TestSchema } from '@dxos/echo/testing';
 import { createObject } from '@dxos/echo-db';
+import { arrayMove } from '@dxos/util';
 
 import * as AtomObj from './atom';
 
@@ -203,4 +204,30 @@ describe('Echo Atom - Reactivity', () => {
 
     unsubscribe();
   });
+
+  test('property atom for array property updates when array is reordered in place', () => {
+    // Verifies that makeProperty(obj, 'columns')-style atoms subscribe to in-place
+    // array mutations (e.g. arrayMove), so UI stays in sync after column reorder.
+    const obj = createObject(Obj.make(TestSchema.Example, { stringArray: ['a', 'b', 'c'] }));
+
+    const registry = Registry.make();
+    const atom = AtomObj.makeProperty(obj, 'stringArray');
+
+    const initial = registry.get(atom);
+    expect(initial).toEqual(['a', 'b', 'c']);
+
+    let updateCount = 0;
+    registry.subscribe(atom, () => {
+      updateCount++;
+    });
+
+    // Reorder in place (e.g. move first to last).
+    Obj.change(obj, (obj) => {
+      arrayMove(obj.stringArray!, 0, 2);
+    });
+
+    expect(updateCount).toBe(1);
+    const afterReorder = registry.get(atom);
+    expect(afterReorder).toEqual(['b', 'c', 'a']);
+  });
 });

package/src/ref-atom.test.ts

@@ -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);
@@ -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);