fix: Added urlResolver on Resolver options

Author: dinumathai

packages/openapi-to-graphql/README.md

@@ -180,6 +180,8 @@ Resolver options:
 
 - `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,4 +1,3 @@
-/// <reference types="node" />
 /**
  * Functions to create resolve functions.
  */

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

@@ -43,6 +43,16 @@ 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?: {
+    source: TSource;
+    args: TArgs;
+    context: TContext;
+    info: GraphQLResolveInfo;
+}) => string;
 /**
  * We rely on the Request library in order to make resolver API calls.
  *
@@ -187,6 +197,11 @@ 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

@@ -203,6 +203,7 @@ function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
     requestOptions,
     connectOptions,
     baseUrl,
+    urlResolver,
     customResolvers,
     customSubscriptionResolvers,
 
@@ -242,6 +243,7 @@ function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
     requestOptions,
     connectOptions,
     baseUrl,
+    urlResolver,
     customResolvers,
     customSubscriptionResolvers,
 

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

@@ -644,6 +644,18 @@ 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,6 +60,22 @@ 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> = (
+  method: string,
+  path: string,
+  title: string,
+  resolverParams?: {
+    source: TSource;
+    args: TArgs;
+    context: TContext;
+    info: GraphQLResolveInfo;
+  }
+) => string;
+
 /**
  * We rely on the Request library in order to make resolver API calls.
  *
@@ -234,6 +250,12 @@ 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.