Changed requestOptions as function so that we can change options depending on the request

Author: dinumathai

packages/openapi-to-graphql/README.md

@@ -176,12 +176,10 @@ Resolver options:
 
 - `qs` (type: `object`, default: `{}`): Query parameters to be sent in every request to the API. Parameters defined in the OpenAPI Specification and set by these query parameters will be ignored by OpenAPI-to-GraphQL.
 
-- `requestOptions` (type: `object`, default: `{}`): Additional [options](https://github.com/request/request#requestoptions-callback), provided by the [`Request` module](https://github.com/request/request), that can be used to configure the HTTP calls that powers the generated GraphQL resolvers. A common use case for this option is to set up a web proxy with the `proxy` field. Parameters defined in the OpenAPI Specification and  set by this option will be ignored by OpenAPI-to-GraphQL. Additionally, the `headers` field has the feature of being used as a function. If used as a function, the following parameters will be exposed per-request: the operation's `method`, the operation's `path`, the API `title`, and `resolverParams` (the [GraphQL resolver's parameters](https://graphql.org/learn/execution/#root-fields-resolvers)). The function should return the desired headers.
+- `requestOptions` (type: `object` | `function`, default: `{}`): Additional [options](https://github.com/request/request#requestoptions-callback), provided by the [`Request` module](https://github.com/request/request), that can be used to configure the HTTP calls that powers the generated GraphQL resolvers. A common use case for this option is to set up a web proxy with the `proxy` field. Parameters defined in the OpenAPI Specification and  set by this option will be ignored by OpenAPI-to-GraphQL. Additionally, the `headers` field has the feature of being used as a function. If used as a function, the following parameters will be exposed per-request: the operation's `method`, the operation's `path`, the API `title`, and `resolverParams` (the [GraphQL resolver's parameters](https://graphql.org/learn/execution/#root-fields-resolvers)). The function should return the desired headers. If `requestOptions` is used as a function, the following parameters will be exposed per-request: the operation's `method`, the operation's `path`, the API `title`, and `resolverParams` (the [GraphQL resolver's parameters](https://graphql.org/learn/execution/#root-fields-resolvers)). It should return object of type [options](https://github.com/request/request#requestoptions-callback). If `requestOptions` is used as a function `url` and `method` can also be set.
 
 - `baseUrl` (type: `string`): Used to manually specify the base URL which all paths will be built on. Normally, OpenAPI-to-GraphQL will select a base URL from the [server object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverObject) defined in the OAS. However, if the server object contains multiple URLs, OpenAPI-to-GraphQL will randomly select one. The purpose of this option is to provide greater control over the base URL in these situations, especially when the OAS cannot be modified. This option may also prove to be useful in testing and development.
 
-- `urlResolver` (type: `object` | `function`, default: `{}`): URL used to send every request to the API. The following parameters will be exposed per-request: the operation's `method`, the operation's `path`, the API `title`, and `resolverParams` (the [GraphQL resolver's parameters](https://graphql.org/learn/execution/#root-fields-resolvers)). The function should return the desired url.
-
 - `customResolvers` (type: `object`, default: `{}`): OpenAPI-to-GraphQL, by default, creates resolver functions that make REST calls to resolve Query and Mutation fields in the generated GraphQL interface. This option allows users to provide custom resolver functions to be used in place of said ones created by OpenAPI-to-GraphQL. The field that the custom resolver will affect is identifed first by the [title](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject) of the OAS, then the [path](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#paths-object) of the operation, and lastly the [method](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#path-item-object) of the operation. The `customResolvers` object is thus a triply nested object where the outer key is the title, followed by the path, and finally the method, which points to the [resolver function](https://graphql.org/learn/execution/#root-fields-resolvers) itself. The resolver function can use the parameters `obj`, `args`, `context`, and `info` in order to produce the proper data, as do standard [resolver functions](https://graphql.org/learn/execution/#root-fields-resolvers) in GraphQL. Use cases include the resolution of complex relationships between types, implementing performance improvements like caching, or dealing with non-standard authentication requirements. _Note: Because the arguments are provided by the GraphQL interface, they may look different from the [parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject) defined by the OAS. For example, they will have [sanitized](https://github.com/IBM/openapi-to-graphql#characteristics) names. The [request body](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#requestBodyObject) will also be contained in the arguments as an [input object type](https://graphql.org/graphql-js/mutations-and-input-types/)._
 
 - `customSubscriptionResolvers` (type: `object`, default: `{}`): If the `createSubscriptionsFromCallbacks` is enabled, OpenAPI-to-GraphQL will generate Subscription fields. This option allows users to provide custom resolver and subscribe functions to be used in place of said ones created by OpenAPI-to-GraphQL. The field that the custom resolver and subscribe functions will affect is identifed first by the [title](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject) of the OAS, then the [path](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#paths-object) of the operation, and lastly the [method](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#path-item-object) of the operation. The resolver is provided via the `resolver` field and the publish function is provided via the `publish` field. The `customSubscriptionResolvers` object is thus a quadruply nested object where the outer key is the title, followed by the path, then the method, and lastly either `resolver` or `publish` which points to the [resolver function](https://graphql.org/learn/execution/#root-fields-resolvers) itself or publish function. See the [Subscriptions tutorial](./docs/subscriptions.md) for more information. _Note: Because the arguments are provided by the GraphQL interface, they may look different from the [parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject) defined by the OAS. For example, they will have [sanitized](https://github.com/IBM/openapi-to-graphql#characteristics) names. The [request body](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#requestBodyObject) will also be contained in the arguments as an [input object type](https://graphql.org/graphql-js/mutations-and-input-types/)._

packages/openapi-to-graphql/lib/index.js

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 /**
  * Functions to create resolve functions.
  */
@@ -6,7 +7,7 @@ import { ConnectOptions } from './types/options';
 import { Operation } from './types/operation';
 import { SubscriptionContext } from './types/graphql';
 import { PreprocessingData } from './types/preprocessing_data';
-import { RequestOptions } from './types/options';
+import { RequestOptions, RequestOptionsFunction } from './types/options';
 import { GraphQLFieldResolver } from 'graphql';
 import { IncomingHttpHeaders } from 'http';
 export declare const OPENAPI_TO_GRAPHQL = "_openAPIToGraphQL";
@@ -19,7 +20,7 @@ declare type GetResolverParams<TSource, TContext, TArgs> = {
     responseName?: string;
     data: PreprocessingData<TSource, TContext, TArgs>;
     baseUrl?: string;
-    requestOptions?: Partial<RequestOptions<TSource, TContext, TArgs>>;
+    requestOptions?: Partial<RequestOptions<TSource, TContext, TArgs>> | RequestOptionsFunction<TSource, TContext, TArgs>;
 };
 declare type GetSubscribeParams<TSource, TContext, TArgs> = {
     operation: Operation;

packages/openapi-to-graphql/lib/index.js.map

@@ -43,16 +43,12 @@ export declare type RequestHeadersFunction<TSource, TContext, TArgs> = (method:
     context: TContext;
     info: GraphQLResolveInfo;
 }) => Headers;
-/**
- * Given a set parameters corresponding to a specific operation in the OAS,
- * provide the appropriate url
- */
-export declare type RequestURLFunction<TSource, TContext, TArgs> = (method: string, path: string, title: string, resolverParams?: {
+export declare type RequestOptionsFunction<TSource, TContext, TArgs> = (method: string, path: string, title: string, resolverParams?: {
     source: TSource;
     args: TArgs;
     context: TContext;
     info: GraphQLResolveInfo;
-}) => string;
+}) => Partial<NodeRequest.CoreOptions>;
 /**
  * We rely on the Request library in order to make resolver API calls.
  *
@@ -185,7 +181,7 @@ export declare type InternalOptions<TSource, TContext, TArgs> = {
      *
      * Based on: https://github.com/request/request#requestoptions-callback
      */
-    requestOptions?: Partial<RequestOptions<TSource, TContext, TArgs>>;
+    requestOptions?: Partial<RequestOptions<TSource, TContext, TArgs>> | RequestOptionsFunction<TSource, TContext, TArgs>;
     /**
      * Allows to override or add options to the PubSub connect object used to make
      * publish/subscribe to the API backend.
@@ -197,11 +193,6 @@ export declare type InternalOptions<TSource, TContext, TArgs> = {
      * Overrides the server object in the OAS.
      */
     baseUrl?: string;
-    /**
-     * Specifies the function which returns a URL, which will be used for request made by a resolve function.
-     * Overrides the server object in the OAS and baseUrl.
-     */
-    urlResolver?: RequestURLFunction<TSource, TContext, TArgs>;
     /**
      * Allows to define custom resolvers for fields on the Query/Mutation root
      * operation type.

packages/openapi-to-graphql/lib/resolver_builder.d.ts

@@ -36,6 +36,7 @@ import {
   InternalOptions,
   Report,
   ConnectOptions,
+  RequestOptionsFunction,
   RequestOptions
 } from './types/options'
 import { Oas3 } from './types/oas3'
@@ -203,7 +204,6 @@ function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
     requestOptions,
     connectOptions,
     baseUrl,
-    urlResolver,
     customResolvers,
     customSubscriptionResolvers,
 
@@ -243,7 +243,6 @@ function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
     requestOptions,
     connectOptions,
     baseUrl,
-    urlResolver,
     customResolvers,
     customSubscriptionResolvers,
 
@@ -642,7 +641,9 @@ function getFieldForOperation<TSource, TContext, TArgs>(
   operation: Operation,
   baseUrl: string,
   data: PreprocessingData<TSource, TContext, TArgs>,
-  requestOptions: Partial<RequestOptions<TSource, TContext, TArgs>>,
+  requestOptions:
+    | Partial<RequestOptions<TSource, TContext, TArgs>>
+    | RequestOptionsFunction<TSource, TContext, TArgs>,
   connectOptions: ConnectOptions
 ): GraphQLFieldConfig<TSource, TContext | SubscriptionContext, TArgs> {
   // Create GraphQL Type for response:

packages/openapi-to-graphql/lib/resolver_builder.js

@@ -14,7 +14,7 @@ import { Operation } from './types/operation'
 import { SubscriptionContext } from './types/graphql'
 import { PreprocessingData } from './types/preprocessing_data'
 import * as NodeRequest from 'request'
-import { RequestOptions } from './types/options'
+import { RequestOptions, RequestOptionsFunction } from './types/options'
 
 // Imports:
 import * as Oas3Tools from './oas_3_tools'
@@ -57,7 +57,9 @@ type GetResolverParams<TSource, TContext, TArgs> = {
   responseName?: string
   data: PreprocessingData<TSource, TContext, TArgs>
   baseUrl?: string
-  requestOptions?: Partial<RequestOptions<TSource, TContext, TArgs>>
+  requestOptions?:
+    | Partial<RequestOptions<TSource, TContext, TArgs>>
+    | RequestOptionsFunction<TSource, TContext, TArgs>
 }
 
 type GetSubscribeParams<TSource, TContext, TArgs> = {
@@ -487,7 +489,7 @@ export function getResolver<TSource, TContext, TArgs>({
       args,
       data
     )
-    const url = baseUrl + path
+    let url = baseUrl + path
 
     /**
      * The Content-Type and Accept property should not be changed because the
@@ -510,21 +512,41 @@ export function getResolver<TSource, TContext, TArgs>({
 
     let options: NodeRequest.OptionsWithUrl
     if (requestOptions) {
+      let requestOptionsVal: any = requestOptions
+      let method = operation.method
+      if (typeof requestOptions === 'function') {
+        requestOptionsVal = requestOptions(method, path, title, {
+          source,
+          args,
+          context,
+          info
+        })
+
+        if (
+          requestOptionsVal.url &&
+          requestOptionsVal.url.toString().trim().length > 0
+        ) {
+          url = requestOptionsVal.url.toString().trim()
+        }
+        if (requestOptionsVal.method && requestOptionsVal.method.length > 0) {
+          method = Oas3Tools.methodToHttpMethod(requestOptionsVal.method)
+        }
+      }
       options = {
-        ...requestOptions,
-        method: operation.method,
+        ...requestOptionsVal,
+        method: method,
         url // Must be after the requestOptions spread as url is a mandatory field so undefined may be used
       }
 
       options.headers = {} // Handle requestOptions.header later if applicable
       options.qs = {} // Handle requestOptions.qs later if applicable
 
-      if (requestOptions.headers) {
+      if (requestOptionsVal.headers) {
         // requestOptions.headers may be either an object or a function
-        if (typeof requestOptions.headers === 'object') {
-          Object.assign(options.headers, headers, requestOptions.headers)
-        } else if (typeof requestOptions.headers === 'function') {
-          const headers = requestOptions.headers(method, path, title, {
+        if (typeof requestOptionsVal.headers === 'object') {
+          Object.assign(options.headers, headers, requestOptionsVal.headers)
+        } else if (typeof requestOptionsVal.headers === 'function') {
+          const headers = requestOptionsVal.headers(method, path, title, {
             source,
             args,
             context,
@@ -539,8 +561,8 @@ export function getResolver<TSource, TContext, TArgs>({
         options.headers = headers
       }
 
-      if (requestOptions.qs) {
-        Object.assign(options.qs, qs, requestOptions.qs)
+      if (requestOptionsVal.qs) {
+        Object.assign(options.qs, qs, requestOptionsVal.qs)
       } else {
         options.qs = qs
       }
@@ -644,18 +666,6 @@ export function getResolver<TSource, TContext, TArgs>({
       Object.assign(options.headers, oauthHeader)
     }
 
-    if (data.options.urlResolver) {
-      const url = data.options.urlResolver(method, path, title, {
-        source,
-        args,
-        context,
-        info
-      });
-      if (typeof url === 'string') {
-        options.url = url;
-      }
-    }
-
     resolveData.usedRequestOptions = options
     resolveData.usedStatusCode = operation.statusCode
 

packages/openapi-to-graphql/lib/resolver_builder.js.map

@@ -60,21 +60,17 @@ export type RequestHeadersFunction<TSource, TContext, TArgs> = (
   }
 ) => Headers
 
-/**
- * Given a set parameters corresponding to a specific operation in the OAS,
- * provide the appropriate url
- */
-export type RequestURLFunction<TSource, TContext, TArgs> = (
+export type RequestOptionsFunction<TSource, TContext, TArgs> = (
   method: string,
   path: string,
   title: string,
   resolverParams?: {
-    source: TSource;
-    args: TArgs;
-    context: TContext;
-    info: GraphQLResolveInfo;
+    source: TSource
+    args: TArgs
+    context: TContext
+    info: GraphQLResolveInfo
   }
-) => string;
+) => Partial<NodeRequest.CoreOptions>
 
 /**
  * We rely on the Request library in order to make resolver API calls.
@@ -235,7 +231,9 @@ export type InternalOptions<TSource, TContext, TArgs> = {
    *
    * Based on: https://github.com/request/request#requestoptions-callback
    */
-  requestOptions?: Partial<RequestOptions<TSource, TContext, TArgs>>
+  requestOptions?:
+    | Partial<RequestOptions<TSource, TContext, TArgs>>
+    | RequestOptionsFunction<TSource, TContext, TArgs>
 
   /**
    * Allows to override or add options to the PubSub connect object used to make
@@ -250,12 +248,6 @@ export type InternalOptions<TSource, TContext, TArgs> = {
    */
   baseUrl?: string
 
-  /**
-   * Specifies the function which returns a URL, which will be used for request made by a resolve function.
-   * Overrides the server object in the OAS and baseUrl.
-   */
-  urlResolver?: RequestURLFunction<TSource, TContext, TArgs>;
-
   /**
    * Allows to define custom resolvers for fields on the Query/Mutation root
    * operation type.