@splitsoftware/splitio-commons 1.3.1 → 1.3.2-rc.2

package/cjs/consent/sdkUserConsent.js

@@ -23,7 +23,7 @@ function createUserConsentAPI(params) {
             var _a, _b;
             // validate input param
             if (!(0, lang_1.isBoolean)(consent)) {
-                log.warn(constants_1.ERROR_NOT_BOOLEAN, ['setUserConsent']);
+                log.warn(constants_1.ERROR_NOT_BOOLEAN, ['UserConsent.setStatus']);
                 return false;
             }
             var newConsentStatus = consent ? constants_2.CONSENT_GRANTED : constants_2.CONSENT_DECLINED;

package/cjs/listeners/browser.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BrowserSignalListener = void 0;
-var impressionsSyncTask_1 = require("../sync/submitters/impressionsSyncTask");
-var impressionCountsSyncTask_1 = require("../sync/submitters/impressionCountsSyncTask");
+var impressionsSubmitter_1 = require("../sync/submitters/impressionsSubmitter");
+var impressionCountsSubmitter_1 = require("../sync/submitters/impressionCountsSubmitter");
 var constants_1 = require("../utils/constants");
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_2 = require("../logger/constants");
@@ -20,7 +20,7 @@ var BrowserSignalListener = /** @class */ (function () {
         this.storage = storage;
         this.serviceApi = serviceApi;
         this.flushData = this.flushData.bind(this);
-        this.fromImpressionsCollector = impressionsSyncTask_1.fromImpressionsCollector.bind(undefined, settings.core.labelsEnabled);
+        this.fromImpressionsCollector = impressionsSubmitter_1.fromImpressionsCollector.bind(undefined, settings.core.labelsEnabled);
     }
     /**
      * start method.
@@ -62,7 +62,8 @@ var BrowserSignalListener = /** @class */ (function () {
             this._flushData(eventsUrl + '/testImpressions/beacon', this.storage.impressions, this.serviceApi.postTestImpressionsBulk, this.fromImpressionsCollector, extraMetadata);
             this._flushData(eventsUrl + '/events/beacon', this.storage.events, this.serviceApi.postEventsBulk);
             if (this.storage.impressionCounts)
-                this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, impressionCountsSyncTask_1.fromImpressionCountsCollector);
+                this._flushData(eventsUrl + '/testImpressions/count/beacon', this.storage.impressionCounts, this.serviceApi.postTestImpressionsCount, impressionCountsSubmitter_1.fromImpressionCountsCollector);
+            // No beacon endpoint for `/metrics/usage`
         }
         // Close streaming connection
         if (this.syncManager.pushManager)

package/cjs/logger/constants.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 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.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_SPLITS_SEGMENTS = exports.SYNC_SPLITS_REMOVED = exports.SYNC_SPLITS_NEW = 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_WHITELIST = exports.ENGINE_MATCHER_STARTS_WITH = exports.ENGINE_MATCHER_STRING_INVALID = exports.ENGINE_MATCHER_STRING = exports.ENGINE_MATCHER_SEGMENT = exports.ENGINE_MATCHER_PART_OF = exports.ENGINE_MATCHER_LESS = exports.ENGINE_MATCHER_GREATER = exports.ENGINE_MATCHER_ENDS_WITH = exports.ENGINE_MATCHER_EQUAL_TO_SET = exports.ENGINE_MATCHER_EQUAL = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_MATCHER_CONTAINS_STRING = exports.ENGINE_MATCHER_CONTAINS_ANY = exports.ENGINE_MATCHER_CONTAINS_ALL = exports.ENGINE_MATCHER_BOOLEAN = exports.ENGINE_MATCHER_BETWEEN = exports.ENGINE_MATCHER_ALL = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
 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.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_API_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 = 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 = void 0;
-exports.LOG_PREFIX_CLEANUP = 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_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = 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 = void 0;
+exports.LOG_PREFIX_CLEANUP = 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_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = 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 = 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.
@@ -125,6 +125,7 @@ exports.ERROR_HTTP = 322;
 exports.ERROR_LOCALHOST_MODULE_REQUIRED = 323;
 exports.ERROR_STORAGE_INVALID = 324;
 exports.ERROR_NOT_BOOLEAN = 325;
+exports.ERROR_MIN_CONFIG_PARAM = 326;
 // Log prefixes (a.k.a. tags or categories)
 exports.LOG_PREFIX_SETTINGS = 'settings';
 exports.LOG_PREFIX_INSTANTIATION = 'Factory instantiation';

package/cjs/logger/messages/error.js

@@ -35,5 +35,6 @@ exports.codesError = [
     // initialization / settings validation
     [c.ERROR_INVALID_CONFIG_PARAM, c.LOG_PREFIX_SETTINGS + ': you passed an invalid "%s" config param. It should be one of the following values: %s. Defaulting to "%s".'],
     [c.ERROR_LOCALHOST_MODULE_REQUIRED, c.LOG_PREFIX_SETTINGS + ': an invalid value was received for "sync.localhostMode" config. A valid entity should be provided for localhost mode.'],
-    [c.ERROR_STORAGE_INVALID, c.LOG_PREFIX_SETTINGS + ': The provided storage is invalid.%s Fallbacking into default MEMORY storage'],
+    [c.ERROR_STORAGE_INVALID, c.LOG_PREFIX_SETTINGS + ': the provided storage is invalid.%s Falling back into default MEMORY storage'],
+    [c.ERROR_MIN_CONFIG_PARAM, c.LOG_PREFIX_SETTINGS + ': the provided "%s" config param is lower than allowed. Setting to the minimum value %s seconds'],
 ];

package/cjs/logger/messages/info.js

@@ -16,8 +16,8 @@ exports.codesInfo = warn_1.codesWarn.concat([
     [c.NEW_FACTORY, 'New Split SDK instance created.'],
     [c.EVENTS_TRACKER_SUCCESS, c.LOG_PREFIX_EVENTS_TRACKER + 'Successfully queued %s'],
     [c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
-    [c.USER_CONSENT_UPDATED, 'setUserConsent: consent status changed from %s to %s.'],
-    [c.USER_CONSENT_NOT_UPDATED, 'setUserConsent: call had no effect because it was the current consent status (%s).'],
+    [c.USER_CONSENT_UPDATED, 'UserConsent: consent status changed from %s to %s.'],
+    [c.USER_CONSENT_NOT_UPDATED, 'UserConsent: call had no effect because it was the current consent status (%s).'],
     [c.USER_CONSENT_INITIAL, 'Starting the SDK with %s user consent. No data will be sent.'],
     // synchronizer
     [c.POLLING_SMART_PAUSING, c.LOG_PREFIX_SYNC_POLLING + 'Turning segments data polling %s.'],
@@ -25,7 +25,7 @@ exports.codesInfo = warn_1.codesWarn.concat([
     [c.POLLING_STOP, c.LOG_PREFIX_SYNC_POLLING + 'Stopping polling'],
     [c.SYNC_SPLITS_FETCH_RETRY, c.LOG_PREFIX_SYNC_SPLITS + 'Retrying download of splits #%s. Reason: %s'],
     [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and reseting timer.'],
-    [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s %s.'],
+    [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s.'],
     [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/messages/warn.js

@@ -14,8 +14,8 @@ exports.codesWarn = error_1.codesError.concat([
     [c.STREAMING_PARSING_ERROR_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE error notification: %s'],
     [c.STREAMING_PARSING_MESSAGE_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE message notification: %s'],
     [c.STREAMING_FALLBACK, c.LOG_PREFIX_SYNC_STREAMING + 'Falling back to polling mode. Reason: %s'],
-    [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Droping %s %s after retry. Reason: %s.'],
-    [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s %s, keeping data to retry on next iteration. Reason: %s.'],
+    [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Droping %s after retry. Reason: %s.'],
+    [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
     // client status
     [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect. Make sure to wait for SDK readiness before using this method.'],
     [c.CLIENT_NO_LISTENER, 'No listeners for SDK Readiness detected. Incorrect control treatments could have been logged if you called getTreatment/s while the SDK was not yet ready.'],

package/cjs/sdkClient/client.js

@@ -12,16 +12,17 @@ var constants_2 = require("../logger/constants");
 /**
  * Creator of base client with getTreatments and track methods.
  */
-// @TODO missing time tracking to collect telemetry
 function clientFactory(params) {
-    var readinessManager = params.sdkReadinessManager.readinessManager, storage = params.storage, settings = params.settings, impressionsTracker = params.impressionsTracker, eventTracker = params.eventTracker;
+    var readinessManager = params.sdkReadinessManager.readinessManager, storage = params.storage, settings = params.settings, impressionsTracker = params.impressionsTracker, eventTracker = params.eventTracker, telemetryTracker = params.telemetryTracker;
     var log = settings.log, mode = settings.mode;
     function getTreatment(key, splitName, attributes, withConfig) {
         if (withConfig === void 0) { withConfig = false; }
+        var stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? constants_1.TREATMENT_WITH_CONFIG : constants_1.TREATMENT);
         var wrapUp = function (evaluationResult) {
             var queue = [];
             var treatment = processEvaluation(evaluationResult, splitName, key, attributes, withConfig, "getTreatment" + (withConfig ? 'withConfig' : ''), queue);
             impressionsTracker.track(queue, attributes);
+            stopTelemetryTracker(queue[0] && queue[0].label);
             return treatment;
         };
         var evaluation = (0, evaluator_1.evaluateFeature)(log, key, splitName, attributes, storage);
@@ -32,6 +33,7 @@ function clientFactory(params) {
     }
     function getTreatments(key, splitNames, attributes, withConfig) {
         if (withConfig === void 0) { withConfig = false; }
+        var stopTelemetryTracker = telemetryTracker.trackEval(withConfig ? constants_1.TREATMENTS_WITH_CONFIG : constants_1.TREATMENTS);
         var wrapUp = function (evaluationResults) {
             var queue = [];
             var treatments = {};
@@ -39,6 +41,7 @@ function clientFactory(params) {
                 treatments[splitName] = processEvaluation(evaluationResults[splitName], splitName, key, attributes, withConfig, "getTreatments" + (withConfig ? 'withConfig' : ''), queue);
             });
             impressionsTracker.track(queue, attributes);
+            stopTelemetryTracker(queue[0] && queue[0].label);
             return treatments;
         };
         var evaluations = (0, evaluator_1.evaluateFeatures)(log, key, splitNames, attributes, storage);
@@ -80,6 +83,7 @@ function clientFactory(params) {
     }
     function track(key, trafficTypeName, eventTypeId, value, properties, size) {
         if (size === void 0) { size = 1024; }
+        var stopTelemetryTracker = telemetryTracker.trackEval(constants_1.TRACK);
         var matchingKey = (0, key_1.getMatching)(key);
         var timestamp = Date.now();
         var eventData = {
@@ -92,7 +96,17 @@ function clientFactory(params) {
         };
         // This may be async but we only warn, we don't actually care if it is valid or not in terms of queueing the event.
         (0, trafficTypeExistance_1.validateTrafficTypeExistance)(log, readinessManager, storage.splits, mode, trafficTypeName, 'track');
-        return eventTracker.track(eventData, size);
+        var result = eventTracker.track(eventData, size);
+        if ((0, thenable_1.thenable)(result)) {
+            return result.then(function (result) {
+                stopTelemetryTracker();
+                return result;
+            });
+        }
+        else {
+            stopTelemetryTracker();
+            return result;
+        }
     }
     return {
         getTreatment: getTreatment,

package/cjs/sdkClient/sdkClient.js

@@ -9,7 +9,7 @@ var clientInputValidation_1 = require("./clientInputValidation");
  * Creates an Sdk client, i.e., a base client with status and destroy interface
  */
 function sdkClientFactory(params, isSharedClient) {
-    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings;
+    var sdkReadinessManager = params.sdkReadinessManager, syncManager = params.syncManager, storage = params.storage, signalListener = params.signalListener, settings = params.settings, telemetryTracker = params.telemetryTracker;
     return (0, objectAssign_1.objectAssign)(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkReadinessManager.sdkStatus), 
@@ -18,6 +18,9 @@ function sdkClientFactory(params, isSharedClient) {
     // Sdk destroy
     {
         destroy: function () {
+            // record stat before flushing data
+            if (!isSharedClient)
+                telemetryTracker.sessionLength();
             // Stop background jobs
             syncManager && syncManager.stop();
             var flush = syncManager ? syncManager.flush() : Promise.resolve();

package/cjs/sdkFactory/index.js

@@ -4,6 +4,7 @@ exports.sdkFactory = void 0;
 var sdkReadinessManager_1 = require("../readiness/sdkReadinessManager");
 var impressionsTracker_1 = require("../trackers/impressionsTracker");
 var eventTracker_1 = require("../trackers/eventTracker");
+var telemetryTracker_1 = require("../trackers/telemetryTracker");
 var key_1 = require("../utils/key");
 var utils_1 = require("../trackers/impressionObserver/utils");
 var apiKey_1 = require("../utils/inputValidation/apiKey");
@@ -18,12 +19,12 @@ var objectAssign_1 = require("../utils/lang/objectAssign");
 function sdkFactory(params) {
     var settings = params.settings, platform = params.platform, storageFactory = params.storageFactory, splitApiFactory = params.splitApiFactory, extraProps = params.extraProps, syncManagerFactory = params.syncManagerFactory, SignalListener = params.SignalListener, impressionsObserverFactory = params.impressionsObserverFactory, integrationsManagerFactory = params.integrationsManagerFactory, sdkManagerFactory = params.sdkManagerFactory, sdkClientMethodFactory = params.sdkClientMethodFactory;
     var log = settings.log;
-    // @TODO handle non-recoverable errors: not start sync, mark the SDK as destroyed, etc.
+    // @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid API Key, etc.
+    // On non-recoverable errors, we should mark the SDK as destroyed and not start synchronization.
     // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
     (0, apiKey_1.validateAndTrackApiKey)(log, settings.core.authorizationKey);
-    // @TODO handle non-recoverable error, such as, `fetch` api not available, invalid API Key, etc.
     var sdkReadinessManager = (0, sdkReadinessManager_1.sdkReadinessManagerFactory)(log, platform.EventEmitter, settings.startup.readyTimeout);
-    var readinessManager = sdkReadinessManager.readinessManager;
+    var readiness = sdkReadinessManager.readinessManager;
     // @TODO consider passing the settings object, so that each storage access only what it needs
     var storageFactoryParams = {
         impressionsQueueSize: settings.scheduler.impressionsQueueSize,
@@ -39,32 +40,28 @@ function sdkFactory(params) {
         onReadyCb: function (error) {
             if (error)
                 return; // Don't emit SDK_READY if storage failed to connect. Error message is logged by wrapperAdapter
-            readinessManager.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
-            readinessManager.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
+            readiness.splits.emit(constants_2.SDK_SPLITS_ARRIVED);
+            readiness.segments.emit(constants_2.SDK_SEGMENTS_ARRIVED);
         },
         metadata: (0, metadataBuilder_1.metadataBuilder)(settings),
         log: log
     };
     var storage = storageFactory(storageFactoryParams);
     // @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
-    // splitApi is used by SyncManager and Browser signal listener
-    var splitApi = splitApiFactory && splitApiFactory(settings, platform);
-    var syncManager = syncManagerFactory && syncManagerFactory({
-        settings: settings,
-        splitApi: splitApi,
-        storage: storage,
-        readiness: sdkReadinessManager.readinessManager,
-        platform: platform
-    });
     var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage });
     // trackers
     var observer = impressionsObserverFactory && impressionsObserverFactory();
-    var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, integrationsManager, observer, storage.impressionCounts);
-    var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager);
-    // signal listener
+    var impressionsTracker = (0, impressionsTracker_1.impressionsTrackerFactory)(settings, storage.impressions, integrationsManager, observer, storage.impressionCounts, storage.telemetry);
+    var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager, storage.telemetry);
+    var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);
+    // splitApi is used by SyncManager and Browser signal listener
+    var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
+    var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
+    var syncManager = syncManagerFactory && syncManagerFactory(ctx);
+    ctx.syncManager = syncManager;
     var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
-    // Sdk client and manager
-    var ctx = { eventTracker: eventTracker, impressionsTracker: impressionsTracker, sdkReadinessManager: sdkReadinessManager, settings: settings, storage: storage, syncManager: syncManager, signalListener: signalListener };
+    ctx.signalListener = signalListener;
+    // SDK client and manager
     var clientMethod = sdkClientMethodFactory(ctx);
     var managerInstance = sdkManagerFactory(log, storage.splits, sdkReadinessManager);
     syncManager && syncManager.start();

package/cjs/services/splitApi.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.splitApiFactory = void 0;
 var splitHttpClient_1 = require("./splitHttpClient");
 var objectAssign_1 = require("../utils/lang/objectAssign");
+var constants_1 = require("../utils/constants");
 var noCacheHeaderOptions = { headers: { 'Cache-Control': 'no-cache' } };
 function userKeyToQueryParam(userKey) {
     return 'users=' + encodeURIComponent(userKey); // no need to check availability of `encodeURIComponent`, since it is a global highly supported.
@@ -13,7 +14,7 @@ function userKeyToQueryParam(userKey) {
  * @param settings validated settings object
  * @param platform object containing environment-specific `getFetch` and `getOptions` dependencies
  */
-function splitApiFactory(settings, platform) {
+function splitApiFactory(settings, platform, telemetryTracker) {
     var urls = settings.urls;
     var filterQueryString = settings.sync.__splitFiltersValidation && settings.sync.__splitFiltersValidation.queryString;
     var SplitSDKImpressionsMode = settings.sync.impressionsMode;
@@ -34,15 +35,15 @@ function splitApiFactory(settings, platform) {
                 if (queryParams) // accounting the possibility that `userKeys` and thus `queryParams` are empty
                     url += '?' + queryParams;
             }
-            return splitHttpClient(url);
+            return splitHttpClient(url, undefined, telemetryTracker.trackHttp(constants_1.TOKEN));
         },
         fetchSplitChanges: function (since, noCache) {
             var url = urls.sdk + "/splitChanges?since=" + since + (filterQueryString || '');
-            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined);
+            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.SPLITS));
         },
         fetchSegmentChanges: function (since, segmentName, noCache) {
             var url = urls.sdk + "/segmentChanges/" + segmentName + "?since=" + since;
-            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined);
+            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.SEGMENT));
         },
         fetchMySegments: function (userMatchingKey, noCache) {
             /**
@@ -52,7 +53,7 @@ function splitApiFactory(settings, platform) {
              *  - match user keys with special characters. E.g.: 'foo%bar', 'foo/bar'
              */
             var url = urls.sdk + "/mySegments/" + encodeURIComponent(userMatchingKey);
-            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined);
+            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.MY_SEGMENT));
         },
         /**
          * Post events.
@@ -62,7 +63,7 @@ function splitApiFactory(settings, platform) {
          */
         postEventsBulk: function (body, headers) {
             var url = urls.events + "/events/bulk";
-            return splitHttpClient(url, { method: 'POST', body: body, headers: headers });
+            return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.EVENTS));
         },
         /**
          * Post impressions.
@@ -77,7 +78,7 @@ function splitApiFactory(settings, platform) {
                 method: 'POST',
                 body: body,
                 headers: (0, objectAssign_1.objectAssign)({ SplitSDKImpressionsMode: SplitSDKImpressionsMode }, headers)
-            });
+            }, telemetryTracker.trackHttp(constants_1.IMPRESSIONS));
         },
         /**
          * Post impressions counts.
@@ -87,15 +88,15 @@ function splitApiFactory(settings, platform) {
          */
         postTestImpressionsCount: function (body, headers) {
             var url = urls.events + "/testImpressions/count";
-            return splitHttpClient(url, { method: 'POST', body: body, headers: headers });
+            return splitHttpClient(url, { method: 'POST', body: body, headers: headers }, telemetryTracker.trackHttp(constants_1.IMPRESSIONS_COUNT));
         },
-        postMetricsCounters: function (body) {
-            var url = urls.events + "/metrics/counters";
-            return splitHttpClient(url, { method: 'POST', body: body }, true);
+        postMetricsConfig: function (body) {
+            var url = urls.telemetry + "/v1/metrics/config";
+            return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(constants_1.TELEMETRY), true);
         },
-        postMetricsTimes: function (body) {
-            var url = urls.events + "/metrics/times";
-            return splitHttpClient(url, { method: 'POST', body: body }, true);
+        postMetricsUsage: function (body) {
+            var url = urls.telemetry + "/v1/metrics/usage";
+            return splitHttpClient(url, { method: 'POST', body: body }, telemetryTracker.trackHttp(constants_1.TELEMETRY), true);
         }
     };
 }

package/cjs/services/splitHttpClient.js

@@ -28,8 +28,9 @@ function splitHttpClientFactory(settings, getFetch, getOptions) {
         headers['SplitSDKMachineIP'] = ip;
     if (hostname)
         headers['SplitSDKMachineName'] = hostname;
-    return function httpClient(url, reqOpts, logErrorsAsInfo) {
+    return function httpClient(url, reqOpts, latencyTracker, logErrorsAsInfo) {
         if (reqOpts === void 0) { reqOpts = {}; }
+        if (latencyTracker === void 0) { latencyTracker = function () { }; }
         if (logErrorsAsInfo === void 0) { logErrorsAsInfo = false; }
         var request = (0, objectAssign_1.objectAssign)({
             headers: reqOpts.headers ? (0, objectAssign_1.objectAssign)({}, headers, reqOpts.headers) : headers,
@@ -43,6 +44,7 @@ function splitHttpClientFactory(settings, getFetch, getOptions) {
             if (!response.ok) {
                 return response.text().then(function (message) { return Promise.reject({ response: response, message: message }); });
             }
+            latencyTracker();
             return response;
         })
             .catch(function (error) {
@@ -68,6 +70,7 @@ function splitHttpClientFactory(settings, getFetch, getOptions) {
             var networkError = new Error(msg);
             // passes `undefined` as statusCode if not an HTTP error (resp === undefined)
             networkError.statusCode = resp && resp.status;
+            latencyTracker(networkError);
             throw networkError;
         }) : Promise.reject(new Error(messageNoFetch));
     };

package/cjs/storages/AbstractSegmentsCacheSync.js

@@ -13,11 +13,6 @@ var AbstractSegmentsCacheSync = /** @class */ (function () {
      * For client-side synchronizer: the method is not used.
      */
     AbstractSegmentsCacheSync.prototype.registerSegments = function (names) { return false; };
-    /**
-     * For server-side synchronizer: get the list of segments in the cache.
-     * For client-side synchronizer: the method is not used.
-     */
-    AbstractSegmentsCacheSync.prototype.getRegisteredSegments = function () { return []; };
     /**
      * For server-side synchronizer: set the change number of `name` segment.
      * For client-side synchronizer: the method is not used.

package/cjs/storages/KeyBuilderSS.js

@@ -3,9 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyBuilderSS = void 0;
 var tslib_1 = require("tslib");
 var KeyBuilder_1 = require("./KeyBuilder");
-// NOT USED
-// const everythingAfterCount = /count\.([^/]+)$/;
-// const latencyMetricNameAndBucket = /latency\.([^/]+)\.bucket\.([0-9]+)$/;
+var methodNames = {
+    t: 'treatment',
+    ts: 'treatments',
+    tc: 'treatmentWithConfig',
+    tcs: 'treatmentsWithConfig',
+    tr: 'track'
+};
 var KeyBuilderSS = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(KeyBuilderSS, _super);
     function KeyBuilderSS(prefix, metadata) {
@@ -17,7 +21,7 @@ var KeyBuilderSS = /** @class */ (function (_super) {
         return this.prefix + ".segments.registered";
     };
     KeyBuilderSS.prototype.buildVersionablePrefix = function () {
-        return this.prefix + "/" + this.metadata.s + "/" + this.metadata.i;
+        return this.metadata.s + "/" + this.metadata.n + "/" + this.metadata.i;
     };
     KeyBuilderSS.prototype.buildImpressionsKey = function () {
         return this.prefix + ".impressions";
@@ -25,23 +29,12 @@ var KeyBuilderSS = /** @class */ (function (_super) {
     KeyBuilderSS.prototype.buildEventsKey = function () {
         return this.prefix + ".events";
     };
-    KeyBuilderSS.prototype.buildLatencyKeyPrefix = function () {
-        return this.buildVersionablePrefix() + "/latency";
+    KeyBuilderSS.prototype.buildLatencyKey = function (method, bucket) {
+        return this.prefix + ".telemetry.latencies::" + this.buildVersionablePrefix() + "/" + methodNames[method] + "/" + bucket;
     };
-    KeyBuilderSS.prototype.buildLatencyKey = function (metricName, bucketNumber) {
-        return this.buildLatencyKeyPrefix() + "." + metricName + ".bucket." + bucketNumber;
+    KeyBuilderSS.prototype.buildExceptionKey = function (method) {
+        return this.prefix + ".telemetry.exceptions::" + this.buildVersionablePrefix() + "/" + methodNames[method];
     };
-    KeyBuilderSS.prototype.buildCountKey = function (metricName) {
-        return this.buildVersionablePrefix() + "/count." + metricName;
-    };
-    // NOT USED
-    // buildGaugeKey(metricName: string) {
-    //   return `${this.buildVersionablePrefix()}/gauge.${metricName}`;
-    // }
-    // NOT USED
-    // searchPatternForCountKeys() {
-    //   return `${this.buildVersionablePrefix()}/count.*`;
-    // }
     KeyBuilderSS.prototype.searchPatternForSplitKeys = function () {
         return this.buildSplitKeyPrefix() + "*";
     };

package/cjs/storages/findLatencyIndex.js

@@ -2,12 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.findLatencyIndex = void 0;
 var lang_1 = require("../utils/lang");
-// @TODO add unit tests
-function findLatencyIndex(latency, min, max, base) {
-    if (min === void 0) { min = 0; }
-    if (max === void 0) { max = 23; }
-    if (base === void 0) { base = 1.5; }
-    var index = Math.min(max, Math.max(min, Math.floor(Math.log(latency) / Math.log(base))));
+var MIN = 0;
+var MAX = 22;
+var BASE = 1.5;
+/**
+ * Calculates buckets from latency in milliseconds
+ *
+ * @param latencyInMs
+ * @returns a bucket index from 0 to 22 inclusive
+ */
+function findLatencyIndex(latencyInMs) {
+    var index = Math.min(MAX, Math.max(MIN, Math.ceil(Math.log(latencyInMs) / Math.log(BASE))));
     return (0, lang_1.isNaNNumber)(index) ? 0 : index; // index is NaN if latency is not a positive number
 }
 exports.findLatencyIndex = findLatencyIndex;

package/cjs/storages/inLocalStorage/MySegmentsCacheInLocal.js

@@ -65,7 +65,7 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
                 accum.push(segmentName);
             }
             else {
-                // @BREAKING: This is only to clean up "old" keys. Remove this whole else code block.
+                // @TODO @BREAKING: This is only to clean up "old" keys. Remove this whole else code block and reuse `getRegisteredSegments` method.
                 segmentName = _this.keys.extractOldSegmentKey(key);
                 if (segmentName) { // this was an old segment key, let's clean up.
                     var newSegmentKey = _this.keys.buildSegmentNameKey(segmentName);
@@ -107,6 +107,18 @@ var MySegmentsCacheInLocal = /** @class */ (function (_super) {
         }
         return isDiff;
     };
+    MySegmentsCacheInLocal.prototype.getRegisteredSegments = function () {
+        var _this = this;
+        return Object.keys(localStorage).reduce(function (accum, key) {
+            var segmentName = _this.keys.extractSegmentName(key);
+            if (segmentName)
+                accum.push(segmentName);
+            return accum;
+        }, []);
+    };
+    MySegmentsCacheInLocal.prototype.getKeysCount = function () {
+        return 1;
+    };
     return MySegmentsCacheInLocal;
 }(AbstractSegmentsCacheSync_1.AbstractSegmentsCacheSync));
 exports.MySegmentsCacheInLocal = MySegmentsCacheInLocal;

package/cjs/storages/inLocalStorage/index.js

@@ -15,6 +15,7 @@ var browser_1 = require("../../utils/constants/browser");
 var InMemoryStorageCS_1 = require("../inMemory/InMemoryStorageCS");
 var constants_1 = require("./constants");
 var constants_2 = require("../../utils/constants");
+var TelemetryCacheInMemory_1 = require("../inMemory/TelemetryCacheInMemory");
 /**
  * InLocal storage factory for standalone client-side SplitFactory
  */
@@ -24,7 +25,7 @@ function InLocalStorage(options) {
     function InLocalStorageCSFactory(params) {
         // Fallback to InMemoryStorage if LocalStorage API is not available
         if (!(0, isLocalStorageAvailable_1.isLocalStorageAvailable)()) {
-            params.log.warn(constants_1.LOG_PREFIX + 'LocalStorage API is unavailable. Fallbacking into default MEMORY storage');
+            params.log.warn(constants_1.LOG_PREFIX + 'LocalStorage API is unavailable. Falling back to default MEMORY storage');
             return (0, InMemoryStorageCS_1.InMemoryStorageCSFactory)(params);
         }
         var log = params.log;
@@ -36,6 +37,7 @@ function InLocalStorage(options) {
             impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(params.impressionsQueueSize),
             impressionCounts: params.optimize ? new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() : undefined,
             events: new EventsCacheInMemory_1.EventsCacheInMemory(params.eventsQueueSize),
+            telemetry: params.mode !== constants_2.LOCALHOST_MODE && (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)() ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory() : undefined,
             destroy: function () {
                 this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory();
                 this.segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
@@ -52,6 +54,7 @@ function InLocalStorage(options) {
                     impressions: this.impressions,
                     impressionCounts: this.impressionCounts,
                     events: this.events,
+                    telemetry: this.telemetry,
                     destroy: function () {
                         this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory();
                         this.segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();

package/cjs/storages/inMemory/InMemoryStorage.js

@@ -7,6 +7,7 @@ var ImpressionsCacheInMemory_1 = require("./ImpressionsCacheInMemory");
 var EventsCacheInMemory_1 = require("./EventsCacheInMemory");
 var ImpressionCountsCacheInMemory_1 = require("./ImpressionCountsCacheInMemory");
 var constants_1 = require("../../utils/constants");
+var TelemetryCacheInMemory_1 = require("./TelemetryCacheInMemory");
 /**
  * InMemory storage factory for standalone server-side SplitFactory
  *
@@ -19,6 +20,7 @@ function InMemoryStorageFactory(params) {
         impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(params.impressionsQueueSize),
         impressionCounts: params.optimize ? new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() : undefined,
         events: new EventsCacheInMemory_1.EventsCacheInMemory(params.eventsQueueSize),
+        telemetry: params.mode !== constants_1.LOCALHOST_MODE ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory() : undefined,
         // When using MEMORY we should clean all the caches to leave them empty
         destroy: function () {
             this.splits.clear();

package/cjs/storages/inMemory/InMemoryStorageCS.js

@@ -7,6 +7,7 @@ var ImpressionsCacheInMemory_1 = require("./ImpressionsCacheInMemory");
 var EventsCacheInMemory_1 = require("./EventsCacheInMemory");
 var ImpressionCountsCacheInMemory_1 = require("./ImpressionCountsCacheInMemory");
 var constants_1 = require("../../utils/constants");
+var TelemetryCacheInMemory_1 = require("./TelemetryCacheInMemory");
 /**
  * InMemory storage factory for standalone client-side SplitFactory
  *
@@ -19,6 +20,7 @@ function InMemoryStorageCSFactory(params) {
         impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(params.impressionsQueueSize),
         impressionCounts: params.optimize ? new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory() : undefined,
         events: new EventsCacheInMemory_1.EventsCacheInMemory(params.eventsQueueSize),
+        telemetry: params.mode !== constants_1.LOCALHOST_MODE && (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)() ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory() : undefined,
         // When using MEMORY we should clean all the caches to leave them empty
         destroy: function () {
             this.splits.clear();
@@ -35,6 +37,7 @@ function InMemoryStorageCSFactory(params) {
                 impressions: this.impressions,
                 impressionCounts: this.impressionCounts,
                 events: this.events,
+                telemetry: this.telemetry,
                 // Set a new splits cache to clean it for the client without affecting other clients
                 destroy: function () {
                     this.splits = new SplitsCacheInMemory_1.SplitsCacheInMemory();

package/cjs/storages/inMemory/MySegmentsCacheInMemory.js

@@ -66,6 +66,12 @@ var MySegmentsCacheInMemory = /** @class */ (function (_super) {
         }
         return isDiff;
     };
+    MySegmentsCacheInMemory.prototype.getRegisteredSegments = function () {
+        return Object.keys(this.segmentCache);
+    };
+    MySegmentsCacheInMemory.prototype.getKeysCount = function () {
+        return 1;
+    };
     return MySegmentsCacheInMemory;
 }(AbstractSegmentsCacheSync_1.AbstractSegmentsCacheSync));
 exports.MySegmentsCacheInMemory = MySegmentsCacheInMemory;

package/cjs/storages/inMemory/SegmentsCacheInMemory.js

@@ -57,6 +57,12 @@ var SegmentsCacheInMemory = /** @class */ (function (_super) {
     SegmentsCacheInMemory.prototype.getRegisteredSegments = function () {
         return Object.keys(this.segmentCache);
     };
+    SegmentsCacheInMemory.prototype.getKeysCount = function () {
+        var _this = this;
+        return Object.keys(this.segmentCache).reduce(function (acum, segmentName) {
+            return acum + _this.segmentCache[segmentName].size;
+        }, 0);
+    };
     SegmentsCacheInMemory.prototype.setChangeNumber = function (name, changeNumber) {
         this.segmentChangeNumber[name] = changeNumber;
         return true;