@dxos/echo 0.8.4-main.2e9d522 → 0.8.4-main.3c1ae3b

package/src/internal/object/schema-validator.test.ts

@@ -0,0 +1,186 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+import { describe, expect, test } from 'vitest';
+
+import { getDeep } from '@dxos/util';
+
+import { SchemaValidator } from './schema-validator';
+
+describe('schema-validator', () => {
+  describe('validateSchema', () => {
+    test('throws on ambiguous discriminated type union', () => {
+      const TestSchema = Schema.Struct({
+        union: Schema.Union(Schema.Struct({ a: Schema.Number }), Schema.Struct({ b: Schema.String })),
+      });
+
+      expect(() => SchemaValidator.validateSchema(TestSchema)).to.throw();
+    });
+  });
+
+  describe('hasPropertyAnnotation', () => {
+    test('has annotation', () => {
+      const annotationId = Symbol('foo');
+      const annotationValue = 'bar';
+      const TestSchema: Schema.Schema.AnyNoContext = Schema.Struct({
+        name: Schema.String.annotations({ [annotationId]: annotationValue }),
+        parent: Schema.optional(Schema.suspend(() => TestSchema.annotations({ [annotationId]: annotationValue }))),
+        friends: Schema.suspend(() =>
+          Schema.mutable(Schema.Array(TestSchema.annotations({ [annotationId]: annotationValue }))),
+        ),
+      });
+      expect(SchemaValidator.hasTypeAnnotation(TestSchema, 'name', annotationId)).to.be.true;
+      expect(SchemaValidator.hasTypeAnnotation(TestSchema, 'parent', annotationId)).to.be.true;
+      expect(SchemaValidator.hasTypeAnnotation(TestSchema, 'friends', annotationId)).to.be.true;
+    });
+
+    test('no annotation', () => {
+      const annotationId = Symbol('foo');
+      const Person: Schema.Schema.AnyNoContext = Schema.Struct({
+        name: Schema.String,
+        parent: Schema.optional(Schema.suspend(() => Person)),
+        friends: Schema.suspend(() => Schema.mutable(Schema.Array(Person))),
+      });
+      expect(SchemaValidator.hasTypeAnnotation(Person, 'name', annotationId)).to.be.false;
+      expect(SchemaValidator.hasTypeAnnotation(Person, 'parent', annotationId)).to.be.false;
+      expect(SchemaValidator.hasTypeAnnotation(Person, 'friends', annotationId)).to.be.false;
+    });
+  });
+
+  describe('getPropertySchema', () => {
+    const validateValueToAssign = (args: {
+      schema: Schema.Schema.AnyNoContext;
+      target: any;
+      path: string[];
+      valueToAssign: any;
+      expectToThrow?: boolean;
+    }) => {
+      const expectation = expect(() => {
+        const nestedSchema = SchemaValidator.getPropertySchema(args.schema, args.path, (path) => {
+          return getDeep(args.target, path);
+        });
+        Schema.validateSync(nestedSchema)(args.valueToAssign);
+      });
+      if (args.expectToThrow) {
+        expectation.to.throw();
+      } else {
+        expectation.not.to.throw();
+      }
+    };
+
+    test('basic', () => {
+      for (const value of [42, '42']) {
+        validateValueToAssign({
+          schema: Schema.Struct({ object: Schema.Struct({ field: Schema.Number }) }),
+          target: {},
+          path: ['object', 'field'],
+          valueToAssign: value,
+          expectToThrow: typeof value !== 'number',
+        });
+      }
+    });
+
+    test('preserves annotations', () => {
+      const annotationId = Symbol('foo');
+      const annotationValue = 'bar';
+      const Person: Schema.Schema.AnyNoContext = Schema.Struct({
+        parent: Schema.optional(Schema.suspend(() => Person.annotations({ [annotationId]: annotationValue }))),
+        friends: Schema.suspend(() =>
+          Schema.mutable(Schema.Array(Person.annotations({ [annotationId]: annotationValue }))),
+        ),
+      });
+      expect(SchemaValidator.getPropertySchema(Person, ['parent']).ast.annotations[annotationId]).to.eq(
+        annotationValue,
+      );
+      expect(SchemaValidator.getPropertySchema(Person, ['friends', '0']).ast.annotations[annotationId]).to.eq(
+        annotationValue,
+      );
+    });
+
+    test('discriminated union', () => {
+      const square = Schema.Struct({ type: Schema.Literal('square'), side: Schema.Number });
+      const circle = Schema.Struct({ type: Schema.Literal('circle'), radius: Schema.Number });
+      const shape = Schema.Union(square, circle);
+      validateValueToAssign({
+        schema: shape,
+        target: { type: 'square' },
+        path: ['side'],
+        valueToAssign: 1,
+      });
+      validateValueToAssign({
+        schema: shape,
+        target: { type: 'circle' },
+        path: ['side'],
+        valueToAssign: 1,
+        expectToThrow: true,
+      });
+      validateValueToAssign({
+        schema: shape,
+        target: { type: 'square' },
+        path: ['radius'],
+        valueToAssign: 1,
+        expectToThrow: true,
+      });
+    });
+
+    test('any', () => {
+      validateValueToAssign({
+        schema: Schema.Any,
+        target: { field: { nested: { value: Schema.Number } } },
+        path: ['field', 'nested'],
+        valueToAssign: { any: 'value' },
+      });
+    });
+    test('index signatures', () => {
+      for (const value of [42, '42']) {
+        validateValueToAssign({
+          schema: Schema.Struct({ field: Schema.String }, { key: Schema.String, value: Schema.Number }),
+          target: {},
+          path: ['unknownField'],
+          valueToAssign: value,
+          expectToThrow: typeof value !== 'number',
+        });
+      }
+    });
+
+    test('index signature from optional record', () => {
+      for (const value of [42, '42']) {
+        validateValueToAssign({
+          schema: Schema.Struct({
+            field: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Number })),
+          }),
+          target: {},
+          path: ['field', 'unknownField'],
+          valueToAssign: value,
+          expectToThrow: typeof value !== 'number',
+        });
+      }
+    });
+
+    test('suspend', () => {
+      const schemaWithSuspend = Schema.Struct({
+        array: Schema.optional(Schema.suspend(() => Schema.Array(Schema.Union(Schema.Null, Schema.Number)))),
+        object: Schema.optional(
+          Schema.suspend(() => Schema.Union(Schema.Null, Schema.Struct({ field: Schema.Number }))),
+        ),
+      });
+      const target: any = { array: [1, 2, null], object: { field: 3 } };
+      for (const value of [42, '42']) {
+        for (const path of [
+          ['array', '0'],
+          ['object', 'field'],
+        ]) {
+          validateValueToAssign({
+            schema: schemaWithSuspend,
+            target,
+            path,
+            valueToAssign: value,
+            expectToThrow: typeof value !== 'number',
+          });
+        }
+      }
+    });
+  });
+});

package/src/internal/object/schema-validator.ts

@@ -0,0 +1,244 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+
+import { invariant } from '@dxos/invariant';
+import { log } from '@dxos/log';
+
+import { SchemaId } from '../types';
+
+// TODO(burdon): Reconcile with @dxos/effect visit().
+
+export class SchemaValidator {
+  /**
+   * Recursively check that schema specifies constructions we can handle.
+   * Validates there are no ambiguous discriminated union types.
+   */
+  public static validateSchema(schema: Schema.Schema.AnyNoContext): void {
+    const visitAll = (nodes: SchemaAST.AST[]) => nodes.forEach((node) => this.validateSchema(Schema.make(node)));
+    if (SchemaAST.isUnion(schema.ast)) {
+      const typeAstList = schema.ast.types.filter((type) => SchemaAST.isTypeLiteral(type)) as SchemaAST.TypeLiteral[];
+      // Check we can handle a discriminated union.
+      if (typeAstList.length > 1) {
+        getTypeDiscriminators(typeAstList);
+      }
+      visitAll(typeAstList);
+    } else if (SchemaAST.isTupleType(schema.ast)) {
+      const positionalTypes = schema.ast.elements.map((t) => t.type);
+      const allTypes = positionalTypes.concat(schema.ast.rest.map((t) => t.type));
+      visitAll(allTypes);
+    } else if (SchemaAST.isTypeLiteral(schema.ast)) {
+      visitAll(SchemaAST.getPropertySignatures(schema.ast).map((p) => p.type));
+    }
+  }
+
+  public static hasTypeAnnotation(
+    rootObjectSchema: Schema.Schema.AnyNoContext,
+    property: string,
+    annotation: symbol,
+  ): boolean {
+    try {
+      let type = this.getPropertySchema(rootObjectSchema, [property]);
+      if (SchemaAST.isTupleType(type.ast)) {
+        type = this.getPropertySchema(rootObjectSchema, [property, '0']);
+      }
+
+      return type.ast.annotations[annotation] != null;
+    } catch {
+      return false;
+    }
+  }
+
+  public static getPropertySchema(
+    rootObjectSchema: Schema.Schema.AnyNoContext,
+    propertyPath: KeyPath,
+    getProperty: (path: KeyPath) => any = () => null,
+  ): Schema.Schema.AnyNoContext {
+    let schema: Schema.Schema.AnyNoContext = rootObjectSchema;
+    for (let i = 0; i < propertyPath.length; i++) {
+      const propertyName = propertyPath[i];
+      const tupleAst = unwrapArray(schema.ast);
+      if (tupleAst != null) {
+        schema = getArrayElementSchema(tupleAst, propertyName);
+      } else {
+        const propertyType = getPropertyType(schema.ast, propertyName.toString(), (propertyName) =>
+          getProperty([...propertyPath.slice(0, i), propertyName]),
+        );
+        if (propertyType == null) {
+          log.warn('unknown property', { path: propertyPath, property: propertyName });
+          continue;
+        }
+
+        schema = Schema.make(propertyType).annotations(propertyType.annotations);
+      }
+    }
+
+    return schema;
+  }
+
+  public static getTargetPropertySchema(target: any, prop: string | symbol): Schema.Schema.AnyNoContext {
+    const schema: Schema.Schema.AnyNoContext | undefined = (target as any)[SchemaId];
+    invariant(schema, 'target has no schema');
+    const arrayAst = unwrapArray(schema.ast);
+    if (arrayAst != null) {
+      return getArrayElementSchema(arrayAst, prop);
+    }
+
+    const propertyType = getPropertyType(schema.ast, prop.toString(), (prop) => target[prop]);
+    if (propertyType == null) {
+      return Schema.Any; // TODO(burdon): HACK.
+    }
+
+    invariant(propertyType, `invalid property: ${prop.toString()}`);
+    return Schema.make(propertyType);
+  }
+}
+
+/**
+ * Tuple AST is used both for:
+ * fixed-length tuples ([string, number]) in which case AST will be { elements: [Schema.String, Schema.Number] }
+ * variable-length arrays (Array<string | number>) in which case AST will be { rest: [Schema.Union(Schema.String, Schema.Number)] }
+ */
+const getArrayElementSchema = (
+  tupleAst: SchemaAST.TupleType,
+  property: string | symbol | number,
+): Schema.Schema.AnyNoContext => {
+  const elementIndex = typeof property === 'string' ? parseInt(property, 10) : Number.NaN;
+  if (Number.isNaN(elementIndex)) {
+    invariant(property === 'length', `invalid array property: ${String(property)}`);
+    return Schema.Number;
+  }
+  if (elementIndex < tupleAst.elements.length) {
+    const elementType = tupleAst.elements[elementIndex].type;
+    return Schema.make(elementType).annotations(elementType.annotations);
+  }
+
+  const restType = tupleAst.rest;
+  return Schema.make(restType[0].type).annotations(restType[0].annotations);
+};
+
+const flattenUnion = (typeAst: SchemaAST.AST): SchemaAST.AST[] =>
+  SchemaAST.isUnion(typeAst) ? typeAst.types.flatMap(flattenUnion) : [typeAst];
+
+const getProperties = (
+  typeAst: SchemaAST.AST,
+  getTargetPropertyFn: (propertyName: string) => any,
+): SchemaAST.PropertySignature[] => {
+  const astCandidates = flattenUnion(typeAst);
+  const typeAstList = astCandidates.filter((type) => SchemaAST.isTypeLiteral(type)) as SchemaAST.TypeLiteral[];
+  if (typeAstList.length === 0) {
+    return [];
+  }
+  if (typeAstList.length === 1) {
+    return SchemaAST.getPropertySignatures(typeAstList[0]);
+  }
+
+  const typeDiscriminators = getTypeDiscriminators(typeAstList);
+  const targetPropertyValue = getTargetPropertyFn(String(typeDiscriminators[0].name));
+  const typeIndex = typeDiscriminators.findIndex((p) => targetPropertyValue === (p.type as SchemaAST.Literal).literal);
+  invariant(typeIndex !== -1, 'discriminator field not set on target');
+  return SchemaAST.getPropertySignatures(typeAstList[typeIndex]);
+};
+
+const getPropertyType = (
+  ast: SchemaAST.AST,
+  propertyName: string,
+  getTargetPropertyFn: (propertyName: string) => any,
+): SchemaAST.AST | null => {
+  const anyOrObject = unwrapAst(
+    ast,
+    (candidate) => SchemaAST.isAnyKeyword(candidate) || SchemaAST.isObjectKeyword(candidate),
+  );
+  if (anyOrObject != null) {
+    return ast;
+  }
+
+  const typeOrDiscriminatedUnion = unwrapAst(ast, (t) => {
+    return SchemaAST.isTypeLiteral(t) || (SchemaAST.isUnion(t) && t.types.some((t) => SchemaAST.isTypeLiteral(t)));
+  });
+  if (typeOrDiscriminatedUnion == null) {
+    return null;
+  }
+
+  const targetProperty = getProperties(typeOrDiscriminatedUnion, getTargetPropertyFn).find(
+    (p) => p.name === propertyName,
+  );
+  if (targetProperty != null) {
+    return unwrapAst(targetProperty.type);
+  }
+
+  const indexSignatureType = unwrapAst(ast, SchemaAST.isTypeLiteral);
+  if (
+    indexSignatureType &&
+    SchemaAST.isTypeLiteral(indexSignatureType) &&
+    indexSignatureType.indexSignatures.length > 0
+  ) {
+    return unwrapAst(indexSignatureType.indexSignatures[0].type);
+  }
+
+  return null;
+};
+
+const getTypeDiscriminators = (typeAstList: SchemaAST.TypeLiteral[]): SchemaAST.PropertySignature[] => {
+  const discriminatorPropCandidates = typeAstList
+    .flatMap(SchemaAST.getPropertySignatures)
+    .filter((p) => SchemaAST.isLiteral(p.type));
+  const propertyName = discriminatorPropCandidates[0].name;
+  const isValidDiscriminator = discriminatorPropCandidates.every((p) => p.name === propertyName && !p.isOptional);
+  const everyTypeHasDiscriminator = discriminatorPropCandidates.length === typeAstList.length;
+  const isDiscriminatedUnion = isValidDiscriminator && everyTypeHasDiscriminator;
+  invariant(isDiscriminatedUnion, 'type ambiguity: every type in a union must have a single unique-literal field');
+  return discriminatorPropCandidates;
+};
+
+/**
+ * Used to check that rootAst is for a type matching the provided predicate.
+ * That's not always straightforward because types of optionality and recursive types.
+ * const Task = Schema.Struct({
+ *   ...,
+ *   previous?: Schema.optional(Schema.suspend(() => Task)),
+ * });
+ * Here the AST for `previous` field is going to be Union(Suspend(Type), Undefined).
+ * SchemaAST.isTypeLiteral(field) will return false, but unwrapAst(field, (ast) => SchemaAST.isTypeLiteral(ast))
+ * will return true.
+ */
+const unwrapAst = (rootAst: SchemaAST.AST, predicate?: (ast: SchemaAST.AST) => boolean): SchemaAST.AST | null => {
+  let ast: SchemaAST.AST | undefined = rootAst;
+  while (ast != null) {
+    if (predicate?.(ast)) {
+      return ast;
+    }
+
+    if (SchemaAST.isUnion(ast)) {
+      const next: any = ast.types.find((t) => (predicate != null && predicate(t)) || SchemaAST.isSuspend(t));
+      if (next != null) {
+        ast = next;
+        continue;
+      }
+    }
+
+    if (SchemaAST.isSuspend(ast)) {
+      ast = ast.f();
+    } else {
+      return predicate == null ? ast : null;
+    }
+  }
+
+  return null;
+};
+
+const unwrapArray = (ast: SchemaAST.AST) => unwrapAst(ast, SchemaAST.isTupleType) as SchemaAST.TupleType | null;
+
+export const checkIdNotPresentOnSchema = (schema: Schema.Schema<any, any, any>) => {
+  invariant(SchemaAST.isTypeLiteral(schema.ast));
+  const idProperty = SchemaAST.getPropertySignatures(schema.ast).find((prop) => prop.name === 'id');
+  if (idProperty != null) {
+    throw new Error('"id" property name is reserved');
+  }
+};
+
+// TODO(burdon): Reconcile with JsonPath.
+type KeyPath = readonly (string | number)[];

package/src/internal/object/typed-object.test.ts

@@ -0,0 +1,34 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+import { describe, expect, test } from 'vitest';
+
+import { TypedObject } from './typed-object';
+
+class Organization extends TypedObject({
+  typename: 'example.com/type/Organization',
+  version: '0.1.0',
+})({
+  name: Schema.String,
+}) {}
+
+describe('EchoObjectSchema class DSL', () => {
+  test('type is a valid schema', async () => {
+    expect(Schema.isSchema(Organization)).to.be.true;
+  });
+
+  test('static typename accessor', async () => {
+    expect(Organization.typename).to.eq('example.com/type/Organization');
+  });
+
+  test('expect constructor to throw', async () => {
+    expect(() => new Organization()).to.throw();
+  });
+
+  test('expect schema', async () => {
+    expect(SchemaAST.isTypeLiteral(Organization.ast)).to.be.true;
+  });
+});

package/src/internal/object/typed-object.ts

@@ -0,0 +1,94 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+
+import { invariant } from '@dxos/invariant';
+
+import {
+  type TypeAnnotation,
+  TypeAnnotationId,
+  type TypeMeta,
+  TypenameSchema,
+  VersionSchema,
+  makeTypeJsonSchemaAnnotation,
+} from '../annotations';
+import { EntityKind, type HasId } from '../types';
+
+import { type TypedObjectFields, type TypedObjectOptions, makeTypedEntityClass } from './common';
+
+/**
+ * Definition for an object type that can be stored in an ECHO database.
+ * Implements effect schema to define object properties.
+ * Has a typename and version.
+ *
+ * In contrast to {@link EchoSchema} this definition is not recorded in the database.
+ */
+export interface TypedObject<A = any, I = any> extends TypeMeta, Schema.Schema<A, I> {}
+
+/**
+ * Typed object that could be used as a prototype in class definitions.
+ * This is an internal API type.
+ * Use {@link TypedObject} for the common use-cases.
+ */
+export interface TypedObjectPrototype<A = any, I = any> extends TypedObject<A, I> {
+  /** Type constructor. */
+  new (): HasId & A;
+}
+
+export type TypedObjectProps = TypeMeta & {
+  // TODO(dmaretskyi): Remove after all legacy types has been removed.
+  disableValidation?: boolean;
+};
+
+/**
+ * Base class factory for typed objects.
+ * @deprecated Use Function.pipe(Type.Obj) instead.
+ */
+export const TypedObject = ({
+  typename: typenameParam,
+  version: versionParam,
+  disableValidation,
+}: TypedObjectProps) => {
+  const typename = TypenameSchema.make(typenameParam, { disableValidation });
+  const version = VersionSchema.make(versionParam, { disableValidation });
+
+  /**
+   * Return class definition factory.
+   */
+  return <SchemaFields extends Schema.Struct.Fields, Options extends TypedObjectOptions>(
+    fields: SchemaFields,
+    options?: Options,
+  ): TypedObjectPrototype<TypedObjectFields<SchemaFields, Options>, Schema.Struct.Encoded<SchemaFields>> => {
+    // Create schema from fields.
+    const schema: Schema.Schema.All = options?.record
+      ? Schema.Struct(fields, { key: Schema.String, value: Schema.Any })
+      : Schema.Struct(fields);
+
+    // Set ECHO object id property.
+    const typeSchema = Schema.extend(
+      Schema.mutable(options?.partial ? Schema.partial(schema) : schema),
+      Schema.Struct({ id: Schema.String }),
+    );
+
+    // Set ECHO annotations.
+    invariant(typeof EntityKind.Object === 'string');
+    const annotatedSchema = typeSchema.annotations({
+      [TypeAnnotationId]: { kind: EntityKind.Object, typename, version } satisfies TypeAnnotation,
+      [SchemaAST.JSONSchemaAnnotationId]: makeTypeJsonSchemaAnnotation({
+        kind: EntityKind.Object,
+        typename,
+        version,
+      }),
+    });
+
+    /**
+     * Return class definition.
+     * NOTE: Actual reactive ECHO objects must be created via the `live(Type)` function.
+     */
+    // TODO(burdon): This is missing fields required by TypedObject (e.g., Type, Encoded, Context)?
+    return class TypedObject extends makeTypedEntityClass(typename, version, annotatedSchema as any) {} as any;
+  };
+};