fix: bug with insertText in non-composite lists! (#2114)

Fix major issue with non-leaf types receiving insertText
graphql · Dec 9, 2021 · d5fca9d · d5fca9d · github-actions · Dec 9, 2021
1 parent f206e9b
commit d5fca9d
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 6 deletions.
diff --git a/.changeset/lazy-lies-sip.md b/.changeset/lazy-lies-sip.md
@@ -0,0 +1,5 @@
+---
+'graphql-language-service-interface': patch
+---
+
+Fix major issue with non-leaf types receiving insertText
diff --git a/packages/graphql-language-service-interface/src/__tests__/__schema__/StarWarsSchema.graphql b/packages/graphql-language-service-interface/src/__tests__/__schema__/StarWarsSchema.graphql
@@ -44,6 +44,7 @@ type Droid implements Character {
   appearsIn: [Episode]
   secretBackstory: String
   primaryFunction: String
+  instructions: [String]!
 }
 
 input InputType {

diff --git a/packages/graphql-language-service-interface/src/__tests__/getAutocompleteSuggestions-test.ts b/packages/graphql-language-service-interface/src/__tests__/getAutocompleteSuggestions-test.ts
@@ -56,10 +56,8 @@ const expectedResults = {
     insertText: `inputTypeTest {\n  $1\n}`,
   },
   appearsIn: {
-    ...commonInsert,
     label: 'appearsIn',
     detail: '[Episode]',
-    insertText: `appearsIn {\n  $1\n}`,
   },
   friends: {
     ...commonInsert,
@@ -492,6 +490,7 @@ describe('getAutocompleteSuggestions', () => {
         expectedResults.appearsIn,
         expectedResults.friends,
         { label: 'id', detail: 'String!' },
+        { label: 'instructions', detail: '[String]!' },
         { label: 'name', detail: 'String' },
         { label: 'primaryFunction', detail: 'String' },
         { label: 'secretBackstory', detail: 'String' },

diff --git a/packages/graphql-language-service-interface/src/getAutocompleteSuggestions.ts b/packages/graphql-language-service-interface/src/getAutocompleteSuggestions.ts
@@ -27,7 +27,6 @@ import {
   Kind,
   DirectiveLocation,
   GraphQLArgument,
-  isObjectType,
   isListType,
   isNonNullType,
 } from 'graphql';
@@ -284,19 +283,24 @@ export function getAutocompleteSuggestions(
 
 const insertSuffix = ` {\n  $1\n}`;
 
+/**
+ * Choose carefully when to insert the `insertText`!
+ * @param field
+ * @returns
+ */
 const getInsertText = (field: GraphQLField<null, null>) => {
   const type = field.type;
   if (isCompositeType(type)) {
     return insertSuffix;
   }
-  if (isListType(type)) {
+  if (isListType(type) && isCompositeType(type.ofType)) {
     return insertSuffix;
   }
   if (isNonNullType(type)) {
-    if (isObjectType(type.ofType)) {
+    if (isCompositeType(type.ofType)) {
       return insertSuffix;
     }
-    if (isListType(type.ofType)) {
+    if (isListType(type.ofType) && isCompositeType(type.ofType.ofType)) {
       return insertSuffix;
     }
   }