@dxos/echo 0.8.4-main.7ace549 → 0.8.4-main.937b3ca

package/src/testing/test-schema.ts

@@ -4,17 +4,33 @@
 
 import * as Schema from 'effect/Schema';
 
-import * as Obj from '../Obj';
 import * as Type from '../Type';
 
 export namespace TestSchema {
+  //
+  // Expando
+  //
+
+  /**
+   * Expando object is an object with an arbitrary set of properties.
+   * This is the test variant with example.com namespace.
+   */
+  export const Expando = Schema.Struct({}, { key: Schema.String, value: Schema.Any }).pipe(
+    Type.object({
+      typename: 'example.com/type/Expando',
+      version: '0.1.0',
+    }),
+  );
+
+  export interface Expando extends Schema.Schema.Type<typeof Expando> {}
+
   //
   // Example
   //
 
   const Nested = Schema.Struct({
     field: Schema.String,
-  }).pipe(Schema.mutable);
+  });
 
   export class TestClass {
     field = 'value';
@@ -30,23 +46,23 @@ export namespace TestSchema {
     boolean: Schema.Boolean,
     null: Schema.Null,
     undefined: Schema.Undefined,
-    stringArray: Schema.mutable(Schema.Array(Schema.String)),
-    twoDimNumberArray: Schema.mutable(Schema.Array(Schema.mutable(Schema.Array(Schema.Number)))),
-    nested: Schema.mutable(Nested),
-    nestedArray: Schema.mutable(Schema.Array(Nested)),
-    nestedNullableArray: Schema.mutable(Schema.Array(Schema.Union(Nested, Schema.Null))),
+    stringArray: Schema.Array(Schema.String),
+    twoDimNumberArray: Schema.Array(Schema.Array(Schema.Number)),
+    nested: Nested,
+    nestedArray: Schema.Array(Nested),
+    nestedNullableArray: Schema.Array(Schema.Union(Nested, Schema.Null)),
     reference: Schema.suspend((): Type.Ref<Example> => Type.Ref(Example)),
-    referenceArray: Schema.mutable(Schema.Array(Schema.suspend((): Type.Ref<Example> => Type.Ref(Example)))),
+    referenceArray: Schema.Array(Schema.suspend((): Type.Ref<Example> => Type.Ref(Example))),
     classInstance: Schema.instanceOf(TestClass),
     other: Schema.Any,
-  }).pipe(Schema.partial, Schema.mutable);
+  }).pipe(Schema.partial);
 
   /** @deprecated Use another test schema or create a specific local test schema. */
   export interface ExampleSchema extends Schema.Schema.Type<typeof ExampleSchema> {}
 
   /** @deprecated Use another test schema or create a specific local test schema. */
   export const Example = ExampleSchema.pipe(
-    Type.Obj({
+    Type.object({
       typename: 'example.com/type/Example',
       version: '0.1.0',
     }),
@@ -70,7 +86,7 @@ export namespace TestSchema {
   });
 
   export const Message = MessageStruct.pipe(
-    Type.Obj({
+    Type.object({
       typename: 'example.com/type/Message',
       version: '0.1.0',
     }),
@@ -84,8 +100,14 @@ export namespace TestSchema {
 
   export const Organization = Schema.Struct({
     name: Schema.String,
+    properties: Schema.optional(
+      Schema.Record({
+        key: Schema.String,
+        value: Schema.String,
+      }),
+    ),
   }).pipe(
-    Type.Obj({
+    Type.object({
       typename: 'example.com/type/Organization',
       version: '0.1.0',
     }),
@@ -101,7 +123,8 @@ export namespace TestSchema {
     name: Schema.String,
     username: Schema.String,
     email: Schema.String,
-    tasks: Schema.mutable(Schema.Array(Schema.suspend((): Type.Ref<Task> => Type.Ref(Task)))),
+    age: Schema.Number.pipe(Schema.optional),
+    tasks: Schema.Array(Schema.suspend((): Type.Ref<Task> => Type.Ref(Task))),
     employer: Schema.optional(Type.Ref(Organization)),
     address: Schema.Struct({
       city: Schema.optional(Schema.String),
@@ -112,9 +135,13 @@ export namespace TestSchema {
         lng: Schema.optional(Schema.Number),
       }),
     }),
+    fields: Schema.Struct({
+      label: Schema.String,
+      value: Schema.String,
+    }).pipe(Schema.Array, Schema.optional),
   }).pipe(
     Schema.partial,
-    Type.Obj({
+    Type.object({
       typename: 'example.com/type/Person',
       version: '0.1.0',
     }),
@@ -132,11 +159,11 @@ export namespace TestSchema {
     completed: Schema.optional(Schema.Boolean),
     assignee: Schema.optional(Type.Ref(Person)),
     previous: Schema.optional(Schema.suspend((): Type.Ref<Task> => Type.Ref(Task))),
-    subTasks: Schema.optional(Schema.mutable(Schema.Array(Schema.suspend((): Type.Ref<Task> => Type.Ref(Task))))),
+    subTasks: Schema.optional(Schema.Array(Schema.suspend((): Type.Ref<Task> => Type.Ref(Task)))),
     description: Schema.optional(Schema.String),
   }).pipe(
     Schema.partial,
-    Type.Obj({
+    Type.object({
       typename: 'example.com/type/Task',
       version: '0.1.0',
     }),
@@ -149,7 +176,7 @@ export namespace TestSchema {
   //
 
   export const HasManager = Schema.Struct({}).pipe(
-    Type.Relation({
+    Type.relation({
       typename: 'example.com/type/HasManager',
       version: '0.1.0',
       source: Person,
@@ -167,7 +194,7 @@ export namespace TestSchema {
     role: Schema.String,
     since: Schema.optional(Schema.String),
   }).pipe(
-    Type.Relation({
+    Type.relation({
       typename: 'example.com/type/EmployedBy',
       version: '0.1.0',
       source: Person,
@@ -188,22 +215,20 @@ export namespace TestSchema {
   }
 
   export const Container = Schema.Struct({
-    objects: Schema.mutable(Schema.Array(Type.Ref(Obj.Any))),
-    records: Schema.mutable(
-      Schema.Array(
-        Schema.partial(
-          Schema.Struct({
-            title: Schema.String,
-            description: Schema.String,
-            contacts: Schema.mutable(Schema.Array(Type.Ref(Person))),
-            type: Schema.Enums(RecordType),
-          }),
-        ),
+    objects: Schema.Array(Type.Ref(Type.Obj)),
+    records: Schema.Array(
+      Schema.partial(
+        Schema.Struct({
+          title: Schema.String,
+          description: Schema.String,
+          contacts: Schema.Array(Type.Ref(Person)),
+          type: Schema.Enums(RecordType),
+        }),
       ),
     ),
   }).pipe(
     Schema.partial,
-    Type.Obj({
+    Type.object({
       typename: 'example.com/type/Container',
       version: '0.1.0',
     }),

package/src/testing/util.ts

@@ -2,17 +2,13 @@
 // Copyright 2024 DXOS.org
 //
 
-import { effect } from '@preact/signals-core';
 import type * as Schema from 'effect/Schema';
 import type * as SchemaAST from 'effect/SchemaAST';
 
-import { registerSignalsRuntime } from '@dxos/echo-signals';
 import { assertArgument } from '@dxos/invariant';
 import { deepMapValues } from '@dxos/util';
 
-import { EchoSchema, PersistentSchema, getSchemaTypename, makeObject, toJsonSchema } from '../internal';
-
-registerSignalsRuntime();
+import { EchoSchema, PersistentSchema, getSchemaTypename, makeObject, subscribe, toJsonSchema } from '../internal';
 
 /**
  * Create a reactive mutable schema that updates when the JSON schema is updated.
@@ -25,8 +21,7 @@ export const createEchoSchema = (schema: Schema.Schema.AnyNoContext, version = '
   const echoSchema = new EchoSchema(makeObject(PersistentSchema, { typename, version, jsonSchema }));
 
   // TODO(burdon): Unsubscribe is never called.
-  effect(() => {
-    const _ = echoSchema.jsonSchema;
+  subscribe(echoSchema.persistentSchema, () => {
     echoSchema._invalidate();
   });
 
@@ -60,17 +55,29 @@ export const prepareAstForCompare = (obj: SchemaAST.AST): any =>
     return recurse(value);
   });
 
-// TODO(burdon): Use @dxos/util.
-export const updateCounter = (touch: () => void) => {
-  let updateCount = -1;
-  const unsubscribe = effect(() => {
-    touch();
-    updateCount++;
-  });
+/**
+ * Creates an update counter that tracks changes to reactive objects.
+ * @param objects - Reactive objects to subscribe to.
+ * @returns An object with a count property and Symbol.dispose for cleanup.
+ */
+export const updateCounter = (...objects: object[]) => {
+  let updateCount = 0;
+
+  const unsubscribes = objects.map((obj) =>
+    subscribe(obj, () => {
+      updateCount++;
+    }),
+  );
+
+  const unsubscribeAll = () => {
+    for (const unsub of unsubscribes) {
+      unsub();
+    }
+  };
 
   return {
     // https://github.com/tc39/proposal-explicit-resource-management
-    [Symbol.dispose]: unsubscribe,
+    [Symbol.dispose]: unsubscribeAll,
     get count() {
       return updateCount;
     },