feat: move to winston logger

[ahochsteger]

This PR unifies the logging across zwavejs2mqtt using winston.

Usage:

// Simple logger with module name and default config:
const logger = require('./logger.js').module('Zwave')

// Logger setup with module name and specific config:
const logger = require('./logger.js').module('Zwave').setup(
  { enabled: true, level: 'info', logToFile: true, filename: "zwavejs2mqtt.log" }
)

// Do some logging:
logger.info(`Some log message with a ${value}`)
logger.warn('Some warning')

// Reconfigure an existing logger:
logger.setup({ enabled: true, level: 'info', logToFile: true, filename: "zwavejs2mqtt.log" })

// Reconfigure loggers for all modules (e.g. after config changes in the UI):
const loggers = require('./logger.js')
loggers.setupAll({ enabled: true, level: 'info', logToFile: true, filename: "zwavejs2mqtt.log" })

Conditions & Requirements:

• The logging solution should be as simple as possible while supporting the other requirements
• Winston should be used the basis for unified logging
• All loggers should be defined on a central place (logger.js)
• The primary logging format should be: <timestamp> <level> <moduleName/label>: <logMessage> (e.g. 2020-12-04 09:06:32.568 INFO APP: Zwave2MQTT Version 0.0.0)
• All loggers should use the same transports
• All loggers should use the same format by default
• Loggers for different modules may use a different logging configuration
• Different log levels should be used to signal event severity (see https://github.com/winstonjs/winston#logging-levels)
• Modules/labels should be as short as possible. The following should be used: ZWAVE MQTT GATEWAY STORE HASS HTTP APP
• Log statements with multiple arguments using commas should be converted to the template syntax
• The logging must be changeable during runtime from the UI
• It should be able to change the configuration of all loggers at once (to be used by UI for central logging config changes)
• Runtime changes to the logging settings must be persisted to settings.js
• The logging must be controlled by settings.js using the existing options logLevel and logToFile
• Add new setting logEnabled to settings.js and UI

Required changes to the existing codebase:

The following files are affected and show the existing logging implementation that should be migrated to the new logging module:

• lib/ZwaveClient.js (uses debug) --> winston ZWAVE module
• app.js (uses debug & morgan) ---> winston HTTP and APP modules
• lib/jsonStore.js (uses debug) ---> winston STORE module (need to think about this, we could use console otherwise)
• lib/Gateway.js (uses debug) ---> winston GATEWAY and (maybe) HASS modules
• lib/MqttClient.js (uses debug) --> winston MQTT module
• lib/SocketManager.js (uses debug) --> winston SOCKET module
• lib/debug.js (uses debug) ---> Obsolete, replaced with logger.js

[coveralls]

Pull Request Test Coverage Report for Build 426057167

• 100 of 232 (43.1%) changed or added relevant lines in 7 files are covered.
• 2 unchanged lines in 1 file lost coverage.
• Overall coverage increased (+0.7%) to 28.523%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
lib/SocketManager.js	3	4	75.0%
lib/logger.js	90	94	95.74%
lib/MqttClient.js	0	14	0.0%
lib/Gateway.js	5	23	21.74%
app.js	0	29	0.0%
lib/ZwaveClient.js	0	66	0.0%

Files with Coverage Reduction	New Missed Lines	%
lib/Gateway.js	2	19.93%

Totals
Change from base Build 422618431:	0.7%
Covered Lines:	1931
Relevant Lines:	6914

---

💛 - Coveralls

[ahochsteger]

@robertsLando the previous debug-based logging is now fully replaced with the new winston-based logging module.

The only thing that is intentionally left is integration into the UI and control using settings.json which requires some discussion about the best approach to propagate logging config changes to the module loggers.

[ahochsteger]

@robertsLando after some more work I was able to resolve all open questions and handle the logging configuration in app.js (see setupLogging()).
Changes in the UI now automatically update the logger of all modules.

But there's a side-effect I observed I was not yet able to solve yet:
After changing the logging settings in the UI and restarting the server there are no more logs available from node-zwave-js. Maybe there's a conflict somewhere? At least I tried to not touch other Winston loggers as much as possible (e.g. by prefixing logger names with "zwavejs2mqtt." and only handle these in setupAll()).

So from my POV the PR is ready for review.

[robertsLando]

After changing the logging settings in the UI and restarting the server there are no more logs available from node-zwave-js. Maybe there's a conflict somewhere

@AlCalzone Do you know if this could cause some conflict with your loggers?

[robertsLando]

@ahochsteger Review done. Feel free to squash and merge if you are done here 😄

[robertsLando]

@ahochsteger I would like a cleaner output format. The color should be applied only to level and the timestamp could be gray. It is much pretty to read

[robertsLando]

I also think you have missed stderrLevels: ['error'] in console transport. If user is using pm2 that will redirect errors to stderror

[robertsLando]

Output now:

[robertsLando]

LGTM