Merge pull request #1140 from cardstack/cs-6667-search-by-coderef-ie-…

…catalog-entries

Add support for `formatValue` hook to serialize query values

packages/base/boolean.gts

@@ -2,6 +2,7 @@ import {
   primitive,
   serialize,
   queryableValue,
+  formatQuery,
   Component,
   useIndexBasedKey,
   FieldDef,
@@ -48,10 +49,10 @@ export default class BooleanField extends FieldDef {
   }
 
   static [queryableValue](val: any): boolean {
-    if (typeof val === 'string') {
-      return val.toLowerCase() === 'true';
-    }
-    return Boolean(val);
+    return asBoolean(val);
+  }
+  static [formatQuery](val: any): boolean {
+    return asBoolean(val);
   }
 
   static embedded = View;
@@ -87,3 +88,10 @@ export default class BooleanField extends FieldDef {
     }
   };
 }
+
+function asBoolean(val: any): boolean {
+  if (typeof val === 'string') {
+    return val.toLowerCase() === 'true';
+  }
+  return Boolean(val);
+}

packages/base/card-api.gts

@@ -57,6 +57,7 @@ export const useIndexBasedKey = Symbol.for('cardstack-use-index-based-key');
 export const fieldDecorator = Symbol.for('cardstack-field-decorator');
 export const fieldType = Symbol.for('cardstack-field-type');
 export const queryableValue = Symbol.for('cardstack-queryable-value');
+export const formatQuery = Symbol.for('cardstack-format-query');
 export const relativeTo = Symbol.for('cardstack-relative-to');
 export const realmInfo = Symbol.for('cardstack-realm-info');
 export const realmURL = Symbol.for('cardstack-realm-url');
@@ -1606,6 +1607,13 @@ export class BaseDef {
     }
   }
 
+  static [formatQuery](value: any): any {
+    if (primitive in this) {
+      return value;
+    }
+    throw new Error(`Cannot format query value for composite card/field`);
+  }
+
   static [queryableValue](value: any, stack: BaseDef[] = []): any {
     if (primitive in this) {
       return value;
@@ -2140,6 +2148,13 @@ export function getQueryableValue(
   return fieldOrCard.queryableValue(value, stack);
 }
 
+export function formatQueryValue(
+  field: Field<typeof BaseDef>,
+  queryValue: any,
+): any {
+  return field.card[formatQuery](queryValue);
+}
+
 function peekAtField(instance: BaseDef, fieldName: string): any {
   let field = getField(
     Reflect.getPrototypeOf(instance)!.constructor as typeof BaseDef,

packages/base/code-ref.gts

@@ -3,6 +3,7 @@ import {
   primitive,
   serialize,
   deserialize,
+  formatQuery,
   queryableValue,
   CardDef,
   BaseDefConstructor,
@@ -51,18 +52,28 @@ export default class CodeRefField extends FieldDef {
     codeRef: ResolvedCodeRef | undefined,
     stack: CardDef[] = [],
   ) {
-    if (codeRef) {
-      // if a stack is passed in, use the containing card to resolve relative references
-      let moduleHref =
-        stack.length > 0
-          ? new URL(codeRef.module, stack[0][relativeTo]).href
-          : codeRef.module;
-      return `${moduleHref}/${codeRef.name}`;
-    }
-    return undefined;
+    return maybeSerializeCodeRef(codeRef, stack);
+  }
+  static [formatQuery](codeRef: ResolvedCodeRef) {
+    return maybeSerializeCodeRef(codeRef);
   }
 
   static embedded = class Embedded extends BaseView {};
   // The edit template is meant to be read-only, this field card is not mutable
   static edit = class Edit extends BaseView {};
 }
+
+function maybeSerializeCodeRef(
+  codeRef: ResolvedCodeRef | undefined,
+  stack: CardDef[] = [],
+) {
+  if (codeRef) {
+    // if a stack is passed in, use the containing card to resolve relative references
+    let moduleHref =
+      stack.length > 0
+        ? new URL(codeRef.module, stack[0][relativeTo]).href
+        : codeRef.module;
+    return `${moduleHref}/${codeRef.name}`;
+  }
+  return undefined;
+}

packages/host/tests/cards/event.gts

@@ -0,0 +1,9 @@
+import { contains, field, CardDef } from 'https://cardstack.com/base/card-api';
+import DateField from 'https://cardstack.com/base/date';
+import StringField from 'https://cardstack.com/base/string';
+
+export class Event extends CardDef {
+  @field title = contains(StringField);
+  @field venue = contains(StringField);
+  @field date = contains(DateField);
+}

packages/host/tests/cards/silly-number.gts

@@ -2,6 +2,7 @@ import {
   Component,
   FieldDef,
   queryableValue,
+  formatQuery,
   primitive,
 } from 'https://cardstack.com/base/card-api';
 
@@ -19,40 +20,47 @@ class View extends Component<typeof SillyNumberField> {
 
 export default class SillyNumberField extends FieldDef {
   static [primitive]: string[];
+  static [formatQuery](value: string[]) {
+    return format(value);
+  }
   static [queryableValue](value: string[] | undefined) {
-    if (!value) {
-      return undefined;
-    }
-    let result = value.map((word) => {
-      switch (word) {
-        case 'zero':
-          return '0';
-        case 'one':
-          return '1';
-        case 'two':
-          return '2';
-        case 'three':
-          return '3';
-        case 'four':
-          return '4';
-        case 'five':
-          return '5';
-        case 'six':
-          return '6';
-        case 'seven':
-          return '7';
-        case 'eight':
-          return '8';
-        case 'nine':
-          return '9';
-        default:
-          return '0';
-      }
-    });
-    return parseInt(result.join(''));
+    return format(value);
   }
 
   static embedded = View;
   static isolated = View;
   static edit = View;
 }
+
+function format(value: string[] | undefined) {
+  if (!value) {
+    return undefined;
+  }
+  let result = value.map((word) => {
+    switch (word) {
+      case 'zero':
+        return '0';
+      case 'one':
+        return '1';
+      case 'two':
+        return '2';
+      case 'three':
+        return '3';
+      case 'four':
+        return '4';
+      case 'five':
+        return '5';
+      case 'six':
+        return '6';
+      case 'seven':
+        return '7';
+      case 'eight':
+        return '8';
+      case 'nine':
+        return '9';
+      default:
+        return '0';
+    }
+  });
+  return parseInt(result.join(''));
+}

packages/host/tests/integration/search-index-test.gts

@@ -2953,6 +2953,38 @@ posts/ignore-me.json
           },
         },
       },
+      'event-1.json': {
+        data: {
+          type: 'card',
+          attributes: {
+            title: "Mango's Birthday",
+            venue: 'Dog Park',
+            date: '2024-10-30',
+          },
+          meta: {
+            adoptsFrom: {
+              module: `${testModuleRealm}event`,
+              name: 'Event',
+            },
+          },
+        },
+      },
+      'event-2.json': {
+        data: {
+          type: 'card',
+          attributes: {
+            title: "Van Gogh's Birthday",
+            venue: 'Backyard',
+            date: '2024-11-19',
+          },
+          meta: {
+            adoptsFrom: {
+              module: `${testModuleRealm}event`,
+              name: 'Event',
+            },
+          },
+        },
+      },
       'mango.json': {
         data: {
           type: 'card',
@@ -3348,7 +3380,7 @@ posts/ignore-me.json
       }
     });
 
-    test('can use a range filter with custom queryableValue', async function (assert) {
+    test('can use a range filter with custom formatQuery', async function (assert) {
       let { data: matching } = await indexer.search({
         filter: {
           on: { module: `${testModuleRealm}dog`, name: 'Dog' },
@@ -3363,6 +3395,21 @@ posts/ignore-me.json
       );
     });
 
+    test('can use an eq filter with a date field', async function (assert) {
+      let { data: matching } = await indexer.search({
+        filter: {
+          on: { module: `${testModuleRealm}event`, name: 'Event' },
+          eq: {
+            date: '2024-10-30',
+          },
+        },
+      });
+      assert.deepEqual(
+        matching.map((m) => m.id),
+        [`${paths.url}event-1`],
+      );
+    });
+
     test(`gives a good error when query refers to missing card`, async function (assert) {
       try {
         await indexer.search({
@@ -3663,6 +3710,8 @@ posts/ignore-me.json
           `${paths.url}mango`, // dog
           `${paths.url}ringo`, // dog
           `${paths.url}vangogh`, // dog
+          `${paths.url}event-1`, // event
+          `${paths.url}event-2`, // event
           `${paths.url}friend2`, // friend
           `${paths.url}friend1`, // friend
           `${paths.url}person-card1`, // person