fix: swap out bunyan for pino

Author: AVVS

package.json

@@ -36,11 +36,11 @@
   },
   "dependencies": {
     "bluebird": "^3.7.1",
-    "bunyan": "^1.8.12",
     "callback-queue": "^3.0.0",
     "denque": "^1.4.1",
     "ioredis-lock": "^4.0.0",
     "lodash": "^4.17.15",
+    "pino": "^6.3.2",
     "serialize-error": "^7.0.1"
   },
   "devDependencies": {

src/callback-queue.js

@@ -18,7 +18,7 @@ async function call(queueName, args, logger) {
   }
 
   // these are async anyways - gonna schedule them
-  logger.debug('Calling %s callback with args', queueName, args);
+  logger.debug('Calling %s callback with args %j', queueName, args);
   callback(...args);
 
   // clean local queue
@@ -89,7 +89,7 @@ exports.createConsumer = function createConsumer(redis, pubsubChannel, logger) {
       logger.info('Subscribed to channel %s', pubsubChannel);
     })
     .catch((err) => {
-      logger.fatal('Failed to subsctibe to pubsub channel:', err);
+      logger.fatal({ err }, 'Failed to subsctibe to pubsub channel');
       return Promise.delay(250).then(connect);
     });
 
@@ -108,7 +108,7 @@ exports.createConsumer = function createConsumer(redis, pubsubChannel, logger) {
 
     const [key, args] = message;
     if (!key || !isArray(args)) {
-      logger.warn('Malformed message passed: no key or args.', message);
+      logger.warn({ redisMsg: message }, 'Malformed message passed: no key or args');
       return;
     }
 

src/distributed-callback-queue.js

@@ -1,7 +1,7 @@
 const Promise = require('bluebird');
 const redislock = require('ioredis-lock');
 const Redis = require('ioredis');
-const bunyan = require('bunyan');
+const pino = require('pino');
 const assert = require('assert');
 
 // may only use redis with bluebird promise
@@ -40,9 +40,9 @@ const isTimeoutError = (e) => e === TimeoutError;
  *        @param {Number} timeout - defaults to 10000
  *        @param {Number} retries - defaults to 0
  *        @param {Number} delay - defaults to 100
- *    @param {Object|Boolean} log: sets up logger. If set to false supresses all warnings
- *        @param {String} name: name to use when reporting
- *        @param {String|Object} preset - either name of preset or streams obj for bunyan
+ *    @param {Pino|Boolean} [log] sets up logger. If set to false supresses all warnings
+ *    @param {String} [name] name to use when reporting
+ *    @param {Boolean} [debug=false] show additional diagnostic information
  *    @param {String} lockPrefix - used for creating locks in redis
  */
 class DistributedCallbackQueue {
@@ -82,31 +82,30 @@ class DistributedCallbackQueue {
     this.logger.info('Initialized...');
   }
 
+  static isCompatibleLogger(logger) {
+    for (const level of ['debug', 'info', 'warn', 'error', 'fatal'].values()) {
+      if (typeof logger[level] !== 'function') {
+        return false;
+      }
+    }
+
+    return true;
+  }
+
   static initLogger(options) {
     const { log: logger, debug, name } = options;
     const loggerEnabled = typeof logger === 'undefined' ? !!debug : logger;
 
-    if (loggerEnabled && logger instanceof bunyan) {
+    if (loggerEnabled && DistributedCallbackQueue.isCompatibleLogger(logger)) {
       return logger;
     }
 
-    const streams = [{
-      level: 'trace',
-      type: 'raw',
-      stream: new bunyan.RingBuffer({ limit: 100 }),
-    }];
-
+    let level = 'silent';
     if (loggerEnabled) {
-      streams.push({
-        stream: process.stdout,
-        level: debug ? 'debug' : 'info',
-      });
+      level = debug ? 'debug' : 'info';
     }
 
-    return bunyan.createLogger({
-      name: name || pkg.name,
-      streams,
-    });
+    return pino({ name: name || pkg.name, level }, pino.destination(1));
   }
 
   /**
@@ -415,7 +414,7 @@ class DistributedCallbackQueue {
         await lock.extend();
       } catch (error) {
         // because a job may take too much time, other listeners must implement timeout/retry strategy
-        this.logger.warn('failed to release lock and publish results', error);
+        this.logger.warn({ err: error }, 'failed to release lock and publish results');
         return null;
       }