Add test for composite oneOf allOf link

Signed-off-by: Alan Cha <Alan.cha1@ibm.com>

Author: Alan-Cha

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

@@ -87,10 +87,10 @@ function processOperation<TSource, TContext, TArgs>(
     if (data.options.equivalentToMessages) {
       // Description may not exist
       if (typeof description !== 'string') {
-        description = ''
+        description = `Equivalent to ${operationString}`
+      } else {
+        description += `\n\nEquivalent to ${operationString}`
       }
-
-      description += `\n\nEquivalent to ${operationString}`
     }
 
     // Tags
@@ -699,7 +699,13 @@ export function createDataDef<TSource, TContext, TArgs>(
     // Found existing data definition and fetch it
     const existingDataDef = data.defs[index]
 
-    if (existingDataDef.targetGraphQLType === TargetGraphQLType.oneOfUnion && Array.isArray(existingDataDef.subDefinitions) // Special handling for oneOf. Sub definitions are always an array (see createOneOfUnion)
+    /**
+     * Special handling for oneOf. Subdefinitions are always an array 
+     * (see createOneOfUnion)
+     */
+    if (
+      existingDataDef.targetGraphQLType === TargetGraphQLType.oneOfUnion && 
+      Array.isArray(existingDataDef.subDefinitions) 
     ) {
       existingDataDef.subDefinitions.forEach((def) => {
           collapseLinksIntoDataDefinition({
@@ -1140,8 +1146,6 @@ function sanitizeLinks<TSource, TContext, TArgs>({
 /**
  * Given an existing data definition, collapse the link object with the existing
  * one captured in the data definition.
- *
- *
  */
 function collapseLinksIntoDataDefinition<TSource, TContext, TArgs>({
   additionalLinks,
@@ -1558,7 +1562,8 @@ function createOneOfUnion<TSource, TContext, TArgs>(
       memberSchema,
       isInputObjectType,
       data,
-      oas
+      oas,
+      def.links
     )
     ;(def.subDefinitions as DataDefinition[]).push(subDefinition)
   })

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

@@ -812,8 +812,12 @@ function createFields<TSource, TContext, TArgs>({
 
           let description = link.description
 
-          if (data.options.equivalentToMessages && description) {
-            description += `\n\nEquivalent to ${linkedOp.operationString}`
+          if (data.options.equivalentToMessages) {
+            if (typeof description !== 'string') {
+              description = `Equivalent to ${linkedOp.operationString}`
+            } else {
+              description += `\n\nEquivalent to ${linkedOp.operationString}`
+            }
           }
 
           // Finally, add the object type to the fields (using sanitized field name)

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

@@ -676,3 +676,70 @@ test('oneOf test with allOf, requiring oneOf collapse\n\nEquivalent to GET /oneO
     })
   })
 })
+
+/**
+ * oneOf contains two member schemas, each with allOf
+ * 
+ * oneOf also contains a link object
+ *
+ * Resolving the oneOf and allOfs should correctly create a union of two object
+ * types, each object type with a link field from the oneOf schema
+ */
+ test('oneOf test with allOfs, requiring oneOf collapse\n\nEquivalent to GET /OneOfWithAllOfsAndLink', () => {
+  return graphql(createdSchema, oneOfQuery).then((result) => {
+    expect(
+      result.data['__schema'].queryType.fields.find((field) => {
+        return field.name === 'oneOfWithAllOfsAndLink'
+      })
+    ).toEqual({
+      "name": "oneOfWithAllOfsAndLink",
+      "description": "Equivalent to GET /oneOfWithAllOfsAndLink",
+      "type": {
+        "name": "OneOfWithAllOfsAndLink",
+        "kind": "UNION",
+        "possibleTypes": [
+          {
+            "name": "One",
+            "fields": [
+              {
+                "type": {
+                  "name": "String"
+                }
+              },
+              {
+                "type": {
+                  "name": "String"
+                }
+              },
+              {
+                "type": {
+                  "name": "String"
+                }
+              }
+            ]
+          },
+          {
+            "name": "Two",
+            "fields": [
+              {
+                "type": {
+                  "name": "String"
+                }
+              },
+              {
+                "type": {
+                  "name": "String"
+                }
+              },
+              {
+                "type": {
+                  "name": "String"
+                }
+              }
+            ]
+          }
+        ]
+      }
+    })
+  })
+})

packages/openapi-to-graphql/test/example_gql_server.js

@@ -14,9 +14,11 @@ const openAPIToGraphQL = require('../dist/index')
 // const oas = require('./fixtures/example_oas.json')
 // const oas = require('./fixtures/example_oas2.json')
 // const oas = require('./fixtures/example_oas3.json')
-// const oas = require('./fixtures/example_oas4.json')
+const oas = require('./fixtures/example_oas4.json')
 // const oas = require('./fixtures/example_oas5.json')
-const oas = require('./fixtures/example_oas6.json')
+// const oas = require('./fixtures/example_oas6.json')
+// const oas = require('./fixtures/example_oas7.json')
+// const oas = require('./fixtures/example_oas8.json')
 // const oas = require('./fixtures/file_upload.json')
 
 // const oas = require('./fixtures/github.json')

packages/openapi-to-graphql/test/fixtures/example_oas4.json

@@ -506,6 +506,47 @@
           }
         }
       }
+    },
+    "/testLink": {
+      "get": {
+        "operationId": "testLink",
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/oneOfWithAllOfsAndLink": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Return a user.\n\nEquivalent to GET /oneOfWithAllOfsAndLink",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OneOfWithAllOfsAndLink"
+                }
+              }
+            },
+            "links": {
+              "testLink": {
+                "operationId": "testLink",
+                "parameters": {
+                  "someId": "$request.path.id"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -533,6 +574,60 @@
             "type": "string"
           }
         }
+      },
+      "OneOfWithAllOfsAndLink": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/One"
+          },
+          {
+            "$ref": "#/components/schemas/Two"
+          }
+        ]
+      },
+      "Abstract": {
+        "type": "object",
+        "properties": {
+          "commonProp": {
+            "type": "string"
+          }
+        }
+      },
+      "OneProps": {
+        "type": "object",
+        "properties": {
+          "differentOneProp": {
+            "type": "string"
+          }
+        }
+      },
+      "TwoProps": {
+        "type": "object",
+        "properties": {
+          "differentTwoProp": {
+            "type": "string"
+          }
+        }
+      },
+      "One": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/Abstract"
+          },
+          {
+            "$ref": "#/components/schemas/OneProps"
+          }
+        ]
+      },
+      "Two": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/Abstract"
+          },
+          {
+            "$ref": "#/components/schemas/TwoProps"
+          }
+        ]
       }
     }
   }