@thoughtspot/visual-embed-sdk/src/utils/logger.spec.ts

ThoughtSpot Embed SDK

let logger: any;
let LogLevel: any;
let setGlobalLogLevelOverride: any;

const consoleErrorSpy = jest.spyOn(console, 'error');
const consoleWarnSpy = jest.spyOn(console, 'warn');
const consoleInfoSpy = jest.spyOn(console, 'info');
const consoleDebugSpy = jest.spyOn(console, 'debug');
const consoleTraceSpy = jest.spyOn(console, 'trace');

describe('Logger', () => {
    beforeAll(async () => {
        const a = await import('./logger');
        logger = a.logger;
        LogLevel = a.LogLevel;
        setGlobalLogLevelOverride = a.setGlobalLogLevelOverride;
    });

    beforeEach(() => {
        // Reset the logger's log level before each test
        setGlobalLogLevelOverride(LogLevel.TRACE);
        logger.setLogLevel(LogLevel.ERROR);

        consoleErrorSpy.mockRestore();
        consoleWarnSpy.mockRestore();
        consoleInfoSpy.mockRestore();
        consoleDebugSpy.mockRestore();
        consoleTraceSpy.mockRestore();
    });

    it('should set the log level correctly', () => {
        logger.setLogLevel(LogLevel.INFO);
        expect(logger.getLogLevel()).toBe(LogLevel.INFO);

        logger.setLogLevel(LogLevel.DEBUG);
        expect(logger.getLogLevel()).toBe(LogLevel.DEBUG);
    });

    it('should log messages based on the log level', () => {
        setGlobalLogLevelOverride(undefined);

        logger.setLogLevel(LogLevel.SILENT);
        logger.logMessages(['log me'], LogLevel.SILENT);
        logger.error('Error message');
        logger.warn('Warning message');
        logger.debug('Debug message');
        expect(consoleErrorSpy).not.toHaveBeenCalled();
        expect(consoleWarnSpy).not.toHaveBeenCalled();
        expect(consoleDebugSpy).not.toHaveBeenCalled();

        logger.setLogLevel(LogLevel.ERROR);
        logger.error('Error message');
        logger.warn('Warning message');
        logger.debug('Debug message');
        expect(consoleErrorSpy).toHaveBeenCalledWith('Error message');
        expect(consoleWarnSpy).not.toHaveBeenCalled();
        expect(consoleDebugSpy).not.toHaveBeenCalled();

        logger.error('Warning message');
        logger.warn('Warning message');
        logger.debug('Debug message');
        expect(consoleTraceSpy).not.toHaveBeenCalled();

        logger.setLogLevel(LogLevel.WARN);
        logger.error('Warning message');
        logger.warn('Warning message');
        logger.debug('Debug message');
        expect(consoleErrorSpy).toHaveBeenCalledWith('Warning message');
        expect(consoleWarnSpy).toHaveBeenCalledWith('Warning message');
        expect(consoleDebugSpy).not.toHaveBeenCalled();

        logger.setLogLevel(LogLevel.DEBUG);
        logger.error('Warning message');
        logger.warn('Warning message');
        logger.debug('Debug message');
        expect(consoleErrorSpy).toHaveBeenCalledWith('Warning message');
        expect(consoleWarnSpy).toHaveBeenCalledWith('Warning message');
        expect(consoleDebugSpy).toHaveBeenCalledWith('Debug message');
    });

    it('should log messages with the global log level override', () => {
        setGlobalLogLevelOverride(LogLevel.WARN);

        logger.error('Error message');
        logger.warn('Warn message');
        logger.info('Info message');
        logger.trace('Trace message');
        expect(consoleErrorSpy).toHaveBeenCalledWith('Error message');
        expect(consoleWarnSpy).toHaveBeenCalledWith('Warn message');
        expect(consoleInfoSpy).not.toHaveBeenCalled();
        expect(consoleDebugSpy).not.toHaveBeenCalled();
        expect(consoleTraceSpy).not.toHaveBeenCalled();
    });

    it('If global level is not set , default local level (error) should be used', () => {
        setGlobalLogLevelOverride(undefined);

        logger.error('Error message');
        logger.warn('Warn message');
        logger.info('Info message');
        logger.trace('Trace message');
        expect(consoleErrorSpy).toHaveBeenCalledWith('Error message');
        expect(consoleWarnSpy).not.toHaveBeenCalled();
        expect(consoleInfoSpy).not.toHaveBeenCalled();
        expect(consoleDebugSpy).not.toHaveBeenCalled();
        expect(consoleTraceSpy).not.toHaveBeenCalled();
    });
});