Skip to content

Commit

Permalink
remove receiveAllAppenders flag
Browse files Browse the repository at this point in the history
it breaks legacy-appender compatibility with legacy flags: silent, quiet, verbose
  • Loading branch information
mshustov committed Jan 31, 2020
1 parent a51c3b4 commit de25412
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 89 deletions.
6 changes: 0 additions & 6 deletions src/core/server/logging/appenders/appenders.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,6 @@ export type AppenderConfigType = TypeOf<typeof appendersSchema>;
*/
export interface Appender {
append(record: LogRecord): void;

/**
* Used to signal to `Logger` that log level filtering should be ignored for this appender. Defaults to `false`.
* @deprecated Should be removed once the `LegacyAppender` is removed.
*/
receiveAllLevels?: boolean;
}

/**
Expand Down
82 changes: 0 additions & 82 deletions src/core/server/logging/logger.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -410,85 +410,3 @@ test('passes log record to appenders only if log level is supported.', () => {
});
}
});

test('passes log record to appender with receiveAllLevels: true, regardless if log level is supported', () => {
const receiveAllAppender = { append: jest.fn(), receiveAllLevels: true };
const warnLogger = new BaseLogger(context, LogLevel.Warn, [receiveAllAppender], factory);

warnLogger.trace('trace-message');
expect(receiveAllAppender.append).toHaveBeenCalledTimes(1);
expect(receiveAllAppender.append.mock.calls[0][0]).toMatchObject({
level: LogLevel.Trace,
message: 'trace-message',
});

warnLogger.debug('debug-message');
expect(receiveAllAppender.append).toHaveBeenCalledTimes(2);
expect(receiveAllAppender.append.mock.calls[1][0]).toMatchObject({
level: LogLevel.Debug,
message: 'debug-message',
});

warnLogger.info('info-message');
expect(receiveAllAppender.append).toHaveBeenCalledTimes(3);
expect(receiveAllAppender.append.mock.calls[2][0]).toMatchObject({
level: LogLevel.Info,
message: 'info-message',
});

warnLogger.warn('warn-message');
expect(receiveAllAppender.append).toHaveBeenCalledTimes(4);
expect(receiveAllAppender.append.mock.calls[3][0]).toMatchObject({
level: LogLevel.Warn,
message: 'warn-message',
});

warnLogger.error('error-message');
expect(receiveAllAppender.append).toHaveBeenCalledTimes(5);
expect(receiveAllAppender.append.mock.calls[4][0]).toMatchObject({
level: LogLevel.Error,
message: 'error-message',
});

warnLogger.fatal('fatal-message');
expect(receiveAllAppender.append).toHaveBeenCalledTimes(6);
expect(receiveAllAppender.append.mock.calls[5][0]).toMatchObject({
level: LogLevel.Fatal,
message: 'fatal-message',
});
});

test('passes log record to appender with receiveAllLevels: false, only if log level is supported', () => {
const notReceiveAllAppender = { append: jest.fn(), receiveAllLevels: false };
const warnLogger = new BaseLogger(context, LogLevel.Warn, [notReceiveAllAppender], factory);

warnLogger.trace('trace-message');
expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(0);

warnLogger.debug('debug-message');
expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(0);

warnLogger.info('info-message');
expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(0);

warnLogger.warn('warn-message');
expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(1);
expect(notReceiveAllAppender.append.mock.calls[0][0]).toMatchObject({
level: LogLevel.Warn,
message: 'warn-message',
});

warnLogger.error('error-message');
expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(2);
expect(notReceiveAllAppender.append.mock.calls[1][0]).toMatchObject({
level: LogLevel.Error,
message: 'error-message',
});

warnLogger.fatal('fatal-message');
expect(notReceiveAllAppender.append).toHaveBeenCalledTimes(3);
expect(notReceiveAllAppender.append.mock.calls[2][0]).toMatchObject({
level: LogLevel.Fatal,
message: 'fatal-message',
});
});
2 changes: 1 addition & 1 deletion src/core/server/logging/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ export class BaseLogger implements Logger {
const supportedLevel = this.level.supports(record.level);

for (const appender of this.appenders) {
if (supportedLevel || appender.receiveAllLevels) {
if (supportedLevel) {
appender.append(record);
}
}
Expand Down

0 comments on commit de25412

Please sign in to comment.