handle circular body, add test cases for utils.formatRequest

Author: Sourav

bin/helpers/utils.js

@@ -7,6 +7,7 @@ const getmac = require('getmac').default;
 const { v4: uuidv4 } = require('uuid');
 const browserstack = require('browserstack-local');
 const crypto = require('crypto');
+const util = require('util');
 
 const usageReporting = require("./usageReporting"),
   logger = require("./logger").winstonLogger,
@@ -973,7 +974,7 @@ exports.formatRequest = (err, resp, body) => {
   return {
     err,
     status: resp ? resp.statusCode : null,
-    body: body ? JSON.stringify(body) : null
+    body: body ? util.format('%j', body) : null
   }
 }
 

test/unit/bin/helpers/utils.js

@@ -2919,4 +2919,15 @@ describe('utils', () => {
       expect(utils.getVideoConfig({video: false, videoUploadOnPasses: false})).to.be.eql({video: false, videoUploadOnPasses: false});
     });
   });
+
+  describe('formatRequest', () => {
+    it('should return correct JSON', () => {
+      expect(utils.formatRequest('Something went wrong.', undefined, undefined)).to.be.eql({err: 'Something went wrong.', status: null, body: null});
+      const body = {message: "Something went wrong"};
+      expect(utils.formatRequest(null, {statusCode: 400}, body)).to.be.eql({err: null, status: 400, body: JSON.stringify(body)});
+      const cricularBody = {message: "Something went wrong"};
+      cricularBody.body = cricularBody;
+      expect(utils.formatRequest(null, {statusCode: 500}, cricularBody)).to.be.eql({err: null, status: 500, body: '[Circular]'});
+    });
+  });
 });

test/unit/bin/helpers/zipUpload.js

@@ -49,7 +49,8 @@ describe("zipUpload", () => {
         formatRequest,
       };
       loggerStub = {
-        info: sandbox.stub().returns(null)
+        info: sandbox.stub().returns(null),
+        error: sandbox.stub().returns(null),
       };
       sinon.stub(fs, 'lstatSync').returns({ size: 123 });
     });