Merge branch 'winston3'

Author: shakty

conf/loggers.js

@@ -1,6 +1,6 @@
 /**
  * # loggers.js
- * Copyright(c) 2020 Stefano Balietti
+ * Copyright(c) 2021 Stefano Balietti
  * MIT Licensed
  *
  * Configuration file for Winston.js in nodegame-server
@@ -13,81 +13,86 @@ const winston = require('winston');
 
 // Variable loggers is winston.loggers.
 function configure(loggers, logDir) {
+ let format = winston.format;
  let logLevel = winston.level;
+ let transports = winston.transports;
+
+ const logFormatter = format.printf((info) => {
+ let { timestamp, level, stack, message } = info;
+ message = stack || message;
+ return `${timestamp} ${level}: ${message}`;
+ });
+
+ let consoleFormat = format.combine(format.colorize(), format.simple(),
+ format.timestamp(), logFormatter);
 
  // ServerNode.
  loggers.add('servernode', {
- console: {
- level: logLevel,
- colorize: true
- },
- file: {
- level: logLevel,
- timestamp: true,
- filename: path.join(logDir, 'servernode.log'),
- maxsize: 1000000,
- maxFiles: 10
- }
+ // format: format.errors({ stack: true }),
+ transports: [
+ new transports.Console({
+ level: logLevel,
+ // colorize: true
+ format: consoleFormat
+ }),
+ new transports.File({
+ level: logLevel,
+ timestamp: true,
+ filename: path.join(logDir, 'servernode.log'),
+ maxsize: 1000000,
+ maxFiles: 10
+ })
+ ]
+
  });
 
  // Channel.
  loggers.add('channel', {
- console: {
- level: logLevel,
- colorize: true,
- },
- file: {
- level: logLevel,
- timestamp: true,
- filename: path.join(logDir, 'channels.log'),
- maxsize: 1000000,
- maxFiles: 10
- }
+ format: format.errors({ stack: true }),
+ transports: [
+ new transports.Console({
+ level: logLevel,
+ // colorize: true
+ format: consoleFormat
+ }),
+ new transports.File({
+ level: logLevel,
+ timestamp: true,
+ filename: path.join(logDir, 'channels.log'),
+ maxsize: 1000000,
+ maxFiles: 10
+ })
+ ]
  });
 
  // Messages.
  // Make custom levels and only File transports for messages.
- let msgLogger = loggers.add('messages');
- msgLogger.remove(winston.transports.Console);
- msgLogger.add(winston.transports.File, {
- timestamp: true,
- maxsize: 1000000,
- filename: path.join(logDir, 'messages.log')
+ let msgLogger = loggers.add('messages', {
+ format: format.errors({ stack: true }),
+ transports: [
+ new transports.File({
+ timestamp: true,
+ maxsize: 1000000,
+ filename: path.join(logDir, 'messages.log')
+ })
+ ]
  });
 
- // Do not change, or logging might be affected.
- // Logger.js hardcodes the values for speed.
- msgLogger.setLevels({
- // Log none.
- none: 0,
- // All DATA msgs.
- data: 1,
- // All SET and DATA msgs.
- set: 3,
- // All SET, GET and DATA msgs.
- get: 5,
- // All SETUP, SET, GET and DATA msgs.
- setup: 7,
- // All messages, but **not** PLAYER_UPDATE, SERVERCOMMAND and ALERT.
- game: 9,
- // All messages.
- all: 11
- });
-
- // Set default logging level for messages.
- msgLogger.level = 'all';
-
  // Clients.
  loggers.add('clients', {
- console: {
- level: logLevel,
- colorize: true,
- },
- file: {
- level: 'silly',
- timestamp: true,
- filename: path.join(logDir, 'clients.log')
- }
+ format: format.errors({ stack: true }),
+ transports: [
+ new transports.Console({
+ level: logLevel,
+ // colorize: true
+ format: consoleFormat
+ }),
+ new transports.File({
+ level: 'silly',
+ timestamp: true,
+ filename: path.join(logDir, 'clients.log')
+ })
+ ]
  });
 
  return true;

lib/ServerNode.js

@@ -333,23 +333,28 @@ ServerNode.prototype.init = function(options) {
  }
  });
 
-
  // Loading default config files.
- this.logger.verbose('ServerNode.init: loading default conf files');
  if (options.logDir) this.logDir = resolvePath(options.logDir);
+ // Loggers first.
  this.loadConfFile(path.join(this.defaultConfDir, 'loggers.js'),
- this.configureLoggers);
+ this.configureLoggers, false);
+ // Setting servernode logger.
  this.logger = winston.loggers.get('servernode');
+ // Print what loadConfFile could not.
+ this.logger.debug('ServerNode.loadConfFile: loaded ' +
+ path.join(this.defaultConfDir, 'loggers.js'));
+ // Loading remaining conf.
  this.loadConfDir(this.defaultConfDir, { loggers: false });
 
- // Loading user configuration files
+ // Loading user configuration files.
  if (options.confDir) {
  this.logger.verbose('ServerNode.init: loading user conf files');
- // We load the loggers configuration file first, so that
- // the the output is nicely formatted.
+ // Loggers first
  let dir = resolvePath(options.confDir);
  this.loadConfFile(path.join(dir, 'loggers.js'), this.configureLoggers);
+ // Re-setting servernode logger.
  this.logger = winston.loggers.get('servernode');
+ // Loading remaining conf.
  this.loadConfDir(dir, { loggers: false });
  }
 
@@ -959,14 +964,15 @@ ServerNode.prototype.loadConfDir = function(dir, mask, force) {
  *
  * @param {string} file The path to the configuration file
  * @param {function} cb The callback function (e.g. ServerNode.configureHTTP)
+ * @param {boolean} silent If FALSE, do not call logger (might not be ready)
  *
  * @see ServerNode.loadConfDir
  * @see ServerNode.configure
  * @see ServerNode.configureHTTP
  * @see ServerNode.confiureSIO
  * @see ServerNode.confiureLoggers
  */
-ServerNode.prototype.loadConfFile = function(file, cb) {
+ServerNode.prototype.loadConfFile = function(file, cb, log = true) {
  if ('string' !== typeof file) {
  throw new TypeError('ServerNode.loadConfFile: file must be string.' +
  'Found: ' + file);
@@ -994,7 +1000,8 @@ ServerNode.prototype.loadConfFile = function(file, cb) {
  // care of passing the right parameters to it.
  cb.call(this, conf);
 
- this.logger.debug('ServerNode.loadConfFile: loaded ' + file)
+ // The first time it is called, this.logger is not yet set.
+ if (log) this.logger.debug('ServerNode.loadConfFile: loaded ' + file);
 };
 
 /**