Merge pull request #93 from patricklodder/detailed_errors_cp

patricklodder · patricklodder · commit 99d74e85d7b5 · 2015-01-09T13:28:49.000+01:00
Clientside detailed error reporting
diff --git a/README.md b/README.md
@@ -170,6 +170,34 @@ var client = xmlrpc.createClient('YOUR_ENDPOINT');
 client.methodCall('YOUR_METHOD', [new YourType(yourVariable)], yourCallback);
 ```
 
+### To Debug (client-side)
+
+Error callbacks on the client are enriched with request and response
+information and the returned body as long as a http connection was made,
+to aide with request debugging. Example:
+
+```javascript
+var client = xmlrpc.createClient({ host: 'example.com', port: 80 });
+client.methodCall('FAULTY_METHOD', [], function (error, value) {
+  if (error) {
+    console.log('error:', error);
+    console.log('req headers:', error.req && error.req._header);
+    console.log('res code:', error.res && error.res.statusCode);
+    console.log('res body:', error.body);
+  } else {
+    console.log('value:', value);
+  }
+});
+
+// error: [Error: Unknown XML-RPC tag 'TITLE']
+// req headers: POST / HTTP/1.1
+// User-Agent: NodeJS XML-RPC Client
+// ...
+// res code: 200
+// res body: <!doctype html>
+// ...
+```
+
 ### To Test
 
 [![Build
diff --git a/lib/client.js b/lib/client.js
@@ -104,13 +104,31 @@ Client.prototype.methodCall = function methodCall(method, params, callback) {
   options.headers['Content-Length'] = Buffer.byteLength(xml, 'utf8')
   this.headersProcessors.composeRequest(options.headers)
   var request = transport.request(options, function(response) {
+
+    var body = []
+    response.on('data', function (chunk) { body.push(chunk) })
+
+    function __enrichError (err) {
+      Object.defineProperty(err, 'req', { value: request })
+      Object.defineProperty(err, 'res', { value: response })
+      Object.defineProperty(err, 'body', { value: body.join('') })
+      return err
+    }
+
     if (response.statusCode == 404) {
-      callback(new Error('Not Found'));
+      callback(__enrichError(new Error('Not Found')))
     }
     else {
       this.headersProcessors.parseResponse(response.headers)
+
       var deserializer = new Deserializer(options.responseEncoding)
-      deserializer.deserializeMethodResponse(response, callback)
+
+      deserializer.deserializeMethodResponse(response, function(err, result) {
+        if (err) {
+          err = __enrichError(err)
+        }
+        callback(err, result)
+      })
     }
   }.bind(this))
 
diff --git a/test/client_test.js b/test/client_test.js
@@ -5,6 +5,7 @@ var vows   = require('vows')
   , fs     = require('fs')
 
 const VALID_RESPONSE = fs.readFileSync(__dirname + '/fixtures/good_food/string_response.xml')
+const BROKEN_XML= fs.readFileSync(__dirname + '/fixtures/bad_food/broken_xml.xml')
 
 vows.describe('Client').addBatch({
   //////////////////////////////////////////////////////////////////////
@@ -309,6 +310,36 @@ vows.describe('Client').addBatch({
         assert.equal(value, 'a=b')
       }
     }
-
+  , 'that responds with a malformed xml': {
+      topic: function () {
+        var that = this
+        http.createServer(function(request, response) {
+          response.writeHead(500, {'Content-Type': 'text/html'})
+          response.write(BROKEN_XML)
+          response.end()
+        }).listen(9097, 'localhost', function () {
+          var client = new Client({ host: 'localhost', port: 9097, path: '/' }, false)
+          client.methodCall('broken', null, that.callback)
+        })
+      }
+    , 'returns an error': function (error, value) {
+        assert.instanceOf(error, Error)
+        assert.match(error.message, /^Unexpected end/)
+      }
+    , 'returns the request object with the error': function (error, value) {
+        assert.instanceOf(error, Error)
+        assert.isObject(error.req)
+        assert.isObject(error.req.connection)
+        assert.isString(error.req._header)
+      }
+    , 'returns the response object with the error': function (error, value) {
+        assert.instanceOf(error, Error)
+        assert.isObject(error.res)
+        assert.strictEqual(error.res.statusCode, 500)
+      }
+    , 'returns the body with the error': function (error, value) {
+        assert.strictEqual(error.body, BROKEN_XML.toString())
+      }
+    }
   }
 }).export(module)
