- Add query-string library as a dependency

DanailPenev · DanailPenev · commit bd7ccc6acfe5 · 2022-04-02T18:29:05.000+01:00
- Add an optional parameter `useQueryString` to `RequestOptions` which allows callers to use the query string library when generating the resolvers
- Add branching logic that uses either query-string or the previous custom logic

Signed-off-by: Dani Penev &lt;danailnpenev@gmail.com&gt;
diff --git a/packages/openapi-to-graphql/package.json b/packages/openapi-to-graphql/package.json
@@ -94,6 +94,7 @@
     "jsonpointer": "^5.0.0",
     "oas-validator": "^5.0.2",
     "pluralize": "^8.0.0",
+    "query-string": "^7.1.1",
     "swagger2openapi": "^7.0.2",
     "tslib": "^2.3.0",
     "url-join": "4.0.1",
@@ -105,7 +106,7 @@
   "devDependencies": {
     "@types/deep-equal": "^1.0.1",
     "@types/graphql": "^14.0.3",
-    "@types/graphql-upload": "^8.0.7",
+    "@types/graphql-upload": "8.0.7",
     "@types/jest": "^26.0.14",
     "@types/node": "^16.3.3",
     "@types/url-join": "^4.0.1",
diff --git a/packages/openapi-to-graphql/src/resolver_builder.ts b/packages/openapi-to-graphql/src/resolver_builder.ts
@@ -28,6 +28,7 @@ import formurlencoded from 'form-urlencoded'
 import { PubSub } from 'graphql-subscriptions'
 import urljoin from 'url-join'
 import FormData from 'form-data'
+import * as querystring from 'query-string';
 
 const pubsub = new PubSub()
 
@@ -722,7 +723,11 @@ export function getResolver<TSource, TContext, TArgs>({
 
     resolveData.usedRequestOptions = options
     resolveData.usedStatusCode = operation.statusCode
-    setSearchParamsFromObj(url, qs, [])
+    if (requestOptions.useQueryString) {
+      setSearchFromObj(url, qs)
+    } else {
+      setSearchParamsFromObj(url, qs, [])
+    }
     resolveData.url = url.toString().replace(url.search, '')
 
     // Make the call
@@ -1411,6 +1416,12 @@ export function extractRequestDataFromArgs<TSource, TContext, TArgs>(
   return { path, qs, headers }
 }
 
+// This can be extended in the future to take an optional object which controls 
+// the stringify options as listed here https://github.com/sindresorhus/query-string#stringifyobject-options
+const setSearchFromObj = (url: URL, obj: any) => {
+  url.search = querystring.stringify(obj);
+}
+
 const setSearchParamsFromObj = (url: URL, obj: any, path: string[]) => {
   for (const key in obj) {
     const val = obj[key]
diff --git a/packages/openapi-to-graphql/src/types/options.ts b/packages/openapi-to-graphql/src/types/options.ts
@@ -68,13 +68,16 @@ export type RequestHeadersFunction<TSource, TContext, TArgs> = (
  * function.
  *
  * Based on: https://github.com/request/request#requestoptions-callback
+ * 
+ * useQueryString is an optional parameter to use a the query-string library
  */
 export type RequestOptions<TSource, TContext, TArgs> = Omit<
   RequestInit,
   'headers'
 > & {
   headers?: HeadersInit | RequestHeadersFunction<TSource, TContext, TArgs>
   qs?: Record<string, string>
+  useQueryString?: boolean
 }
 
 /**
diff --git a/packages/openapi-to-graphql/test/example_api6.test.ts b/packages/openapi-to-graphql/test/example_api6.test.ts
@@ -396,3 +396,41 @@ test('Handle no response schema', () => {
     })
   })
 })
+
+/**
+ * GET /arrayInQueryParameters with and without the useQueryString requestOption
+ *
+ * The default behaviour is to add indexed parameters, i.e. a[0]=x&a[1]=y.
+ * The querystring behaviour (which can be made configurable in the future) is a=x&a=y
+ */
+test('Optionally use queryString', () => {
+  const query = `{
+    arrayInQueryParameters(ids: ["a", "b"])
+  }`
+
+  // Use default settings
+  const promise = graphql(createdSchema, query).then((result) => {
+    expect(result.data).toEqual({
+      arrayInQueryParameters: encodeURI('ids[0]=a&ids[1]=b')
+    })
+  })
+
+  // Set useQueryString to true
+  const options: Options<any, any, any> = {
+    requestOptions: {
+      useQueryString: true
+    }
+  }
+
+  const promise2 = openAPIToGraphQL
+    .createGraphQLSchema(oas, options)
+    .then(({ schema, report }) => {
+      return graphql(schema, query).then((result) => {
+        expect(result.data).toEqual({
+          arrayInQueryParameters: encodeURI('ids=a&ids=b')
+        })
+      })
+    })
+
+  return Promise.all([promise, promise2])
+})
diff --git a/packages/openapi-to-graphql/test/example_api6_server.js b/packages/openapi-to-graphql/test/example_api6_server.js
@@ -57,6 +57,13 @@ function startServer(PORT) {
     }
   )
 
+  app.get(
+    '/api/arrayInQueryParameters',
+    (req, res) => {
+      res.send(req.originalUrl.split('?')[1])
+    }
+  )
+
   function stringifyRussianDolls(russianDoll) {
     if (!typeof russianDoll.name === 'string') {
       return ''
diff --git a/packages/openapi-to-graphql/test/fixtures/example_oas6.json b/packages/openapi-to-graphql/test/fixtures/example_oas6.json
@@ -416,6 +416,36 @@
           }
         }
       }
+    },
+    "/arrayInQueryParameters": {
+      "get": {
+        "description": "Takes an array as GET query parameter",
+        "responses": {
+          "200": {
+            "description": "Success",
+            "content": {
+              "text/html": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "ids",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        ]
+      }
     }
   },
   "components": {
diff --git a/packages/openapi-to-graphql/yarn.lock b/packages/openapi-to-graphql/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,13 @@ function startServer(PORT) {`
`57`	`57`	`}`
`58`	`58`	`)`
`59`	`59`
	`60`	`+ app.get(`
	`61`	`+ '/api/arrayInQueryParameters',`
	`62`	`+ (req, res) => {`
	`63`	`+ res.send(req.originalUrl.split('?')[1])`
	`64`	`+ }`
	`65`	`+ )`
	`66`	`+`
`60`	`67`	`function stringifyRussianDolls(russianDoll) {`
`61`	`68`	`if (!typeof russianDoll.name === 'string') {`
`62`	`69`	`return ''`