Relationship API bug fixes & updates (#481)

* adds default selection set to buildFieldSelection

used when adding selections for unselected ordered fields

* removes unused variable

* adds selectUnselectedOrderedFields for selection independet ordering

updates buildQueryFieldArguments to support appropriate type names for filtering vs ordering argument types

* Update node.js

* updates for pagination and ordering on relationship types

adds getTypeDefiningField to support appropriate translation of relationship type fields when querying incoming nodes of the .from field in a sub-selection of the .to field, or visa versa

* updates for pagination and ordering on relationship types

* removes comments

* uses selectUnselectedOrderedFields to support selection independent ordering

also updates function arguments for the @relation field and type translation functions for use in support for ordering

* translates ordering arguments and interfaces for relationship types

updates decideRelationFilterMetadata to better determine the direction of the relationship path pattern used when filtering relationship type fields

* Update cypherTestHelpers.js

* Update filterTck.md

* Update parser.js

* Update testSchema.js

* Update augmentSchemaTest.test.js

* Update cypherTest.test.js

Author: michaeldgraham

src/augment/ast.js

@@ -209,7 +209,10 @@ export const buildFieldSelection = ({
   args = [],
   directives = [],
   name = {},
-  selectionSet = {}
+  selectionSet = {
+    kind: Kind.SELECTION_SET,
+    selections: []
+  }
 }) => {
   return {
     kind: Kind.FIELD,

src/augment/fields.js

@@ -251,7 +251,6 @@ export const propertyFieldExists = ({
 }) => {
   const fields = definition.fields || [];
   return fields.find(field => {
-    const fieldName = field.name.value;
     const fieldType = field.type;
     const unwrappedType = unwrapNamedType({ type: fieldType });
     const outputType = unwrappedType.name;

src/augment/input-values.js

@@ -5,7 +5,8 @@ import {
   buildInputValue,
   buildInputObjectType,
   buildEnumType,
-  buildEnumValue
+  buildEnumValue,
+  buildFieldSelection
 } from './ast';
 import {
   isNeo4jTemporalType,
@@ -97,6 +98,7 @@ export const buildQueryFieldArguments = ({
   argumentMap = {},
   fieldArguments,
   fieldDirectives,
+  typeName,
   outputType,
   outputTypeWrappers,
   isUnionType,
@@ -167,6 +169,9 @@ export const buildQueryFieldArguments = ({
         const argumentIndex = fieldArguments.findIndex(
           arg => arg.name.value === FilteringArgument.FILTER
         );
+        if (typeName) {
+          outputType = `${typeName}${outputType}`;
+        }
         // Does overwrite
         if (argumentIndex === -1) {
           fieldArguments.push(
@@ -439,9 +444,7 @@ export const buildFilters = ({ fieldName, fieldConfig, filterTypes = [] }) => {
           [TypeWrappers.LIST_TYPE]: true
         };
       } else if (isPointDistanceFilter) {
-        fieldConfig.type.name = `${Neo4jTypeName}${
-          SpatialType.POINT
-        }DistanceFilter`;
+        fieldConfig.type.name = `${Neo4jTypeName}${SpatialType.POINT}DistanceFilter`;
       }
       inputValues.push(
         buildInputValue({
@@ -462,3 +465,56 @@ export const buildFilters = ({ fieldName, fieldConfig, filterTypes = [] }) => {
     ]
   );
 };
+
+export const selectUnselectedOrderedFields = ({
+  selectionFilters,
+  fieldSelectionSet
+}) => {
+  let orderingArguments = selectionFilters['orderBy'];
+  const orderedFieldSelectionSet = [];
+  // cooerce to array if not provided as list
+  if (orderingArguments) {
+    // if a single ordering enum argument value is provided,
+    // cooerce back into an array
+    if (typeof orderingArguments === 'string') {
+      orderingArguments = [orderingArguments];
+    }
+    orderedFieldSelectionSet.push(...fieldSelectionSet);
+    // add field selection AST for ordered fields if those fields are
+    // not selected, since apoc.coll.sortMulti requires data to sort
+    const orderedFieldNameMap = orderingArguments.reduce(
+      (uniqueFieldMap, orderingArg) => {
+        const fieldName = orderingArg.substring(
+          0,
+          orderingArg.lastIndexOf('_')
+        );
+        // prevent redundant selections
+        // ex: [datetime_asc, datetime_desc], if provided, would result
+        // in adding two selections for the datetime field
+        if (!uniqueFieldMap[fieldName]) uniqueFieldMap[fieldName] = true;
+        return uniqueFieldMap;
+      },
+      {}
+    );
+    const orderingArgumentFieldNames = Object.keys(orderedFieldNameMap);
+    orderingArgumentFieldNames.forEach(orderedFieldName => {
+      if (
+        !fieldSelectionSet.some(
+          field => field.name && field.name.value === orderedFieldName
+        )
+      ) {
+        // add the field so that its data can be used for ordering
+        // since as it is not actually selected, it will be removed
+        // by default GraphQL post-processing field resolvers
+        orderedFieldSelectionSet.push(
+          buildFieldSelection({
+            name: buildName({
+              name: orderedFieldName
+            })
+          })
+        );
+      }
+    });
+  }
+  return orderedFieldSelectionSet;
+};

src/augment/types/node/node.js

@@ -197,12 +197,13 @@ export const augmentNodeTypeFields = ({
   config
 }) => {
   let isIgnoredType = true;
+  let filterTypeName = `_${typeName}Filter`;
+  const fields = definition.fields;
   if (!isUnionType && !isUnionExtension) {
-    const fields = definition.fields;
     if (!isQueryType) {
       if (!nodeInputTypeMap[FilteringArgument.FILTER]) {
         nodeInputTypeMap[FilteringArgument.FILTER] = {
-          name: `_${typeName}Filter`,
+          name: filterTypeName,
           fields: []
         };
       }