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

package/esm/sync/submitters/telemetrySubmitter.js

@@ -53,6 +53,7 @@ export function getTelemetryConfigStats(mode, storageType) {
  */
 export function telemetryCacheConfigAdapter(telemetry, settings) {
     return {
+        name: 'telemetry config',
         isEmpty: function () { return false; },
         clear: function () { },
         pop: function () {
@@ -102,7 +103,7 @@ export function telemetrySubmitterFactory(params) {
         return; // No submitter created if telemetry cache is not defined
     var settings = params.settings, _a = params.settings, log = _a.log, telemetryRefreshRate = _a.scheduler.telemetryRefreshRate, splitApi = params.splitApi, readiness = params.readiness, sdkReadinessManager = params.sdkReadinessManager;
     var startTime = timer(now);
-    var submitter = firstPushWindowDecorator(submitterFactory(log, splitApi.postMetricsUsage, telemetry, telemetryRefreshRate, 'telemetry stats', undefined, 0, true), telemetryRefreshRate);
+    var submitter = firstPushWindowDecorator(submitterFactory(log, splitApi.postMetricsUsage, telemetry, telemetryRefreshRate, undefined, 0, true), telemetryRefreshRate);
     readiness.gate.once(SDK_READY_FROM_CACHE, function () {
         telemetry.recordTimeUntilReadyFromCache(startTime());
     });
@@ -111,7 +112,7 @@ export function telemetrySubmitterFactory(params) {
         telemetry.recordTimeUntilReady(startTime());
         // Post config data when the SDK is ready and if the telemetry submitter was started
         if (submitter.isRunning()) {
-            var postMetricsConfigTask = submitterFactory(log, splitApi.postMetricsConfig, telemetryCacheConfigAdapter(telemetry, settings), 0, 'telemetry config', undefined, 0, true);
+            var postMetricsConfigTask = submitterFactory(log, splitApi.postMetricsConfig, telemetryCacheConfigAdapter(telemetry, settings), 0, undefined, 0, true);
             postMetricsConfigTask.execute();
         }
     });

package/esm/sync/submitters/uniqueKeysSubmitter.js

@@ -1,6 +1,5 @@
 import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
 import { submitterFactory } from './submitter';
-var DATA_NAME = 'unique keys';
 var UNIQUE_KEYS_RATE = 900000; // 15 minutes
 /**
  * Submitter that periodically posts impression counts
@@ -9,11 +8,11 @@ export function uniqueKeysSubmitterFactory(params) {
     var _a = params.settings, log = _a.log, key = _a.core.key, _b = params.splitApi, postUniqueKeysBulkCs = _b.postUniqueKeysBulkCs, postUniqueKeysBulkSs = _b.postUniqueKeysBulkSs, uniqueKeys = params.storage.uniqueKeys;
     var isClientSide = key !== undefined;
     var postUniqueKeysBulk = isClientSide ? postUniqueKeysBulkCs : postUniqueKeysBulkSs;
-    var syncTask = submitterFactory(log, postUniqueKeysBulk, uniqueKeys, UNIQUE_KEYS_RATE, DATA_NAME);
+    var syncTask = submitterFactory(log, postUniqueKeysBulk, uniqueKeys, UNIQUE_KEYS_RATE);
     // register unique keys submitter to be executed when uniqueKeys cache is full
     uniqueKeys.setOnFullQueueCb(function () {
         if (syncTask.isRunning()) {
-            log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+            log.info(SUBMITTERS_PUSH_FULL_QUEUE, [uniqueKeys.name]);
             syncTask.execute();
         }
         // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.

package/esm/utils/settingsValidation/logger/builtinLogger.js

@@ -32,9 +32,10 @@ else if (isLogLevelString(initialState)) {
  * @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) {
-    var debug = settings.debug;
+    var debug = settings.debug, logger = settings.logger;
     var logLevel = debug !== undefined ? getLogLevel(debug) : initialLogLevel;
     var 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.');

package/esm/utils/settingsValidation/logger/commons.js

@@ -7,18 +7,14 @@ import { LogLevels, isLogLevelString } from '../../../logger';
  * @returns LogLevel of the given debugValue or undefined if the provided value is invalid
  */
 export function getLogLevel(debugValue) {
-    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) {
+    return log !== null && typeof log === 'object' && typeof log.debug === 'function' && typeof log.info === 'function' && typeof log.warn === 'function' && typeof log.error === 'function';
 }

package/esm/utils/settingsValidation/logger/pluggableLogger.js

@@ -1,7 +1,7 @@
 import { Logger, LogLevels } from '../../../logger';
-import { getLogLevel } from './commons';
-function isLogger(log) {
-    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';
+import { getLogLevel, isLogger } from './commons';
+function isILogger(log) {
+    return isLogger(log) && typeof log.setLogLevel === 'function';
 }
 // By default it starts disabled.
 var initialLogLevel = LogLevels.NONE;
@@ -13,14 +13,17 @@ var initialLogLevel = LogLevels.NONE;
  * or one with NONE log level if `debug` is not defined or invalid.
  */
 export function validateLogger(settings) {
-    var debug = settings.debug;
+    var debug = settings.debug, logger = settings.logger;
     var logLevel = initialLogLevel;
     if (debug !== undefined) {
-        if (isLogger(debug))
+        if (isILogger(debug)) {
+            debug.setLogger(logger);
             return debug;
+        }
         logLevel = getLogLevel(settings.debug);
     }
     var 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.');

package/package.json

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

package/src/listeners/browser.ts

@@ -9,7 +9,7 @@ import { ISettings } from '../types';
 import SplitIO from '../../types/splitio';
 import { ImpressionsPayload } from '../sync/submitters/types';
 import { objectAssign } from '../utils/lang/objectAssign';
-import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants';
+import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING, SUBMITTERS_PUSH_PAGE_HIDDEN } from '../logger/constants';
 import { ISyncManager } from '../sync/types';
 import { isConsentGranted } from '../consent';
 
@@ -104,6 +104,7 @@ export class BrowserSignalListener implements ISignalListener {
       if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
         postService(JSON.stringify(dataPayload)).catch(() => { }); // no-op to handle possible promise rejection
       }
+      this.settings.log.debug(SUBMITTERS_PUSH_PAGE_HIDDEN, [cache.name]);
     }
   }
 

package/src/logger/constants.ts

@@ -55,6 +55,7 @@ export const IMPRESSIONS_TRACKER_SUCCESS = 121;
 export const USER_CONSENT_UPDATED = 122;
 export const USER_CONSENT_NOT_UPDATED = 123;
 export const USER_CONSENT_INITIAL = 124;
+export const SUBMITTERS_PUSH_PAGE_HIDDEN = 125;
 
 export const ENGINE_VALUE_INVALID = 200;
 export const ENGINE_VALUE_NO_ATTRIBUTES = 201;

package/src/logger/index.ts

@@ -2,6 +2,7 @@ import { objectAssign } from '../utils/lang/objectAssign';
 import { ILoggerOptions, ILogger } from './types';
 import { find, isObject } from '../utils/lang';
 import SplitIO from '../../types/splitio';
+import { isLogger } from '../utils/settingsValidation/logger/commons';
 
 export const LogLevels: SplitIO.ILoggerAPI['LogLevel'] = {
   DEBUG: 'DEBUG',
@@ -48,6 +49,7 @@ export class Logger implements ILogger {
   private options: Required<ILoggerOptions>;
   private codes: Map<number, string>;
   private logLevel: number;
+  private logger?: SplitIO.Logger;
 
   constructor(options?: ILoggerOptions, codes?: Map<number, string>) {
     this.options = objectAssign({}, defaultOptions, options);
@@ -60,6 +62,15 @@ export class Logger implements ILogger {
     this.logLevel = LogLevelIndexes[logLevel];
   }
 
+  setLogger(logger?: SplitIO.Logger) {
+    if (!logger || isLogger(logger)) {
+      this.logger = logger;
+    } else {
+      this._log(LogLevels.ERROR, 'Invalid `logger` instance. It must be an object with `debug`, `info`, `warn` and `error` methods. Defaulting to `console.log`');
+      this.logger = undefined;
+    }
+  }
+
   debug(msg: string | number, args?: any[]) {
     if (this._shouldLog(LogLevelIndexes.DEBUG)) this._log(LogLevels.DEBUG, msg, args);
   }
@@ -86,6 +97,14 @@ export class Logger implements ILogger {
 
     const formattedText = this._generateLogMessage(level, msg);
 
+    // Do not break on custom logger errors
+    if (this.logger) {
+      try { // @ts-expect-error
+        this.logger[level.toLowerCase()](formattedText);
+        return;
+      } catch (e) { /* empty */ }
+    }
+
     console.log(formattedText);
   }
 

package/src/logger/messages/info.ts

@@ -25,6 +25,7 @@ export const codesInfo: [number, string][] = codesWarn.concat([
   [c.SYNC_SPLITS_FETCH_RETRY, c.LOG_PREFIX_SYNC_SPLITS + 'Retrying download of feature flags #%s. Reason: %s'],
   [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and resetting timer.'],
   [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s.'],
+  [c.SUBMITTERS_PUSH_PAGE_HIDDEN, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing %s because page became hidden.'],
   [c.STREAMING_REFRESH_TOKEN, c.LOG_PREFIX_SYNC_STREAMING + 'Refreshing streaming token in %s seconds, and connecting streaming in %s seconds.'],
   [c.STREAMING_RECONNECT, c.LOG_PREFIX_SYNC_STREAMING + 'Attempting to reconnect streaming in %s seconds.'],
   [c.STREAMING_CONNECTING, c.LOG_PREFIX_SYNC_STREAMING + 'Connecting streaming.'],

package/src/logger/sdkLogger.ts

@@ -30,6 +30,13 @@ export function createLoggerAPI(log: ILogger): SplitIO.ILoggerAPI {
      * @param logLevel - Custom LogLevel value.
      */
     setLogLevel,
+    /**
+     * Sets a custom logger for the SDK logs.
+     * @param logger - Custom logger.
+     */
+    setLogger(logger?: ILogger) {
+      log.setLogger(logger);
+    },
     /**
      * Disables all the log levels.
      */

package/src/logger/types.ts

@@ -1,12 +1,14 @@
 import SplitIO from '../../types/splitio';
 
 export interface ILoggerOptions {
-  prefix?: string,
-  logLevel?: SplitIO.LogLevel,
-  showLevel?: boolean, // @TODO remove this param eventually since it is not being set `false` anymore
+  prefix?: string;
+  logLevel?: SplitIO.LogLevel;
+  showLevel?: boolean; // @TODO remove this param eventually since it is not being set `false` anymore
 }
 
 export interface ILogger extends SplitIO.ILogger {
+  setLogger(logger?: SplitIO.Logger): void;
+
   debug(msg: any): void;
   debug(msg: string | number, args?: any[]): void;
 

package/src/storages/inMemory/EventsCacheInMemory.ts

@@ -5,6 +5,7 @@ const MAX_QUEUE_BYTE_SIZE = 5 * 1024 * 1024; // 5M
 
 export class EventsCacheInMemory implements IEventsCacheSync {
 
+  public name = 'events';
   private onFullQueue?: () => void;
   private readonly maxQueue: number;
   private queue: SplitIO.EventData[];

package/src/storages/inMemory/ImpressionCountsCacheInMemory.ts

@@ -3,6 +3,8 @@ import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
 import { IImpressionCountsCacheSync } from '../types';
 
 export class ImpressionCountsCacheInMemory implements IImpressionCountsCacheSync {
+
+  public name = 'impression counts';
   protected cache: Record<string, number> = {};
   private readonly maxStorage: number;
   protected onFullQueue?: () => void;

package/src/storages/inMemory/ImpressionsCacheInMemory.ts

@@ -3,6 +3,7 @@ import SplitIO from '../../../types/splitio';
 
 export class ImpressionsCacheInMemory implements IImpressionsCacheSync {
 
+  public name = 'impressions';
   private onFullQueue?: () => void;
   private readonly maxQueue: number;
   private queue: SplitIO.ImpressionDTO[];

package/src/storages/inMemory/TelemetryCacheInMemory.ts

@@ -25,6 +25,8 @@ export function shouldRecordTelemetry({ settings }: IStorageFactoryParams) {
 
 export class TelemetryCacheInMemory implements ITelemetryCacheSync {
 
+  public name = 'telemetry stats';
+
   constructor(private splits?: ISplitsCacheSync, private segments?: ISegmentsCacheSync, private largeSegments?: ISegmentsCacheSync) { }
 
   // isEmpty flag

package/src/storages/inMemory/UniqueKeysCacheInMemory.ts

@@ -1,4 +1,4 @@
-import { IUniqueKeysCacheBase } from '../types';
+import { IUniqueKeysCacheSync } from '../types';
 import { UniqueKeysPayloadSs } from '../../sync/submitters/types';
 import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
 import { setToArray } from '../../utils/lang/sets';
@@ -22,8 +22,8 @@ export function fromUniqueKeysCollector(uniqueKeys: { [featureName: string]: Set
   return { keys: payload };
 }
 
-export class UniqueKeysCacheInMemory implements IUniqueKeysCacheBase {
-
+export class UniqueKeysCacheInMemory implements IUniqueKeysCacheSync {
+  public name = 'unique keys';
   protected onFullQueue?: () => void;
   private readonly maxStorage: number;
   private uniqueTrackerSize = 0;

package/src/storages/inMemory/UniqueKeysCacheInMemoryCS.ts

@@ -1,10 +1,10 @@
-import { IUniqueKeysCacheBase } from '../types';
+import { IUniqueKeysCacheSync } from '../types';
 import { UniqueKeysPayloadCs } from '../../sync/submitters/types';
 import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
 import { setToArray } from '../../utils/lang/sets';
 
-export class UniqueKeysCacheInMemoryCS implements IUniqueKeysCacheBase {
-
+export class UniqueKeysCacheInMemoryCS implements IUniqueKeysCacheSync {
+  public name = 'unique keys';
   private onFullQueue?: () => void;
   private readonly maxStorage: number;
   private uniqueTrackerSize = 0;

package/src/storages/types.ts

@@ -325,6 +325,7 @@ export interface IUniqueKeysCacheBase {
 
 // API methods for sync recorder storages, used by submitters in standalone mode to pop data and post it to Split BE.
 export interface IRecorderCacheSync<T> {
+  name: string,
   // @TODO names are inconsistent with spec
   /* Checks if cache is empty. Returns true if the cache was just created or cleared */
   isEmpty(): boolean

package/src/sync/submitters/eventsSubmitter.ts

@@ -2,8 +2,6 @@ import { submitterFactory, firstPushWindowDecorator } from './submitter';
 import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 
-const DATA_NAME = 'events';
-
 /**
  * Submitter that periodically posts tracked events
  */
@@ -16,7 +14,7 @@ export function eventsSubmitterFactory(params: ISdkFactoryContextSync) {
   } = params;
 
   // don't retry events.
-  let submitter = submitterFactory(log, postEventsBulk, events, eventsPushRate, DATA_NAME);
+  let submitter = submitterFactory(log, postEventsBulk, events, eventsPushRate);
 
   // Set a timer for the first push window of events.
   if (eventsFirstPushWindow > 0) submitter = firstPushWindowDecorator(submitter, eventsFirstPushWindow);
@@ -24,7 +22,7 @@ export function eventsSubmitterFactory(params: ISdkFactoryContextSync) {
   // register events submitter to be executed when events cache is full
   events.setOnFullQueueCb(() => {
     if (submitter.isRunning()) {
-      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [events.name]);
       submitter.execute();
     }
     // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.

package/src/sync/submitters/impressionCountsSubmitter.ts

@@ -40,5 +40,5 @@ export function impressionCountsSubmitterFactory(params: ISdkFactoryContextSync)
   } = params;
 
   // retry impressions counts only once.
-  return submitterFactory(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, 'impression counts', fromImpressionCountsCollector, 1);
+  return submitterFactory(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, fromImpressionCountsCollector, 1);
 }

package/src/sync/submitters/impressionsSubmitter.ts

@@ -5,8 +5,6 @@ import { ImpressionsPayload } from './types';
 import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 
-const DATA_NAME = 'impressions';
-
 /**
  * Converts `impressions` data from cache into request payload.
  */
@@ -14,7 +12,6 @@ export function fromImpressionsCollector(sendLabels: boolean, data: SplitIO.Impr
   let groupedByFeature = groupBy(data, 'feature');
   let dto: ImpressionsPayload = [];
 
-  // using forOwn instead of for...in since the last also iterates over prototype enumerables
   forOwn(groupedByFeature, (value, name) => {
     dto.push({
       f: name, // Test Name
@@ -50,12 +47,12 @@ export function impressionsSubmitterFactory(params: ISdkFactoryContextSync) {
   } = params;
 
   // retry impressions only once.
-  const syncTask = submitterFactory(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, DATA_NAME, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
+  const syncTask = submitterFactory(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
 
   // register impressions submitter to be executed when impressions cache is full
   impressions.setOnFullQueueCb(() => {
     if (syncTask.isRunning()) {
-      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [impressions.name]);
       syncTask.execute();
     }
     // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.

package/src/sync/submitters/submitter.ts

@@ -13,12 +13,12 @@ export function submitterFactory<T>(
   postClient: (body: string) => Promise<IResponse>,
   sourceCache: IRecorderCacheSync<T>,
   postRate: number,
-  dataName: string,
   fromCacheToPayload?: (cacheData: T) => any,
   maxRetries: number = 0,
   debugLogs?: boolean // true for telemetry submitters
 ): ISyncTask<[], void> {
 
+  const dataName = sourceCache.name;
   let retries = 0;
   let data: any;
 

package/src/sync/submitters/telemetrySubmitter.ts

@@ -66,6 +66,7 @@ export function getTelemetryConfigStats(mode: SplitIO.SDKMode, storageType: stri
  */
 export function telemetryCacheConfigAdapter(telemetry: ITelemetryCacheSync, settings: ISettings) {
   return {
+    name: 'telemetry config',
     isEmpty() { return false; },
     clear() { },
 
@@ -124,7 +125,7 @@ export function telemetrySubmitterFactory(params: ISdkFactoryContextSync) {
     submitterFactory(
       log, splitApi.postMetricsUsage,
       telemetry,
-      telemetryRefreshRate, 'telemetry stats', undefined, 0, true
+      telemetryRefreshRate, undefined, 0, true
     ),
     telemetryRefreshRate
   );
@@ -139,7 +140,7 @@ export function telemetrySubmitterFactory(params: ISdkFactoryContextSync) {
 
     // Post config data when the SDK is ready and if the telemetry submitter was started
     if (submitter.isRunning()) {
-      const postMetricsConfigTask = submitterFactory(log, splitApi.postMetricsConfig, telemetryCacheConfigAdapter(telemetry, settings), 0, 'telemetry config', undefined, 0, true);
+      const postMetricsConfigTask = submitterFactory(log, splitApi.postMetricsConfig, telemetryCacheConfigAdapter(telemetry, settings), 0, undefined, 0, true);
       postMetricsConfigTask.execute();
     }
   });

package/src/sync/submitters/uniqueKeysSubmitter.ts

@@ -2,7 +2,6 @@ import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 import { submitterFactory } from './submitter';
 
-const DATA_NAME = 'unique keys';
 const UNIQUE_KEYS_RATE = 900000; // 15 minutes
 
 /**
@@ -19,12 +18,12 @@ export function uniqueKeysSubmitterFactory(params: ISdkFactoryContextSync) {
   const isClientSide = key !== undefined;
   const postUniqueKeysBulk = isClientSide ? postUniqueKeysBulkCs : postUniqueKeysBulkSs;
 
-  const syncTask = submitterFactory(log, postUniqueKeysBulk, uniqueKeys, UNIQUE_KEYS_RATE, DATA_NAME);
+  const syncTask = submitterFactory(log, postUniqueKeysBulk, uniqueKeys, UNIQUE_KEYS_RATE);
 
   // register unique keys submitter to be executed when uniqueKeys cache is full
   uniqueKeys.setOnFullQueueCb(() => {
     if (syncTask.isRunning()) {
-      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [uniqueKeys.name]);
       syncTask.execute();
     }
     // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.

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

@@ -40,12 +40,13 @@ 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.');

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,16 +17,20 @@ 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.');

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).
@@ -587,6 +591,7 @@ declare namespace SplitIO {
       telemetry: string;
     };
     readonly integrations?: IntegrationFactory[];
+    readonly logger?: Logger;
     readonly debug: boolean | LogLevel | ILogger;
     readonly version: string;
     /**
@@ -617,6 +622,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 +645,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.
      */