@dxos/echo-query 0.8.4-main.ead640a → 0.8.4-main.f466a3d56e

package/src/parser/query.test.ts

@@ -3,12 +3,12 @@
 //
 
 import { type Tree } from '@lezer/common';
-import { describe, it } from 'vitest';
+import { describe, it, test } from 'vitest';
 
 import { Filter, Tag } from '@dxos/echo';
 
 import { QueryDSL } from './gen';
-import { QueryBuilder } from './query-builder';
+import { type BuildResult, QueryBuilder, normalizeInput } from './query-builder';
 
 // TODO(burdon): Ref/Relation traversal.
 
@@ -51,10 +51,10 @@ describe('query', () => {
       },
       // Type
       {
-        input: 'type:dxos.org/type/Person',
+        input: 'type:org.dxos.type.person',
         expected: [
           'Query',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -111,10 +111,10 @@ describe('query', () => {
         ],
       },
       {
-        input: 'type:dxos.org/type/Person OR type:dxos.org/type/Organization',
+        input: 'type:org.dxos.type.person OR type:org.dxos.type.organization',
         expected: [
           'Query',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -122,7 +122,7 @@ describe('query', () => {
           'Identifier',
           // OR
           'Or',
-          // type:dxos.org/type/Organization
+          // type:org.dxos.type.organization
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -131,11 +131,11 @@ describe('query', () => {
         ],
       },
       {
-        input: '(type:dxos.org/type/Person OR type:dxos.org/type/Organization) AND { name: "DXOS" }',
+        input: '(type:org.dxos.type.person OR type:org.dxos.type.organization) AND { name: "DXOS" }',
         expected: [
           'Query',
           '(',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -143,7 +143,7 @@ describe('query', () => {
           'Identifier',
           // OR
           'Or',
-          // type:dxos.org/type/Organization
+          // type:org.dxos.type.organization
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -164,10 +164,10 @@ describe('query', () => {
         ],
       },
       {
-        input: 'type:dxos.org/type/Person -> type:dxos.org/type/Organization',
+        input: 'type:org.dxos.type.person -> type:org.dxos.type.organization',
         expected: [
           'Query',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -175,7 +175,7 @@ describe('query', () => {
           'Identifier',
           'Relation',
           'ArrowRight',
-          // type:dxos.org/type/Organization
+          // type:org.dxos.type.organization
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -184,10 +184,10 @@ describe('query', () => {
         ],
       },
       {
-        input: 'type:dxos.org/type/Organization <- type:dxos.org/type/Person',
+        input: 'type:org.dxos.type.organization <- type:org.dxos.type.person',
         expected: [
           'Query',
-          // type:dxos.org/type/Organization
+          // type:org.dxos.type.organization
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -195,7 +195,7 @@ describe('query', () => {
           'Identifier',
           'Relation',
           'ArrowLeft',
-          // type:dxos.org/type/Person
+          // type:org.dxos.type.person
           'Filter',
           'TypeFilter',
           'TypeKeyword',
@@ -206,7 +206,7 @@ describe('query', () => {
       {
         // Persons for Organizations with name "DXOS"
         // TODO(burdon): Filter relations.
-        input: '((type:dxos.org/type/Organization AND { name: "DXOS" }) -> type:dxos.org/type/Person)',
+        input: '((type:org.dxos.type.organization AND { name: "DXOS" }) -> type:org.dxos.type.person)',
         expected: [
           'Query',
           '(',
@@ -238,7 +238,7 @@ describe('query', () => {
         ],
       },
       {
-        input: 'type:dxos.org/type/Person and { name: "DXOS" }',
+        input: 'type:org.dxos.type.person and { name: "DXOS" }',
         expected: [
           'Query',
           'Filter',
@@ -258,6 +258,22 @@ describe('query', () => {
           '}',
         ],
       },
+      {
+        input: 'x = ( type: org.dxos.type.person )',
+        expected: [
+          'Query',
+          'Assignment',
+          'Identifier',
+          '=',
+          '(',
+          'Filter',
+          'TypeFilter',
+          'TypeKeyword',
+          ':',
+          'Identifier',
+          ')',
+        ],
+      },
     ];
 
     for (const { input, expected } of tests) {
@@ -285,72 +301,109 @@ describe('query', () => {
     });
 
     // TODO(burdon): Test "not"
-    type Test = { input: string; expected: Filter.Any };
+    type Test = { input: string; expected: BuildResult };
     const tests: Test[] = [
       // Types
       {
-        input: 'type:dxos.org/type/Person',
-        expected: Filter.typename('dxos.org/type/Person'),
+        input: 'type:org.dxos.type.person',
+        expected: {
+          filter: Filter.typename('org.dxos.type.person'),
+        },
       },
       // Tags
       {
         input: '#foo',
-        expected: Filter.tag('tag_1'),
+        expected: {
+          filter: Filter.tag('tag_1'),
+        },
       },
       {
         input: '#foo AND #bar',
-        expected: Filter.and(Filter.tag('tag_1'), Filter.tag('tag_2')),
+        expected: {
+          filter: Filter.and(Filter.tag('tag_1'), Filter.tag('tag_2')),
+        },
       },
       {
         input: '#foo #bar',
-        expected: Filter.and(Filter.tag('tag_1'), Filter.tag('tag_2')),
+        expected: {
+          filter: Filter.and(Filter.tag('tag_1'), Filter.tag('tag_2')),
+        },
       },
       // Text
       {
         input: '"test"',
-        expected: Filter.text('test'),
+        expected: {
+          filter: Filter.text('test'),
+        },
       },
       // Mixed
       {
         input: '#foo "test"',
-        expected: Filter.and(Filter.tag('tag_1'), Filter.text('test')),
+        expected: {
+          filter: Filter.and(Filter.tag('tag_1'), Filter.text('test')),
+        },
       },
       // Props
       {
         input: '{ name: "DXOS" }',
-        expected: Filter.props({ name: 'DXOS' }),
+        expected: {
+          filter: Filter.props({ name: 'DXOS' }),
+        },
       },
       {
         input: '{ value: 100 }',
-        expected: Filter.props({ value: 100 }),
+        expected: {
+          filter: Filter.props({ value: 100 }),
+        },
+      },
+      {
+        input: 'type:org.dxos.type.person OR type:org.dxos.type.organization',
+        expected: {
+          filter: Filter.or(Filter.typename('org.dxos.type.person'), Filter.typename('org.dxos.type.organization')),
+        },
       },
       {
-        input: 'type:dxos.org/type/Person OR type:dxos.org/type/Organization',
-        expected: Filter.or(Filter.typename('dxos.org/type/Person'), Filter.typename('dxos.org/type/Organization')),
+        input: '(type:org.dxos.type.person OR type:org.dxos.type.organization) AND { name: "DXOS" }',
+        expected: {
+          filter: Filter.and(
+            Filter.or(Filter.typename('org.dxos.type.person'), Filter.typename('org.dxos.type.organization')),
+            Filter.props({ name: 'DXOS' }),
+          ),
+        },
       },
       {
-        input: '(type:dxos.org/type/Person OR type:dxos.org/type/Organization) AND { name: "DXOS" }',
-        expected: Filter.and(
-          Filter.or(Filter.typename('dxos.org/type/Person'), Filter.typename('dxos.org/type/Organization')),
-          Filter.props({ name: 'DXOS' }),
-        ),
+        input: 'type:org.dxos.type.person and { name: "DXOS" }',
+        expected: {
+          filter: Filter.and(Filter.typename('org.dxos.type.person'), Filter.props({ name: 'DXOS' })),
+        },
       },
+      // Assignment
       {
-        input: 'type:dxos.org/type/Person and { name: "DXOS" }',
-        expected: Filter.and(Filter.typename('dxos.org/type/Person'), Filter.props({ name: 'DXOS' })),
+        input: 'x = ( type:org.dxos.type.person )',
+        expected: {
+          name: 'x',
+          filter: Filter.typename('org.dxos.type.person'),
+        },
+      },
+      {
+        input: 'x = ( #foo AND "bar" )',
+        expected: {
+          name: 'x',
+          filter: Filter.and(Filter.tag('tag_1'), Filter.text('bar')),
+        },
       },
       // TODO(burdon): Convert Query/Filter expr to AST.
       // TODO(burdon): Person -> Organization (many-to-many relation).
       // Get Research Note objects for Organization objects for Person objects with jobTitle.
       //
-      // Cypher: MATCH (p:Person)-[:WorksAt]->(o:Organization)<-[:ResearchOn]-(r:ResearchNote) WHERE p.jotTitle IS NOT NULL
-      // ((type:Person AND { jobTitle: "investor" }) -[:WorksAt]-> type:Organization) <-[:ResearchOn]- type:ResearchNote
+      // Cypher: MATCH (p:Person)-[:WorksAt]->(o:Organization)<-[:HasSubject]-(r:ResearchNote) WHERE p.jotTitle IS NOT NULL
+      // ((type:Person AND { jobTitle: "investor" }) -[:WorksAt]-> type:Organization) <-[:HasSubject]- type:ResearchNote
       //
       // {
       //   input: '',
-      //   expected: Query.select(Filter.typename('dxos.org/type/Person', { jobTitle: 'investor' }))
+      //   expected: Query.select(Filter.typename('org.dxos.type.person', { jobTitle: 'investor' }))
       //     .reference('organization')
-      //     .targetOf(Relation.of('dxos.org/relation/ResearchOn')) // TODO(burdon): Invert?
+      //     .targetOf(Relation.of('org.dxos.relation.hasSubject')) // TODO(burdon): Invert?
       //     .source(),
       // },
     ];
@@ -360,4 +413,117 @@ describe('query', () => {
       expect(result, JSON.stringify({ input, result, expected }, null, 2)).toEqual(expected);
     });
   });
+
+  test('normalizeInput', ({ expect }) => {
+    type Test = { input: string; expected: string };
+    const tests: Test[] = [
+      { input: 'foo', expected: '"foo"' },
+      { input: 'foo bar', expected: '"foo" "bar"' },
+      { input: 'foo  bar', expected: '"foo"  "bar"' },
+      { input: '"already" bare', expected: '"already" "bare"' },
+      { input: 'from:rich@dxos.org', expected: 'from:"rich@dxos.org"' },
+      { input: 'from:rich@dxos.org urgent', expected: 'from:"rich@dxos.org" "urgent"' },
+      { input: 'name:DXOS', expected: 'name:"DXOS"' },
+      { input: 'count:42', expected: 'count:42' },
+      { input: 'active:true', expected: 'active:true' },
+      { input: 'value:null', expected: 'value:null' },
+      { input: 'name:"DXOS"', expected: 'name:"DXOS"' },
+      { input: 'type:org.dxos.type.person', expected: 'type:org.dxos.type.person' },
+      { input: '#tag', expected: '#tag' },
+      { input: '#tag foo', expected: '#tag "foo"' },
+      { input: 'foo AND bar', expected: '"foo" AND "bar"' },
+      { input: 'foo OR bar', expected: '"foo" OR "bar"' },
+      { input: 'NOT foo', expected: 'NOT "foo"' },
+      { input: '!foo', expected: '!"foo"' },
+      { input: '(foo bar)', expected: '("foo" "bar")' },
+      { input: 'x = ( foo )', expected: 'x = ( "foo" )' },
+      { input: '{ name: "DXOS" }', expected: '{ name: "DXOS" }' },
+      // Apostrophes inside barewords don't open a quoted string.
+      { input: "don't", expected: '"don\'t"' },
+      { input: "O'Connor", expected: '"O\'Connor"' },
+      { input: "don't worry", expected: '"don\'t" "worry"' },
+      // Unmatched closing brace/bracket — passed through, no infinite loop.
+      { input: 'foo}', expected: '"foo"}' },
+      { input: 'foo]bar', expected: '"foo"]"bar"' },
+      // Genuine single-quoted string still works.
+      { input: "'foo bar'", expected: "'foo bar'" },
+      // URLs are searched as text rather than auto-promoted to property filters.
+      { input: 'https://dxos.org', expected: '"https://dxos.org"' },
+      { input: 'http://example.com/foo', expected: '"http://example.com/foo"' },
+      { input: 'mailto:rich@dxos.org', expected: '"mailto:rich@dxos.org"' },
+      // Escapes round-trip: backslashes are escaped in the literal body.
+      { input: 'foo\\bar', expected: '"foo\\\\bar"' },
+    ];
+
+    for (const { input, expected } of tests) {
+      expect(normalizeInput(input), input).toEqual(expected);
+    }
+  });
+
+  test('build with property and text fragments', ({ expect }) => {
+    const queryBuilder = new QueryBuilder({
+      tag_1: Tag.make({ label: 'foo' }),
+    });
+
+    type Test = { input: string; expected: BuildResult };
+    const tests: Test[] = [
+      // Property filter from `key:value` text input.
+      {
+        input: 'from:rich@dxos.org',
+        expected: { filter: Filter.props({ from: 'rich@dxos.org' }) },
+      },
+      {
+        input: 'name:DXOS',
+        expected: { filter: Filter.props({ name: 'DXOS' }) },
+      },
+      // Bare text fragment becomes text search.
+      {
+        input: 'urgent',
+        expected: { filter: Filter.text('urgent') },
+      },
+      // Multiple bare fragments are AND-joined.
+      {
+        input: 'urgent review',
+        expected: { filter: Filter.and(Filter.text('urgent'), Filter.text('review')) },
+      },
+      // Mixed property + text fragment.
+      {
+        input: 'from:rich@dxos.org urgent',
+        expected: {
+          filter: Filter.and(Filter.props({ from: 'rich@dxos.org' }), Filter.text('urgent')),
+        },
+      },
+      // Tag + text fragment.
+      {
+        input: '#foo bar',
+        expected: { filter: Filter.and(Filter.tag('tag_1'), Filter.text('bar')) },
+      },
+      // Three fragments AND-joined.
+      {
+        input: 'a b c',
+        expected: {
+          filter: Filter.and(Filter.text('a'), Filter.text('b'), Filter.text('c')),
+        },
+      },
+      // URLs are text-searched, not promoted to property filters.
+      {
+        input: 'https://dxos.org',
+        expected: { filter: Filter.text('https://dxos.org') },
+      },
+      {
+        input: 'mailto:rich@dxos.org',
+        expected: { filter: Filter.text('mailto:rich@dxos.org') },
+      },
+      // Escapes decode back to the original input.
+      {
+        input: 'foo\\bar',
+        expected: { filter: Filter.text('foo\\bar') },
+      },
+    ];
+
+    tests.forEach(({ input, expected }) => {
+      const result = queryBuilder.build(input);
+      expect(result, JSON.stringify({ input, result, expected }, null, 2)).toEqual(expected);
+    });
+  });
 });