@splitsoftware/splitio-commons 2.6.0 → 2.6.1-rc.1

package/src/utils/settingsValidation/logger/builtinLogger.ts

@@ -40,15 +40,16 @@ if (/^(enabled?|on)/i.test(initialState)) {
  * @param settings - user config object, with an optional `debug` property of type boolean or string log level.
  * @returns a logger instance with the log level at `settings.debug`. If `settings.debug` is invalid or not provided, `initialLogLevel` is used.
  */
-export function validateLogger(settings: { debug: unknown }): ILogger {
-  const { debug } = settings;
+export function validateLogger(settings: { debug: unknown, logger?: SplitIO.Logger }): ILogger {
+  const { debug, logger } = settings;
 
   const logLevel: SplitIO.LogLevel | undefined = debug !== undefined ? getLogLevel(debug) : initialLogLevel;
 
   const log = new Logger({ logLevel: logLevel || initialLogLevel }, allCodes);
+  log.setLogger(logger);
 
-  // @ts-ignore // if logLevel is undefined at this point, it means that settings `debug` value is invalid
-  if (!logLevel) log._log(LogLevels.ERROR, 'Invalid Log Level - No changes to the logs will be applied.');
+  // if logLevel is undefined at this point, it means that settings `debug` value is invalid
+  if (!logLevel) log._log('error', 'Invalid Log Level - No changes to the logs will be applied.');
 
   return log;
 }

package/src/utils/settingsValidation/logger/commons.ts

@@ -10,15 +10,15 @@ import SplitIO from '../../../../types/splitio';
  * @returns LogLevel of the given debugValue or undefined if the provided value is invalid
  */
 export function getLogLevel(debugValue: unknown): SplitIO.LogLevel | undefined {
-  if (typeof debugValue === 'boolean') {
-    if (debugValue) {
-      return LogLevels.DEBUG;
-    } else {
-      return LogLevels.NONE;
-    }
-  } else if (typeof debugValue === 'string' && isLogLevelString(debugValue)) {
-    return debugValue;
-  } else {
-    return undefined;
-  }
+  return typeof debugValue === 'boolean' ?
+    debugValue ?
+      LogLevels.DEBUG :
+      LogLevels.NONE :
+    typeof debugValue === 'string' && isLogLevelString(debugValue) ?
+      debugValue :
+      undefined;
+}
+
+export function isLogger(log: any): log is SplitIO.Logger {
+  return log !== null && typeof log === 'object' && typeof log.debug === 'function' && typeof log.info === 'function' && typeof log.warn === 'function' && typeof log.error === 'function';
 }

package/src/utils/settingsValidation/logger/pluggableLogger.ts

@@ -1,10 +1,10 @@
 import { Logger, LogLevels } from '../../../logger';
 import { ILogger } from '../../../logger/types';
 import SplitIO from '../../../../types/splitio';
-import { getLogLevel } from './commons';
+import { getLogLevel, isLogger } from './commons';
 
-function isLogger(log: any): log is ILogger {
-  return log !== null && typeof log === 'object' && typeof log.debug === 'function' && typeof log.info === 'function' && typeof log.warn === 'function' && typeof log.error === 'function' && typeof log.setLogLevel === 'function';
+function isILogger(log: any): log is ILogger {
+  return isLogger(log) && typeof (log as any).setLogLevel === 'function';
 }
 
 // By default it starts disabled.
@@ -17,19 +17,23 @@ let initialLogLevel = LogLevels.NONE;
  * @returns a logger instance, that might be: the provided logger at `settings.debug`, or one with the given `debug` log level,
  * or one with NONE log level if `debug` is not defined or invalid.
  */
-export function validateLogger(settings: { debug: unknown }): ILogger {
-  const { debug } = settings;
+export function validateLogger(settings: { debug: unknown, logger?: SplitIO.Logger }): ILogger {
+  const { debug, logger } = settings;
   let logLevel: SplitIO.LogLevel | undefined = initialLogLevel;
 
   if (debug !== undefined) {
-    if (isLogger(debug)) return debug;
+    if (isILogger(debug)) {
+      debug.setLogger(logger);
+      return debug;
+    }
     logLevel = getLogLevel(settings.debug);
   }
 
   const log = new Logger({ logLevel: logLevel || initialLogLevel });
+  log.setLogger(logger);
 
-  // @ts-ignore // `debug` value is invalid if logLevel is undefined at this point
-  if (!logLevel) log._log(LogLevels.ERROR, 'Invalid `debug` value at config. Logs will be disabled.');
+  // `debug` value is invalid if logLevel is undefined at this point
+  if (!logLevel) log._log('error', 'Invalid `debug` value at config. Logs will be disabled.');
 
   return log;
 }

package/types/splitio.d.ts

@@ -91,6 +91,10 @@ interface ISharedSettings {
    * Do not change these settings unless you're working an advanced use case, like connecting to the Split proxy.
    */
   urls?: SplitIO.UrlSettings;
+  /**
+   * Custom logger object. If not provided, the SDK will use the default `console.log` method for all log levels.
+   */
+  logger?: SplitIO.Logger;
 }
 /**
  * Common settings properties for SDKs with synchronous API (standalone and localhost modes).
@@ -141,6 +145,8 @@ 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;
@@ -164,6 +170,8 @@ 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;
@@ -587,6 +595,7 @@ declare namespace SplitIO {
       telemetry: string;
     };
     readonly integrations?: IntegrationFactory[];
+    readonly logger?: Logger;
     readonly debug: boolean | LogLevel | ILogger;
     readonly version: string;
     /**
@@ -617,6 +626,15 @@ declare namespace SplitIO {
    * Log levels.
    */
   type LogLevel = 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'NONE';
+  /**
+   * Custom logger interface.
+   */
+  interface Logger {
+    debug(message: string): any;
+    info(message: string): any;
+    warn(message: string): any;
+    error(message: string): any;
+  }
   /**
    * Logger API
    */
@@ -631,8 +649,16 @@ declare namespace SplitIO {
     disable(): void;
     /**
      * Sets a log level for the SDK logs.
+     *
+     * @param logLevel - The log level to set.
      */
     setLogLevel(logLevel: LogLevel): void;
+    /**
+     * Sets a custom logger for the SDK logs.
+     *
+     * @param logger - The custom logger to set, or `undefined` to remove the custom logger and fall back to the default `console.log` method.
+     */
+    setLogger(logger?: Logger): void;
     /**
      * Log level constants. Use this to pass them to setLogLevel function.
      */