Collapse required schema properties

Signed-off-by: Alan Cha <[email protected]>

Author: Alan-Cha

packages/openapi-to-graphql/lib/preprocessor.js

@@ -8,6 +8,12 @@ import * as GraphQLJSON from 'graphql-type-json';
 export declare type DataDefinition = {
     preferredName: string;
     schema: SchemaObject;
+    /**
+     * Similar to the required property in object schemas but because of certain
+     * keywords to combine schemas, e.g. "allOf", this resolves the required
+     * property in all subschemas
+     */
+    required: string[];
     targetGraphQLType: string;
     links: {
         [key: string]: LinkObject;

packages/openapi-to-graphql/lib/preprocessor.js.map

@@ -544,6 +544,7 @@ export function createDataDef(
        * currently, it does not.
        */
       schema,
+      required: [],
       targetGraphQLType,
       subDefinitions: undefined,
       links: saneLinks,
@@ -583,7 +584,14 @@ export function createDataDef(
 
         // Resolve allOf element in schema if applicable
         if ('allOf' in schema) {
-          addAllOfToDataDef(def, schema, isInputObjectType, data, oas)
+          addAllOfToDataDef(
+            def,
+            schema,
+            def.required,
+            isInputObjectType,
+            data,
+            oas
+          )
         } else if ('anyOf' in schema) {
           handleWarning({
             typeKey: 'UNSUPPORTED_JSON_SCHEMA_KEYWORD',
@@ -614,7 +622,14 @@ export function createDataDef(
         }
 
         // Add existing properties (regular object type)
-        addObjectPropertiesToDataDef(def, schema, isInputObjectType, data, oas)
+        addObjectPropertiesToDataDef(
+          def,
+          schema,
+          def.required,
+          isInputObjectType,
+          data,
+          oas
+        )
       } else if (targetGraphQLType === 'union') {
         def.subDefinitions = []
 
@@ -822,6 +837,7 @@ function getSchemaName(
 function addAllOfToDataDef(
   def: DataDefinition,
   schema: SchemaObject,
+  required: string[],
   isInputObjectType: boolean,
   data: PreprocessingData,
   oas?: Oas3
@@ -834,11 +850,18 @@ function addAllOfToDataDef(
 
     // Recurse into nested allOf (if applicable)
     if ('allOf' in subSchema) {
-      addAllOfToDataDef(def, subSchema, isInputObjectType, data, oas)
+      addAllOfToDataDef(def, subSchema, required, isInputObjectType, data, oas)
     }
 
     // Add properties of the subSchema
-    addObjectPropertiesToDataDef(def, subSchema, isInputObjectType, data, oas)
+    addObjectPropertiesToDataDef(
+      def,
+      subSchema,
+      required,
+      isInputObjectType,
+      data,
+      oas
+    )
   })
 }
 
@@ -848,10 +871,22 @@ function addAllOfToDataDef(
 function addObjectPropertiesToDataDef(
   def: DataDefinition,
   schema: SchemaObject,
+  required: string[],
   isInputObjectType: boolean,
   data: PreprocessingData,
   oas?: Oas3
 ) {
+  /**
+   * Resolve all required properties
+   *
+   * TODO: required may contain duplicates, which is not necessarily a problem
+   */
+  if (Array.isArray(schema.required)) {
+    schema.required.forEach(requiredProperty => {
+      required.push(requiredProperty)
+    })
+  }
+
   for (let propertyKey in schema.properties) {
     let propSchemaName = propertyKey
     let propSchema = schema.properties[propertyKey]

packages/openapi-to-graphql/lib/schema_builder.js

@@ -612,7 +612,7 @@ function createFields({
     })
 
     const requiredProperty =
-      'required' in def.schema && def.schema.required.includes(fieldTypeKey) // The full schema, not field schema, will contain the required property
+      typeof def.required === 'object' && def.required.includes(fieldTypeKey)
 
     // Finally, add the object type to the fields (using sanitized field name)
     if (objectType) {
@@ -1217,20 +1217,19 @@ export function getArgs({
     })
 
     // Sanitize the argument name
-    const saneName = data.options.genericPayloadArgName
-      ? 'requestBody'
-      : Oas3Tools.sanitize(
+    const saneName = data.options.genericPayloadArgName ?
+      'requestBody' :
+      Oas3Tools.sanitize(
         requestPayloadDef.graphQLInputObjectTypeName,
         Oas3Tools.CaseStyle.camelCase
       )
 
-    let reqRequired = false
-    if (
+    const reqRequired =
       typeof operation === 'object' &&
       typeof operation.payloadRequired === 'boolean'
-    ) {
-      reqRequired = operation.payloadRequired
-    }
+        ? operation.payloadRequired
+        : false
+
     args[saneName] = {
       type: reqRequired ? new GraphQLNonNull(reqObjectType) : reqObjectType,
       // TODO: addendum to the description explaining this is the request body

packages/openapi-to-graphql/lib/schema_builder.js.map

@@ -36,6 +36,13 @@ export type DataDefinition = {
   // The schema of the data type, why may have gone through some resolution, and is used with preferredName to identify a specific GraphQL type
   schema: SchemaObject
 
+  /**
+   * Similar to the required property in object schemas but because of certain
+   * keywords to combine schemas, e.g. "allOf", this resolves the required
+   * property in all subschemas
+   */
+  required: string[]
+
   // The type GraphQL type this dataDefintion will be created into
   targetGraphQLType: string
 

packages/openapi-to-graphql/lib/types/operation.d.ts

@@ -2258,4 +2258,44 @@ test('Option genericPayloadArgName', () => {
     })
 
   return Promise.all([promise, promise2])
-})
+})
+
+test('Non-nullable properties from nested allOf', () => {
+  // Check query/mutation field descriptions
+  const query = `{
+    __type(name: "Nomenclature") {
+      fields {
+        name
+        type {
+          kind
+          ofType {
+            name
+            kind
+          }
+        }
+      }
+    }
+  }`
+
+  return openAPIToGraphQL.createGraphQlSchema(oas).then(({ schema }) => {
+    const ast = parse(query)
+    const errors = validate(schema, ast)
+    expect(errors).toEqual([])
+    return graphql(schema, query).then(result => {
+      expect(
+        result.data['__type'].fields.find(field => {
+          return field.name === 'family'
+        })
+      ).toEqual({
+        name: 'family',
+        type: {
+          kind: 'NON_NULL',
+          ofType: {
+            name: 'String',
+            kind: 'SCALAR'
+          }
+        }
+      })
+    })
+  })
+})

packages/openapi-to-graphql/src/preprocessor.ts

@@ -1243,7 +1243,8 @@
               "family": {
                 "$ref": "#/components/schemas/familyString"
               }
-            }
+            },
+            "required": ["family"]
           },
           {
             "properties": {