Feature/34 logger improvements (#38)

* Set more sensible defaults for logger in driver/client and pool.

* add logger types to index.ts exports

* fix issue where LogLevel.Off would not correctly be set in the constructor, fixed by using a default in the constructor instead and not doing an 'implicit' check for undefined + gave explicit values to all LogLevel levels.

* Add tests for logger

* Changes doc

doc/changes/changes_0.2.0.md

@@ -1,14 +1,16 @@
-# Exasol Driver ts 0.2.0, released 2024-??-??
+# Exasol Driver ts 0.2.0, released 2024-11-13
 
-Code name: TBD
+Code name: Connection pool and logging
 
 ## Summary
 
 Adds `ExasolPool`, which is a connection pool using `ExasolDriver` underneath. See the user guide for a new section on how to configure and use the `ExasolPool` class.
+Logging is now configurable for both driver/client and pool. The defaults are now also more sensible (off). An issue with switching off logging was also resolved.
 
 ## Features
 
 - #28: Add a connection pool.
+- #34: Make log level configurable.
 
 ## Dependency Updates
 

src/index.ts

@@ -6,3 +6,4 @@ export * from './lib/commands';
 export * from './lib/sql-client.interface';
 export * from './lib/statement';
 export * from './lib/connection';
+export * from './lib/logger/logger';

src/lib/logger/logger.spec.ts

@@ -0,0 +1,44 @@
+import { LogLevel, Logger } from './logger';
+
+describe('Logger', () => {
+  it('Should "console.log()" with default Log level (= debug) when using logger.debug()', () => {
+    const defaultLogger = new Logger();
+
+    const logSpy = jest.spyOn(global.console, 'log');
+    defaultLogger.debug('hello');
+    expect(logSpy).toHaveBeenCalled();
+  });
+  it('Should "console.log()" with log level debug when using logger.debug()', () => {
+    const defaultLogger = new Logger(LogLevel.Debug);
+
+    const logSpy = jest.spyOn(global.console, 'log');
+    defaultLogger.debug('hello');
+    expect(logSpy).toHaveBeenCalled();
+  });
+  it('Should not "console.log" with log level "off" when using logger.debug()', () => {
+    const defaultLogger = new Logger(LogLevel.Off);
+
+    const logSpy = jest.spyOn(global.console, 'log');
+    defaultLogger.debug('hello');
+    expect(logSpy).not.toHaveBeenCalled();
+  });
+  it('Should not "console.log" with a lower debug level than debug when using logger.debug()', () => {
+    const defaultLogger = new Logger(LogLevel.Error);
+
+    const logSpy = jest.spyOn(global.console, 'log');
+    defaultLogger.debug('hello');
+    expect(logSpy).not.toHaveBeenCalled();
+  });
+
+  it('Should "console.log" with a higher debug level than debug when using logger.debug()', () => {
+    const defaultLogger = new Logger(LogLevel.Trace);
+
+    const logSpy = jest.spyOn(global.console, 'log');
+    defaultLogger.debug('hello');
+    expect(logSpy).toHaveBeenCalled();
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+});

src/lib/logger/logger.ts

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 export enum LogLevel {
   Off = 0,
-  Error,
-  Warn,
-  Info,
-  Debug,
-  Trace,
+  Error = 1,
+  Warn = 2,
+  Info = 3,
+  Debug = 4,
+  Trace = 5,
 }
 
 export type LoggerMethod = (...data: any) => void;
@@ -21,10 +21,8 @@ export interface ILogger {
 export class Logger implements ILogger {
   private readonly level: LogLevel = LogLevel.Debug;
 
-  constructor(level?: number) {
-    if (level) {
-      this.level = level;
-    }
+  constructor(level: LogLevel = LogLevel.Debug) {
+    this.level = level;
   }
 
   private readonly emptyLog = () => {
@@ -81,7 +79,7 @@ export class Logger implements ILogger {
       `%c[${new Date().toISOString()}] %c${level}%c: %s`,
       'color: gray',
       'color: ' + color,
-      'color: inherit'
+      'color: inherit',
     );
   }
 }

src/lib/sql-client.ts

@@ -1,6 +1,5 @@
 import * as forge from 'node-forge';
 
-
 import { getURIScheme } from './utils';
 import { CreatePreparedStatementResponse, PublicKeyResponse, SQLQueriesResponse, SQLResponse } from './types';
 import { Statement } from './statement';
@@ -68,7 +67,7 @@ export class ExasolDriver implements IExasolDriver {
 
   private readonly pool: ConnectionPool<Connection>;
 
-  constructor(websocketFactory: websocketFactory, config: Partial<Config>, logger: ILogger = new Logger(LogLevel.Debug)) {
+  constructor(websocketFactory: websocketFactory, config: Partial<Config>, logger: ILogger = new Logger(LogLevel.Off)) {
     // Used internally to avoid parallel execution
     this.pool = new ConnectionPool<Connection>(1, logger);
     this.config = {

src/lib/sql-pool.ts

@@ -56,7 +56,7 @@ export class ExasolPool {
   constructor(
     websocketFactory: websocketFactory,
     config: Partial<Config> & Partial<ClientPoolConfig>,
-    logger: ILogger = new Logger(LogLevel.Debug),
+    logger: ILogger = new Logger(LogLevel.Off),
   ) {
     this.logger = logger;
     this.internalPool = getPool(websocketFactory, config, logger);