fix: graphql-upload types

Author: Pagebakers

packages/openapi-to-graphql/package.json

@@ -104,7 +104,7 @@
   },
   "devDependencies": {
     "@types/deep-equal": "^1.0.1",
-    "@types/graphql-upload": "^8.0.7",
+    "@types/graphql-upload": "^15.0.2",
     "@types/jest": "^27.1.5",
     "@types/node": "^16.3.3",
     "@types/url-join": "^4.0.1",

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

@@ -15,7 +15,7 @@ import { SubscriptionContext } from './types/graphql'
 import { PreprocessingData } from './types/preprocessing_data'
 import { RequestOptions, FileUploadOptions } from './types/options'
 import crossFetch from 'cross-fetch'
-import { FileUpload } from 'graphql-upload'
+import { FileUpload } from 'graphql-upload/Upload'
 
 // Imports:
 import stream from 'stream'
@@ -349,10 +349,16 @@ function inferLinkArguments<TSource, TContext, TArgs>({
   resolveData,
   source,
   args
-}: inferLinkArgumentsParam<TSource, TContext, TArgs>)  {
+}: inferLinkArgumentsParam<TSource, TContext, TArgs>) {
   if (typeof value === 'object') {
     return Object.entries(value).reduce((acc, [key, value]) => {
-      acc[key] = inferLinkArguments({paramName, value, resolveData, source, args})
+      acc[key] = inferLinkArguments({
+        paramName,
+        value,
+        resolveData,
+        source,
+        args
+      })
       return acc
     }, {})
   }
@@ -361,13 +367,22 @@ function inferLinkArguments<TSource, TContext, TArgs>({
     return value
   } else if (value.search(/{|}/) === -1) {
     return isRuntimeExpression(value)
-        ? resolveRuntimeExpression(paramName, value, resolveData, source, args)
-        : value
+      ? resolveRuntimeExpression(paramName, value, resolveData, source, args)
+      : value
   } else {
     // Replace link parameters with appropriate values
     const linkParams = value.match(/{([^}]*)}/g)
     linkParams.forEach((linkParam) => {
-      value = value.replace(linkParam, resolveRuntimeExpression(paramName, linkParam.substring(1, linkParam.length - 1), resolveData, source, args))
+      value = value.replace(
+        linkParam,
+        resolveRuntimeExpression(
+          paramName,
+          linkParam.substring(1, linkParam.length - 1),
+          resolveData,
+          source,
+          args
+        )
+      )
     })
     return value
   }
@@ -493,7 +508,13 @@ export function getResolver<TSource, TContext, TArgs extends object>({
 
       let value = argsFromLink[paramName]
 
-      args[saneParamName] = inferLinkArguments({paramName, value, resolveData, source, args})
+      args[saneParamName] = inferLinkArguments({
+        paramName,
+        value,
+        resolveData,
+        source,
+        args
+      })
     }
 
     // Stored used parameters to future requests:
@@ -595,51 +616,64 @@ export function getResolver<TSource, TContext, TArgs extends object>({
       } else if (operation.payloadContentType === 'multipart/form-data') {
         form = new FormData(fileUploadOptions)
 
-        const formFieldsPayloadEntries = Object.entries(args[sanePayloadName]);
-
-        (await Promise.all(formFieldsPayloadEntries.map(([_, v]) => v)))
-            .forEach((fieldValue, idx) => {
-              const fieldName = formFieldsPayloadEntries[idx][0]
-
-              if (typeof fieldValue === 'object' && Boolean((fieldValue as Partial<FileUpload>).createReadStream)) {
-                const uploadingFile = fieldValue as FileUpload
-                const originalFileStream = uploadingFile.createReadStream()
-                const filePassThrough = new stream.PassThrough()
+        const formFieldsPayloadEntries = Object.entries(args[sanePayloadName])
 
-                originalFileStream.on('readable', function () {
-                  let data
+        ;(
+          await Promise.all(formFieldsPayloadEntries.map(([_, v]) => v))
+        ).forEach((fieldValue, idx) => {
+          const fieldName = formFieldsPayloadEntries[idx][0]
 
-                  while (data = this.read()) {
-                    const canReadNext = filePassThrough.write(data)
-                    if (!canReadNext) {
-                      this.pause()
-                      filePassThrough.once('drain', () => this.resume())
-                    }
-                  }
-                })
+          if (
+            typeof fieldValue === 'object' &&
+            Boolean((fieldValue as Partial<FileUpload>).createReadStream)
+          ) {
+            const uploadingFile = fieldValue as FileUpload
+            const originalFileStream = uploadingFile.createReadStream()
+            const filePassThrough = new stream.PassThrough()
+
+            originalFileStream.on('readable', function () {
+              let data
+
+              while ((data = this.read())) {
+                const canReadNext = filePassThrough.write(data)
+                if (!canReadNext) {
+                  this.pause()
+                  filePassThrough.once('drain', () => this.resume())
+                }
+              }
+            })
 
-                originalFileStream.on('error', () => {
-                  uploadLog('Encountered an error while uploading the file %s', uploadingFile.filename)
-                })
+            originalFileStream.on('error', () => {
+              uploadLog(
+                'Encountered an error while uploading the file %s',
+                uploadingFile.filename
+              )
+            })
 
-                originalFileStream.on('end', () => {
-                  uploadLog('Upload for received file %s completed', uploadingFile.filename)
-                  filePassThrough.end()
-                })
+            originalFileStream.on('end', () => {
+              uploadLog(
+                'Upload for received file %s completed',
+                uploadingFile.filename
+              )
+              filePassThrough.end()
+            })
 
-                uploadLog('Queuing upload for received file %s', uploadingFile.filename)
+            uploadLog(
+              'Queuing upload for received file %s',
+              uploadingFile.filename
+            )
 
-                form.append(fieldName, filePassThrough, {
-                  filename: uploadingFile.filename,
-                  contentType: uploadingFile.mimetype
-                })
-              } else if (typeof fieldValue !== 'string') {
-                // Handle all other primitives that aren't strings as strings the way the web server would expect it
-                form.append(fieldName, JSON.stringify(fieldValue))
-              } else {
-                form.append(fieldName, fieldValue)
-              }
+            form.append(fieldName, filePassThrough, {
+              filename: uploadingFile.filename,
+              contentType: uploadingFile.mimetype
             })
+          } else if (typeof fieldValue !== 'string') {
+            // Handle all other primitives that aren't strings as strings the way the web server would expect it
+            form.append(fieldName, JSON.stringify(fieldValue))
+          } else {
+            form.append(fieldName, fieldValue)
+          }
+        })
 
         rawPayload = form
       } else {
@@ -772,7 +806,10 @@ export function getResolver<TSource, TContext, TArgs extends object>({
     } else {
       httpLog(`${response.status} - ${Oas3Tools.trim(body, 100)}`)
 
-      if (response.headers.get('content-type') && operation.responseContentType) {
+      if (
+        response.headers.get('content-type') &&
+        operation.responseContentType
+      ) {
         /**
          * Throw warning if the non-application/json content does not
          * match the OAS.
@@ -903,7 +940,7 @@ export function getResolver<TSource, TContext, TArgs extends object>({
             ) {
               let arraySaneData = saneData
 
-              if ('limit' in args && typeof(args['limit']) === 'number') {
+              if ('limit' in args && typeof args['limit'] === 'number') {
                 const limit = args['limit'] as number
 
                 if (limit >= 0) {
@@ -1211,7 +1248,9 @@ function resolveRuntimeExpression(
 
       // CASE: parameter in previous header parameter
     } else if (runtimeExpression.startsWith('$request.header')) {
-      return resolveData.usedRequestOptions.headers[runtimeExpression.split('header.')[1]]
+      return resolveData.usedRequestOptions.headers[
+        runtimeExpression.split('header.')[1]
+      ]
     }
   } else if (runtimeExpression.startsWith('$response.')) {
     /**
@@ -1339,7 +1378,11 @@ function graphQLErrorWithExtensions(
  * Replaces the path parameter in the given path with values in the given args.
  * Furthermore adds the query parameters for a request.
  */
-export function extractRequestDataFromArgs<TSource, TContext, TArgs extends object>(
+export function extractRequestDataFromArgs<
+  TSource,
+  TContext,
+  TArgs extends object
+>(
   path: string,
   parameters: ParameterObject[],
   args: TArgs, // NOTE: argument keys are sanitized!
@@ -1371,18 +1414,28 @@ export function extractRequestDataFromArgs<TSource, TContext, TArgs extends obje
         // Query parameters
         case 'query':
           // setting param style as form assumes explode is true by default
-          if (param.style === 'form' && typeof args[saneParamName] === 'object') {
+          if (
+            param.style === 'form' &&
+            typeof args[saneParamName] === 'object'
+          ) {
             if (param.explode === false) {
-              qs[param.name] = Object.entries(args[saneParamName]).reduce((acc, val) => {
-                acc += val.join(',')
-                return acc
-              }, '')
+              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) {
+          } else if (
+            Array.isArray(args[saneParamName]) &&
+            param.style === 'form' &&
+            param.explode !== false
+          ) {
             qs[param.name] = args[saneParamName].join(',')
           } else {
             qs[param.name] = args[saneParamName]

yarn.lock

@@ -979,15 +979,15 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/graphql-upload@npm:^8.0.7":
-  version: 8.0.12
-  resolution: "@types/graphql-upload@npm:8.0.12"
+"@types/graphql-upload@npm:^15.0.2":
+  version: 15.0.2
+  resolution: "@types/graphql-upload@npm:15.0.2"
   dependencies:
     "@types/express": "*"
     "@types/koa": "*"
     fs-capacitor: ^8.0.0
     graphql: 0.13.1 - 16
-  checksum: 394d5e05f4d5a205dc53f66670af28de73bc73b0910e68907e6d01348caeeb27478621cfdb238a71668f0cca7347ed362c2f1a68266da4b823707dc4daba92ee
+  checksum: 3e88a03082ce1e1de39b414a096fbd47cf1f97b6027c93cc71a216229bdfb248f54f1afc209e970e1ae3856153c20cf40d458febe348b287be237f62ea84ffc0
   languageName: node
   linkType: hard
 
@@ -4762,14 +4762,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"graphql@npm:0.13.1 - 16":
-  version: 15.8.0
-  resolution: "graphql@npm:15.8.0"
-  checksum: 423325271db8858428641b9aca01699283d1fe5b40ef6d4ac622569ecca927019fce8196208b91dd1d8eb8114f00263fe661d241d0eb40c10e5bfd650f86ec5e
-  languageName: node
-  linkType: hard
-
-"graphql@npm:^16.5.0":
+"graphql@npm:0.13.1 - 16, graphql@npm:^16.5.0":
   version: 16.6.0
   resolution: "graphql@npm:16.6.0"
   checksum: bf1d9e3c1938ce3c1a81e909bd3ead1ae4707c577f91cff1ca2eca474bfbc7873d5d7b942e1e9777ff5a8304421dba57a4b76d7a29eb19de8711cb70e3c2415e
@@ -7439,7 +7432,7 @@ __metadata:
   resolution: "openapi-to-graphql@workspace:packages/openapi-to-graphql"
   dependencies:
     "@types/deep-equal": ^1.0.1
-    "@types/graphql-upload": ^8.0.7
+    "@types/graphql-upload": ^15.0.2
     "@types/jest": ^27.1.5
     "@types/node": ^16.3.3
     "@types/url-join": ^4.0.1
@@ -9946,11 +9939,11 @@ __metadata:
 
 "typescript@patch:typescript@^4.3.4#~builtin<compat/typescript>":
   version: 4.9.5
-  resolution: "typescript@patch:typescript@npm%3A4.9.5#~builtin<compat/typescript>::version=4.9.5&hash=ad5954"
+  resolution: "typescript@patch:typescript@npm%3A4.9.5#~builtin<compat/typescript>::version=4.9.5&hash=23ec76"
   bin:
     tsc: bin/tsc
     tsserver: bin/tsserver
-  checksum: 8f6260acc86b56bfdda6004bc53f32ea548f543e8baef7071c8e34d29d292f3e375c8416556c8de10b24deef6933cd1c16a8233dc84a3dd43a13a13265d0faab
+  checksum: ab417a2f398380c90a6cf5a5f74badd17866adf57f1165617d6a551f059c3ba0a3e4da0d147b3ac5681db9ac76a303c5876394b13b3de75fdd5b1eaa06181c9d
   languageName: node
   linkType: hard