fix: patched documentation generator exception on missing astNode (#176)

fixes #175 

Co-authored-by: James Mortemore <[email protected]>

Author: velias

index.js

@@ -147,21 +147,25 @@ function constraintDirectiveDocumentation (options) {
   return (schema) =>
     mapSchema(schema, {
       [MapperKind.FIELD]: (fieldConfig) => {
-        const directiveArgumentMap = getDirectiveValues(constraintDirectiveTypeDefsObj, fieldConfig.astNode)
+        if (fieldConfig?.astNode) {
+          const directiveArgumentMap = getDirectiveValues(constraintDirectiveTypeDefsObj, fieldConfig.astNode)
 
-        if (directiveArgumentMap) {
-          documentConstraintDirective(fieldConfig, directiveArgumentMap)
+          if (directiveArgumentMap) {
+            documentConstraintDirective(fieldConfig, directiveArgumentMap)
 
-          return fieldConfig
+            return fieldConfig
+          }
         }
       },
       [MapperKind.ARGUMENT]: (fieldConfig) => {
-        const directiveArgumentMap = getDirectiveValues(constraintDirectiveTypeDefsObj, fieldConfig.astNode)
+        if (fieldConfig?.astNode) {
+          const directiveArgumentMap = getDirectiveValues(constraintDirectiveTypeDefsObj, fieldConfig.astNode)
 
-        if (directiveArgumentMap) {
-          documentConstraintDirective(fieldConfig, directiveArgumentMap)
+          if (directiveArgumentMap) {
+            documentConstraintDirective(fieldConfig, directiveArgumentMap)
 
-          return fieldConfig
+            return fieldConfig
+          }
         }
       }
     })

test/snapshots/ws-1-1.txt

@@ -0,0 +1,51 @@
+directive @constraint(minLength: Int, maxLength: Int, startsWith: String, endsWith: String, contains: String, notContains: String, pattern: String, format: String, min: Float, max: Float, exclusiveMin: Float, exclusiveMax: Float, multipleOf: Float, minItems: Int, maxItems: Int, uniqueTypeName: String) on INPUT_FIELD_DEFINITION | FIELD_DEFINITION | ARGUMENT_DEFINITION
+
+type Query {
+  """Query books field documented"""
+  books(
+    "*Constraints:*\n* Minimal value: `1`\n* Maximal value: `3`\n"
+    size: Int
+
+    " Query argument documented \n\n*Constraints:*\n* Minimal length: `1`\n"
+    first: String
+  ): [Book]
+
+  """ Query book field documented """
+  book: Book
+  addedField: String
+}
+
+type Book {
+  "*Constraints:*\n* Maximal length: `10`\n"
+  title: String
+
+  "Book description already documented\n\n*Constraints:*\n* Minimal length: `10`\n* Maximal length: `50`\n"
+  description: String
+  authors(
+    "Book authors argument documented\n\n*Constraints:*\n* Maximal value: `4`\n"
+    size: Int
+
+    """
+    Already documented
+    
+    *Constraints:*
+    * Minimal length as documented: 1
+    """
+    first: String
+  ): [String]
+}
+
+type Mutation {
+  createBook(input: BookInput): Book
+}
+
+input BookInput {
+  "*Constraints:*\n* Minimal value: `3`\n"
+  title: Int!
+  author: AuthorInput
+}
+
+input AuthorInput {
+  "*Constraints:*\n* Minimal length: `2`\n"
+  name: String!
+}

test/testsuite-documentation.js

@@ -1,8 +1,9 @@
 const { constraintDirectiveTypeDefs, constraintDirectiveDocumentation, constraintDirective } = require('..')
 const { makeExecutableSchema } = require('@graphql-tools/schema')
-const { printSchema } = require('graphql')
+const { GraphQLString, GraphQLObjectType, printSchema } = require('graphql')
 const { equal } = require('assert')
 const fs = require('fs')
+const { mapSchema, MapperKind } = require('@graphql-tools/utils')
 
 /**
  * If `true` schema data are refreshed in the storage, if `false` schema is compared with the data in the storage
@@ -82,6 +83,33 @@ describe('Schema Documentation', function () {
     assertSchemaData('ws-1', schema)
   })
 
+  it('works - default options - modified schema', async function () {
+    let schema = makeExecutableSchema({
+      typeDefs: [constraintDirectiveTypeDefs, typeDefs]
+    })
+
+    schema = addFieldToSchema(schema)
+
+    schema = constraintDirectiveDocumentation()(schema)
+
+    assertSchemaData('ws-1-1', schema)
+  })
+
+  function addFieldToSchema (schema) {
+    return mapSchema(schema, {
+      [MapperKind.OBJECT_TYPE]: type => {
+        if (type.name === 'Query') {
+          const config = type.toConfig()
+          config.fields.addedField = {
+            type: GraphQLString,
+            args: {}
+          }
+          return new GraphQLObjectType(config)
+        }
+      }
+    })
+  }
+
   it('works - customized options', async function () {
     let schema = makeExecutableSchema({
       typeDefs: [constraintDirectiveTypeDefs, typeDefs]