feat: support @FlexSearch on OffsetDateTime field

Previously, it was possible to add the directive, but it did not generate any flex search filter fields.
AEB-labs · Mar 3, 2023 · 06f95c5 · 06f95c5
1 parent a2fffc4
commit 06f95c5
Show file tree

Hide file tree

Showing 11 changed files with 108 additions and 13 deletions.
diff --git a/spec/dev/model/simple.graphqls b/spec/dev/model/simple.graphqls
@@ -28,7 +28,7 @@ type Hero
     info: JSON
     infoObj: JSONObject
     attributes: StringMap
-    timeOfDeath: OffsetDateTime
+    timeOfDeath: OffsetDateTime @flexSearch
     recursion: Recursion @flexSearch
 }
 

diff --git a/spec/regression/logistics/model/delivery.graphqls b/spec/regression/logistics/model/delivery.graphqls
@@ -39,7 +39,7 @@ type Delivery
     defaultValueFloat: Float @defaultValue(value: 3.14)
     defaultValueEnum: Foobarit @defaultValue(value: Bar)
 
-    dispatchDate: OffsetDateTime @index
+    dispatchDate: OffsetDateTime @index @flexSearch
     pickupDate: LocalDate
     pickupTimeStart: LocalTime
     pickupTimeEnd: LocalTime

diff --git a/spec/regression/logistics/test-data.json b/spec/regression/logistics/test-data.json
@@ -134,7 +134,8 @@
         "sometimesNull": "1",
         "caseInsensitiveField": "Ä TEXT",
         "colorData": { "packageColor": "red" },
-        "serialNumbers": ["12345", "67890"]
+        "serialNumbers": ["12345", "67890"],
+        "dispatchDate": "2001-01-02T03:00:00Z"
       },
       {
         "@id": "2",
@@ -179,7 +180,8 @@
         "sometimesNull": "2",
         "caseInsensitiveField": "ä text",
         "colorData": { "packageColor": "blue" },
-        "serialNumbers": ["54321"]
+        "serialNumbers": ["54321"],
+        "dispatchDate": "2001-01-02T04:00:00+01:00"
       },
       {
         "@id": "3",

diff --git a/spec/regression/logistics/tests/descriptions.result.json b/spec/regression/logistics/tests/descriptions.result.json
@@ -5557,6 +5557,46 @@
               "description": "Checks if `completionDate` is greater or equal a specified value.",
               "deprecationReason": null
             },
+            {
+              "name": "dispatchDate",
+              "description": "Checks if `dispatchDate` equals a specified value.",
+              "deprecationReason": null
+            },
+            {
+              "name": "dispatchDate_not",
+              "description": "Checks if `dispatchDate` does not equal a specified value",
+              "deprecationReason": null
+            },
+            {
+              "name": "dispatchDate_in",
+              "description": "Checks if `dispatchDate` is equal to one of the specified values.",
+              "deprecationReason": null
+            },
+            {
+              "name": "dispatchDate_not_in",
+              "description": "Checks if `dispatchDate` is not equal to one of the specified values.",
+              "deprecationReason": null
+            },
+            {
+              "name": "dispatchDate_lt",
+              "description": "Checks if `dispatchDate` is less than a specified value.",
+              "deprecationReason": null
+            },
+            {
+              "name": "dispatchDate_lte",
+              "description": "Checks if `dispatchDate` is less or equal a specified value.",
+              "deprecationReason": null
+            },
+            {
+              "name": "dispatchDate_gt",
+              "description": "Checks if `dispatchDate` is greater than a specified value.",
+              "deprecationReason": null
+            },
+            {
+              "name": "dispatchDate_gte",
+              "description": "Checks if `dispatchDate` is greater or equal a specified value.",
+              "deprecationReason": null
+            },
             {
               "name": "description_contains_any_word",
               "description": "Tokenizes the provided string into words, and checks if `description` contains at least one of them.\n Stemming (reduction of words on their base form) is applied.",

diff --git a/spec/regression/logistics/tests/flex-search-in-memory.graphql b/spec/regression/logistics/tests/flex-search-in-memory.graphql
@@ -212,3 +212,11 @@ query string_aggregation {
         serialNumbers
     }
 }
+
+query offset_date_time {
+    flexSearchDeliveries(flexSearchFilter: { dispatchDate: "2001-01-02T03:00:00Z" }) {
+        deliveryNumber
+        serialNumbers
+        dispatchDate
+    }
+}
diff --git a/spec/regression/logistics/tests/flex-search-in-memory.result.json b/spec/regression/logistics/tests/flex-search-in-memory.result.json
@@ -365,5 +365,26 @@
         }
       ]
     }
+  },
+  "offset_date_time": {
+    "data": {
+      "flexSearchDeliveries": [
+        {
+          "deliveryNumber": "1000173",
+          "serialNumbers": [
+            "12345",
+            "67890"
+          ],
+          "dispatchDate": "2001-01-02T03:00:00+00:00"
+        },
+        {
+          "deliveryNumber": "1000521",
+          "serialNumbers": [
+            "54321"
+          ],
+          "dispatchDate": "2001-01-02T04:00:00+01:00"
+        }
+      ]
+    }
   }
 }
diff --git a/spec/regression/logistics/tests/offset-date-time.result.json b/spec/regression/logistics/tests/offset-date-time.result.json
@@ -3,16 +3,16 @@
     "data": {
       "allDeliveries": [
         {
-          "deliveryNumber": "1000173",
+          "deliveryNumber": "1000522",
           "dispatchDate": null
         },
         {
-          "deliveryNumber": "1000521",
-          "dispatchDate": null
+          "deliveryNumber": "1000173",
+          "dispatchDate": "2001-01-02T03:00:00+00:00"
         },
         {
-          "deliveryNumber": "1000522",
-          "dispatchDate": null
+          "deliveryNumber": "1000521",
+          "dispatchDate": "2001-01-02T04:00:00+01:00"
         }
       ]
     }
@@ -89,4 +89,4 @@
       ]
     }
   }
-}
+}
diff --git a/src/database/arangodb/schema-migration/arango-search-helpers.ts b/src/database/arangodb/schema-migration/arango-search-helpers.ts
@@ -23,6 +23,10 @@ import {
     SchemaMigration,
     UpdateArangoSearchViewMigration,
 } from './migrations';
+import {
+    GraphQLOffsetDateTime,
+    TIMESTAMP_PROPERTY,
+} from '../../../schema/scalars/offset-date-time';
 
 export const FLEX_SEARCH_VIEW_PREFIX = 'flex_view_';
 
@@ -214,7 +218,16 @@ function getPropertiesFromDefinition(
             link.includeAllFields = true;
         }
 
-        return link;
+        // for GraphQLOffsetDateTime, we actually need to index the ".timestamp" field
+        if (field.type.name === GraphQLOffsetDateTime.name) {
+            return {
+                fields: {
+                    [TIMESTAMP_PROPERTY]: link,
+                },
+            };
+        } else {
+            return link;
+        }
     }
 }
 

diff --git a/src/schema-generation/filter-input-types/filter-fields.ts b/src/schema-generation/filter-input-types/filter-fields.ts
@@ -55,7 +55,7 @@ export function getScalarFilterValueNode(fieldNode: QueryNode, type: Type): Quer
     return fieldNode;
 }
 
-function getScalarFilterLiteralValue(value: unknown, type: Type): unknown {
+export function getScalarFilterLiteralValue(value: unknown, type: Type): unknown {
     if (
         type.isScalarType &&
         type.graphQLScalarType === GraphQLOffsetDateTime &&

diff --git a/src/schema-generation/flex-search-filter-input-types/constants.ts b/src/schema-generation/flex-search-filter-input-types/constants.ts
@@ -37,6 +37,7 @@ import {
     notStartsWithOp,
     startsWithOp,
 } from '../utils/input-types';
+import { GraphQLOffsetDateTime } from '../../schema/scalars/offset-date-time';
 
 export const SOME_PREFIX = 'some';
 
@@ -111,6 +112,7 @@ export const FLEX_SEARCH_FILTER_FIELDS_BY_TYPE: { [name: string]: string[] } = {
     [GraphQLDateTime.name]: NUMERIC_FILTER_FIELDS,
     [GraphQLLocalDate.name]: NUMERIC_FILTER_FIELDS,
     [GraphQLLocalTime.name]: NUMERIC_FILTER_FIELDS,
+    [GraphQLOffsetDateTime.name]: NUMERIC_FILTER_FIELDS,
     [GraphQLBoolean.name]: [INPUT_FIELD_EQUAL, INPUT_FIELD_NOT],
 };
 

diff --git a/src/schema-generation/flex-search-filter-input-types/filter-fields.ts b/src/schema-generation/flex-search-filter-input-types/filter-fields.ts
@@ -36,7 +36,11 @@ import {
     OR_FILTER_FIELD,
 } from '../../schema/constants';
 import { AnyValue, PlainObject } from '../../utils/utils';
-import { FilterField } from '../filter-input-types/filter-fields';
+import {
+    FilterField,
+    getScalarFilterLiteralValue,
+    getScalarFilterValueNode,
+} from '../filter-input-types/filter-fields';
 import { QueryNodeResolveInfo } from '../query-node-object-type';
 import { TypedInputFieldBase } from '../typed-input-object-type';
 import { not } from '../utils/input-types';
@@ -148,6 +152,11 @@ export class FlexSearchScalarOrEnumFieldFilterField implements FlexSearchFilterF
         } else {
             valueNode = new FieldQueryNode(sourceNode, this.field);
         }
+
+        // handle special cases like .timestamp for OffsetDateTime
+        valueNode = getScalarFilterValueNode(valueNode, this.field.type);
+        filterValue = getScalarFilterLiteralValue(filterValue, this.field.type);
+
         return resolveFilterField(this, valueNode, filterValue, this.analyzer);
     }
 }