Add extensions for errors

Fix #115

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

Author: Alan-Cha

packages/oasgraph/lib/resolver_builder.js

@@ -19,6 +19,7 @@ import * as Oas3Tools from './oas_3_tools'
 import * as querystring from 'querystring'
 import * as JSONPath from 'jsonpath-plus'
 import { debug } from 'debug'
+import { GraphQLError } from 'graphql'
 
 const log = debug('http')
 // Type definitions & exports:
@@ -267,7 +268,18 @@ export function getResolver({
           reject(err)
         } else if (response.statusCode > 299) {
           log(`${response.statusCode} - ${Oas3Tools.trim(body, 100)}`)
-          reject(new Error(`${response.statusCode} - ${JSON.stringify(body)}`))
+
+          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)
+          }
+          reject(graphQLErrorWithExtensions(`Could not invoke operation ${operationString}`, extensions))
+
         } else {
           log(`${response.statusCode} - ${Oas3Tools.trim(body, 100)}`)
 
@@ -618,10 +630,17 @@ function getIdentifier(info): string {
 function getParentIdentifier(info): string {
   return getIdentifierRecursive(info.path.prev)
 }
-
+ 
 /**
  * Get the path of nested field names (or aliases if provided)
  */
 function getIdentifierRecursive(path): string {
   return (typeof path.prev === 'undefined') ? path.key : `${path.key}/${getIdentifierRecursive(path.prev)}`
 }
+
+/**
+ * Create a new GraphQLError with an extensions field
+ */
+function graphQLErrorWithExtensions(message: string, extensions: { [key: string]: any }): GraphQLError {
+  return new GraphQLError(message, null, null, null, null, null, extensions)
+}

packages/oasgraph/lib/resolver_builder.js.map

@@ -673,3 +673,26 @@ test('Resolve allOf', () => {
     })
   })
 })
+
+test('Error contains extension', () => {
+  let query = `query {
+    user(username: "abcdef") {
+      name
+    }
+  }`
+  return graphql(createdSchema, query, null, {}).then(error => {
+    const extensions = error.errors[0].extensions
+    expect(extensions).toBeDefined()
+
+    // Remove headers because it contains fields that may change from run to run
+    delete extensions.responseHeaders
+    expect(extensions).toEqual({
+      "method": "get",
+      "path": "/users/{username}",
+      "statusCode": 401,
+      "responseBody": {
+        "message": "Wrong username."
+      }
+    })
+  })
+})

packages/oasgraph/src/resolver_builder.ts

@@ -278,7 +278,13 @@ function startServer (PORT) {
 
   app.get('/api/users/:username', (req, res) => {
     console.log(req.method, req.path)
-    res.send(Users[req.params.username])
+    if (req.params.username in Users) {
+      res.send(Users[req.params.username])
+    } else {
+      res.status(401).send({
+        message: 'Wrong username.'
+      })
+    }
   })
 
   app.get('/api/users/:username/car', (req, res) => {

packages/oasgraph/test/example_api.test.js

@@ -10,13 +10,13 @@ const graphqlHTTP = require('express-graphql')
 const app = express()
 const OasGraph = require('../lib/index.js')
 
-// let oas = require('./fixtures/example_oas.json')
+let oas = require('./fixtures/example_oas.json')
 // let oas2 = require('./fixtures/example_oas2.json')
 // let oas3 = require('./fixtures/example_oas3.json')
 
 // let oas = require('./fixtures/github_oas.json')
 // let oas = require('./fixtures/instagram.json')
-let oas = require('./fixtures/government_social_work_api.json')
+// let oas = require('./fixtures/government_social_work_api.json')
 // let oas = require('./fixtures/weather_underground_api.json')
 
 // const yamljs = require('yamljs')