mirror of
https://github.com/pyscript/pyscript.git
synced 2025-12-19 18:27:29 -05:00
f3157b377f
This PR tries to improve and rationalize what we log. Key points:
- introduce `logger.ts`: each file/component is encouraged to use the logger instead of writing directly to `console.*`
* the logger automatically prepend a prefix like `[py-config]`, `[py-env]` which make it easier to understand where a certain message is printed from
* it provide a central place where to add more features in the future. E.g., I can imagine having a config setting to completely silence the logs (not implemented yet)
- use the new loggers everywhere
- write to `.info()` instead of `.log()`. The idea is to keep `console.log` free, so that for the users it's easier to tell apart their own messages and the pyscript ones
- generally improve what we log. This is an endless exercise, but I tried to print more things which are useful to understand what's going on and in which order the various things are executed, and remove prints which were clearly debugging leftovers
58 lines
1.6 KiB
TypeScript
58 lines
1.6 KiB
TypeScript
import { jest } from '@jest/globals';
|
|
import { getLogger } from '../../src/logger';
|
|
|
|
describe('getLogger', () => {
|
|
it('getLogger caches results', () => {
|
|
let a1 = getLogger('a');
|
|
let b = getLogger('b');
|
|
let a2 = getLogger('a');
|
|
|
|
expect(a1).not.toBe(b);
|
|
expect(a1).toBe(a2);
|
|
});
|
|
|
|
it('logger.info prints to console.info', () => {
|
|
console.info = jest.fn();
|
|
|
|
const logger = getLogger('prefix1');
|
|
logger.info('hello world')
|
|
expect(console.info).toHaveBeenCalledWith(
|
|
'[prefix1] hello world'
|
|
)
|
|
});
|
|
|
|
it('logger.info handles multiple args', () => {
|
|
console.info = jest.fn();
|
|
|
|
const logger = getLogger('prefix2');
|
|
logger.info('hello', 'world', 1, 2, 3)
|
|
expect(console.info).toHaveBeenCalledWith(
|
|
'[prefix2] hello', 'world', 1, 2, 3
|
|
)
|
|
});
|
|
|
|
it('logger.{debug,warn,error} also works', () => {
|
|
console.info = jest.fn();
|
|
console.debug = jest.fn();
|
|
console.warn = jest.fn();
|
|
console.error = jest.fn();
|
|
|
|
const logger = getLogger('prefix3');
|
|
logger.debug('this is a debug');
|
|
logger.warn('this is a warning');
|
|
logger.error('this is an error');
|
|
|
|
expect(console.info).not.toHaveBeenCalled();
|
|
expect(console.debug).toHaveBeenCalledWith(
|
|
'[prefix3] this is a debug'
|
|
)
|
|
expect(console.warn).toHaveBeenCalledWith(
|
|
'[prefix3] this is a warning'
|
|
)
|
|
expect(console.error).toHaveBeenCalledWith(
|
|
'[prefix3] this is an error'
|
|
)
|
|
});
|
|
|
|
});
|