Merge pull request #436 from splitio/custom-logger

Update SDK to support log level when `logger` is provided

Author: EmilianoSanchez

CHANGES.txt

@@ -1,5 +1,8 @@
+2.7.1 (October 8, 2025)
+ - Bugfix - Update `debug` option to support log levels when `logger` option is used.
+
 2.7.0 (October 7, 2025)
- - Added support for custom loggers: added `logger` configuration option and `LoggerAPI.setLogger` method to allow the SDK to use a custom logger.
+ - Added support for custom loggers: added `logger` configuration option and `factory.Logger.setLogger` method to allow the SDK to use a custom logger.
 
 2.6.0 (September 18, 2025)
  - Added `storage.wrapper` configuration option to allow the SDK to use a custom storage wrapper for the storage type `LOCALSTORAGE`. Default value is `window.localStorage`.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package.json

@@ -72,8 +72,6 @@ export class Logger implements ILogger {
     if (logger) {
       if (isLogger(logger)) {
         this.logger = logger;
-        // If custom logger is set, all logs are either enabled or disabled
-        if (this.logLevel !== LogLevelIndexes.NONE) this.setLogLevel(LogLevels.DEBUG);
         return;
       } else {
         this.error('Invalid `logger` instance. It must be an object with `debug`, `info`, `warn` and `error` methods. Defaulting to `console.log`');

src/logger/index.ts

@@ -49,19 +49,13 @@ describe('logger validators', () => {
   });
 
   test.each(testTargets)('returns a logger with the provided log level if `debug` property is true or a string log level', (validateLogger) => {
-    expect(getLoggerLogLevel(validateLogger({ debug: true }))).toBe('DEBUG');
+    expect(getLoggerLogLevel(validateLogger({ debug: true, logger: loggerMock }))).toBe('DEBUG');
     expect(getLoggerLogLevel(validateLogger({ debug: 'DEBUG' }))).toBe('DEBUG');
-    expect(getLoggerLogLevel(validateLogger({ debug: 'INFO' }))).toBe('INFO');
+    expect(getLoggerLogLevel(validateLogger({ debug: 'INFO', logger: loggerMock }))).toBe('INFO');
     expect(getLoggerLogLevel(validateLogger({ debug: 'WARN' }))).toBe('WARN');
-    expect(getLoggerLogLevel(validateLogger({ debug: 'ERROR' }))).toBe('ERROR');
+    expect(getLoggerLogLevel(validateLogger({ debug: 'ERROR', logger: loggerMock }))).toBe('ERROR');
     expect(getLoggerLogLevel(validateLogger({ debug: 'NONE' }))).toBe('NONE');
-
-    // When combined with the `logger` option, any log level other than `NONE` (false) will be set to `DEBUG` (true)
-    expect(getLoggerLogLevel(validateLogger({ debug: 'DEBUG', logger: loggerMock }))).toBe('DEBUG');
-    expect(getLoggerLogLevel(validateLogger({ debug: 'INFO', logger: loggerMock }))).toBe('DEBUG');
-    expect(getLoggerLogLevel(validateLogger({ debug: 'WARN', logger: loggerMock }))).toBe('DEBUG');
-    expect(getLoggerLogLevel(validateLogger({ debug: 'ERROR', logger: loggerMock }))).toBe('DEBUG');
-    expect(getLoggerLogLevel(validateLogger({ debug: 'NONE', logger: loggerMock }))).toBe('NONE');
+    expect(getLoggerLogLevel(validateLogger({ debug: false }))).toBe('NONE');
 
     expect(consoleLogSpy).not.toBeCalled();
   });

src/utils/settingsValidation/logger/__tests__/index.spec.ts

@@ -93,6 +93,7 @@ interface ISharedSettings {
   urls?: SplitIO.UrlSettings;
   /**
    * Custom logger object. If not provided, the SDK will use the default `console.log` method for all log levels.
+   * Set together with `debug` option to `true` or a log level string to enable logging.
    */
   logger?: SplitIO.Logger;
 }
@@ -145,8 +146,6 @@ interface IPluggableSharedSettings {
    * config.debug = ErrorLogger()
    * ```
    *
-   * When combined with the `logger` option, any log level other than `NONE` (false) will be set to `DEBUG` (true), delegating log level control to the custom logger.
-   *
    * @defaultValue `false`
    */
   debug?: boolean | SplitIO.LogLevel | SplitIO.ILogger;
@@ -170,8 +169,6 @@ interface INonPluggableSharedSettings {
    * config.debug = 'WARN'
    * ```
    *
-   * When combined with the `logger` option, any log level other than `NONE` (false) will be set to `DEBUG` (true), delegating log level control to the custom logger.
-   *
    * @defaultValue `false`
    */
   debug?: boolean | SplitIO.LogLevel;