Merge pull request #15 from marcellodesales/feature/issue14-Auditor-Support

Adding support to Req/Res Auditor similar to Server.

Author: micahr

lib/HttpClient.js

@@ -19,6 +19,7 @@ var once = require('once');
 var tunnelAgent = require('tunnel-agent');
 
 var dtrace = require('./helpers/dtrace');
+var auditor = require('./helpers/auditor');
 var errors = require('restify-errors');
 var serializers = require('./helpers/bunyan').serializers;
 
@@ -152,9 +153,22 @@ function rawRequest(opts, cb) {
 
     var emitResult = once(function _emitResult(_err, _req, _res) {
         _req.emit('result', _err, _res);
+
+        // Use the default auditor with the switch "opts.audit: true | false"
+        if (opts.audit.defaultEnabled) {
+            auditor(_err, _req, _res);
+
+        } else if (opts.audit.func && typeof opts.audit.func === 'function') {
+            // Use the function provided by the user through "opts.auditor"
+            opts.audit.func(_err, _req, _res);
+        }
     });
 
+    var requestTime = new Date().getTime();
     req = proto.request(opts, function onResponse(res) {
+        var latency = Date.now() - requestTime;
+        res.headers['x-request-received'] = requestTime;
+        res.headers['x-request-processing-time'] = latency;
         clearTimeout(connectionTimer);
         clearTimeout(requestTimer);
 
@@ -343,6 +357,11 @@ function HttpClient(options) {
     this.requestTimeout = options.requestTimeout || false;
     this.headers = options.headers || {};
     this.log = options.log;
+    this.audit = {
+        func: options.auditor || null,
+        defaultEnabled: options.audit || false
+    };
+
 
     if (!this.log.serializers) {
         // Ensure logger has a reasonable serializer for `client_res`
@@ -570,6 +589,8 @@ HttpClient.prototype.request = function request(opts, cb) {
     cb = once(cb);
     /* eslint-enable no-param-reassign */
 
+    opts.audit = this.audit;
+
     if (opts.retry === false) {
         rawRequest(opts, cb);
         return;

lib/helpers/auditor.js

@@ -0,0 +1,30 @@
+'use strict';
+
+module.exports = audit;
+
+/**
+ * Audits the req/res for the client. The audit will use bunyan's
+ * formatters. See bunyan-format for the user-friendly output.
+ *
+ * @param  {Object} err   The http error object.
+ * @param  {Object} req   The http request object.
+ * @param  {Object} res   The http response object.
+ *
+ * @returns {undefined} Does not return anything.
+ */
+function audit(err, req, res) {
+    req.headers = req._headers;
+    req.url = req.path;
+    var log = req.log;
+
+    var obj = {
+        remoteAddress: req.connection.remoteAddress,
+        remotePort: req.connection.remotePort,
+        req: req,
+        res: res,
+        err: err,
+        secure: req.secure
+    };
+
+    log.info(obj);
+}

test/index.js

@@ -13,6 +13,8 @@ var uuid   = require('node-uuid');
 
 var restify = require('restify');
 var clients = require('../lib');
+var auditor = require('../lib/helpers/auditor');
+var pkgJson = require('../package');
 
 ///--- Globals
 
@@ -899,6 +901,62 @@ describe('restify-client tests', function () {
         });
     });
 
+    it('create JSON client with auditor on', function (done) {
+
+        // Bunyan stream to capture the logs.
+        function CapturingStream(recs) {
+
+            this.entries = recs;
+        }
+
+        // Capture the bunyan logs as of
+        // https://github.com/trentm/node-bunyan/blob/master/test/raw-stream.test.js#L19-L24
+        CapturingStream.prototype.checkEntriesTest = function checkEntriesTest() {
+
+            assert.equal(this.entries.length, 1);
+        };
+
+        // The write method to add log entries
+        CapturingStream.prototype.write = function write(rec) {
+
+            this.entries.push(rec);
+        };
+
+        // Instances of the log entries and the capturing stream
+        var logEntries = [];
+        var streamConfig = {
+            name: 'capturingStream',
+            level: 'info',
+            stream: new CapturingStream(logEntries),
+            type: 'raw',
+        };
+
+        // the logger instance
+        var logger = bunyan.createLogger({
+            url: 'http://127.0.0.1:' + PORT,
+            name: 'http-json-client',
+              streams: [streamConfig]
+        });
+
+        var httpClientOpts = {
+            userAgent: pkgJson.name + "/" + pkgJson.version,
+            auditor: auditor,
+            log: logger,
+            retry: false
+        };
+
+        var client = clients.createJsonClient(httpClientOpts);
+        client.agent = false;
+
+        client.get('/json/mcavage', function (err, req, res, obj) {
+            err
+            //assert.ok(req);
+            //assert.ok(res);
+
+            // The verification is done in the CapturingStream.checkEntriesTest()
+            done();
+        });
+    });
 
     it('create string client with url instead of opts', function (done) {
         var client = clients.createStringClient('http://127.0.0.1:' + PORT);