allow modification to default configuration for form data object used for file uploads

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

Author: eokoneyo

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

@@ -36,7 +36,8 @@ import {
   InternalOptions,
   Report,
   ConnectOptions,
-  RequestOptions
+  RequestOptions,
+  FileUploadOptions
 } from './types/options'
 import { Oas3 } from './types/oas3'
 import { Oas2 } from './types/oas2'
@@ -112,6 +113,7 @@ const DEFAULT_OPTIONS: InternalOptions<any, any, any> = {
   requestOptions: {},
   customResolvers: {},
   customSubscriptionResolvers: {},
+  fileUploadOptions: {},
 
   // Authentication options
   viewer: true,
@@ -193,6 +195,7 @@ export function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
     headers,
     qs,
     requestOptions,
+    fileUploadOptions,
     connectOptions,
     baseUrl,
     customResolvers,
@@ -234,6 +237,7 @@ export function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
     headers,
     qs,
     requestOptions,
+    fileUploadOptions,
     connectOptions,
     baseUrl,
     customResolvers,
@@ -477,6 +481,7 @@ function addQueryFields<TSource, TContext, TArgs>({
     singularNames,
     baseUrl,
     requestOptions,
+      fileUploadOptions,
     connectOptions,
     fetch
   } = options
@@ -486,6 +491,7 @@ function addQueryFields<TSource, TContext, TArgs>({
     baseUrl,
     data,
     requestOptions,
+    fileUploadOptions,
     connectOptions,
     fetch
   )
@@ -654,6 +660,7 @@ function addMutationFields<TSource, TContext, TArgs>({
     singularNames,
     baseUrl,
     requestOptions,
+      fileUploadOptions,
     connectOptions,
     fetch
   } = options
@@ -663,6 +670,7 @@ function addMutationFields<TSource, TContext, TArgs>({
     baseUrl,
     data,
     requestOptions,
+    fileUploadOptions,
     connectOptions,
     fetch
   )
@@ -802,13 +810,14 @@ function addSubscriptionFields<TSource, TContext, TArgs>({
   options: InternalOptions<TSource, TContext, TArgs>
   data: PreprocessingData<TSource, TContext, TArgs>
 }) {
-  const { baseUrl, requestOptions, connectOptions, fetch } = options
+  const { baseUrl, requestOptions, connectOptions, fetch, fileUploadOptions } = options
 
   const field = getFieldForOperation(
     operation,
     baseUrl,
     data,
     requestOptions,
+    fileUploadOptions,
     connectOptions,
     fetch
   )
@@ -912,6 +921,7 @@ function getFieldForOperation<TSource, TContext, TArgs>(
   baseUrl: string,
   data: PreprocessingData<TSource, TContext, TArgs>,
   requestOptions: Partial<RequestOptions<TSource, TContext, TArgs>>,
+  fileUploadOptions: FileUploadOptions,
   connectOptions: ConnectOptions,
   fetch: typeof crossFetch
 ): GraphQLFieldConfig<TSource, TContext | SubscriptionContext, TArgs> {
@@ -978,6 +988,7 @@ function getFieldForOperation<TSource, TContext, TArgs>(
       data,
       baseUrl,
       requestOptions,
+      fileUploadOptions,
       fetch
     })
 

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

@@ -13,7 +13,7 @@ import { ConnectOptions } from './types/options'
 import { TargetGraphQLType, Operation } from './types/operation'
 import { SubscriptionContext } from './types/graphql'
 import { PreprocessingData } from './types/preprocessing_data'
-import { RequestOptions } from './types/options'
+import { RequestOptions, FileUploadOptions } from './types/options'
 import crossFetch from 'cross-fetch'
 import { FileUpload } from 'graphql-upload'
 
@@ -61,6 +61,7 @@ type GetResolverParams<TSource, TContext, TArgs> = {
   data: PreprocessingData<TSource, TContext, TArgs>
   baseUrl?: string
   requestOptions?: Partial<RequestOptions<TSource, TContext, TArgs>>
+  fileUploadOptions?: FileUploadOptions
   fetch: typeof crossFetch
 }
 
@@ -334,6 +335,7 @@ export function getResolver<TSource, TContext, TArgs> ({
   data,
   baseUrl,
   requestOptions,
+    fileUploadOptions,
   fetch
 }: GetResolverParams<TSource, TContext, TArgs>): GraphQLFieldResolver<
   TSource & OpenAPIToGraphQLSource<TSource, TContext, TArgs>,
@@ -578,7 +580,7 @@ export function getResolver<TSource, TContext, TArgs> ({
           Oas3Tools.desanitizeObjectKeys(args[sanePayloadName], data.saneMap)
         )
       } else if (operation.payloadContentType === 'multipart/form-data') {
-        form = new FormData()
+        form = new FormData(fileUploadOptions)
 
         const formFieldsPayloadEntries = Object.entries(args[sanePayloadName]);
 

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

@@ -785,6 +785,7 @@ function createFields<TSource, TContext, TArgs>({
             data,
             baseUrl: data.options.baseUrl,
             requestOptions: data.options.requestOptions,
+            fileUploadOptions: data.options.fileUploadOptions,
             fetch
           })
 

packages/openapi-to-graphql/src/types/options.ts

@@ -7,6 +7,7 @@
 import { GraphQLOperationType, SubscriptionContext } from './graphql'
 import { GraphQLFieldResolver, GraphQLResolveInfo } from 'graphql'
 import crossFetch from 'cross-fetch'
+import FormData from 'form-data'
 
 /**
  * Type definition of the options that users can pass to OpenAPI-to-GraphQL.
@@ -76,6 +77,17 @@ export type RequestOptions<TSource, TContext, TArgs> = Omit<
   qs?: Record<string, string>
 }
 
+/**
+ * We use the form-data library to prepare multipart requests within the resolver API calls,
+ * also it provides support for handling file as streams this way the file upload has a minimal memory footprint,
+ * unlike the situation where the entire file in memory initially.
+ *
+ * Provides accommodation to allow overrides or add options for how the form data representation for multipart requests is generated
+ *
+ * Based on: https://github.com/form-data/form-data#custom-options
+ */
+export type FileUploadOptions = ConstructorParameters<typeof FormData>[0]
+
 export type Options<TSource, TContext, TArgs> = Partial<
   InternalOptions<TSource, TContext, TArgs>
 >
@@ -275,6 +287,14 @@ export type InternalOptions<TSource, TContext, TArgs> = {
     resolve: GraphQLFieldResolver<TSource, TContext, TArgs>
   }>
 
+  /**
+   * Allows one to define config for the form data that will be used in streaming
+   * the uploaded file from the client to the intending endpoint
+   *
+   * Based on https://github.com/form-data/form-data#custom-options
+   */
+  fileUploadOptions?: FileUploadOptions
+
   // Authentication options
 
   /**