Add an option to use res in payload (#155)

* Add an option to use res in payload

implements #154

* add a test for group(req, res) objects

Co-authored-by: Michael DeRazon <[email protected]>

Author: mderazon

packages/node/README.md

@@ -20,7 +20,7 @@ Just add the middleware to [Express](https://expressjs.com/), and that's it!
 ```javascript
 const readme = require('readmeio');
 
-app.use(readme.metrics('<<apiKey>>', req => ({
+app.use(readme.metrics('<<apiKey>>', (req, res) => ({
   id: req.<userId>,
   label: req.<userNameToShowInDashboard>,
   email: req.<userEmailAddress>,

packages/node/__tests__/index.test.js

@@ -126,6 +126,40 @@ describe('#metrics', () => {
       });
   });
 
+  it('should have access to group(req,res) objects', () => {
+    const apiMock = getReadMeApiMock(1);
+    const mock = nock(config.host, {
+      reqheaders: {
+        'Content-Type': 'application/json',
+        'User-Agent': `${pkg.name}/${pkg.version}`,
+      },
+    })
+      .post('/v1/request', ([body]) => {
+        expect(body.group.a).toBe('a');
+        expect(body.group.b).toBe('b');
+        return true;
+      })
+      .basicAuth({ user: apiKey })
+      .reply(200);
+
+    const app = express();
+    app.use((req, res, next) => {
+      req.a = 'a';
+      res.b = 'b';
+      next();
+    });
+    app.use(middleware.metrics(apiKey, (req, res) => ({ a: req.a, b: res.b })));
+    app.get('/test', (req, res) => res.sendStatus(200));
+
+    return request(app)
+      .get('/test')
+      .expect(200)
+      .then(() => {
+        apiMock.done();
+        mock.done();
+      });
+  });
+
   describe('#bufferLength', () => {
     it('should send requests when number hits `bufferLength` size', async function test() {
       const apiMock = getReadMeApiMock(1);

packages/node/lib/construct-payload.js

@@ -5,7 +5,7 @@ const { name, version } = require('../package.json');
 
 module.exports = (req, res, group, options = {}, { logId, startedDateTime }) => ({
   _id: logId,
-  group: group(req),
+  group: group(req, res),
   clientIPAddress: req.ip,
   development: options.development,
   request: {