fix: Convert logger into a class (#22129)

test/logger.test.js

@@ -25,16 +25,12 @@ describe('Logger', () => {
 
     it('Create log directory', () => {
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
         const dirs = fs.readdirSync(dir.name);
         expect(dirs.length).toBe(1);
     });
 
     it('Should cleanup', () => {
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
 
         for (const d of fs.readdirSync(dir.name)) {
             rimrafSync(path.join(dir.name, d));
@@ -51,8 +47,6 @@ describe('Logger', () => {
 
     it('Should not cleanup when there is no timestamp set', () => {
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
         for (let i = 30; i < 40; i++) {
             fs.mkdirSync(path.join(dir.name, `log_${i}`));
         }
@@ -65,16 +59,14 @@ describe('Logger', () => {
 
     it('Set and get log level', () => {
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
         logger.setLevel('debug');
         expect(logger.getLevel()).toBe('debug');
         logger.setLevel('info');
         expect(logger.getLevel()).toBe('info');
         logger.setLevel('warning');
-        expect(logger.getLevel()).toBe('warning');
+        expect(logger.getLevel()).toBe('warn');// match old Z2M levels
         logger.setLevel('warn');
-        expect(logger.getLevel()).toBe('warning');
+        expect(logger.getLevel()).toBe('warn');// match old Z2M levels
         logger.setLevel('error');
         expect(logger.getLevel()).toBe('error');
     });
@@ -83,9 +75,7 @@ describe('Logger', () => {
         settings.set(['advanced', 'log_level'], 'warn');
         settings.reRead();
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
-        expect(logger.getLevel()).toBe('warning');
+        expect(logger.level).toBe('warning');// getLevel() reports old Z2M level to match display/value
         settings.set(['advanced', 'log_level'], 'info');
         settings.reRead();
     });
@@ -97,20 +87,18 @@ describe('Logger', () => {
         }
 
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        expect(logger.winston().transports.length).toBe(2);
+        expect(logger.winston.transports.length).toBe(2);
         const transport = new DummyTransport();
         logger.addTransport(transport);
-        expect(logger.winston().transports.length).toBe(3);
+        expect(logger.winston.transports.length).toBe(3);
         logger.removeTransport(transport);
-        expect(logger.winston().transports.length).toBe(2);
+        expect(logger.winston.transports.length).toBe(2);
     });
 
     it('Logger should be console and file by default', () => {
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
-        const pipes = logger.winston()._readableState.pipes;
+        const pipes = logger.winston._readableState.pipes;
+        console.log(pipes);
         expect(pipes.length).toBe(2);
         expect(pipes[0].constructor.name).toBe('Console');
         expect(pipes[0].silent).toBe(false);
@@ -121,9 +109,7 @@ describe('Logger', () => {
     it('Logger can be file only', () => {
         settings.set(['advanced', 'log_output'], ['file']);
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
-        const pipes = logger.winston()._readableState.pipes;
+        const pipes = logger.winston._readableState.pipes;
         expect(pipes.length).toBe(2);
         expect(pipes[0].constructor.name).toBe('Console');
         expect(pipes[0].silent).toBe(true);
@@ -134,9 +120,7 @@ describe('Logger', () => {
     it('Logger can be console only', () => {
         settings.set(['advanced', 'log_output'], ['console']);
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
-        const pipes = logger.winston()._readableState.pipes;
+        const pipes = logger.winston._readableState.pipes;
         expect(pipes.constructor.name).toBe('Console');
         expect(pipes.silent).toBe(false);
     });
@@ -144,9 +128,7 @@ describe('Logger', () => {
     it('Logger can be nothing', () => {
         settings.set(['advanced', 'log_output'], []);
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
-        const pipes = logger.winston()._readableState.pipes;
+        const pipes = logger.winston._readableState.pipes;
         expect(pipes.constructor.name).toBe('Console');
         expect(pipes.silent).toBe(true);
     });
@@ -154,9 +136,7 @@ describe('Logger', () => {
     it('Should allow to disable log rotation', () => {
         settings.set(['advanced', 'log_rotation'], false);
         const logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
-        const pipes = logger.winston()._readableState.pipes;
+        const pipes = logger.winston._readableState.pipes;
         expect(pipes[1].constructor.name).toBe('File');
         expect(pipes[1].maxFiles).toBeNull();
         expect(pipes[1].tailable).toBeFalsy();
@@ -166,8 +146,6 @@ describe('Logger', () => {
     it('Should allow to symlink logs to current directory', () => {
         settings.set(['advanced', 'log_symlink_current'], true);
         let logger = require('../lib/util/logger').default;
-        logger.init();
-        logger.logOutput();
         expect(fs.readdirSync(dir.name).includes('current')).toBeTruthy()
 
         jest.resetModules();
@@ -176,25 +154,24 @@ describe('Logger', () => {
 
     it('Log', () => {
         const logger = require('../lib/util/logger').default;
-        logger.init();
         logger.setLevel('debug');
 
-        const debug = jest.spyOn(logger.winston(), 'debug');
+        const debug = jest.spyOn(logger.winston, 'debug');
         logger.debug('debug');
         expect(debug).toHaveBeenCalledWith('debug', {namespace: 'z2m'});
         expect(debug).toHaveBeenCalledTimes(1);
 
-        const info = jest.spyOn(logger.winston(), 'info');
+        const info = jest.spyOn(logger.winston, 'info');
         logger.info('info');
         expect(info).toHaveBeenCalledWith('info', {namespace: 'z2m'});
         expect(info).toHaveBeenCalledTimes(1);
 
-        const warning = jest.spyOn(logger.winston(), 'warning');
+        const warning = jest.spyOn(logger.winston, 'warning');
         logger.warning('warning');
         expect(warning).toHaveBeenCalledWith('warning', {namespace: 'z2m'});
         expect(warning).toHaveBeenCalledTimes(1);
 
-        const error = jest.spyOn(logger.winston(), 'error');
+        const error = jest.spyOn(logger.winston, 'error');
         logger.error('error');
         expect(error).toHaveBeenCalledWith('error', {namespace: 'z2m'});