@dxos/echo 0.8.4-main.ef1bc66f44 → 0.8.4-main.effb148878

package/src/testing/test-data.ts

@@ -3,128 +3,187 @@
 //
 
 import { DatabaseDirectory, ObjectStructure } from '@dxos/echo-protocol';
-import { DXN, ObjectId, PublicKey } from '@dxos/keys';
+import { EchoURI, ObjectId, PublicKey } from '@dxos/keys';
 
 import { Type } from '../index';
-
 import { TestSchema } from './test-schema';
 
-const spaceKey = PublicKey.random();
+// Lazy init: Cloudflare workers disallow non-determinism at module scope (e.g. random keys).
+let cachedSpaceKeyHex: string | undefined;
+const getSpaceKeyHex = (): string => {
+  if (cachedSpaceKeyHex === undefined) {
+    cachedSpaceKeyHex = PublicKey.random().toHex();
+  }
+  return cachedSpaceKeyHex;
+};
+
+let cachedPeopleAlice: DatabaseDirectory | undefined;
+let cachedPeopleBob: DatabaseDirectory | undefined;
+let cachedOrgsDxos: DatabaseDirectory | undefined;
+let cachedOrgsCyberdyne: DatabaseDirectory | undefined;
+let cachedWorksFredCyberdyne: DatabaseDirectory | undefined;
+let cachedWorksAliceAperture: DatabaseDirectory | undefined;
+let cachedTasksTask1: DatabaseDirectory | undefined;
+let cachedTasksTask2: DatabaseDirectory | undefined;
 
 // TODO(burdon): Use Obj.make.
 
 export const PEOPLE = {
-  alice: DatabaseDirectory.make({
-    spaceKey: spaceKey.toHex(),
-    objects: {
-      [ObjectId.random()]: ObjectStructure.makeObject({
-        type: Type.getDXN(TestSchema.Person)!.toString(),
-        data: {
-          name: 'Alice',
+  get alice(): DatabaseDirectory {
+    if (cachedPeopleAlice === undefined) {
+      cachedPeopleAlice = DatabaseDirectory.make({
+        spaceKey: getSpaceKeyHex(),
+        objects: {
+          [ObjectId.random()]: ObjectStructure.makeObject({
+            type: Type.getURI(TestSchema.Person)!,
+            data: {
+              name: 'Alice',
+            },
+          }),
         },
-      }),
-    },
-  }),
-  bob: DatabaseDirectory.make({
-    spaceKey: spaceKey.toHex(),
-    objects: {
-      [ObjectId.random()]: ObjectStructure.makeObject({
-        type: Type.getDXN(TestSchema.Person)!.toString(),
-        data: {
-          name: 'Bob',
+      });
+    }
+    return cachedPeopleAlice;
+  },
+
+  get bob(): DatabaseDirectory {
+    if (cachedPeopleBob === undefined) {
+      cachedPeopleBob = DatabaseDirectory.make({
+        spaceKey: getSpaceKeyHex(),
+        objects: {
+          [ObjectId.random()]: ObjectStructure.makeObject({
+            type: Type.getURI(TestSchema.Person)!,
+            data: {
+              name: 'Bob',
+            },
+          }),
         },
-      }),
-    },
-  }),
+      });
+    }
+    return cachedPeopleBob;
+  },
 };
 
 export const ORGS = {
-  dxos: DatabaseDirectory.make({
-    spaceKey: spaceKey.toHex(),
-    objects: {
-      [ObjectId.random()]: ObjectStructure.makeObject({
-        type: Type.getDXN(TestSchema.Organization)!.toString(),
-        data: {
-          name: 'DXOS',
-          founded: '2023',
+  get dxos(): DatabaseDirectory {
+    if (cachedOrgsDxos === undefined) {
+      cachedOrgsDxos = DatabaseDirectory.make({
+        spaceKey: getSpaceKeyHex(),
+        objects: {
+          [ObjectId.random()]: ObjectStructure.makeObject({
+            type: Type.getURI(TestSchema.Organization)!,
+            data: {
+              name: 'DXOS',
+              founded: '2023',
+            },
+          }),
         },
-      }),
-    },
-  }),
-  cyberdyne: DatabaseDirectory.make({
-    spaceKey: spaceKey.toHex(),
-    objects: {
-      [ObjectId.random()]: ObjectStructure.makeObject({
-        type: Type.getDXN(TestSchema.Organization)!.toString(),
-        data: {
-          name: 'Cyberdyne Systems',
-          founded: '1984',
+      });
+    }
+    return cachedOrgsDxos;
+  },
+
+  get cyberdyne(): DatabaseDirectory {
+    if (cachedOrgsCyberdyne === undefined) {
+      cachedOrgsCyberdyne = DatabaseDirectory.make({
+        spaceKey: getSpaceKeyHex(),
+        objects: {
+          [ObjectId.random()]: ObjectStructure.makeObject({
+            type: Type.getURI(TestSchema.Organization)!,
+            data: {
+              name: 'Cyberdyne Systems',
+              founded: '1984',
+            },
+          }),
         },
-      }),
-    },
-  }),
+      });
+    }
+    return cachedOrgsCyberdyne;
+  },
 };
 
 export const WORKS_FOR = {
-  fredWorksForCyberdyne: DatabaseDirectory.make({
-    spaceKey: spaceKey.toHex(),
-    objects: {
-      [ObjectId.random()]: ObjectStructure.makeRelation({
-        type: Type.getDXN(TestSchema.EmployedBy)!.toString(),
-        source: { '/': DXN.fromLocalObjectId(Object.keys(PEOPLE.bob.objects!)[0]).toString() },
-        target: { '/': DXN.fromLocalObjectId(Object.keys(ORGS.cyberdyne.objects!)[0]).toString() },
-        data: {
-          since: '2020',
-          position: 'Engineer',
+  get fredWorksForCyberdyne(): DatabaseDirectory {
+    if (cachedWorksFredCyberdyne === undefined) {
+      cachedWorksFredCyberdyne = DatabaseDirectory.make({
+        spaceKey: getSpaceKeyHex(),
+        objects: {
+          [ObjectId.random()]: ObjectStructure.makeRelation({
+            type: Type.getURI(TestSchema.EmployedBy)!,
+            source: { '/': EchoURI.make({ objectId: Object.keys(PEOPLE.bob.objects!)[0] }) },
+            target: { '/': EchoURI.make({ objectId: Object.keys(ORGS.cyberdyne.objects!)[0] }) },
+            data: {
+              since: '2020',
+              position: 'Engineer',
+            },
+          }),
         },
-      }),
-    },
-  }),
-  aliceWorksForAperture: DatabaseDirectory.make({
-    spaceKey: spaceKey.toHex(),
-    objects: {
-      [ObjectId.random()]: ObjectStructure.makeRelation({
-        type: Type.getDXN(TestSchema.EmployedBy)!.toString(),
-        source: { '/': DXN.fromLocalObjectId(Object.keys(PEOPLE.alice.objects!)[0]).toString() },
-        target: { '/': DXN.fromLocalObjectId(Object.keys(ORGS.dxos.objects!)[0]).toString() },
-        data: {
-          since: '2018',
-          position: 'Research Scientist',
+      });
+    }
+    return cachedWorksFredCyberdyne;
+  },
+
+  get aliceWorksForAperture(): DatabaseDirectory {
+    if (cachedWorksAliceAperture === undefined) {
+      cachedWorksAliceAperture = DatabaseDirectory.make({
+        spaceKey: getSpaceKeyHex(),
+        objects: {
+          [ObjectId.random()]: ObjectStructure.makeRelation({
+            type: Type.getURI(TestSchema.EmployedBy)!,
+            source: { '/': EchoURI.make({ objectId: Object.keys(PEOPLE.alice.objects!)[0] }) },
+            target: { '/': EchoURI.make({ objectId: Object.keys(ORGS.dxos.objects!)[0] }) },
+            data: {
+              since: '2018',
+              position: 'Research Scientist',
+            },
+          }),
         },
-      }),
-    },
-  }),
+      });
+    }
+    return cachedWorksAliceAperture;
+  },
 };
 
 export const TASKS = {
-  task1: DatabaseDirectory.make({
-    spaceKey: spaceKey.toHex(),
-    objects: {
-      [ObjectId.random()]: ObjectStructure.makeObject({
-        type: Type.getDXN(TestSchema.Task)!.toString(),
-        data: {
-          title: 'Complete project documentation',
-          description: 'Write comprehensive documentation for the new system',
-          status: 'in-progress',
-          dueDate: '2023-12-31',
-          assignee: { '/': DXN.fromLocalObjectId(Object.keys(PEOPLE.bob.objects!)[0]).toString() },
+  get task1(): DatabaseDirectory {
+    if (cachedTasksTask1 === undefined) {
+      cachedTasksTask1 = DatabaseDirectory.make({
+        spaceKey: getSpaceKeyHex(),
+        objects: {
+          [ObjectId.random()]: ObjectStructure.makeObject({
+            type: Type.getURI(TestSchema.Task)!,
+            data: {
+              title: 'Complete project documentation',
+              description: 'Write comprehensive documentation for the new system',
+              status: 'in-progress',
+              dueDate: '2023-12-31',
+              assignee: { '/': EchoURI.make({ objectId: Object.keys(PEOPLE.bob.objects!)[0] }) },
+            },
+          }),
         },
-      }),
-    },
-  }),
-  task2: DatabaseDirectory.make({
-    spaceKey: spaceKey.toHex(),
-    objects: {
-      [ObjectId.random()]: ObjectStructure.makeObject({
-        type: Type.getDXN(TestSchema.Task)!.toString(),
-        data: {
-          title: 'Run experiments',
-          description: 'Conduct series of experiments on the portal device',
-          status: 'pending',
-          dueDate: '2023-11-15',
-          assignee: { '/': DXN.fromLocalObjectId(Object.keys(PEOPLE.alice.objects!)[0]).toString() },
+      });
+    }
+    return cachedTasksTask1;
+  },
+
+  get task2(): DatabaseDirectory {
+    if (cachedTasksTask2 === undefined) {
+      cachedTasksTask2 = DatabaseDirectory.make({
+        spaceKey: getSpaceKeyHex(),
+        objects: {
+          [ObjectId.random()]: ObjectStructure.makeObject({
+            type: Type.getURI(TestSchema.Task)!,
+            data: {
+              title: 'Run experiments',
+              description: 'Conduct series of experiments on the portal device',
+              status: 'pending',
+              dueDate: '2023-11-15',
+              assignee: { '/': EchoURI.make({ objectId: Object.keys(PEOPLE.alice.objects!)[0] }) },
+            },
+          }),
         },
-      }),
-    },
-  }),
+      });
+    }
+    return cachedTasksTask2;
+  },
 };

package/src/testing/test-schema.ts

@@ -4,6 +4,10 @@
 
 import * as Schema from 'effect/Schema';
 
+import { DXN } from '@dxos/keys';
+
+import * as Obj from '../Obj';
+import * as Ref from '../Ref';
 import * as Type from '../Type';
 
 export namespace TestSchema {
@@ -16,13 +20,10 @@ export namespace TestSchema {
    * 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',
-    }),
+    Type.makeObject(DXN.make('com.example.type.expando', '0.1.0')),
   );
 
-  export interface Expando extends Schema.Schema.Type<typeof Expando> {}
+  export type Expando = Type.InstanceType<typeof Expando>;
 
   //
   // Example
@@ -51,8 +52,8 @@ export namespace TestSchema {
     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.Array(Schema.suspend((): Type.Ref<Example> => Type.Ref(Example))),
+    reference: Schema.suspend((): Ref.RefSchema<Example> => Ref.Ref(Example)),
+    referenceArray: Schema.Array(Schema.suspend((): Ref.RefSchema<Example> => Ref.Ref(Example))),
     classInstance: Schema.instanceOf(TestClass),
     other: Schema.Any,
   }).pipe(Schema.partial);
@@ -61,15 +62,10 @@ export namespace TestSchema {
   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.object({
-      typename: 'example.com/type/Example',
-      version: '0.1.0',
-    }),
-  );
+  export const Example = ExampleSchema.pipe(Type.makeObject(DXN.make('com.example.type.example', '0.1.0')));
 
   /** @deprecated Use another test schema or create a specific local test schema. */
-  export interface Example extends Schema.Schema.Type<typeof Example> {}
+  export interface Example extends Type.InstanceType<typeof Example> {}
 
   //
   // Message
@@ -85,14 +81,9 @@ export namespace TestSchema {
     ),
   });
 
-  export const Message = MessageStruct.pipe(
-    Type.object({
-      typename: 'example.com/type/Message',
-      version: '0.1.0',
-    }),
-  );
+  export const Message = MessageStruct.pipe(Type.makeObject(DXN.make('com.example.type.message', '0.1.0')));
 
-  export interface Message extends Schema.Schema.Type<typeof Message> {}
+  export type Message = Type.InstanceType<typeof Message>;
 
   //
   // Organization
@@ -106,14 +97,9 @@ export namespace TestSchema {
         value: Schema.String,
       }),
     ),
-  }).pipe(
-    Type.object({
-      typename: 'example.com/type/Organization',
-      version: '0.1.0',
-    }),
-  );
+  }).pipe(Type.makeObject(DXN.make('com.example.type.organization', '0.1.0')));
 
-  export interface Organization extends Schema.Schema.Type<typeof Organization> {}
+  export type Organization = Type.InstanceType<typeof Organization>;
 
   //
   // Person
@@ -124,8 +110,8 @@ export namespace TestSchema {
     username: Schema.String,
     email: Schema.String,
     age: Schema.Number.pipe(Schema.optional),
-    tasks: Schema.Array(Schema.suspend((): Type.Ref<Task> => Type.Ref(Task))),
-    employer: Schema.optional(Type.Ref(Organization)),
+    tasks: Schema.Array(Schema.suspend((): Ref.RefSchema<Task> => Ref.Ref(Task))),
+    employer: Schema.optional(Ref.Ref(Organization)),
     address: Schema.Struct({
       city: Schema.optional(Schema.String),
       state: Schema.optional(Schema.String),
@@ -139,15 +125,9 @@ export namespace TestSchema {
       label: Schema.String,
       value: Schema.String,
     }).pipe(Schema.Array, Schema.optional),
-  }).pipe(
-    Schema.partial,
-    Type.object({
-      typename: 'example.com/type/Person',
-      version: '0.1.0',
-    }),
-  );
+  }).pipe(Schema.partial, Type.makeObject(DXN.make('com.example.type.person', '0.1.0')));
 
-  export interface Person extends Schema.Schema.Type<typeof Person> {}
+  export interface Person extends Type.InstanceType<typeof Person> {}
 
   //
   // Task
@@ -157,34 +137,27 @@ export namespace TestSchema {
     title: Schema.optional(Schema.String),
     deadline: Schema.optional(Schema.String),
     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.Array(Schema.suspend((): Type.Ref<Task> => Type.Ref(Task)))),
+    assignee: Schema.optional(Ref.Ref(Person)),
+    previous: Schema.optional(Schema.suspend((): Ref.RefSchema<Task> => Ref.Ref(Task))),
+    subTasks: Schema.optional(Schema.Array(Schema.suspend((): Ref.RefSchema<Task> => Ref.Ref(Task)))),
     description: Schema.optional(Schema.String),
-  }).pipe(
-    Schema.partial,
-    Type.object({
-      typename: 'example.com/type/Task',
-      version: '0.1.0',
-    }),
-  );
+  }).pipe(Schema.partial, Type.makeObject(DXN.make('com.example.type.task', '0.1.0')));
 
-  export interface Task extends Schema.Schema.Type<typeof Task> {}
+  export interface Task extends Type.InstanceType<typeof Task> {}
 
   //
   // HasManager
   //
 
   export const HasManager = Schema.Struct({}).pipe(
-    Type.relation({
-      typename: 'example.com/type/HasManager',
-      version: '0.1.0',
+    Type.makeRelation({
+      dxn: DXN.make('com.example.type.hasManager', '0.1.0'),
       source: Person,
       target: Person,
     }),
   );
 
-  export interface HasManager extends Schema.Schema.Type<typeof HasManager> {}
+  export type HasManager = Type.InstanceType<typeof HasManager>;
 
   //
   // EmployedBy
@@ -194,15 +167,14 @@ export namespace TestSchema {
     role: Schema.String,
     since: Schema.optional(Schema.String),
   }).pipe(
-    Type.relation({
-      typename: 'example.com/type/EmployedBy',
-      version: '0.1.0',
+    Type.makeRelation({
+      dxn: DXN.make('com.example.type.employedBy', '0.1.0'),
       source: Person,
       target: Organization,
     }),
   );
 
-  export interface EmployedBy extends Schema.Schema.Type<typeof EmployedBy> {}
+  export type EmployedBy = Type.InstanceType<typeof EmployedBy>;
 
   //
   // RecordType
@@ -215,24 +187,18 @@ export namespace TestSchema {
   }
 
   export const Container = Schema.Struct({
-    objects: Schema.Array(Type.Ref(Type.Obj)),
+    objects: Schema.Array(Ref.Ref(Obj.Unknown)),
     records: Schema.Array(
       Schema.partial(
         Schema.Struct({
           title: Schema.String,
           description: Schema.String,
-          contacts: Schema.Array(Type.Ref(Person)),
+          contacts: Schema.Array(Ref.Ref(Person)),
           type: Schema.Enums(RecordType),
         }),
       ),
     ),
-  }).pipe(
-    Schema.partial,
-    Type.object({
-      typename: 'example.com/type/Container',
-      version: '0.1.0',
-    }),
-  );
+  }).pipe(Schema.partial, Type.makeObject(DXN.make('com.example.type.container', '0.1.0')));
 
-  export interface Container extends Schema.Schema.Type<typeof Container> {}
+  export type Container = Type.InstanceType<typeof Container>;
 }

package/src/testing/util.ts

@@ -8,24 +8,27 @@ import type * as SchemaAST from 'effect/SchemaAST';
 import { assertArgument } from '@dxos/invariant';
 import { deepMapValues } from '@dxos/util';
 
-import { EchoSchema, PersistentSchema, getSchemaTypename, makeObject, subscribe, toJsonSchema } from '../internal';
+import { TypeSchema, getSchemaTypename, getStaticTypeSchema, makeObject, subscribe, toJsonSchema } from '../internal';
+import type * as Type from '../Type';
 
 /**
- * Create a reactive mutable schema that updates when the JSON schema is updated.
+ * Create an in-memory `Type.Type` entity (a `TypeSchema` object) for tests.
+ * Accepts a raw Effect Schema. Pass `Type.getSchema(entity)` to convert a
+ * `Type.Type` entity to its underlying source schema first.
  */
 // TODO(dmaretskyi): Should be replaced by registration of typed object.
-export const createEchoSchema = (schema: Schema.Schema.AnyNoContext, version = '0.1.0'): EchoSchema => {
+export const createEchoSchema = (schema: Schema.Schema.AnyNoContext, version = '0.1.0'): Type.Type => {
   const jsonSchema = toJsonSchema(schema);
   const typename = getSchemaTypename(schema);
   assertArgument(typename, 'typename', 'Schema does not have a typename.');
-  const echoSchema = new EchoSchema(makeObject(PersistentSchema, { typename, version, jsonSchema }));
-
-  // TODO(burdon): Unsubscribe is never called.
-  subscribe(echoSchema.persistentSchema, () => {
-    echoSchema._invalidate();
-  });
-
-  return echoSchema;
+  // typename/version are routed via ObjectMeta (the canonical registry-provenance
+  // pair); they're no longer data fields on `TypeSchema`.
+  return makeObject(
+    getStaticTypeSchema(TypeSchema) as any,
+    { jsonSchema },
+    { keys: [], key: typename, version },
+    TypeSchema,
+  ) as unknown as Type.Type;
 };
 
 /**