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

@@ -16,6 +16,7 @@ export declare const mitigations: {
     OBJECT_MISSING_PROPERTIES: 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

@@ -585,7 +585,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({
@@ -596,11 +596,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) {
@@ -609,15 +606,24 @@ function createFields({
         data.saneMap
       )
       fields[sanePropName] = {
-        type: reqMutationProp
+        type: requiredProperty
           ? new GraphQLNonNull(objectType)
           : (objectType as GraphQLOutputType),
 
         description:
-          typeof schema.description === 'undefined'
+          typeof fieldSchema.description === 'undefined'
             ? 'No description available.'
-            : schema.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

@@ -25,6 +25,7 @@ export const mitigations = {
   OBJECT_MISSING_PROPERTIES: `The (sub-)object will be stored in an arbitray JSON type.`,
   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

@@ -1110,7 +1110,6 @@ test('Union type', () => {
   }`
 
   return graphql(createdSchema, query, null, {}).then(result => {
-    console.log(JSON.stringify(result, null, 2))
     expect(result).toEqual({
       data: {
         assets: [
@@ -1846,8 +1845,11 @@ test('Option idFormats', () => {
       fields {
         name
         type {
-          name
           kind
+          ofType {
+            name
+            kind
+          }
         }
       }
     }
@@ -1867,8 +1869,11 @@ test('Option idFormats', () => {
         ).toEqual({
           name: 'patentId',
           type: {
-            name: 'ID',
-            kind: 'SCALAR'
+            kind: 'NON_NULL',
+            ofType: {
+              name: 'ID',
+              kind: 'SCALAR'
+            }
           }
         })
       })
@@ -1878,11 +1883,19 @@ 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!'
   )
   expect(userInputType.toConfig().fields.address2.type.toString()).toEqual(
     'AddressInput'
   )
 })
+
+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!')
+})