Store object with no properties in arbitray JSON type

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

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

@@ -409,11 +409,6 @@ export function getResolver({
 
                 resolveData.responseHeaders = response.headers
 
-                responseBody = stringifyObjectsWithNoProperties(
-                  responseBody,
-                  operation.responseDefinition
-                )
-
                 // Deal with the fact that the server might send unsanitized data
                 let saneData = Oas3Tools.sanitizeObjKeys(responseBody)
 
@@ -904,41 +899,3 @@ function graphQLErrorWithExtensions(
 ): GraphQLError {
   return new GraphQLError(message, null, null, null, null, null, extensions)
 }
-
-/**
- * Ideally, all objects should be defined with properties. However, if they are
- * not, then we can at least stringify the data.
- *
- * This function recursively ensures that objects have properties, if not
- * stringify the data to match the mitigation.
- */
-function stringifyObjectsWithNoProperties(
-  data: any,
-  dataDef: DataDefinition
-): any {
-  if (typeof dataDef !== 'undefined') {
-    if (dataDef.type === 'array') {
-      data = data.map(element => {
-        return stringifyObjectsWithNoProperties(
-          element,
-          dataDef.subDefinitions as DataDefinition
-        )
-      })
-    } else if (dataDef.type === 'object') {
-      if (typeof dataDef.schema.properties !== 'undefined') {
-        Object.keys(data).forEach(propertyName => {
-          data[propertyName] = stringifyObjectsWithNoProperties(
-            data[propertyName],
-            dataDef.subDefinitions[propertyName]
-          )
-        })
-
-        // Schema does not have properties defined, therefore stringify
-      } else {
-        return JSON.stringify(data)
-      }
-    }
-  }
-
-  return data
-}

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

@@ -207,12 +207,7 @@ function createOrReuseOt({
        * cannot create a GraphQL Object Type for it because in GraphQL, all Object
        * Type properties must be named.
        *
-       * Instead, stringify the response.
-       *
-       * NOTE: there is a similar check in the resolver_builder.ts so that the
-       * response data is properly stringified.
-       *
-       * See stringifyObjectsWithNoProperties() function
+       * Instead, store response in an arbitray JSON type.
        */
       if (typeof def.schema.properties === 'undefined') {
         handleWarning({
@@ -226,7 +221,7 @@ function createOrReuseOt({
           data,
           log: translationLog
         })
-        return GraphQLString
+        return GraphQLJSON
       }
 
       const description =

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

@@ -23,7 +23,7 @@ export const mitigations = {
   UNRESOLVABLE_REFERENCE: `The schema will not be resolved.`,
   UNSUPPORTED_HTTP_SECURITY_SCHEME: `Ignore security scheme.`,
   NON_APPLICATION_JSON_SCHEMA: `Ignore schema`,
-  OBJECT_MISSING_PROPERTIES: `The (sub-)object will be stringified. The property will return a string in the interface.`,
+  OBJECT_MISSING_PROPERTIES: `The (sub-)object will be stored in an arbitray JSON type.`,
 
   // Links
   UNRESOLVABLE_LINK: `Ignore link.`,

packages/openapi-to-graphql/test/example_api.test.ts

@@ -1259,7 +1259,7 @@ test('Content property in parameter object', () => {
   })
 })
 
-test('Stringify objects without defined properties', () => {
+test('Handle objects without defined properties with arbitrary GraphQL JSON type', () => {
   const query = `{
     trashcan(username:"arlene") {
       brand,
@@ -1272,28 +1272,50 @@ test('Stringify objects without defined properties', () => {
   return graphql(createdSchema, query).then(result => {
     expect(result).toEqual({
       data: {
-        trashcan: {
-          brand: '"Garbage Emporium"',
-          contents: [
-            '{"type":"apple","message":"Half-eaten"}',
-            '{"type":"sock","message":"Lost one"}'
+        "trashcan": {
+          "brand": "Garbage Emporium",
+          "contents": [
+            {
+              "type": "apple",
+              "message": "Half-eaten"
+            },
+            {
+              "type": "sock",
+              "message": "Lost one"
+            }
           ]
         },
-        trashcans: [
+        "trashcans": [
           {
-            contents: [
-              '{"type":"apple","message":"Half-eaten"}',
-              '{"type":"sock","message":"Lost one"}'
+            "contents": [
+              {
+                "type": "apple",
+                "message": "Half-eaten"
+              },
+              {
+                "type": "sock",
+                "message": "Lost one"
+              }
             ]
           },
           {
-            contents: ['{"type":"sock","message":"Lost one"}']
+            "contents": [
+              {
+                "type": "sock",
+                "message": "Lost one"
+              }
+            ]
           },
           {
-            contents: []
+            "contents": []
           },
           {
-            contents: ['{"type":"tissue","message":"Used"}']
+            "contents": [
+              {
+                "type": "tissue",
+                "message": "Used"
+              }
+            ]
           }
         ]
       }