Merge pull request #9 from joaquimserafim/v5

v5

README.md

@@ -14,11 +14,12 @@ a plugin for superagent that uses bunyan to log the request and responses
 `const superagentLogger = require('superagent-bunyan')`
 
 ```js
-superagentLogger(bunyan_logger[, requestId])
+superagentLogger(bunyan_logger[, requestId, extra])
 ```
 
 * **bunyan logger** should be a bunyan createLogger or child object
 * **requestId** uuid, by default will try to pick up from the headers injected in superagent, or can be set by using a module/function to generate the requestId, by default will use an internal id generator
+* **extra** an object that you can use to add extra info int the log entry
 
 **some notes:**
 * should use the plugin after the definiton of the http method to use

index.js

@@ -9,10 +9,16 @@ max-len: ["error", 80]
 const getPropValue  = require('get-property-value')
 const objectSize    = require('object.size')
 const url           = require('url')
+const isObject      = require('is.object')
 
 module.exports = logger
 
-function logger (bunyan, requestId) {
+function logger (bunyan, requestId, extra) {
+
+  if (isObject(requestId)) {
+    extra = requestId
+    requestId = null
+  }
 
   return runLogger
 
@@ -21,22 +27,22 @@ function logger (bunyan, requestId) {
     let endTime     = 0
     const startTime = process.hrtime()
 
-    const service = req.url
-    const method  = req.method
-
     req.id = requestId || getPropValue(req.header, 'X-Request-ID') || id()
 
-    const log = bunyan.child(
-      {
-        origin: 'superagent',
-        req_id: req.id,
-        serializers: {
-          err: bunyan.constructor.stdSerializers.err,
-          req: reqSerializer,
-          res: resSerializer
-        }
-      }
-    )
+    const log = bunyan
+      .child(Object
+          .assign({
+            origin: 'superagent',
+            req_id: req.id,
+            serializers: {
+              err: bunyan.constructor.stdSerializers.err,
+              req: reqSerializer,
+              res: resSerializer
+            }
+          },
+          isObject(extra) ? extra : {}
+        )
+      )
 
     log.info({req: req}, 'start of the request')
 
@@ -57,8 +63,6 @@ function logger (bunyan, requestId) {
       log.error(
         {
           res: appendRes,
-          service: service,
-          method: method,
           err: err,
           duration: endTime[0] * 1e3 + endTime[1] * 1e-6
         },
@@ -75,8 +79,6 @@ function logger (bunyan, requestId) {
         log.info(
           {
             res: res,
-            service: service,
-            method: method,
             duration: endTime[0] * 1e3 + endTime[1] * 1e-6
           },
           'end of the request'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "superagent-bunyan",
-  "version": "4.3.0",
+  "version": "5.0.0",
   "description": "a plugin for superagent that uses bunyan to log the request s and responses",
   "main": "index.js",
   "files": [
@@ -41,6 +41,7 @@
   },
   "dependencies": {
     "get-property-value": "^2.0.0",
+    "is.object": "^1.0.0",
     "object.size": "^1.0.0"
   },
   "engines": {

test.js

@@ -189,7 +189,6 @@ describe('superagent-bunyan', () => {
             expect(log2.res).to.be.an('object')
             expect(log2.res.statusCode).to.be.equal(200)
             expect(log2.res.headers).to.be.an('object')
-            expect(log2.method).to.be.equal('GET')
             done()
           })
         })
@@ -210,7 +209,6 @@ describe('superagent-bunyan', () => {
             expect(log2.res).to.be.an('object')
             expect(log2.res.statusCode).to.be.equal(200)
             expect(log2.res.headers).to.be.an('object')
-            expect(log2.method).to.be.equal('GET')
             done()
           })
         })
@@ -236,7 +234,6 @@ describe('superagent-bunyan', () => {
             expect(log2.res).to.be.an('object')
             expect(log2.res.statusCode).to.be.equal(200)
             expect(log2.res.headers).to.be.an('object')
-            expect(log2.method).to.be.equal('POST')
             done()
           })
         })
@@ -259,7 +256,6 @@ describe('superagent-bunyan', () => {
             expect(log2.res.statusCode).to.be.equal(200)
             expect(log2.res.body).to.be.deep.equal({msg: 'Hello World!'})
             expect(log2.res.headers).to.be.an('object')
-            expect(log2.method).to.be.equal('GET')
             done()
           })
         })
@@ -282,7 +278,6 @@ describe('superagent-bunyan', () => {
             expect(log2.res).to.be.an('object')
             expect(log2.res.statusCode).to.be.equal(200)
             expect(log2.res.headers).to.be.an('object')
-            expect(log2.method).to.be.equal('GET')
             done()
           })
         })
@@ -307,7 +302,59 @@ describe('superagent-bunyan', () => {
             expect(log2.res).to.be.an('object')
             expect(log2.res.statusCode).to.be.equal(200)
             expect(log2.res.headers).to.be.an('object')
-            expect(log2.method).to.be.equal('GET')
+            done()
+          })
+        })
+    })
+
+    it('using `extra` to pass extra info in the log entry', (done) => {
+      request
+        .get('http://localhost:3000/someuuidbutdontsend')
+        .use(
+          superagentLogger(
+            logger,
+            {extra: 'But then again, who does?'}
+          )
+        )
+        .end((err, res) => {
+          expect(err).to.be.a('null')
+          expect(res).to.be.an('object')
+
+          testLogRecords(getRecords(), (log1, log2) => {
+            expect(log1.req.qs).to.be.an('undefined')
+            expect(log1.extra).to.be.equal('But then again, who does?')
+            expect(log2.err).to.not.exist
+            expect(log2.res).to.be.an('object')
+            expect(log2.res.statusCode).to.be.equal(200)
+            expect(log2.res.headers).to.be.an('object')
+            expect(log2.extra).to.be.equal('But then again, who does?')
+            done()
+          })
+        })
+    })
+
+    it('passing the request id and using `extra` arg', (done) => {
+      request
+        .get('http://localhost:3000/someuuidbutdontsend')
+        .use(
+          superagentLogger(
+            logger,
+            1234,
+            {extra: 'But then again, who does?'}
+          )
+        )
+        .end((err, res) => {
+          expect(err).to.be.a('null')
+          expect(res).to.be.an('object')
+
+          testLogRecords(getRecords(), (log1, log2) => {
+            expect(log1.req.qs).to.be.an('undefined')
+            expect(log1.extra).to.be.equal('But then again, who does?')
+            expect(log2.err).to.not.exist
+            expect(log2.res).to.be.an('object')
+            expect(log2.res.statusCode).to.be.equal(200)
+            expect(log2.res.headers).to.be.an('object')
+            expect(log2.extra).to.be.equal('But then again, who does?')
             done()
           })
         })
@@ -327,7 +374,6 @@ describe('superagent-bunyan', () => {
             expect(log2.res.statusCode).to.be.equal(404)
             expect(log2.res.headers).to.be.an('object')
             expect(log2.err.name).to.be.equal('Error')
-            expect(log2.method).to.be.equal('GET')
             done()
           })
         })
@@ -345,7 +391,6 @@ describe('superagent-bunyan', () => {
             expect(log2.res).to.be.an('object')
             expect(log2.err).to.be.an('object')
             expect(log2.err.name).to.be.equal('Error')
-            expect(log2.method).to.be.equal('GET')
             done()
           })
         })
@@ -382,8 +427,6 @@ function testLogRecords (records, runExtraExpections) {
       expect(record.req.headers).to.be.an('object')
     } else { // the response
       expect(record.msg).to.be.equal('end of the request')
-      expect(record.service).to.be.a('string')
-      expect(record.method).to.be.a('string')
       expect(record.duration).to.be.a('number')
     }
   }