Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add enable method #847

Merged
merged 2 commits into from
Feb 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/core/src/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export class MidwayContextLogger<T> {
protected contextLogger: ILogger;
public ctx: T;

constructor(ctx, contextLogger: ILogger, contextLabelHandler?) {
constructor(ctx, contextLogger: ILogger) {
this.ctx = ctx;
this.contextLogger = contextLogger;
}
Expand Down Expand Up @@ -57,6 +57,7 @@ export class MidwayContextLogger<T> {
...args,
{
label: this.formatContextLabel(),
ctx: this.ctx,
},
]);
}
Expand Down
5 changes: 5 additions & 0 deletions packages/logger/src/format.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ export const displayCommonMessage = format(
info.ignoreFormat = false;
}

if (!info.ctx) {
info.ctx = null;
}

if (!info.LEVEL) {
info.LEVEL = info.level.toUpperCase();
}
Expand All @@ -43,6 +47,7 @@ export const displayCommonMessage = format(
LEVEL: info.LEVEL,
defaultLabel: info.defaultLabel,
ignoreFormat: info.ignoreFormat,
ctx: null,
},
opts.defaultMeta || opts.target?.getDefaultMeta() || {}
);
Expand Down
6 changes: 6 additions & 0 deletions packages/logger/src/interface.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ export interface IMidwayLogger extends ILogger {
enableFile();
disableError();
enableError();
isEnableFile(): boolean ;
isEnableConsole(): boolean;
isEnableError(): boolean ;
updateLevel(level: LoggerLevel): void;
updateFileLevel(level: LoggerLevel): void;
updateConsoleLevel(level: LoggerLevel): void;
Expand All @@ -22,6 +25,9 @@ export interface IMidwayLogger extends ILogger {
getDefaultLabel(): string;
getDefaultMeta(): Record<string, unknown>;
write(...args): boolean;
add(transport: any): any;
remove(transport: any): any;
close(): any;
}

export type LoggerLevel = 'silly' | 'debug' | 'info' | 'warn' | 'error';
Expand Down
24 changes: 24 additions & 0 deletions packages/logger/src/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,18 @@ export class MidwayBaseLogger extends EmptyLogger implements IMidwayLogger {
this.add(this.errTransport);
}

isEnableFile(): boolean {
return !!this.fileTransport;
}

isEnableConsole(): boolean {
return !!this.consoleTransport;
}

isEnableError(): boolean {
return !!this.errTransport;
}

updateLevel(level: LoggerLevel): void {
this.level = level;
this.consoleTransport.level = level;
Expand Down Expand Up @@ -230,6 +242,18 @@ export class MidwayBaseLogger extends EmptyLogger implements IMidwayLogger {
return super.write.apply(this, args);
}
}

add(transport): any {
return super.add(transport);
}

remove(transport: any): any {
return super.remove(transport);
}

close(): any {
return super.close();
}
}

/**
Expand Down
53 changes: 50 additions & 3 deletions packages/logger/test/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ import {
IMidwayLogger,
loggers,
format,
displayCommonMessage
displayCommonMessage,
EmptyTransport,
ILogger
} from '../src';
import { join } from 'path';
import {
Expand All @@ -21,8 +23,7 @@ import {
getCurrentDateString
} from './util';
import { EggLogger } from 'egg-logger';
import { readFileSync } from "fs";
import { ILogger } from '../dist';
import { readFileSync, writeFileSync } from 'fs';

describe('/test/index.test.ts', () => {
it('should test create logger', async () => {
Expand Down Expand Up @@ -528,4 +529,50 @@ describe('/test/index.test.ts', () => {
await removeFileOrDir(logsDir);
});

it('should custom transport', async () => {
clearAllLoggers();
const logsDir = join(__dirname, 'logs');
await removeFileOrDir(logsDir);

class CustomTransport extends EmptyTransport {
log(info, callback) {
const levelLowerCase = info.level;
if (levelLowerCase === 'error' || levelLowerCase === 'warn') {
writeFileSync(join(logsDir, 'test.log'), info.message);
}
callback();
}
}

const logger = createLogger<IMidwayLogger>('logger', {
dir: logsDir,
disableError: true,
level: 'info',
});

expect(logger.isEnableConsole()).toBeTruthy();
expect(logger.isEnableFile()).toBeTruthy();
expect(logger.isEnableError()).toBeFalsy();

const customTransport = new CustomTransport({
level: 'warn'
});
logger.add(customTransport);
logger.info('hello world info');
logger.warn('hello world warn');
logger.remove(customTransport);
logger.warn('hello world another warn');
await sleep();

expect(matchContentTimes(join(logsDir, 'midway-core.log'), 'hello world info')).toEqual(1);
expect(matchContentTimes(join(logsDir, 'midway-core.log'), 'hello world warn')).toEqual(1);
expect(matchContentTimes(join(logsDir, 'midway-core.log'), 'hello world another warn')).toEqual(1);

expect(matchContentTimes(join(logsDir, 'test.log'), 'hello world info')).toEqual(0);
expect(matchContentTimes(join(logsDir, 'test.log'), 'hello world warn')).toEqual(1);
expect(matchContentTimes(join(logsDir, 'test.log'), 'hello world another warn')).toEqual(0);

await removeFileOrDir(logsDir);
});

});