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

package/CHANGES.txt

@@ -1,3 +1,6 @@
+2.7.0 (October XX, 2025)
+ - Added support for custom loggers: added `logger` configuration option and `LoggerAPI.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/cjs/listeners/browser.js

@@ -87,6 +87,7 @@ var BrowserSignalListener = /** @class */ (function () {
             if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
                 postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op to handle possible promise rejection
             }
+            this.settings.log.debug(constants_1.SUBMITTERS_PUSH_PAGE_HIDDEN, [cache.name]);
         }
     };
     /**

package/cjs/logger/constants.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.ENGINE_DEFAULT = exports.ENGINE_MATCHER_RESULT = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_RBS_UPDATE = exports.SYNC_SPLITS_UPDATE = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
-exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.WARN_FLAGSET_WITHOUT_FLAGS = exports.WARN_FLAGSET_NOT_CONFIGURED = exports.WARN_LOWERCASE_FLAGSET = exports.WARN_INVALID_FLAGSET = exports.STREAMING_PARSING_SPLIT_UPDATE = exports.STREAMING_PARSING_MEMBERSHIPS_UPDATE = exports.WARN_SDK_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = void 0;
-exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_CLIENT_INSTANTIATION = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ENGINE_MATCHER_ERROR = exports.ERROR_SETS_FILTER_EXCLUSIVE = exports.ERROR_TOO_MANY_SETS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_HTTP = void 0;
+exports.SUBMITTERS_PUSH_PAGE_HIDDEN = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.ENGINE_DEFAULT = exports.ENGINE_MATCHER_RESULT = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_RBS_UPDATE = exports.SYNC_SPLITS_UPDATE = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
+exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.WARN_FLAGSET_WITHOUT_FLAGS = exports.WARN_FLAGSET_NOT_CONFIGURED = exports.WARN_LOWERCASE_FLAGSET = exports.WARN_INVALID_FLAGSET = exports.STREAMING_PARSING_SPLIT_UPDATE = exports.STREAMING_PARSING_MEMBERSHIPS_UPDATE = exports.WARN_SDK_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = void 0;
+exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_CLIENT_INSTANTIATION = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ENGINE_MATCHER_ERROR = exports.ERROR_SETS_FILTER_EXCLUSIVE = exports.ERROR_TOO_MANY_SETS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_HTTP = exports.ERROR_INVALID_CONFIG_PARAM = void 0;
 /**
  * Message codes used to trim string log messages from commons and client-side API modules,
  * in order to reduce the minimal SDK size for Browser and eventually other client-side environments.
@@ -59,6 +59,7 @@ exports.IMPRESSIONS_TRACKER_SUCCESS = 121;
 exports.USER_CONSENT_UPDATED = 122;
 exports.USER_CONSENT_NOT_UPDATED = 123;
 exports.USER_CONSENT_INITIAL = 124;
+exports.SUBMITTERS_PUSH_PAGE_HIDDEN = 125;
 exports.ENGINE_VALUE_INVALID = 200;
 exports.ENGINE_VALUE_NO_ATTRIBUTES = 201;
 exports.CLIENT_NO_LISTENER = 202;

package/cjs/logger/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = exports._sprintf = exports.isLogLevelString = exports.LogLevels = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var lang_1 = require("../utils/lang");
+var commons_1 = require("../utils/settingsValidation/logger/commons");
 exports.LogLevels = {
     DEBUG: 'DEBUG',
     INFO: 'INFO',
@@ -53,6 +54,15 @@ var Logger = /** @class */ (function () {
         this.options.logLevel = logLevel;
         this.logLevel = LogLevelIndexes[logLevel];
     };
+    Logger.prototype.setLogger = function (logger) {
+        if (!logger || (0, commons_1.isLogger)(logger)) {
+            this.logger = logger;
+        }
+        else {
+            this._log(exports.LogLevels.ERROR, 'Invalid `logger` instance. It must be an object with `debug`, `info`, `warn` and `error` methods. Defaulting to `console.log`');
+            this.logger = undefined;
+        }
+    };
     Logger.prototype.debug = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.DEBUG))
             this._log(exports.LogLevels.DEBUG, msg, args);
@@ -79,6 +89,14 @@ var Logger = /** @class */ (function () {
                 msg = _sprintf(msg, args);
         }
         var 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);
     };
     Logger.prototype._generateLogMessage = function (level, text) {

package/cjs/logger/messages/info.js

@@ -26,6 +26,7 @@ exports.codesInfo = warn_1.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/cjs/logger/sdkLogger.js

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

package/cjs/storages/inMemory/EventsCacheInMemory.js

@@ -10,6 +10,7 @@ var EventsCacheInMemory = /** @class */ (function () {
      */
     function EventsCacheInMemory(eventsQueueSize) {
         if (eventsQueueSize === void 0) { eventsQueueSize = 0; }
+        this.name = 'events';
         this.maxQueue = eventsQueueSize;
         this.queue = [];
         this.queueByteSize = 0;

package/cjs/storages/inMemory/ImpressionCountsCacheInMemory.js

@@ -6,6 +6,7 @@ var constants_1 = require("../inRedis/constants");
 var ImpressionCountsCacheInMemory = /** @class */ (function () {
     function ImpressionCountsCacheInMemory(impressionCountsCacheSize) {
         if (impressionCountsCacheSize === void 0) { impressionCountsCacheSize = constants_1.DEFAULT_CACHE_SIZE; }
+        this.name = 'impression counts';
         this.cache = {};
         this.cacheSize = 0;
         this.maxStorage = impressionCountsCacheSize;

package/cjs/storages/inMemory/ImpressionsCacheInMemory.js

@@ -9,6 +9,7 @@ var ImpressionsCacheInMemory = /** @class */ (function () {
      */
     function ImpressionsCacheInMemory(impressionsQueueSize) {
         if (impressionsQueueSize === void 0) { impressionsQueueSize = 0; }
+        this.name = 'impressions';
         this.maxQueue = impressionsQueueSize;
         this.queue = [];
     }

package/cjs/storages/inMemory/TelemetryCacheInMemory.js

@@ -27,6 +27,7 @@ var TelemetryCacheInMemory = /** @class */ (function () {
         this.splits = splits;
         this.segments = segments;
         this.largeSegments = largeSegments;
+        this.name = 'telemetry stats';
         // isEmpty flag
         this.e = true;
         this.notReadyUsage = 0;

package/cjs/storages/inMemory/UniqueKeysCacheInMemory.js

@@ -24,6 +24,7 @@ exports.fromUniqueKeysCollector = fromUniqueKeysCollector;
 var UniqueKeysCacheInMemory = /** @class */ (function () {
     function UniqueKeysCacheInMemory(uniqueKeysQueueSize) {
         if (uniqueKeysQueueSize === void 0) { uniqueKeysQueueSize = constants_1.DEFAULT_CACHE_SIZE; }
+        this.name = 'unique keys';
         this.uniqueTrackerSize = 0;
         this.uniqueKeysTracker = {};
         this.maxStorage = uniqueKeysQueueSize;

package/cjs/storages/inMemory/UniqueKeysCacheInMemoryCS.js

@@ -6,6 +6,7 @@ var sets_1 = require("../../utils/lang/sets");
 var UniqueKeysCacheInMemoryCS = /** @class */ (function () {
     function UniqueKeysCacheInMemoryCS(uniqueKeysQueueSize) {
         if (uniqueKeysQueueSize === void 0) { uniqueKeysQueueSize = constants_1.DEFAULT_CACHE_SIZE; }
+        this.name = 'unique keys';
         this.uniqueTrackerSize = 0;
         this.uniqueKeysTracker = {};
         this.maxStorage = uniqueKeysQueueSize;

package/cjs/sync/submitters/eventsSubmitter.js

@@ -3,21 +3,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.eventsSubmitterFactory = void 0;
 var submitter_1 = require("./submitter");
 var constants_1 = require("../../logger/constants");
-var DATA_NAME = 'events';
 /**
  * Submitter that periodically posts tracked events
  */
 function eventsSubmitterFactory(params) {
     var _a = params.settings, log = _a.log, eventsPushRate = _a.scheduler.eventsPushRate, eventsFirstPushWindow = _a.startup.eventsFirstPushWindow, postEventsBulk = params.splitApi.postEventsBulk, events = params.storage.events;
     // don't retry events.
-    var submitter = (0, submitter_1.submitterFactory)(log, postEventsBulk, events, eventsPushRate, DATA_NAME);
+    var submitter = (0, submitter_1.submitterFactory)(log, postEventsBulk, events, eventsPushRate);
     // Set a timer for the first push window of events.
     if (eventsFirstPushWindow > 0)
         submitter = (0, submitter_1.firstPushWindowDecorator)(submitter, eventsFirstPushWindow);
     // register events submitter to be executed when events cache is full
     events.setOnFullQueueCb(function () {
         if (submitter.isRunning()) {
-            log.info(constants_1.SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+            log.info(constants_1.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/cjs/sync/submitters/impressionCountsSubmitter.js

@@ -31,6 +31,6 @@ var IMPRESSIONS_COUNT_RATE = 1800000; // 30 minutes
 function impressionCountsSubmitterFactory(params) {
     var log = params.settings.log, postTestImpressionsCount = params.splitApi.postTestImpressionsCount, impressionCounts = params.storage.impressionCounts;
     // retry impressions counts only once.
-    return (0, submitter_1.submitterFactory)(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, 'impression counts', fromImpressionCountsCollector, 1);
+    return (0, submitter_1.submitterFactory)(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, fromImpressionCountsCollector, 1);
 }
 exports.impressionCountsSubmitterFactory = impressionCountsSubmitterFactory;

package/cjs/sync/submitters/impressionsSubmitter.js

@@ -4,14 +4,12 @@ exports.impressionsSubmitterFactory = exports.fromImpressionsCollector = void 0;
 var lang_1 = require("../../utils/lang");
 var submitter_1 = require("./submitter");
 var constants_1 = require("../../logger/constants");
-var DATA_NAME = 'impressions';
 /**
  * Converts `impressions` data from cache into request payload.
  */
 function fromImpressionsCollector(sendLabels, data) {
     var groupedByFeature = (0, lang_1.groupBy)(data, 'feature');
     var dto = [];
-    // using forOwn instead of for...in since the last also iterates over prototype enumerables
     (0, lang_1.forOwn)(groupedByFeature, function (value, name) {
         dto.push({
             f: name,
@@ -39,11 +37,11 @@ exports.fromImpressionsCollector = fromImpressionsCollector;
 function impressionsSubmitterFactory(params) {
     var _a = params.settings, log = _a.log, impressionsRefreshRate = _a.scheduler.impressionsRefreshRate, labelsEnabled = _a.core.labelsEnabled, postTestImpressionsBulk = params.splitApi.postTestImpressionsBulk, impressions = params.storage.impressions;
     // retry impressions only once.
-    var syncTask = (0, submitter_1.submitterFactory)(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, DATA_NAME, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
+    var syncTask = (0, submitter_1.submitterFactory)(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
     // register impressions submitter to be executed when impressions cache is full
     impressions.setOnFullQueueCb(function () {
         if (syncTask.isRunning()) {
-            log.info(constants_1.SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+            log.info(constants_1.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/cjs/sync/submitters/submitter.js

@@ -6,9 +6,10 @@ var constants_1 = require("../../logger/constants");
 /**
  * Base function to create submitters, such as ImpressionsSubmitter and EventsSubmitter
  */
-function submitterFactory(log, postClient, sourceCache, postRate, dataName, fromCacheToPayload, maxRetries, debugLogs // true for telemetry submitters
+function submitterFactory(log, postClient, sourceCache, postRate, fromCacheToPayload, maxRetries, debugLogs // true for telemetry submitters
 ) {
     if (maxRetries === void 0) { maxRetries = 0; }
+    var dataName = sourceCache.name;
     var retries = 0;
     var data;
     function postData() {

package/cjs/sync/submitters/telemetrySubmitter.js

@@ -57,6 +57,7 @@ exports.getTelemetryConfigStats = getTelemetryConfigStats;
  */
 function telemetryCacheConfigAdapter(telemetry, settings) {
     return {
+        name: 'telemetry config',
         isEmpty: function () { return false; },
         clear: function () { },
         pop: function () {
@@ -107,7 +108,7 @@ 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 = (0, timer_1.timer)(now);
-    var submitter = (0, submitter_1.firstPushWindowDecorator)((0, submitter_1.submitterFactory)(log, splitApi.postMetricsUsage, telemetry, telemetryRefreshRate, 'telemetry stats', undefined, 0, true), telemetryRefreshRate);
+    var submitter = (0, submitter_1.firstPushWindowDecorator)((0, submitter_1.submitterFactory)(log, splitApi.postMetricsUsage, telemetry, telemetryRefreshRate, undefined, 0, true), telemetryRefreshRate);
     readiness.gate.once(constants_2.SDK_READY_FROM_CACHE, function () {
         telemetry.recordTimeUntilReadyFromCache(startTime());
     });
@@ -116,7 +117,7 @@ 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 = (0, submitter_1.submitterFactory)(log, splitApi.postMetricsConfig, telemetryCacheConfigAdapter(telemetry, settings), 0, 'telemetry config', undefined, 0, true);
+            var postMetricsConfigTask = (0, submitter_1.submitterFactory)(log, splitApi.postMetricsConfig, telemetryCacheConfigAdapter(telemetry, settings), 0, undefined, 0, true);
             postMetricsConfigTask.execute();
         }
     });

package/cjs/sync/submitters/uniqueKeysSubmitter.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.uniqueKeysSubmitterFactory = void 0;
 var constants_1 = require("../../logger/constants");
 var submitter_1 = require("./submitter");
-var DATA_NAME = 'unique keys';
 var UNIQUE_KEYS_RATE = 900000; // 15 minutes
 /**
  * Submitter that periodically posts impression counts
@@ -12,11 +11,11 @@ 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 = (0, submitter_1.submitterFactory)(log, postUniqueKeysBulk, uniqueKeys, UNIQUE_KEYS_RATE, DATA_NAME);
+    var syncTask = (0, submitter_1.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(constants_1.SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+            log.info(constants_1.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/cjs/utils/settingsValidation/logger/builtinLogger.js

@@ -35,9 +35,10 @@ else if ((0, logger_1.isLogLevelString)(initialState)) {
  * @returns a logger instance with the log level at `settings.debug`. If `settings.debug` is invalid or not provided, `initialLogLevel` is used.
  */
 function validateLogger(settings) {
-    var debug = settings.debug;
+    var debug = settings.debug, logger = settings.logger;
     var logLevel = debug !== undefined ? (0, commons_1.getLogLevel)(debug) : initialLogLevel;
     var log = new logger_1.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(logger_1.LogLevels.ERROR, 'Invalid Log Level - No changes to the logs will be applied.');

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLogLevel = void 0;
+exports.isLogger = exports.getLogLevel = void 0;
 var logger_1 = require("../../../logger");
 /**
  * Returns the LogLevel for the given debugValue or undefined if it is invalid,
@@ -10,19 +10,16 @@ var logger_1 = require("../../../logger");
  * @returns LogLevel of the given debugValue or undefined if the provided value is invalid
  */
 function getLogLevel(debugValue) {
-    if (typeof debugValue === 'boolean') {
-        if (debugValue) {
-            return logger_1.LogLevels.DEBUG;
-        }
-        else {
-            return logger_1.LogLevels.NONE;
-        }
-    }
-    else if (typeof debugValue === 'string' && (0, logger_1.isLogLevelString)(debugValue)) {
-        return debugValue;
-    }
-    else {
-        return undefined;
-    }
+    return typeof debugValue === 'boolean' ?
+        debugValue ?
+            logger_1.LogLevels.DEBUG :
+            logger_1.LogLevels.NONE :
+        typeof debugValue === 'string' && (0, logger_1.isLogLevelString)(debugValue) ?
+            debugValue :
+            undefined;
 }
 exports.getLogLevel = getLogLevel;
+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';
+}
+exports.isLogger = isLogger;

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

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateLogger = void 0;
 var logger_1 = require("../../../logger");
 var commons_1 = require("./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';
+function isILogger(log) {
+    return (0, commons_1.isLogger)(log) && typeof log.setLogLevel === 'function';
 }
 // By default it starts disabled.
 var initialLogLevel = logger_1.LogLevels.NONE;
@@ -16,14 +16,17 @@ var initialLogLevel = logger_1.LogLevels.NONE;
  * or one with NONE log level if `debug` is not defined or invalid.
  */
 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 = (0, commons_1.getLogLevel)(settings.debug);
     }
     var log = new logger_1.Logger({ logLevel: logLevel || initialLogLevel });
+    log.setLogger(logger);
     // @ts-ignore // `debug` value is invalid if logLevel is undefined at this point
     if (!logLevel)
         log._log(logger_1.LogLevels.ERROR, 'Invalid `debug` value at config. Logs will be disabled.');

package/esm/listeners/browser.js

@@ -1,7 +1,7 @@
 import { fromImpressionsCollector } from '../sync/submitters/impressionsSubmitter';
 import { fromImpressionCountsCollector } from '../sync/submitters/impressionCountsSubmitter';
 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 { isConsentGranted } from '../consent';
 var VISIBILITYCHANGE_EVENT = 'visibilitychange';
 var PAGEHIDE_EVENT = 'pagehide';
@@ -84,6 +84,7 @@ var BrowserSignalListener = /** @class */ (function () {
             if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
                 postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op to handle possible promise rejection
             }
+            this.settings.log.debug(SUBMITTERS_PUSH_PAGE_HIDDEN, [cache.name]);
         }
     };
     /**

package/esm/logger/constants.js

@@ -54,6 +54,7 @@ export var IMPRESSIONS_TRACKER_SUCCESS = 121;
 export var USER_CONSENT_UPDATED = 122;
 export var USER_CONSENT_NOT_UPDATED = 123;
 export var USER_CONSENT_INITIAL = 124;
+export var SUBMITTERS_PUSH_PAGE_HIDDEN = 125;
 export var ENGINE_VALUE_INVALID = 200;
 export var ENGINE_VALUE_NO_ATTRIBUTES = 201;
 export var CLIENT_NO_LISTENER = 202;

package/esm/logger/index.js

@@ -1,5 +1,6 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { find, isObject } from '../utils/lang';
+import { isLogger } from '../utils/settingsValidation/logger/commons';
 export var LogLevels = {
     DEBUG: 'DEBUG',
     INFO: 'INFO',
@@ -48,6 +49,15 @@ var Logger = /** @class */ (function () {
         this.options.logLevel = logLevel;
         this.logLevel = LogLevelIndexes[logLevel];
     };
+    Logger.prototype.setLogger = function (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;
+        }
+    };
     Logger.prototype.debug = function (msg, args) {
         if (this._shouldLog(LogLevelIndexes.DEBUG))
             this._log(LogLevels.DEBUG, msg, args);
@@ -74,6 +84,14 @@ var Logger = /** @class */ (function () {
                 msg = _sprintf(msg, args);
         }
         var 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);
     };
     Logger.prototype._generateLogMessage = function (level, text) {

package/esm/logger/messages/info.js

@@ -22,6 +22,7 @@ export var codesInfo = 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/esm/logger/sdkLogger.js

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

package/esm/storages/inMemory/EventsCacheInMemory.js

@@ -7,6 +7,7 @@ var EventsCacheInMemory = /** @class */ (function () {
      */
     function EventsCacheInMemory(eventsQueueSize) {
         if (eventsQueueSize === void 0) { eventsQueueSize = 0; }
+        this.name = 'events';
         this.maxQueue = eventsQueueSize;
         this.queue = [];
         this.queueByteSize = 0;

package/esm/storages/inMemory/ImpressionCountsCacheInMemory.js

@@ -3,6 +3,7 @@ import { DEFAULT_CACHE_SIZE } from '../inRedis/constants';
 var ImpressionCountsCacheInMemory = /** @class */ (function () {
     function ImpressionCountsCacheInMemory(impressionCountsCacheSize) {
         if (impressionCountsCacheSize === void 0) { impressionCountsCacheSize = DEFAULT_CACHE_SIZE; }
+        this.name = 'impression counts';
         this.cache = {};
         this.cacheSize = 0;
         this.maxStorage = impressionCountsCacheSize;

package/esm/storages/inMemory/ImpressionsCacheInMemory.js

@@ -6,6 +6,7 @@ var ImpressionsCacheInMemory = /** @class */ (function () {
      */
     function ImpressionsCacheInMemory(impressionsQueueSize) {
         if (impressionsQueueSize === void 0) { impressionsQueueSize = 0; }
+        this.name = 'impressions';
         this.maxQueue = impressionsQueueSize;
         this.queue = [];
     }

package/esm/storages/inMemory/TelemetryCacheInMemory.js

@@ -22,6 +22,7 @@ var TelemetryCacheInMemory = /** @class */ (function () {
         this.splits = splits;
         this.segments = segments;
         this.largeSegments = largeSegments;
+        this.name = 'telemetry stats';
         // isEmpty flag
         this.e = true;
         this.notReadyUsage = 0;

package/esm/storages/inMemory/UniqueKeysCacheInMemory.js

@@ -20,6 +20,7 @@ export function fromUniqueKeysCollector(uniqueKeys) {
 var UniqueKeysCacheInMemory = /** @class */ (function () {
     function UniqueKeysCacheInMemory(uniqueKeysQueueSize) {
         if (uniqueKeysQueueSize === void 0) { uniqueKeysQueueSize = DEFAULT_CACHE_SIZE; }
+        this.name = 'unique keys';
         this.uniqueTrackerSize = 0;
         this.uniqueKeysTracker = {};
         this.maxStorage = uniqueKeysQueueSize;

package/esm/storages/inMemory/UniqueKeysCacheInMemoryCS.js

@@ -3,6 +3,7 @@ import { setToArray } from '../../utils/lang/sets';
 var UniqueKeysCacheInMemoryCS = /** @class */ (function () {
     function UniqueKeysCacheInMemoryCS(uniqueKeysQueueSize) {
         if (uniqueKeysQueueSize === void 0) { uniqueKeysQueueSize = DEFAULT_CACHE_SIZE; }
+        this.name = 'unique keys';
         this.uniqueTrackerSize = 0;
         this.uniqueKeysTracker = {};
         this.maxStorage = uniqueKeysQueueSize;

package/esm/sync/submitters/eventsSubmitter.js

@@ -1,20 +1,19 @@
 import { submitterFactory, firstPushWindowDecorator } from './submitter';
 import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
-var DATA_NAME = 'events';
 /**
  * Submitter that periodically posts tracked events
  */
 export function eventsSubmitterFactory(params) {
     var _a = params.settings, log = _a.log, eventsPushRate = _a.scheduler.eventsPushRate, eventsFirstPushWindow = _a.startup.eventsFirstPushWindow, postEventsBulk = params.splitApi.postEventsBulk, events = params.storage.events;
     // don't retry events.
-    var submitter = submitterFactory(log, postEventsBulk, events, eventsPushRate, DATA_NAME);
+    var submitter = submitterFactory(log, postEventsBulk, events, eventsPushRate);
     // Set a timer for the first push window of events.
     if (eventsFirstPushWindow > 0)
         submitter = firstPushWindowDecorator(submitter, eventsFirstPushWindow);
     // register events submitter to be executed when events cache is full
     events.setOnFullQueueCb(function () {
         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/esm/sync/submitters/impressionCountsSubmitter.js

@@ -27,5 +27,5 @@ var IMPRESSIONS_COUNT_RATE = 1800000; // 30 minutes
 export function impressionCountsSubmitterFactory(params) {
     var log = params.settings.log, postTestImpressionsCount = params.splitApi.postTestImpressionsCount, impressionCounts = params.storage.impressionCounts;
     // 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/esm/sync/submitters/impressionsSubmitter.js

@@ -1,14 +1,12 @@
 import { groupBy, forOwn } from '../../utils/lang';
 import { submitterFactory } from './submitter';
 import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
-var DATA_NAME = 'impressions';
 /**
  * Converts `impressions` data from cache into request payload.
  */
 export function fromImpressionsCollector(sendLabels, data) {
     var groupedByFeature = groupBy(data, 'feature');
     var dto = [];
-    // using forOwn instead of for...in since the last also iterates over prototype enumerables
     forOwn(groupedByFeature, function (value, name) {
         dto.push({
             f: name,
@@ -35,11 +33,11 @@ export function fromImpressionsCollector(sendLabels, data) {
 export function impressionsSubmitterFactory(params) {
     var _a = params.settings, log = _a.log, impressionsRefreshRate = _a.scheduler.impressionsRefreshRate, labelsEnabled = _a.core.labelsEnabled, postTestImpressionsBulk = params.splitApi.postTestImpressionsBulk, impressions = params.storage.impressions;
     // retry impressions only once.
-    var syncTask = submitterFactory(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, DATA_NAME, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
+    var syncTask = submitterFactory(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
     // register impressions submitter to be executed when impressions cache is full
     impressions.setOnFullQueueCb(function () {
         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/esm/sync/submitters/submitter.js

@@ -3,9 +3,10 @@ import { SUBMITTERS_PUSH, SUBMITTERS_PUSH_FAILS, SUBMITTERS_PUSH_RETRY } from '.
 /**
  * Base function to create submitters, such as ImpressionsSubmitter and EventsSubmitter
  */
-export function submitterFactory(log, postClient, sourceCache, postRate, dataName, fromCacheToPayload, maxRetries, debugLogs // true for telemetry submitters
+export function submitterFactory(log, postClient, sourceCache, postRate, fromCacheToPayload, maxRetries, debugLogs // true for telemetry submitters
 ) {
     if (maxRetries === void 0) { maxRetries = 0; }
+    var dataName = sourceCache.name;
     var retries = 0;
     var data;
     function postData() {