feat: update tests for logger

Author: thinkjrs

test/index.spec.ts

@@ -1,10 +1,11 @@
-import { logger } from '../src/index';
+import { Logger, logger } from '../src/index';
 
-describe('Logger', () => {
+describe('Logger Configuration', () => {
   let consoleLogSpy: jest.SpyInstance;
   let consoleWarnSpy: jest.SpyInstance;
   let consoleErrorSpy: jest.SpyInstance;
   let consoleDebugSpy: jest.SpyInstance;
+  let customLogger: Logger;
 
   beforeEach(() => {
     consoleLogSpy = jest.spyOn(console, 'log').mockImplementation();
@@ -14,84 +15,82 @@ describe('Logger', () => {
   });
 
   afterEach(() => {
-    consoleLogSpy.mockRestore();
-    consoleWarnSpy.mockRestore();
-    consoleErrorSpy.mockRestore();
-    consoleDebugSpy.mockRestore();
+    jest.restoreAllMocks();
   });
 
-  it("should log a message with an optional parameter when NODE_ENV is not 'production'", () => {
-    process.env.NODE_ENV = 'development';
-    const message = 'Test log message';
-    const additionalParam = { key: 'value' };
+  it('should use default log level "log" and log messages of that level or higher', () => {
+    logger.debug('This should not be logged');
+    logger.log('This should be logged');
+    logger.warn('This should be logged');
+    logger.error('This should be logged');
 
-    logger.log(message, additionalParam);
+    expect(consoleDebugSpy).not.toHaveBeenCalled();
+    expect(consoleLogSpy).toHaveBeenCalledTimes(1);
+    expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
+    expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
+  });
 
-    expect(consoleLogSpy).toHaveBeenCalledWith(
-      expect.stringMatching(/\[LOG\] .*: Test log message \{"key":"value"\}/)
-    );
+  it('should allow instantiating a custom logger with log level "debug"', () => {
+    customLogger = new Logger({ logLevel: 'debug' });
+
+    customLogger.debug('Debug message');
+    customLogger.log('Log message');
+    customLogger.warn('Warn message');
+    customLogger.error('Error message');
+
+    expect(consoleDebugSpy).toHaveBeenCalledTimes(1);
+    expect(consoleLogSpy).toHaveBeenCalledTimes(1);
+    expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
+    expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
   });
 
-  it("should log a message without an optional parameter when NODE_ENV is not 'production'", () => {
-    process.env.NODE_ENV = 'development';
-    const message = 'Test log message';
+  it('should not log anything when isProduction is true', () => {
+    customLogger = new Logger({ logLevel: 'debug', isProduction: true });
 
-    logger.log(message);
+    customLogger.debug('Debug message');
+    customLogger.log('Log message');
+    customLogger.warn('Warn message');
+    customLogger.error('Error message');
 
+    expect(consoleDebugSpy).not.toHaveBeenCalled();
+    expect(consoleLogSpy).not.toHaveBeenCalled();
+    expect(consoleWarnSpy).not.toHaveBeenCalled();
+    expect(consoleErrorSpy).not.toHaveBeenCalled();
+  });
+
+  it('should format log messages correctly', () => {
+    logger.log('Test log message');
     expect(consoleLogSpy).toHaveBeenCalledWith(
       expect.stringMatching(/\[LOG\] .*: Test log message/)
     );
   });
 
-  it("should warn a message with an optional parameter when NODE_ENV is not 'production'", () => {
-    process.env.NODE_ENV = 'development';
-    const message = 'Test warn message';
-    const additionalParam = [1, 2, 3];
-
-    logger.warn(message, additionalParam);
-
+  it('should format warning messages correctly', () => {
+    logger.warn('Test warn message');
     expect(consoleWarnSpy).toHaveBeenCalledWith(
-      expect.stringMatching(/\[WARN\] .*: Test warn message \[1,2,3\]/)
+      expect.stringMatching(/\[WARN\] .*: Test warn message/)
     );
   });
 
-  it("should error a message with an optional parameter when NODE_ENV is not 'production'", () => {
-    process.env.NODE_ENV = 'development';
-    const message = 'Test error message';
-    const additionalParam = 'extra details';
-
-    logger.error(message, additionalParam);
-
+  it('should format error messages correctly', () => {
+    logger.error('Test error message');
     expect(consoleErrorSpy).toHaveBeenCalledWith(
-      expect.stringMatching(/\[ERROR\] .*: Test error message extra details/)
+      expect.stringMatching(/\[ERROR\] .*: Test error message/)
     );
   });
 
-  it("should debug a message with an optional parameter when NODE_ENV is not 'production'", () => {
-    process.env.NODE_ENV = 'development';
-    const message = 'Test debug message';
-    const additionalParam = { debug: true };
-
-    logger.debug(message, additionalParam);
-
+  it('should format debug messages correctly', () => {
+    customLogger = new Logger({ logLevel: 'debug' });
+    customLogger.debug('Test debug message');
     expect(consoleDebugSpy).toHaveBeenCalledWith(
-      expect.stringMatching(/\[DEBUG\] .*: Test debug message \{"debug":true\}/)
+      expect.stringMatching(/\[DEBUG\] .*: Test debug message/)
     );
   });
 
-  it("should not log, warn, error, or debug a message when NODE_ENV is 'production'", () => {
-    process.env.NODE_ENV = 'production';
-    const message = 'Test message';
-    const additionalParam = { ignored: true };
-
-    logger.log(message, additionalParam);
-    logger.warn(message, additionalParam);
-    logger.error(message, additionalParam);
-    logger.debug(message, additionalParam);
-
-    expect(consoleLogSpy).not.toHaveBeenCalled();
-    expect(consoleWarnSpy).not.toHaveBeenCalled();
-    expect(consoleErrorSpy).not.toHaveBeenCalled();
-    expect(consoleDebugSpy).not.toHaveBeenCalled();
+  it('should include additional parameters in log messages', () => {
+    logger.log('Log with params', { key: 'value' });
+    expect(consoleLogSpy).toHaveBeenCalledWith(
+      expect.stringMatching(/\[LOG\] .*: Log with params \{"key":"value"\}/)
+    );
   });
 });