adds support for OAS query parameter serialization expection for generated http requests

Signed-off-by: Eyo O. Eyo <[email protected]>

Author: eokoneyo

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

@@ -1360,7 +1360,23 @@ export function extractRequestDataFromArgs<TSource, TContext, TArgs>(
 
         // Query parameters
         case 'query':
-          qs[param.name] = args[saneParamName]
+          // setting param style as form assumes explode is true by default
+          if (param.style === 'form' && Object.prototype.toString.call(args[saneParamName]) === '[object Object]') {
+            if (param.explode === false) {
+              qs[param.name] = Object.entries(args[saneParamName]).reduce((acc, val) => {
+                acc += val.join(',')
+                return acc
+              }, '')
+            } else {
+              Object.entries(args[saneParamName]).forEach(([key, value]) => {
+                qs[key] = value
+              })
+            }
+          } else if (Array.isArray(args[saneParamName]) && param.style === 'form' && param.explode !== false) {
+            qs[param.name] = args[saneParamName].join(',')
+          } else {
+            qs[param.name] = args[saneParamName]
+          }
           break
 
         // Header parameters

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

@@ -2411,3 +2411,32 @@ test('Non-nullable properties from nested allOf', () => {
     })
   })
 })
+
+test('it formats the request url appropriate when style and explode is set to true', async () => {
+  const LIMIT = 10
+  const OFFSET = 0
+
+  const query = `
+    query {
+      fetchAllOfficesWithFormStyleAndExplodeTrue(parameters: { limit: ${LIMIT}, offset: ${OFFSET} }) {
+        roomNumber
+        company {
+          id
+        }
+      }
+    }
+  `
+
+  await graphql(createdSchema, query).then((result) => {
+    // target error field because the corresponding server url is not implemented,
+    // also we get the full request url as in failed request errors
+    result.errors.forEach((error) => {
+      const url = new URL(error.extensions.url)
+
+      expect(url.searchParams.has('limit')).toBe(true)
+      expect(url.searchParams.get('limit')).toBe(String(LIMIT))
+      expect(url.searchParams.has('offset')).toBe(true)
+      expect(url.searchParams.get('offset')).toBe(String(OFFSET))
+    })
+  })
+})

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

@@ -471,6 +471,46 @@
         }
       }
     },
+    "/offices": {
+      "get": {
+        "x-graphql-field-name": "fetchAllOfficesWithFormStyleAndExplodeTrue",
+        "operationId": "returnAllOffices",
+        "description": "returns all offices",
+        "parameters": [{
+          "name": "parameters",
+          "in": "query",
+          "required": true,
+          "style": "form",
+          "explode": true,
+          "schema": {
+            "type": "object",
+            "properties": {
+              "limit": {
+                "type": "integer"
+              },
+              "offset": {
+                "type": "integer"
+              }
+            }
+          }
+        }],
+        "responses": {
+          "200": {
+            "description": "A list of users.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/office"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/offices/{id}": {
       "get": {
         "operationId": "getOffice",