Add provideErrorExtension option

Signed-off-by: Alan Cha <[email protected]>

Author: Alan-Cha

packages/oasgraph/README.md

@@ -157,6 +157,8 @@ The options object can contain the following properties:
 
 * `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 is to use this to up set a web proxy with the `proxy` field.
 
+* `provideErrorExtensions` (type: `boolean`, default: `true`): If a query cannot fulfilled, GraphQL will provide a [list of error objects](https://graphql.github.io/graphql-spec/draft/#sec-Errors) for all fields that could not be resolved. OASGraph will add an extensions to all error objects resulting from REST calls that did not return successful HTTP codes (i.e. 200-299). These extensions contain data about the REST call (e.g. the method, path, status code, response headers, and response body). This data can be useful for debugging but it can also _unintentionally leak information_. This option prevents the error extensions from being created. 
+
 Consider this example of passing options:
 
 ```javascript

packages/oasgraph/lib/index.js

@@ -79,6 +79,16 @@ export declare type Options = {
      * e.g. Setup the web proxy to use.
      */
     requestOptions?: NodeRequest.OptionsWithUrl;
+    /**
+     * The error extension is part of the GraphQLErrors that will be returned if
+     * the query cannot be fulfilled. It provides information about the REST call
+     * that could be fulfilled (e.g. the method, path, status code, response
+     * headers, and response body). It can be useful for debugging but may
+     * unintentionally leak information.
+     *
+     * This option prevents the extension from being created.
+     */
+    provideErrorExtensions?: boolean;
 };
 export declare type InternalOptions = {
     /**
@@ -148,4 +158,14 @@ export declare type InternalOptions = {
      * e.g. Setup the web proxy to use.
      */
     requestOptions?: NodeRequest.OptionsWithUrl;
+    /**
+     * The error extension is part of the GraphQLErrors that will be returned if
+     * the query cannot be fulfilled. It provides information about the REST call
+     * that could be fulfilled (e.g. the method, path, status code, response
+     * headers, and response body). It can be useful for debugging but may
+     * unintentionally leak information.
+     *
+     * This option prevents the extension from being created.
+     */
+    provideErrorExtensions: boolean;
 };

packages/oasgraph/lib/index.js.map

@@ -88,6 +88,9 @@ export async function createGraphQlSchema (
   options.operationIdFieldNames = typeof options.operationIdFieldNames === 'boolean'
     ? options.operationIdFieldNames
     : false
+  options.provideErrorExtensions = typeof options.provideErrorExtensions === 'boolean'
+    ? options.provideErrorExtensions
+    : true
 
   options['report'] = {
     warnings: [],
@@ -140,7 +143,8 @@ async function translateOpenApiToGraphQL (
     baseUrl,
     operationIdFieldNames,
     report,
-    requestOptions
+    requestOptions,
+    provideErrorExtensions
   }: InternalOptions
 ): Promise<{ schema: GraphQLSchema, report: Report }> {
   let options = {
@@ -154,7 +158,8 @@ async function translateOpenApiToGraphQL (
     baseUrl,
     operationIdFieldNames,
     report,
-    requestOptions
+    requestOptions,
+    provideErrorExtensions
   }
   log(`Options: ${JSON.stringify(options)}`)
 

packages/oasgraph/lib/resolver_builder.js

@@ -270,15 +270,20 @@ export function getResolver({
           log(`${response.statusCode} - ${Oas3Tools.trim(body, 100)}`)
 
           const operationString = `${operation.method.toUpperCase()} ${operation.path}`
-          const extensions = {
-            method: operation.method,
-            path: operation.path, 
-
-            statusCode: response.statusCode,
-            responseHeaders: response.headers,
-            responseBody: JSON.parse(body)
+          const errorString = `Could not invoke operation ${operationString}`
+          if (data.options.provideErrorExtensions) {
+            const extensions = {
+              method: operation.method,
+              path: operation.path, 
+
+              statusCode: response.statusCode,
+              responseHeaders: response.headers,
+              responseBody: JSON.parse(body)
+            }
+            reject(graphQLErrorWithExtensions(errorString, extensions))
+          } else {
+            reject(new Error(errorString))
           }
-          reject(graphQLErrorWithExtensions(`Could not invoke operation ${operationString}`, extensions))
 
         } else {
           log(`${response.statusCode} - ${Oas3Tools.trim(body, 100)}`)

packages/oasgraph/lib/resolver_builder.js.map

@@ -93,6 +93,17 @@ export type Options = {
    * e.g. Setup the web proxy to use.
    */
   requestOptions?: NodeRequest.OptionsWithUrl
+
+  /**
+   * The error extensions is part of the GraphQLErrors that will be returned if
+   * the query cannot be fulfilled. It provides information about the REST call
+   * that could be fulfilled (e.g. the method, path, status code, response 
+   * headers, and response body). It can be useful for debugging but may 
+   * unintentionally leak information.
+   * 
+   * This option prevents the extensions from being created. 
+   */
+  provideErrorExtensions?: boolean
 }
 
 
@@ -170,4 +181,15 @@ export type InternalOptions = {
    * e.g. Setup the web proxy to use.
    */
   requestOptions?: NodeRequest.OptionsWithUrl
+
+  /**
+   * The error extensions is part of the GraphQLErrors that will be returned if
+   * the query cannot be fulfilled. It provides information about the REST call
+   * that could be fulfilled (e.g. the method, path, status code, response 
+   * headers, and response body). It can be useful for debugging but may 
+   * unintentionally leak information.
+   * 
+   * This option prevents the extensions from being created. 
+   */
+  provideErrorExtensions: boolean
 }

packages/oasgraph/lib/types/options.d.ts

@@ -630,19 +630,19 @@ test('Define header and query options', () => {
     status2 (globalquery: "test")
   }`
   return OasGraph.createGraphQlSchema(oas, options)
-    .then(({schema}) => {
-      // validate that 'limit' parameter is covered by options:
-      let ast = parse(query)
-      let errors = validate(schema, ast)
-      expect(errors).toEqual([])
-      return graphql(schema, query).then(result => {
-        expect(result).toEqual({
-          data: {
-            status2: 'Ok.'
-          }
-        })
+  .then(({schema}) => {
+    // validate that 'limit' parameter is covered by options:
+    let ast = parse(query)
+    let errors = validate(schema, ast)
+    expect(errors).toEqual([])
+    return graphql(schema, query).then(result => {
+      expect(result).toEqual({
+        data: {
+          status2: 'Ok.'
+        }
       })
     })
+  })
 })
 
 test('Resolve allOf', () => {
@@ -695,4 +695,43 @@ test('Error contains extension', () => {
       }
     })
   })
+})
+
+test('Option provideErrorExtensions should prevent error extensions from being created', () => {
+  let options = {
+    provideErrorExtensions: false 
+  }
+  let query = `query {
+    user(username: "abcdef") {
+      name
+    }
+  }`
+  return OasGraph.createGraphQlSchema(oas, options)
+  .then(({schema}) => {
+    // validate that 'limit' parameter is covered by options:
+    let ast = parse(query)
+    let errors = validate(schema, ast)
+    expect(errors).toEqual([])
+    return graphql(schema, query).then(result => {
+      expect(result).toEqual({
+        "errors": [
+          {
+            "message": "Could not invoke operation GET /users/{username}",
+            "locations": [
+              {
+                "line": 2,
+                "column": 5
+              }
+            ],
+            "path": [
+              "user"
+            ]
+          }
+        ],
+        "data": {
+          "user": null
+        }
+      })
+    })
+  })
 })