chore: use safe stringify in http transport (#2043)

* chore: use safe stringify in http transport

* chore: review feedback, use safe-stable-stringify lib for consistency with winstonjs/logform

* restored package-lock from master

* Re-run npm isntall to fix package-lock

Author: karlwir

lib/winston/transports/http.js

@@ -11,6 +11,7 @@ const http = require('http');
 const https = require('https');
 const { Stream } = require('readable-stream');
 const TransportStream = require('winston-transport');
+const jsonStringify = require('safe-stable-stringify');
 
 /**
  * Transport for outputting to a json-rpc server.
@@ -261,6 +262,6 @@ module.exports = class Http extends TransportStream {
     req.on('response', res => (
       res.on('end', () => callback(null, res)).resume()
     ));
-    req.end(Buffer.from(JSON.stringify(options), 'utf8'));
+    req.end(Buffer.from(jsonStringify(options), 'utf8'));
   }
-};
+};

package-lock.json

@@ -24,12 +24,13 @@
     "stream"
   ],
   "dependencies": {
-    "async": "^3.2.3",
     "@dabh/diagnostics": "^2.0.2",
+    "async": "^3.2.3",
     "is-stream": "^2.0.0",
     "logform": "^2.3.2",
     "one-time": "^1.0.0",
     "readable-stream": "^3.4.0",
+    "safe-stable-stringify": "^2.3.1",
     "stack-trace": "0.0.x",
     "triple-beam": "^1.3.0",
     "winston-transport": "^4.4.2"

package.json

@@ -8,6 +8,7 @@ const http = require('http');
 const hock = require('hock');
 const assume = require('assume');
 const Http = require('../../lib/winston/transports/http');
+const stringifyJson = require('safe-stable-stringify');
 
 const host = '127.0.0.1';
 const port = 0;
@@ -134,4 +135,32 @@ describe('Http({ host, port, path })', function () {
 
   });
 
-});
+  describe('circular structure', function () {
+    const circularLog = {
+      level: 'error',
+      message: 'hello',
+      meta: {}
+    };
+
+    circularLog.self = circularLog;
+
+    beforeEach(function (done) {
+      context = mockHttpServer(done, stringifyJson(circularLog));
+      server = context.server;
+    });
+
+    it('should be able to handle options with circular structure', function (done) {
+      const httpTransport = new Http({
+        host: host,
+        port: server.address().port,
+        path: 'log'
+      })
+        .on('error', assumeError)
+        .on('logged', function () {
+          onLogged(context, done);
+        });
+
+      httpTransport.log(circularLog, assumeError);
+    });
+  });
+});