chore: remove bunyan and move to winston

package.json

@@ -66,7 +66,7 @@
   },
   "dependencies": {
     "bluebird": "^3.5.1",
-    "bunyan": "^1.8.12",
+    "winston": "^3.15.0",
     "ip": "^1.1.5",
     "lodash": "^4.17.15",
     "moment": "^2.22.1",

src/commands/index.js

@@ -42,7 +42,7 @@ class FtpCommands {
     if (logCommand.directive === 'PASS') logCommand.arg = '********';
 
     const log = this.connection.log.child({directive: command.directive});
-    log.trace({command: logCommand}, 'Handle command');
+    log.log('silly', 'Handle command', {command: logCommand});
 
     if (!REGISTRY.hasOwnProperty(command.directive)) {
       return this.connection.reply(502, `Command not allowed: ${command.directive}`);

src/connection.js

@@ -26,12 +26,12 @@ class FtpConnection extends EventEmitter {
     this.connector = new BaseConnector(this);
 
     this.commandSocket.on('error', (err) => {
-      this.log.error(err, 'Client error');
+      this.log.error('Client error', {err});
       this.server.emit('client-error', {connection: this, context: 'commandSocket', error: err});
     });
     this.commandSocket.on('data', this._handleData.bind(this));
     this.commandSocket.on('timeout', () => {
-      this.log.trace('Client timeout');
+      this.log.log('silly','Client timeout');
       this.close();
     });
     this.commandSocket.on('close', () => {
@@ -43,7 +43,7 @@ class FtpConnection extends EventEmitter {
 
   _handleData(data) {
     const messages = _.compact(data.toString(this.encoding).split('\r\n'));
-    this.log.trace(messages);
+    this.log.log('silly',messages);
     return Promise.mapSeries(messages, (message) => this.commands.handle(message));
   }
 
@@ -128,7 +128,7 @@ class FtpConnection extends EventEmitter {
     const processLetter = (letter) => {
       return new Promise((resolve, reject) => {
         if (letter.socket && letter.socket.writable) {
-          this.log.trace({port: letter.socket.address().port, encoding: letter.encoding, message: letter.message}, 'Reply');
+          this.log.log('silly', 'Reply', {port: letter.socket.address().port, encoding: letter.encoding, message: letter.message});
           letter.socket.write(letter.message + '\r\n', letter.encoding, (error) => {
             if (error) {
               this.log.error('[Process Letter] Socket Write Error', { error: error.message });
@@ -137,7 +137,7 @@ class FtpConnection extends EventEmitter {
             resolve();
           });
         } else {
-          this.log.trace({message: letter.message}, 'Could not write message');
+          this.log.log('silly', 'Could not write message', {message: letter.message});
           reject(new errors.SocketError('Socket not writable'));
         }
       });

src/connector/passive.js

@@ -37,18 +37,18 @@ class Passive extends Connector {
 
       const connectionHandler = (socket) => {
         if (!ip.isEqual(this.connection.commandSocket.remoteAddress, socket.remoteAddress)) {
-          this.log.error({
+          this.log.error('Connecting addresses do not match', {
             pasv_connection: socket.remoteAddress,
             cmd_connection: this.connection.commandSocket.remoteAddress
-          }, 'Connecting addresses do not match');
+          });
 
           socket.destroy();
           return this.connection.reply(550, 'Remote addresses do not match')
           .then(() => this.connection.close());
         }
         clearTimeout(idleServerTimeout);
 
-        this.log.trace({port, remoteAddress: socket.remoteAddress}, 'Passive connection fulfilled.');
+        this.log.log('silly', 'Passive connection fulfilled.', {port, remoteAddress: socket.remoteAddress});
 
         this.dataSocket = socket;
         this.dataSocket.on('error', (err) => this.server && this.server.emit('client-error', {connection: this.connection, context: 'dataSocket', error: err}));
@@ -65,7 +65,7 @@ class Passive extends Connector {
 
       this.dataServer.on('error', (err) => this.server && this.server.emit('client-error', {connection: this.connection, context: 'dataServer', error: err}));
       this.dataServer.once('close', () => {
-        this.log.trace('Passive server closed');
+        this.log.log('silly','Passive server closed');
         this.end();
       });
 
@@ -81,14 +81,14 @@ class Passive extends Connector {
           else {
             idleServerTimeout = setTimeout(() => this.closeServer(), CONNECT_TIMEOUT);
 
-            this.log.debug({port}, 'Passive connection listening');
+            this.log.log('debug', 'Passive connection listening', {port});
             resolve(this.dataServer);
           }
         });
       });
     })
     .catch((error) => {
-      this.log.trace(error.message);
+      this.log.log('silly', error.message);
       throw error;
     });
   }

src/index.js

@@ -1,7 +1,7 @@
 const _ = require('lodash');
 const Promise = require('bluebird');
 const nodeUrl = require('url');
-const buyan = require('bunyan');
+const winston = require('winston');
 const net = require('net');
 const tls = require('tls');
 const EventEmitter = require('events');
@@ -13,7 +13,7 @@ class FtpServer extends EventEmitter {
   constructor(options = {}) {
     super();
     this.options = Object.assign({
-      log: buyan.createLogger({name: 'ftp-srv'}),
+      log: winston.createLogger({name: 'ftp-srv', silent: true}),
       url: 'ftp://127.0.0.1:21',
       pasv_min: 1024,
       pasv_max: 65535,
@@ -52,7 +52,7 @@ class FtpServer extends EventEmitter {
       socket.once('close', () => {
         this.emit('disconnect', {connection, id: connection.id, newConnectionCount: Object.keys(this.connections).length});
       })
-      
+
       this.emit('connect', {connection, id: connection.id, newConnectionCount: Object.keys(this.connections).length});
 
       const greeting = this._greeting || [];
@@ -64,10 +64,10 @@ class FtpServer extends EventEmitter {
 
     this.server = (this.isTLS ? tls : net).createServer(serverOptions, serverConnectionHandler);
     this.server.on('error', (err) => {
-      this.log.error(err, '[Event] error');
+      this.log.error('[Event] error', {err});
       this.emit('server-error', {error: err});
     });
-    
+
     const quit = _.debounce(this.quit.bind(this), 100);
 
     process.on('SIGTERM', quit);
@@ -89,11 +89,11 @@ class FtpServer extends EventEmitter {
       this.server.listen(this.url.port, this.url.hostname, (err) => {
         this.server.removeListener('error', reject);
         if (err) return reject(err);
-        this.log.info({
+        this.log.info('Listening', {
           protocol: this.url.protocol.replace(/\W/g, ''),
           ip: this.url.hostname,
           port: this.url.port
-        }, 'Listening');
+        });
         resolve('Listening');
       });
     });
@@ -136,9 +136,9 @@ class FtpServer extends EventEmitter {
       try {
         client.close(0);
       } catch (err) {
-        this.log.error(err, 'Error closing connection', {id});
+        this.log.error('Error closing connection', {id, err});
       }
-      
+
       resolve('Disconnected');
     });
   }
@@ -157,12 +157,12 @@ class FtpServer extends EventEmitter {
     .then(() => new Promise((resolve) => {
       this.server.close((err) => {
         this.log.info('Server closing...');
-        if (err) this.log.error(err, 'Error closing server');
+        if (err) this.log.error('Error closing server', {err});
         resolve('Closed');
       });
     }))
     .then(() => {
-      this.log.debug('Removing event listeners...')
+      this.log.log('debug','Removing event listeners...')
       this.emit('closed', {});
       this.removeAllListeners();
       return;

test/commands/index.spec.js

@@ -1,6 +1,6 @@
 const {expect} = require('chai');
 const Promise = require('bluebird');
-const bunyan = require('bunyan');
+const winston = require('winston');
 const sinon = require('sinon');
 
 const FtpCommands = require('../../src/commands');
@@ -10,7 +10,7 @@ describe('FtpCommands', function () {
   let commands;
   let mockConnection = {
     authenticated: false,
-    log: bunyan.createLogger({name: 'FtpCommands'}),
+    log: winston.createLogger({name: 'FtpCommands'}),
     reply: () => Promise.resolve({}),
     server: {
       options: {

test/commands/registration/cdup.spec.js

@@ -1,12 +1,12 @@
 const Promise = require('bluebird');
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 
 const CMD = 'CDUP';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   const mockClient = {
     reply: () => Promise.resolve(),
     fs: {

test/commands/registration/cwd.spec.js

@@ -1,11 +1,11 @@
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 
 const CMD = 'CWD';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   const mockClient = {
     reply: () => {},
     fs: {chdir: () => {}}

test/commands/registration/dele.spec.js

@@ -1,11 +1,11 @@
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 
 const CMD = 'DELE';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   const mockClient = {
     reply: () => {},
     fs: {delete: () => {}}

test/commands/registration/list.spec.js

@@ -1,12 +1,12 @@
 const Promise = require('bluebird');
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 
 const CMD = 'LIST';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   const mockClient = {
     reply: () => {},
     fs: {

test/commands/registration/mdtm.spec.js

@@ -1,11 +1,11 @@
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 
 const CMD = 'MDTM';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   const mockClient = {
     reply: () => {},
     fs: {get: () => {}}

test/commands/registration/mkd.spec.js

@@ -1,11 +1,11 @@
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 
 const CMD = 'MKD';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   const mockClient = {
     reply: () => {},
     fs: {mkdir: () => {}}

test/commands/registration/nlst.spec.js

@@ -1,12 +1,12 @@
 const Promise = require('bluebird');
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 
 const CMD = 'NLST';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   const mockClient = {
     reply: () => {},
     fs: {

test/commands/registration/pass.spec.js

@@ -1,11 +1,11 @@
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 
 const CMD = 'PASS';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   const mockClient = {
     reply: () => {},
     login: () => {},

test/commands/registration/pwd.spec.js

@@ -1,11 +1,11 @@
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 
 const CMD = 'PWD';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   const mockClient = {
     reply: () => {},
     fs: {currentDirectory: () => {}}

test/commands/registration/retr.spec.js

@@ -1,13 +1,13 @@
 const Promise = require('bluebird');
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 const EventEmitter = require('events');
 
 const CMD = 'RETR';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   let emitter;
   const mockClient = {
     commandSocket: {

test/commands/registration/site/site.spec.js

@@ -1,15 +1,15 @@
 const Promise = require('bluebird');
 const {expect} = require('chai');
 const sinon = require('sinon');
-const bunyan = require('bunyan');
+const winston = require('winston');
 
 const siteRegistry = require('../../../../src/commands/registration/site/registry');
 const FtpCommands = require('../../../../src/commands');
 
 const CMD = 'SITE';
 describe(CMD, function () {
   let sandbox;
-  const log = bunyan.createLogger({name: 'site-test'});
+  const log = winston.createLogger({name: 'site-test'});
   const mockClient = {
     reply: () => Promise.resolve(),
     commands: new FtpCommands()

test/commands/registration/stor.spec.js

@@ -1,13 +1,13 @@
 const Promise = require('bluebird');
-const bunyan = require('bunyan');
+const winston = require('winston');
 const {expect} = require('chai');
 const sinon = require('sinon');
 const EventEmitter = require('events');
 
 const CMD = 'STOR';
 describe(CMD, function () {
   let sandbox;
-  let log = bunyan.createLogger({name: CMD});
+  let log = winston.createLogger({name: CMD});
   let emitter;
   const mockClient = {
     commandSocket: {