Change many-relationship graphQL type to [Item!]! (#3261)

keystonejs · Jul 21, 2020 · c3883e0 · c3883e0
1 parent 39ed515
commit c3883e0
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 9 deletions.
diff --git a/.changeset/wet-masks-sort.md b/.changeset/wet-masks-sort.md
@@ -0,0 +1,9 @@
+---
+'@keystonejs/fields': major
+---
+
+`many` relationships now have a GraphQL type of `[Item!]!`, rather than `[Item]`.
+
+The old type of `[Item]` implied that the relationship field could return `null`, or that some of the items it returned could be `null`. In practice, neither of these things ever happened. The new type better reflects this reality.
+
+The filter argument `{path}_is_null` has also been removed for `many` relationships, as it does not apply to a non-null array type.
diff --git a/packages/fields/src/types/Relationship/Implementation.js b/packages/fields/src/types/Relationship/Implementation.js
@@ -60,7 +60,7 @@ export class Relationship extends Implementation {
     if (this.many) {
       const filterArgs = refList.getGraphqlFilterFragment().join('\n');
       return [
-        `${this.path}(${filterArgs}): [${refList.gqlNames.outputTypeName}]`,
+        `${this.path}(${filterArgs}): [${refList.gqlNames.outputTypeName}!]!`,
         this.withMeta ? `_${this.path}Meta(${filterArgs}): _QueryMeta` : '',
       ];
     }
@@ -89,8 +89,6 @@ export class Relationship extends Implementation {
         ${this.path}_some: ${refList.gqlNames.whereInputName}`,
         `""" condition must be false for all nodes """
         ${this.path}_none: ${refList.gqlNames.whereInputName}`,
-        `""" is the relation field null """
-        ${this.path}_is_null: Boolean`,
       ];
     } else {
       return [`${this.path}: ${refList.gqlNames.whereInputName}`, `${this.path}_is_null: Boolean`];

diff --git a/packages/fields/src/types/Relationship/tests/implementation.test.js b/packages/fields/src/types/Relationship/tests/implementation.test.js
@@ -296,10 +296,16 @@ describe('Type Generation', () => {
               },
               arguments: mockFilterAST,
               type: {
-                kind: 'ListType',
+                kind: 'NonNullType',
                 type: {
-                  name: {
-                    value: 'Zip',
+                  kind: 'ListType',
+                  type: {
+                    kind: 'NonNullType',
+                    type: {
+                      name: {
+                        value: 'Zip',
+                      },
+                    },
                   },
                 },
               },
@@ -354,10 +360,16 @@ describe('Type Generation', () => {
               },
               arguments: mockFilterAST,
               type: {
-                kind: 'ListType',
+                kind: 'NonNullType',
                 type: {
-                  name: {
-                    value: 'Zip',
+                  kind: 'ListType',
+                  type: {
+                    kind: 'NonNullType',
+                    type: {
+                      name: {
+                        value: 'Zip',
+                      },
+                    },
                   },
                 },
               },