Fix stacktrace format for rollbar

.npmignore

@@ -0,0 +1 @@
+/test

README.md

@@ -7,8 +7,8 @@ A [rollbar](https://rollbar.com) transport for [winston](https://github.com/wins
 ## Installation
 
 ``` sh
-  $ npm install winston
-  $ npm install winston-transport-rollbar-3
+  $ yarn add winston
+  $ yarn add winston-transport-rollbar-3
 ```
 
 ## usage
@@ -36,3 +36,9 @@ The Rollbar transport uses the universal [rollbar.js](https://github.com/rollbar
 * **rollbarConfig**:        Rollbar configuration ([more info](https://rollbar.com/docs/notifier/node_rollbar/#configuration-reference)) (mandatory, must contain rollbarAccessToken)
 * **level**:                Level of messages this transport should log. (default: **warn**).
 
+## Contribute
+
+### Test
+```bash
+yarn test
+```

lib/rollbar_transport.js

@@ -16,7 +16,7 @@ const rollbar = require('rollbar');
 class RollbarTransport extends TransportStream {
   constructor(opts) {
     super(opts);
-    if (!opts.rollbarConfig.accessToken) {
+    if (!opts.rollbarConfig?.accessToken) {
       throw "winston-transport-rollbar requires a 'rollbarConfig.accessToken' property";
     }
 
@@ -28,10 +28,10 @@ class RollbarTransport extends TransportStream {
   }
 
   log(info, callback) {
-    const {level, message} = info;
+    const { level, message } = info;
+
     process.nextTick(() => {
-      const message = util.format(info.message, ...(info.splat || []));
-      const meta = info;
+      const error = this.#getErrorObject(info);
       const rollbarLevel = level === 'warn' ? 'warning' : level;
 
       const cb = err => {
@@ -42,11 +42,31 @@ class RollbarTransport extends TransportStream {
         this.emit('logged');
         return callback(null, true);
       };
-      
+
       const logMethod = this.rollbar[rollbarLevel] || this.rollbar.log;
-      return logMethod.apply(this.rollbar, [message, meta, cb]);
+      return logMethod.apply(this.rollbar, [error, info, cb]);
     });
   }
+
+  #getErrorObject(info) {
+    if (info.message instanceof Error) {
+      return info.message;
+    }
+
+    if (info.stack instanceof Error) {
+      return info.stack;
+    }
+
+    if (info.stack) {
+      return new Error(info.stack);
+    }
+
+    if (info.job?.stacktrace) {
+      return new Error(info.job.stacktrace);
+    }
+
+    return new Error(info.message);
+  }
 }
 
 module.exports = RollbarTransport;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "winston-transport-rollbar-3",
   "description": "An updated rollbar transport for winston",
-  "version": "3.2.3",
+  "version": "3.2.4",
   "author": "Andreas Zoellner",
   "license": "MIT",
   "repository": {
@@ -20,7 +20,9 @@
     "winston-transport": "^4.4.0"
   },
   "main": "./lib/rollbar_transport",
-  "scripts": {},
+  "scripts": {
+    "test": "jest"
+  },
   "engines": {
     "node": ">= 8.0.0"
   },
@@ -30,5 +32,8 @@
   "homepage": "https://github.com/zoellner/winston-rollbar#readme",
   "directories": {
     "lib": "lib"
+  },
+  "devDependencies": {
+    "jest": "^29.5.0"
   }
 }

test/rollbar_transport.spec.js

@@ -0,0 +1,99 @@
+const RollbarTransport = require('../lib/rollbar_transport');
+const rollbar = require('rollbar');
+
+jest.mock('rollbar');
+
+describe('RollbarTransport', () => {
+  let transport;
+  let rollbarMock;
+
+  function wait() {
+    // wait for process.nextTick
+    return new Promise(resolve => setTimeout(resolve, 0));
+  }
+
+  beforeEach(() => {
+    rollbarMock = {
+      log: jest.fn(),
+      warning: jest.fn(),
+      error: jest.fn(),
+    };
+
+    rollbar.mockReturnValue(rollbarMock);
+
+    transport = new RollbarTransport({
+      rollbarConfig: { accessToken: 'test' },
+    });
+  });
+
+  describe('#log', () => {
+    it('throws an error if no accessToken is provided', () => {
+      expect(() => new RollbarTransport({})).toThrow(
+        "winston-transport-rollbar requires a 'rollbarConfig.accessToken' property"
+      );
+    });
+
+    it('logs with log level error', async () => {
+      const logData = { level: 'error', message: 'test' };
+      transport.log(logData);
+
+      await wait()
+
+      expect(rollbarMock.error).toHaveBeenCalledWith(new Error(logData.message), logData, expect.any(Function));
+    });
+
+    it('logs with log level warn', async () => {
+      const logData = { level: 'warn', message: 'test' };
+      transport.log(logData);
+
+      await wait()
+
+      expect(rollbarMock.warning).toHaveBeenCalledWith(new Error(logData.message), logData, expect.any(Function));
+    })
+
+    it('logs error object if message is of type Error', async () => {
+      const logData = { level: 'error', message: new Error('test') };
+      transport.log(logData);
+
+      await wait()
+
+      expect(rollbarMock.error).toHaveBeenCalledWith(logData.message, logData, expect.any(Function));
+    })
+
+    it('logs error object if stack is of type Error', async () => {
+      const logData = { level: 'error', stack: new Error('test') };
+      transport.log(logData);
+
+      await wait()
+
+      expect(rollbarMock.error).toHaveBeenCalledWith(logData.stack, logData, expect.any(Function));
+    })
+
+    it('logs error object if stack is a string', async () => {
+      const logData = { level: 'error', stack: 'test' };
+      transport.log(logData);
+
+      await wait()
+
+      expect(rollbarMock.error).toHaveBeenCalledWith(new Error(logData.stack), logData, expect.any(Function));
+    })
+
+    it('logs error object if job.stacktrace is a string', async () => {
+      const logData = { level: 'error', job: { stacktrace: 'test' } };
+      transport.log(logData);
+
+      await wait()
+
+      expect(rollbarMock.error).toHaveBeenCalledWith(new Error(logData.job.stacktrace), logData, expect.any(Function));
+    })
+
+    it('logs error object if only message is a string', async () => {
+      const logData = { level: 'error', message: 'test' };
+      transport.log(logData);
+
+      await wait()
+
+      expect(rollbarMock.error).toHaveBeenCalledWith(new Error(logData.message), logData, expect.any(Function));
+    })
+  });
+});