GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-05 16:11:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5705 from storybooks/fix/debugger-in-code

Browse Source 
Core: Clean up debug logging
This commit is contained in:
Michael Shilman 2019-02-22 14:37:20 +08:00 committed by Michael Shilman
parent cc5761b195
commit 8cd14c26f7
4 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lib/channel-postmessage/package.json
View File

@ -21,6 +21,7 @@
},
"dependencies": {
"@storybook/channels": "5.0.0-rc.4",
"@storybook/client-logger": "5.0.0-rc.4",
"global": "^4.3.2",
"telejson": "^1.0.1"
},

11
lib/channel-postmessage/src/index.ts
View File

@ -1,5 +1,7 @@
import { window, document } from 'global';
import Channel, { ChannelEvent, ChannelHandler } from '@storybook/channels';
import { logger } from '@storybook/client-logger';
import { isJSON, parse, stringify } from 'telejson';
interface RawEvent {
@ -90,15 +92,12 @@ export class PostmsgTransport {
const { data } = rawEvent;
const { key, event } = typeof data === 'string' && isJSON(data) ? parse(data) : data;
if (key === KEY) {
// tslint:disable-next-line no-console
console.debug(`message arrived at ${this.config.page}`, event.type, ...event.args);
logger.debug(`message arrived at ${this.config.page}`, event.type, ...event.args);
this.handler(event);
}
} catch (error) {
// tslint:disable-next-line no-console
console.error(error);
// tslint:disable-next-line no-debugger
debugger;
logger.error(error);
// debugger;
}
}
}

14
lib/client-logger/src/index.test.ts
View File

@ -3,17 +3,29 @@ import { logger } from '.';
describe('client-logger', () => {
const initialConsole = { ...global.console };
beforeEach(() => {
global.console.debug = jest.fn();
global.console.log = jest.fn();
global.console.info = jest.fn();
global.console.warn = jest.fn();
global.console.error = jest.fn();
});
afterAll(() => {
global.console = initialConsole;
});
it('should have an debug method that displays the message in red, with a trace', () => {
const message = 'debug message';
logger.debug(message);
expect(global.console.debug).toHaveBeenCalledWith(message);
});
it('should have an log method that displays the message in red, with a trace', () => {
const message = 'log message';
logger.log(message);
expect(global.console.log).toHaveBeenCalledWith(message);
});
it('should have an info method that displays the message', () => {
const message = 'information';
logger.info(message);
expect(global.console.log).toHaveBeenCalledWith(message);
expect(global.console.info).toHaveBeenCalledWith(message);
});
it('should have a warning method that displays the message in yellow, with a trace', () => {
const message = 'warning message';

6
lib/client-logger/src/index.ts
View File

@ -1,7 +1,11 @@
const { console } = global;
/* tslint:disable: no-console */
export const logger = {
info: (message: any, ...rest: any[]): void => console.log(message, ...rest),
debug: (message: any, ...rest: any[]): void => console.debug(message, ...rest),
log: (message: any, ...rest: any[]): void => console.log(message, ...rest),
info: (message: any, ...rest: any[]): void => console.info(message, ...rest),
warn: (message: any, ...rest: any[]): void => console.warn(message, ...rest),
error: (message: any, ...rest: any[]): void => console.error(message, ...rest),
};