@dxos/echo 0.8.4-main.5ad4a44 → 0.8.4-main.66e292d

package/src/query/query.test.ts

@@ -11,187 +11,127 @@ import { log } from '@dxos/log';
 
 import * as Obj from '../Obj';
 import * as Ref from '../Ref';
-import * as Type from '../Type';
 
-import { Filter, Order, Query } from './query';
+import { Filter } from './filter';
+import { Order } from './order';
+import { Query } from './query';
+import * as Test from './testing';
 
-//
-// Example schema
-//
-
-// TODO(dmaretskyi): Need common set of test types.
-const Person = Schema.Struct({
-  name: Schema.String,
-  email: Schema.optional(Schema.String),
-  age: Schema.optional(Schema.Number),
-  fields: Schema.Struct({
-    label: Schema.String,
-    value: Schema.String,
-  }).pipe(Schema.Array, Schema.optional),
-}).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Person',
-    version: '0.1.0',
-  }),
-);
-interface Person extends Schema.Schema.Type<typeof Person> {}
-
-const Organization = Schema.Struct({
-  name: Schema.String,
-  properties: Schema.optional(
-    Schema.Record({
-      key: Schema.String,
-      value: Schema.String,
-    }),
-  ),
-}).pipe(
-  Type.Obj({
-    typename: 'dxos.org/type/Organization',
-    version: '0.1.0',
-  }),
-);
-interface Organization extends Schema.Schema.Type<typeof Organization> {}
-
-const WorksFor = Schema.Struct({
-  since: Schema.String,
-}).pipe(
-  Type.Relation({
-    typename: 'dxos.org/type/WorksFor',
-    version: '0.1.0',
-    source: Person,
-    target: Organization,
-  }),
-);
-interface WorksFor extends Schema.Schema.Type<typeof WorksFor> {}
-
-const Task = Schema.Struct({
-  title: Schema.String,
-  createdAt: Schema.String,
-  assignee: Schema.optional(Type.Ref(Person)),
-}).pipe(Type.Obj({ typename: 'dxos.org/type/Task', version: '0.1.0' }));
-interface Task extends Schema.Schema.Type<typeof Task> {}
+describe('query api', () => {
+  describe('Query', () => {
+    test('get all people', () => {
+      const getAllPeople = Query.type(Test.Person);
 
-//
-// Example queries
-//
+      log('query', { ast: getAllPeople.ast });
+      Schema.validateSync(QueryAST.Query)(getAllPeople.ast);
+      log('getAllPeople', { ast: getAllPeople.ast });
+    });
 
-describe('query api', () => {
-  test('get all people', () => {
-    const getAllPeople = Query.type(Person);
+    test('get all people ordered by name', () => {
+      const getAllPeopleOrderedByName = Query.type(Test.Person).orderBy(Order.property('name', 'asc'));
 
-    log('query', { ast: getAllPeople.ast });
-    Schema.validateSync(QueryAST.Query)(getAllPeople.ast);
-    console.log('getAllPeople', JSON.stringify(getAllPeople.ast, null, 2));
-  });
+      log('query', { ast: getAllPeopleOrderedByName.ast });
+      Schema.validateSync(QueryAST.Query)(getAllPeopleOrderedByName.ast);
+      log('getAllPeopleOrderedByName', { ast: getAllPeopleOrderedByName.ast });
+    });
 
-  test('get all people ordered by name', () => {
-    const getAllPeopleOrderedByName = Query.type(Person).orderBy(Order.property('name', 'asc'));
+    test('get all people named Fred', () => {
+      const PeopleNamedFred = Query.select(Filter.type(Test.Person, { name: 'Fred' }));
 
-    log('query', { ast: getAllPeopleOrderedByName.ast });
-    Schema.validateSync(QueryAST.Query)(getAllPeopleOrderedByName.ast);
-    console.log('getAllPeopleOrderedByName', JSON.stringify(getAllPeopleOrderedByName.ast, null, 2));
-  });
+      log('query', { ast: PeopleNamedFred.ast });
+      Schema.validateSync(QueryAST.Query)(PeopleNamedFred.ast);
+      log('PeopleNamedFred', { ast: PeopleNamedFred.ast });
+    });
 
-  test('get all people named Fred', () => {
-    const PeopleNamedFred = Query.select(Filter.type(Person, { name: 'Fred' }));
+    test('get all people with field of "label" set to "Research"', () => {
+      const PeopleWithFieldLabelSetToResearch = Query.select(
+        Filter.type(Test.Person, { fields: Filter.contains({ label: 'label', value: 'Research' }) }),
+      );
 
-    log('query', { ast: PeopleNamedFred.ast });
-    Schema.validateSync(QueryAST.Query)(PeopleNamedFred.ast);
-    console.log('PeopleNamedFred', JSON.stringify(PeopleNamedFred.ast, null, 2));
-  });
+      log('query', { ast: PeopleWithFieldLabelSetToResearch.ast });
+      Schema.validateSync(QueryAST.Query)(PeopleWithFieldLabelSetToResearch.ast);
+      log('PeopleWithFieldLabelSetToResearch', { ast: PeopleWithFieldLabelSetToResearch.ast });
+    });
 
-  test('get all people with field of "label" set to "Research"', () => {
-    const PeopleWithFieldLabelSetToResearch = Query.select(
-      Filter.type(Person, { fields: Filter.contains({ label: 'label', value: 'Research' }) }),
-    );
+    test('get all orgs with property "label" set to "Research"', () => {
+      const OrgsWithPropertyLabelSetToResearch = Query.select(
+        Filter.type(Test.Organization, { properties: { label: 'Research' } }),
+      );
 
-    log('query', { ast: PeopleWithFieldLabelSetToResearch.ast });
-    Schema.validateSync(QueryAST.Query)(PeopleWithFieldLabelSetToResearch.ast);
-    console.log('PeopleWithFieldLabelSetToResearch', JSON.stringify(PeopleWithFieldLabelSetToResearch.ast, null, 2));
-  });
+      log('query', { ast: OrgsWithPropertyLabelSetToResearch.ast });
+      Schema.validateSync(QueryAST.Query)(OrgsWithPropertyLabelSetToResearch.ast);
+      log('OrgsWithPropertyLabelSetToResearch', { ast: OrgsWithPropertyLabelSetToResearch.ast });
+    });
 
-  test('get all orgs with property "label" set to "Research"', () => {
-    const OrgsWithPropertyLabelSetToResearch = Query.select(
-      Filter.type(Organization, { properties: { label: 'Research' } }),
-    );
+    test('get all orgs Fred worked for since 2020', () => {
+      const fred = Obj.make(Test.Person, { name: 'Fred' });
+      const OrganizationsFredWorkedForSince2020 = Query.select(Filter.type(Test.Person, { id: fred.id }))
+        .sourceOf(Test.WorksFor, { since: Filter.gt('2020') })
+        .target();
 
-    log('query', { ast: OrgsWithPropertyLabelSetToResearch.ast });
-    Schema.validateSync(QueryAST.Query)(OrgsWithPropertyLabelSetToResearch.ast);
-    console.log('OrgsWithPropertyLabelSetToResearch', JSON.stringify(OrgsWithPropertyLabelSetToResearch.ast, null, 2));
-  });
+      log('query', { ast: OrganizationsFredWorkedForSince2020.ast });
+      Schema.validateSync(QueryAST.Query)(OrganizationsFredWorkedForSince2020.ast);
+      log('OrganizationsFredWorkedForSince2020', { ast: OrganizationsFredWorkedForSince2020.ast });
+    });
 
-  test('get all orgs Fred worked for since 2020', () => {
-    const fred = Obj.make(Person, { name: 'Fred' });
-    const OrganizationsFredWorkedForSince2020 = Query.select(Filter.type(Person, { id: fred.id }))
-      .sourceOf(WorksFor, { since: Filter.gt('2020') })
-      .target();
-
-    log('query', { ast: OrganizationsFredWorkedForSince2020.ast });
-    Schema.validateSync(QueryAST.Query)(OrganizationsFredWorkedForSince2020.ast);
-    console.log(
-      'OrganizationsFredWorkedForSince2020',
-      JSON.stringify(OrganizationsFredWorkedForSince2020.ast, null, 2),
-    );
-  });
+    test('get all tasks for Fred', () => {
+      const fred = Obj.make(Test.Person, { name: 'Fred' });
+      const TasksForFred = Query.select(Filter.type(Test.Person, { id: fred.id })).referencedBy(Test.Task, 'assignee');
 
-  test('get all tasks for Fred', () => {
-    const fred = Obj.make(Person, { name: 'Fred' });
-    const TasksForFred = Query.select(Filter.type(Person, { id: fred.id })).referencedBy(Task, 'assignee');
+      log('query', { ast: TasksForFred.ast });
+      Schema.validateSync(QueryAST.Query)(TasksForFred.ast);
+      log('TasksForFred', { ast: TasksForFred.ast });
+    });
 
-    log('query', { ast: TasksForFred.ast });
-    Schema.validateSync(QueryAST.Query)(TasksForFred.ast);
-    console.log('TasksForFred', JSON.stringify(TasksForFred.ast, null, 2));
-  });
+    test('get all tasks for employees of Cyberdyne', () => {
+      const TasksForEmployeesOfCyberdyne = Query.select(Filter.type(Test.Organization, { name: 'Cyberdyne' }))
+        .targetOf(Test.WorksFor)
+        .source()
+        .referencedBy(Test.Task, 'assignee');
 
-  test('get all tasks for employees of Cyberdyne', () => {
-    const TasksForEmployeesOfCyberdyne = Query.select(Filter.type(Organization, { name: 'Cyberdyne' }))
-      .targetOf(WorksFor)
-      .source()
-      .referencedBy(Task, 'assignee');
+      log('query', { ast: TasksForEmployeesOfCyberdyne.ast });
+      Schema.validateSync(QueryAST.Query)(TasksForEmployeesOfCyberdyne.ast);
+      log('TasksForEmployeesOfCyberdyne', { ast: TasksForEmployeesOfCyberdyne.ast });
+    });
 
-    log('query', { ast: TasksForEmployeesOfCyberdyne.ast });
-    Schema.validateSync(QueryAST.Query)(TasksForEmployeesOfCyberdyne.ast);
-    console.log('TasksForEmployeesOfCyberdyne', JSON.stringify(TasksForEmployeesOfCyberdyne.ast, null, 2));
-  });
+    test('get all people or orgs', () => {
+      const PeopleOrOrganizations = Query.all(
+        Query.select(Filter.type(Test.Person)),
+        Query.select(Filter.type(Test.Organization)),
+      );
 
-  test('get all people or orgs', () => {
-    const PeopleOrOrganizations = Query.all(Query.select(Filter.type(Person)), Query.select(Filter.type(Organization)));
+      log('query', { ast: PeopleOrOrganizations.ast });
+      Schema.validateSync(QueryAST.Query)(PeopleOrOrganizations.ast);
+      log('PeopleOrOrganizations', { ast: PeopleOrOrganizations.ast });
+    });
 
-    log('query', { ast: PeopleOrOrganizations.ast });
-    Schema.validateSync(QueryAST.Query)(PeopleOrOrganizations.ast);
-    console.log('PeopleOrOrganizations', JSON.stringify(PeopleOrOrganizations.ast, null, 2));
-  });
+    test('get all people not in orgs', () => {
+      const PeopleNotInOrganizations = Query.without(
+        Query.select(Filter.type(Test.Person)),
+        Query.select(Filter.type(Test.Person)).sourceOf(Test.WorksFor).source(),
+      );
 
-  test('get all people not in orgs', () => {
-    const PeopleNotInOrganizations = Query.without(
-      Query.select(Filter.type(Person)),
-      Query.select(Filter.type(Person)).sourceOf(WorksFor).source(),
-    );
+      log('query', { ast: PeopleNotInOrganizations.ast });
+      Schema.validateSync(QueryAST.Query)(PeopleNotInOrganizations.ast);
+      log('PeopleNotInOrganizations', { ast: PeopleNotInOrganizations.ast });
+    });
 
-    log('query', { ast: PeopleNotInOrganizations.ast });
-    Schema.validateSync(QueryAST.Query)(PeopleNotInOrganizations.ast);
-    console.log('PeopleNotInOrganizations', JSON.stringify(PeopleNotInOrganizations.ast, null, 2));
-  });
+    test('get assignees of all tasks created after 2020', () => {
+      const AssigneesOfAllTasksCreatedAfter2020 = Query.select(
+        Filter.type(Test.Task, { createdAt: Filter.gt('2020') }),
+      ).reference('assignee');
 
-  test('get assignees of all tasks created after 2020', () => {
-    const AssigneesOfAllTasksCreatedAfter2020 = Query.select(
-      Filter.type(Task, { createdAt: Filter.gt('2020') }),
-    ).reference('assignee');
-
-    log('query', { ast: AssigneesOfAllTasksCreatedAfter2020.ast });
-    Schema.validateSync(QueryAST.Query)(AssigneesOfAllTasksCreatedAfter2020.ast);
-    console.log(
-      'AssigneesOfAllTasksCreatedAfter2020',
-      JSON.stringify(AssigneesOfAllTasksCreatedAfter2020.ast, null, 2),
-    );
-  });
+      log('query', { ast: AssigneesOfAllTasksCreatedAfter2020.ast });
+      Schema.validateSync(QueryAST.Query)(AssigneesOfAllTasksCreatedAfter2020.ast);
+      log('AssigneesOfAllTasksCreatedAfter2020', { ast: AssigneesOfAllTasksCreatedAfter2020.ast });
+    });
 
-  test('untyped full-text search', () => {
-    const contactFullTextSearch = Query.select(Filter.text('Bill'));
+    test('untyped full-text search', () => {
+      const contactFullTextSearch = Query.select(Filter.text('Bill'));
 
-    log('query', { ast: contactFullTextSearch.ast });
-    Schema.validateSync(QueryAST.Query)(contactFullTextSearch.ast);
-    expect(contactFullTextSearch.ast).toMatchInlineSnapshot(`
+      log('query', { ast: contactFullTextSearch.ast });
+      Schema.validateSync(QueryAST.Query)(contactFullTextSearch.ast);
+      expect(contactFullTextSearch.ast).toMatchInlineSnapshot(`
       {
         "filter": {
           "searchKind": undefined,
@@ -201,14 +141,14 @@ describe('query api', () => {
         "type": "select",
       }
     `);
-  });
+    });
 
-  test('typed full-text search', () => {
-    const contactFullTextSearch = Query.select(Filter.type(Person)).select(Filter.text('Bill'));
+    test('typed full-text search', () => {
+      const contactFullTextSearch = Query.select(Filter.type(Test.Person)).select(Filter.text('Bill'));
 
-    log('query', { ast: contactFullTextSearch.ast });
-    Schema.validateSync(QueryAST.Query)(contactFullTextSearch.ast);
-    expect(contactFullTextSearch.ast).toMatchInlineSnapshot(`
+      log('query', { ast: contactFullTextSearch.ast });
+      Schema.validateSync(QueryAST.Query)(contactFullTextSearch.ast);
+      expect(contactFullTextSearch.ast).toMatchInlineSnapshot(`
       {
         "filter": {
           "searchKind": undefined,
@@ -227,32 +167,32 @@ describe('query api', () => {
         "type": "filter",
       }
     `);
-  });
+    });
 
-  test('filter by ref', () => {
-    const fred = Obj.make(Person, { name: 'Fred' });
-    const tasksByFred = Filter.type(Task, { assignee: Ref.make(fred) });
-    expect(tasksByFred.ast).toEqual({
-      props: {
-        assignee: {
-          operator: 'eq',
-          type: 'compare',
-          value: {
-            '/': DXN.fromLocalObjectId(fred.id).toString(),
+    test('filter by ref', () => {
+      const fred = Obj.make(Test.Person, { name: 'Fred' });
+      const tasksByFred = Filter.type(Test.Task, { assignee: Ref.make(fred) });
+      expect(tasksByFred.ast).toEqual({
+        props: {
+          assignee: {
+            operator: 'eq',
+            type: 'compare',
+            value: {
+              '/': DXN.fromLocalObjectId(fred.id).toString(),
+            },
           },
         },
-      },
-      type: 'object',
-      typename: 'dxn:type:dxos.org/type/Task:0.1.0',
+        type: 'object',
+        typename: 'dxn:type:dxos.org/type/Task:0.1.0',
+      });
+      log('tasksByFred', { ast: tasksByFred.ast });
     });
-    console.log('tasksByFred', JSON.stringify(tasksByFred.ast, null, 2));
-  });
 
-  test('select orgs and people', () => {
-    const orgsAndPeople = Query.select(Filter.or(Filter.type(Organization), Filter.type(Person)));
+    test('select orgs and people', () => {
+      const orgsAndPeople = Query.select(Filter.or(Filter.type(Test.Organization), Filter.type(Test.Person)));
 
-    Schema.validateSync(QueryAST.Query)(orgsAndPeople.ast);
-    expect(orgsAndPeople.ast).toMatchInlineSnapshot(`
+      Schema.validateSync(QueryAST.Query)(orgsAndPeople.ast);
+      expect(orgsAndPeople.ast).toMatchInlineSnapshot(`
       {
         "filter": {
           "filters": [
@@ -274,15 +214,15 @@ describe('query api', () => {
         "type": "select",
       }
     `);
-  });
+    });
 
-  test('select everything but orgs and people', () => {
-    const everythingButOrgsAndPeople = Query.select(
-      Filter.not(Filter.or(Filter.type(Organization), Filter.type(Person))),
-    );
+    test('select everything but orgs and people', () => {
+      const everythingButOrgsAndPeople = Query.select(
+        Filter.not(Filter.or(Filter.type(Test.Organization), Filter.type(Test.Person))),
+      );
 
-    Schema.validateSync(QueryAST.Query)(everythingButOrgsAndPeople.ast);
-    expect(everythingButOrgsAndPeople.ast).toMatchInlineSnapshot(`
+      Schema.validateSync(QueryAST.Query)(everythingButOrgsAndPeople.ast);
+      expect(everythingButOrgsAndPeople.ast).toMatchInlineSnapshot(`
       {
         "filter": {
           "filter": {
@@ -307,15 +247,15 @@ describe('query api', () => {
         "type": "select",
       }
     `);
-  });
-
-  test('select deleted tasks', () => {
-    const deletedTasks = Query.select(Filter.type(Task)).options({
-      deleted: 'only',
     });
 
-    Schema.validateSync(QueryAST.Query)(deletedTasks.ast);
-    expect(deletedTasks.ast).toMatchInlineSnapshot(`
+    test('select deleted tasks', () => {
+      const deletedTasks = Query.select(Filter.type(Test.Task)).options({
+        deleted: 'only',
+      });
+
+      Schema.validateSync(QueryAST.Query)(deletedTasks.ast);
+      expect(deletedTasks.ast).toMatchInlineSnapshot(`
       {
         "options": {
           "deleted": "only",
@@ -332,31 +272,63 @@ describe('query api', () => {
         "type": "options",
       }
     `);
-  });
+    });
 
-  test.skip('chain', () => {
-    // NOTE: Can't support props without type since they can't be inferred.
-    // const f1: Filter<Person> = Filter.props({ name: 'Fred' });
+    test('filter by tags', () => {
+      const query = Query.select(Filter.type(Test.Task)).select(Filter.tag('important'));
+      Schema.validateSync(QueryAST.Query)(query.ast);
+      expect(query.ast).toMatchInlineSnapshot(`
+        {
+          "filter": {
+            "tag": "important",
+            "type": "tag",
+          },
+          "selection": {
+            "filter": {
+              "id": undefined,
+              "props": {},
+              "type": "object",
+              "typename": "dxn:type:dxos.org/type/Task:0.1.0",
+            },
+            "type": "select",
+          },
+          "type": "filter",
+        }
+      `);
+    });
+
+    test.skip('chain', () => {
+      // NOTE: Can't support props without type since they can't be inferred.
+      // const f1: Filter<Person> = Filter.props({ name: 'Fred' });
+
+      // const x = Query.select(Filter.props({ id: '123' }));
+      const y = Query.select(Filter.type(Test.Person));
 
-    // const x = Query.select(Filter.props({ id: '123' }));
-    const y = Query.select(Filter.type(Person));
+      const or = Filter.or(Filter.type(Test.Person, { id: Filter.in('1', '2', '3') }), Filter.type(Test.Organization));
 
-    const or = Filter.or(Filter.type(Person, { id: Filter.in('1', '2', '3') }), Filter.type(Organization));
+      const and = Filter.and(
+        Filter.type(Test.Person, { id: Filter.in('1', '2', '3') }),
+        Filter.type(Test.Person, { name: 'Fred' }),
+      );
 
-    const and = Filter.and(
-      Filter.type(Person, { id: Filter.in('1', '2', '3') }),
-      Filter.type(Person, { name: 'Fred' }),
-    );
+      const q = Query
+        //
+        // NOTE: Can't support functions since they can't be serialized (to server).
+        // .filter((object) => Math.random() > 0.5)
+        .select(Filter.type(Test.Person))
+        .select(Filter.type(Test.Person, { name: 'Fred' }))
+        .select({ age: Filter.between(20, 40) })
+        .select(Filter.and(Filter.type(Test.Person), Filter.type(Test.Person, { name: Filter.in('bob', 'bill') })));
 
-    const q = Query
-      //
-      // NOTE: Can't support functions since they can't be serialized (to server).
-      // .filter((object) => Math.random() > 0.5)
-      .select(Filter.type(Person))
-      .select(Filter.type(Person, { name: 'Fred' }))
-      .select({ age: Filter.between(20, 40) })
-      .select(Filter.and(Filter.type(Person), Filter.type(Person, { name: Filter.in('bob', 'bill') })));
+      log('stuff', { fOr: or, fAnd: and, q, y });
+    });
+  });
 
-    log('stuff', { fOr: or, fAnd: and, q, y });
+  describe('Filter', () => {
+    test('Filter.or(Filter.typename(...))', () => {
+      const filter = Filter.or(Filter.typename('dxos.org/type/Person'));
+      // TODO(dmaretskyi): Give vitest type-tests a try.
+      const _isAssignable: Obj.Any = null as any as Filter.Type<typeof filter>;
+    });
   });
 });