feat: Remove meta parameter from logging.

This commit is contained in:
Ruben Verborgh
2022-04-01 10:20:45 +02:00
committed by Joachim Van Herwegen
parent ce5a98b16f
commit 2c6167e0cb
8 changed files with 41 additions and 45 deletions

View File

@@ -24,11 +24,11 @@ describe('LazyLogger', (): void => {
};
lazyLoggerFactory.loggerFactory = dummyLoggerFactory;
expect(logger.log('debug', 'my message', { abc: true })).toBe(dummyLogger);
expect(logger.log('debug', 'my message')).toBe(dummyLogger);
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledTimes(1);
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledWith('MyLabel');
expect(dummyLogger.log).toHaveBeenCalledTimes(1);
expect(dummyLogger.log).toHaveBeenCalledWith('debug', 'my message', { abc: true });
expect(dummyLogger.log).toHaveBeenCalledWith('debug', 'my message');
});
it('reuses the logger for repeated calls.', async(): Promise<void> => {
@@ -40,14 +40,14 @@ describe('LazyLogger', (): void => {
};
lazyLoggerFactory.loggerFactory = dummyLoggerFactory;
expect(logger.log('debug', 'my message 1', { abc: true })).toBe(dummyLogger);
expect(logger.log('debug', 'my message 2', { abc: true })).toBe(dummyLogger);
expect(logger.log('debug', 'my message 3', { abc: true })).toBe(dummyLogger);
expect(logger.log('debug', 'my message 1')).toBe(dummyLogger);
expect(logger.log('debug', 'my message 2')).toBe(dummyLogger);
expect(logger.log('debug', 'my message 3')).toBe(dummyLogger);
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledTimes(1);
expect(dummyLoggerFactory.createLogger).toHaveBeenCalledWith('MyLabel');
expect(dummyLogger.log).toHaveBeenCalledTimes(3);
expect(dummyLogger.log).toHaveBeenNthCalledWith(1, 'debug', 'my message 1', { abc: true });
expect(dummyLogger.log).toHaveBeenNthCalledWith(2, 'debug', 'my message 2', { abc: true });
expect(dummyLogger.log).toHaveBeenNthCalledWith(3, 'debug', 'my message 3', { abc: true });
expect(dummyLogger.log).toHaveBeenNthCalledWith(1, 'debug', 'my message 1');
expect(dummyLogger.log).toHaveBeenNthCalledWith(2, 'debug', 'my message 2');
expect(dummyLogger.log).toHaveBeenNthCalledWith(3, 'debug', 'my message 3');
});
});

View File

@@ -2,45 +2,43 @@ import { Logger } from '../../../src/logging/Logger';
describe('Logger', (): void => {
let logger: Logger;
let meta: any;
beforeEach(async(): Promise<void> => {
logger = new (Logger as any)();
logger.log = jest.fn();
meta = { abc: 123 };
});
it('Error delegates to log.', async(): Promise<void> => {
logger.error('my message', meta);
logger.error('my message');
expect(logger.log).toHaveBeenCalledTimes(1);
expect(logger.log).toHaveBeenCalledWith('error', 'my message', meta);
expect(logger.log).toHaveBeenCalledWith('error', 'my message');
});
it('Warn delegates to log.', async(): Promise<void> => {
logger.warn('my message', meta);
logger.warn('my message');
expect(logger.log).toHaveBeenCalledTimes(1);
expect(logger.log).toHaveBeenCalledWith('warn', 'my message', meta);
expect(logger.log).toHaveBeenCalledWith('warn', 'my message');
});
it('Info delegates to log.', async(): Promise<void> => {
logger.info('my message', meta);
logger.info('my message');
expect(logger.log).toHaveBeenCalledTimes(1);
expect(logger.log).toHaveBeenCalledWith('info', 'my message', meta);
expect(logger.log).toHaveBeenCalledWith('info', 'my message');
});
it('Verbose delegates to log.', async(): Promise<void> => {
logger.verbose('my message', meta);
logger.verbose('my message');
expect(logger.log).toHaveBeenCalledTimes(1);
expect(logger.log).toHaveBeenCalledWith('verbose', 'my message', meta);
expect(logger.log).toHaveBeenCalledWith('verbose', 'my message');
});
it('Debug delegates to log.', async(): Promise<void> => {
logger.debug('my message', meta);
logger.debug('my message');
expect(logger.log).toHaveBeenCalledTimes(1);
expect(logger.log).toHaveBeenCalledWith('debug', 'my message', meta);
expect(logger.log).toHaveBeenCalledWith('debug', 'my message');
});
it('Silly delegates to log.', async(): Promise<void> => {
logger.silly('my message', meta);
logger.silly('my message');
expect(logger.log).toHaveBeenCalledTimes(1);
expect(logger.log).toHaveBeenCalledWith('silly', 'my message', meta);
expect(logger.log).toHaveBeenCalledWith('silly', 'my message');
});
});

View File

@@ -157,9 +157,7 @@ describe('GuardedStream', (): void => {
// Only the first error gets logged
jest.advanceTimersByTime(900);
expect(logger.error).toHaveBeenCalledTimes(1);
expect(logger.error).toHaveBeenCalledWith(
'No error listener was attached but error was thrown: 0', { error: errors[0] },
);
expect(logger.error).toHaveBeenCalledWith('No error listener was attached but error was thrown: 0');
jest.advanceTimersByTime(1000);
expect(logger.error).toHaveBeenCalledTimes(1);