@dxos/echo-atom 0.8.4-main.9be5663bfe → 0.8.4-main.abd8ff62ef

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/echo-atom",
-  "version": "0.8.4-main.9be5663bfe",
+  "version": "0.8.4-main.abd8ff62ef",
   "description": "Effect Atom wrappers for ECHO objects with explicit subscriptions.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -20,25 +20,22 @@
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {}
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
     "@effect-atom/atom": "^0.5.1",
-    "@dxos/echo-db": "0.8.4-main.9be5663bfe",
-    "@dxos/echo": "0.8.4-main.9be5663bfe",
-    "@dxos/invariant": "0.8.4-main.9be5663bfe",
-    "@dxos/util": "0.8.4-main.9be5663bfe"
+    "@dxos/echo-db": "0.8.4-main.abd8ff62ef",
+    "@dxos/invariant": "0.8.4-main.abd8ff62ef",
+    "@dxos/echo": "0.8.4-main.abd8ff62ef",
+    "@dxos/util": "0.8.4-main.abd8ff62ef"
   },
   "devDependencies": {
     "effect": "3.20.0",
-    "@dxos/random": "0.8.4-main.9be5663bfe",
-    "@dxos/test-utils": "0.8.4-main.9be5663bfe",
-    "@dxos/context": "0.8.4-main.9be5663bfe"
+    "@dxos/context": "0.8.4-main.abd8ff62ef",
+    "@dxos/random": "0.8.4-main.abd8ff62ef",
+    "@dxos/test-utils": "0.8.4-main.abd8ff62ef"
   },
   "peerDependencies": {
     "effect": "3.20.0"

package/src/atom.test.ts

@@ -55,7 +55,7 @@ describe('Echo Atom - Basic Functionality', () => {
     expect(registry.get(emailAtom)).toBe('test@example.com');
   });
 
-  test('atom updates when object is mutated via Obj.change', () => {
+  test('atom updates when object is mutated via Obj.update', () => {
     const obj = createObject(
       Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
     );
@@ -72,8 +72,8 @@ describe('Echo Atom - Basic Functionality', () => {
       { immediate: true },
     );
 
-    // Mutate object via Obj.change.
-    Obj.change(obj, (obj) => {
+    // Mutate object via Obj.update.
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated';
     });
 
@@ -85,7 +85,7 @@ describe('Echo Atom - Basic Functionality', () => {
     expect(obj.name).toBe('Updated');
   });
 
-  test('property atom supports updater pattern via Obj.change', () => {
+  test('property atom supports updater pattern via Obj.update', () => {
     const obj = createObject(
       Obj.make(TestSchema.Task, {
         title: 'Task',
@@ -104,8 +104,8 @@ describe('Echo Atom - Basic Functionality', () => {
       { immediate: true },
     );
 
-    // Update through Obj.change.
-    Obj.change(obj, (obj) => {
+    // Update through Obj.update.
+    Obj.update(obj, (obj) => {
       obj.title = (obj.title ?? '') + ' Updated';
     });
 
@@ -140,7 +140,7 @@ describe('Echo Atom - Basic Functionality', () => {
     expect(propertyUpdateCount).toBe(1);
 
     // Mutate the standalone object.
-    Obj.change(obj, (obj) => {
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated Standalone';
     });
 
@@ -244,7 +244,7 @@ describe('Echo Atom - Referential Equality', () => {
     expect(updateCount).toBe(1);
 
     // Mutate the object.
-    Obj.change(obj, (obj) => {
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated';
     });
 
@@ -276,7 +276,7 @@ describe('Echo Atom - Referential Equality', () => {
     expect(updateCount).toBe(1);
 
     // Mutate the specific property.
-    Obj.change(obj, (obj) => {
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated';
     });
 

package/src/atom.ts

@@ -188,7 +188,9 @@ const refWithReactiveFamily = Atom.family(<T extends Obj.Unknown>(ref: Ref.Ref<T
   const effect = (get: Atom.Context) =>
     Effect.gen(function* () {
       const snapshot = get(make(ref));
-      if (snapshot == null) return undefined;
+      if (snapshot == null) {
+        return undefined;
+      }
       const option = yield* Obj.getReactiveOption(snapshot);
       return Option.getOrElse(option, () => undefined);
     });
@@ -202,7 +204,7 @@ const refWithReactiveFamily = Atom.family(<T extends Obj.Unknown>(ref: Ref.Ref<T
 /**
  * Like {@link make} but returns the live reactive object instead of a snapshot.
  * Same input: Obj or Ref.Ref. Same output shape: Atom that updates when the object mutates.
- * Prefer {@link make} (snapshot) unless you need the live Obj.Obj for generic mutations (e.g. Obj.change).
+ * Prefer {@link make} (snapshot) unless you need the live Obj.Obj for generic mutations (e.g. Obj.update).
  *
  * @param objOrRef - The reactive object or ref.
  * @returns An atom that returns the live object. Returns undefined for refs (async loading) or undefined input.

package/src/batching.test.ts

@@ -12,7 +12,7 @@ import { TestSchema } from '@dxos/echo/testing';
 import * as AtomObj from './atom';
 
 describe('Echo Atom - Batch Updates', () => {
-  test('multiple updates to same object atom in single Obj.change fire single update', () => {
+  test('multiple updates to same object atom in single Obj.update fire single update', () => {
     const obj = createObject(
       Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
     );
@@ -33,14 +33,14 @@ describe('Echo Atom - Batch Updates', () => {
     const initialCount = updateCount;
     expect(initialCount).toBe(1); // Verify immediate update fired.
 
-    // Make multiple updates to the same object in a single Obj.change call.
-    Obj.change(obj, (obj) => {
+    // Make multiple updates to the same object in a single Obj.update call.
+    Obj.update(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).
+    // Should have fired once for initial + once for the Obj.update (not once per property update).
     expect(updateCount).toBe(2);
 
     // Verify final state.
@@ -50,7 +50,7 @@ describe('Echo Atom - Batch Updates', () => {
     expect(finalValue.username).toBe('updated');
   });
 
-  test('multiple separate Obj.change calls fire separate updates', () => {
+  test('multiple separate Obj.update calls fire separate updates', () => {
     const obj = createObject(
       Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
     );
@@ -71,18 +71,18 @@ describe('Echo Atom - Batch Updates', () => {
     const initialCount = updateCount;
     expect(initialCount).toBe(1);
 
-    // Make multiple separate Obj.change calls.
-    Obj.change(obj, (obj) => {
+    // Make multiple separate Obj.update calls.
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated1';
     });
-    Obj.change(obj, (obj) => {
+    Obj.update(obj, (obj) => {
       obj.email = 'updated@example.com';
     });
-    Obj.change(obj, (obj) => {
+    Obj.update(obj, (obj) => {
       obj.username = 'updated';
     });
 
-    // Should have fired once for initial + once per Obj.change call.
+    // Should have fired once for initial + once per Obj.update call.
     expect(updateCount).toBe(4);
 
     // Verify final state.
@@ -92,7 +92,7 @@ describe('Echo Atom - Batch Updates', () => {
     expect(finalValue.username).toBe('updated');
   });
 
-  test('multiple updates to same property atom in single Obj.change fire single update', () => {
+  test('multiple updates to same property atom in single Obj.update fire single update', () => {
     const obj = createObject(
       Obj.make(TestSchema.Person, { name: 'Test', username: 'test', email: 'test@example.com' }),
     );
@@ -113,14 +113,14 @@ describe('Echo Atom - Batch Updates', () => {
     const initialCount = updateCount;
     expect(initialCount).toBe(1);
 
-    // Make multiple updates to the same property in a single Obj.change call.
-    Obj.change(obj, (obj) => {
+    // Make multiple updates to the same property in a single Obj.update call.
+    Obj.update(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).
+    // Should have fired once for initial + once for the Obj.update (not once per assignment).
     expect(updateCount).toBe(2);
 
     // Verify final state.

package/src/reactivity.test.ts

@@ -28,8 +28,8 @@ describe('Echo Atom - Reactivity', () => {
     // Subscribe to enable reactivity.
     registry.subscribe(atom, () => {});
 
-    // Update the object via Obj.change.
-    Obj.change(obj, (obj) => {
+    // Update the object via Obj.update.
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated';
     });
 
@@ -50,8 +50,8 @@ describe('Echo Atom - Reactivity', () => {
     // Subscribe to enable reactivity.
     registry.subscribe(atom, () => {});
 
-    // Update the property via Obj.change.
-    Obj.change(obj, (obj) => {
+    // Update the property via Obj.update.
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated';
     });
 
@@ -82,8 +82,8 @@ describe('Echo Atom - Reactivity', () => {
       emailUpdateCount++;
     });
 
-    // Update only email property via Obj.change.
-    Obj.change(obj, (obj) => {
+    // Update only email property via Obj.update.
+    Obj.update(obj, (obj) => {
       obj.email = 'updated@example.com';
     });
 
@@ -109,8 +109,8 @@ describe('Echo Atom - Reactivity', () => {
     registry.subscribe(nameAtom, () => {});
     registry.subscribe(emailAtom, () => {});
 
-    // Update multiple properties via Obj.change.
-    Obj.change(obj, (obj) => {
+    // Update multiple properties via Obj.update.
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated';
       obj.email = 'updated@example.com';
     });
@@ -140,15 +140,15 @@ describe('Echo Atom - Reactivity', () => {
     const initialCount = updateCount;
     expect(initialCount).toBe(1);
 
-    // Update object via Obj.change.
-    Obj.change(obj, (obj) => {
+    // Update object via Obj.update.
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated';
     });
-    Obj.change(obj, (obj) => {
+    Obj.update(obj, (obj) => {
       obj.email = 'updated@example.com';
     });
 
-    // Updates fire through Obj.subscribe (one per Obj.change call).
+    // Updates fire through Obj.subscribe (one per Obj.update call).
     expect(updateCount).toBe(initialCount + 2);
 
     // Verify final state - returns snapshot (plain object).
@@ -167,7 +167,7 @@ describe('Echo Atom - Reactivity', () => {
     });
 
     actions.push('before');
-    Obj.change(obj, (obj) => {
+    Obj.update(obj, (obj) => {
       obj.name = 'Updated';
     });
     actions.push('after');
@@ -191,7 +191,7 @@ describe('Echo Atom - Reactivity', () => {
     });
 
     actions.push('before');
-    Obj.change(obj, (obj) => {
+    Obj.update(obj, (obj) => {
       obj.stringArray!.splice(1, 1);
     });
     actions.push('after');
@@ -222,7 +222,7 @@ describe('Echo Atom - Reactivity', () => {
     });
 
     // Reorder in place (e.g. move first to last).
-    Obj.change(obj, (obj) => {
+    Obj.update(obj, (obj) => {
       arrayMove(obj.stringArray!, 0, 2);
     });
 

package/src/ref-atom.test.ts

@@ -5,11 +5,13 @@
 import * as Registry from '@effect-atom/atom/Registry';
 import { afterEach, beforeEach, describe, expect, test } from 'vitest';
 
-import { Obj, Ref } from '@dxos/echo';
+import { Filter, Obj, Ref } from '@dxos/echo';
 import { type EchoDatabase } from '@dxos/echo-db';
 import { EchoTestBuilder } from '@dxos/echo-db/testing';
 import { TestSchema } from '@dxos/echo/testing';
+import { PublicKey } from '@dxos/keys';
 
+import * as AtomObj from './atom';
 import * as AtomRef from './ref-atom';
 
 describe('AtomRef - Basic Functionality', () => {
@@ -60,13 +62,45 @@ describe('AtomRef - Basic Functionality', () => {
     expect(updateCount).toBe(1);
 
     // Mutate target - ref atom does NOT react to this.
-    Obj.change(targetObj, (targetObj) => {
+    Obj.update(targetObj, (targetObj) => {
       targetObj.name = 'Updated';
     });
 
     // Update count should still be 1 - ref atom doesn't subscribe to target changes.
     expect(updateCount).toBe(1);
   });
+
+  // Sibling client (sharing services) creates a brand-new ref target. The atom
+  // must update once the target's document propagates and resolves.
+  test('atom resolves target created by sibling client', async () => {
+    const [spaceKey] = PublicKey.randomSequence();
+    await using peer = await testBuilder.createPeer({
+      types: [TestSchema.Person, TestSchema.Container],
+    });
+    await using db1 = await peer.createDatabase(spaceKey);
+    const parent1 = db1.add(Obj.make(TestSchema.Container, { objects: [] }));
+    await db1.flush();
+
+    await using client2 = await peer.createClient();
+    await using db2 = await peer.openDatabase(spaceKey, db1.rootUrl!, { client: client2 });
+    const [parent2] = await db2.query(Filter.id(parent1.id)).run();
+
+    const newPerson = db2.add(
+      Obj.make(TestSchema.Person, { name: 'Alice', username: 'alice', email: 'alice@example.com' }),
+    );
+    Obj.update(parent2, (parent2) => {
+      parent2.objects = [...(parent2.objects ?? []), Ref.make(newPerson)];
+    });
+    await db2.flush();
+
+    await expect.poll(() => (parent1.objects ?? []).length).toBeGreaterThan(0);
+    const atom = AtomObj.make(parent1.objects![0]);
+
+    let lastValue: any;
+    registry.subscribe(atom, (value) => (lastValue = value), { immediate: true });
+
+    await expect.poll(() => lastValue?.name).toBe('Alice');
+  });
 });
 
 describe('AtomRef - Referential Equality', () => {

package/src/ref-utils.ts

@@ -21,19 +21,34 @@ export const loadRefTarget = <T, R>(
   get: Atom.Context,
   onTargetAvailable: (target: T) => R,
 ): R | undefined => {
+  // Accessing `ref.target` registers a resolution callback when the target is
+  // not yet loaded, so resolution can be observed via `ref.onResolved` below.
   const currentTarget = ref.target;
   if (currentTarget) {
     return onTargetAvailable(currentTarget);
   }
 
-  // Target not loaded yet - trigger async load.
+  // Subscribe to the ref's resolution event in case the target loads later
+  // (e.g. when a sibling client creates the linked object). Without this,
+  // a one-shot async load that fails because the document hasn't propagated
+  // would leave the atom permanently undefined.
+  const unsubscribe = ref.onResolved(() => {
+    const target = ref.target;
+    if (target) {
+      get.setSelf(onTargetAvailable(target));
+    }
+  });
+  get.addFinalizer(unsubscribe);
+
+  // Also try async load (e.g. for objects that need disk loading).
   void ref
     .load()
     .then((loadedTarget) => {
       get.setSelf(onTargetAvailable(loadedTarget));
     })
     .catch(() => {
-      // Loading failed, keep target as undefined.
+      // Loading failed; the resolution subscription above will pick up
+      // cross-client updates when they arrive.
     });
 
   return undefined;