Non-nullable properties in GraphQL object types

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

Author: Alan-Cha

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

@@ -17,6 +17,7 @@ export declare const mitigations: {
     UNSUPPORTED_JSON_SCHEMA_KEYWORD: string;
     UNION_MEMBER_NON_OBJECT: string;
     AMBIGUOUS_UNION_MEMBERS: string;
+    CANNOT_GET_FIELD_TYPE: string;
     UNRESOLVABLE_LINK: string;
     AMBIGUOUS_LINK: string;
     LINK_NAME_COLLISION: string;

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

@@ -475,7 +475,7 @@ function createOrReuseList({
     translationLog(`Reuse GraphQLList '${def.graphQLInputObjectTypeName}'`)
     return def.graphQLInputObjectType as GraphQLList<any>
   }
-  
+
   // Create new List Object Type
   translationLog(`Create GraphQLList '${def.graphQLTypeName}'`)
 
@@ -600,7 +600,7 @@ function createFields({
   // Create fields for properties
   for (let fieldTypeKey in fieldTypeDefinitions) {
     const fieldTypeDefinition = fieldTypeDefinitions[fieldTypeKey]
-    const schema = fieldTypeDefinition.schema
+    const fieldSchema = fieldTypeDefinition.schema
 
     // Get object type describing the property
     const objectType = getGraphQLType({
@@ -611,11 +611,8 @@ function createFields({
       isInputObjectType
     })
 
-    // Determine if this property is required in mutations
-    const reqMutationProp =
-      isInputObjectType &&
-      'required' in def.schema && // The full schema, not subschema, will contain the required property
-      def.schema.required.includes(fieldTypeKey)
+    const requiredProperty =
+      'required' in def.schema && def.schema.required.includes(fieldTypeKey) // The full schema, not field schema, will contain the required property
 
     // Finally, add the object type to the fields (using sanitized field name)
     if (objectType) {
@@ -629,12 +626,21 @@ function createFields({
         data.saneMap
       )
       fields[sanePropName] = {
-        type: reqMutationProp
+        type: requiredProperty
           ? new GraphQLNonNull(objectType)
           : (objectType as GraphQLOutputType),
 
-        description: schema.description
+        description: fieldSchema.description
       }
+    } else {
+      handleWarning({
+        typeKey: 'CANNOT_GET_FIELD_TYPE',
+        message:
+          `Cannot obtain GraphQL type for field '${fieldTypeKey}' in ` +
+          `GraphQL type '${JSON.stringify(def.schema)}'.`,
+        data,
+        log: translationLog
+      })
     }
   }
 

packages/openapi-to-graphql/lib/utils.d.ts

@@ -26,6 +26,7 @@ export const mitigations = {
   UNSUPPORTED_JSON_SCHEMA_KEYWORD: `Ignore keyword and continue.`,
   UNION_MEMBER_NON_OBJECT: `Ignore union member type and continue.`,
   AMBIGUOUS_UNION_MEMBERS: `Ignore issue and continue.`,
+  CANNOT_GET_FIELD_TYPE: `Ignore field and continue.`,
 
   // Links
   UNRESOLVABLE_LINK: `Ignore link.`,

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

@@ -1901,8 +1901,11 @@ test('Option idFormats', () => {
       fields {
         name
         type {
-          name
           kind
+          ofType {
+            name
+            kind
+          }
         }
       }
     }
@@ -1922,8 +1925,11 @@ test('Option idFormats', () => {
         ).toEqual({
           name: 'patentId',
           type: {
-            name: 'ID',
-            kind: 'SCALAR'
+            kind: 'NON_NULL',
+            ofType: {
+              name: 'ID',
+              kind: 'SCALAR'
+            }
           }
         })
       })
@@ -1933,7 +1939,7 @@ test('Option idFormats', () => {
 test('Required properties for input object types', () => {
   const userInputType = createdSchema.getType('UserInput')
 
-  // The exclamation mark shows that it is a required property
+  // The exclamation mark shows that it is a required (non-nullable) property
   expect(userInputType.toConfig().fields.address.type.toString()).toEqual(
     'AddressInput!'
   )
@@ -2186,6 +2192,14 @@ test('Query string arguments are not created when they are provided through requ
     })
 })
 
+test('Non-nullable properties for object types', () => {
+  const coordinates = createdSchema.getType('Coordinates')
+
+  // The exclamation mark shows that it is a required (non-nullable) property
+  expect(coordinates.toConfig().fields.lat.type.toString()).toEqual('Float!')
+  expect(coordinates.toConfig().fields.long.type.toString()).toEqual('Float!')
+})
+
 test('Option genericPayloadArgName', () => {
   const query = `{
     __schema {