@splitsoftware/splitio-commons 1.8.2-rc.0 → 1.8.2-rc.2

package/esm/sdkClient/clientInputValidation.js

@@ -13,10 +13,10 @@ export function clientInputValidationDecorator(settings, client, readinessManage
     /**
      * Avoid repeating this validations code
      */
-    function validateEvaluationParams(maybeKey, maybeSplitOrSplits, maybeAttributes, methodName) {
+    function validateEvaluationParams(maybeKey, maybeFeatureFlagNameOrNames, maybeAttributes, methodName) {
         var multi = startsWith(methodName, 'getTreatments');
         var key = validateKey(log, maybeKey, methodName);
-        var splitOrSplits = multi ? validateSplits(log, maybeSplitOrSplits, methodName) : validateSplit(log, maybeSplitOrSplits, methodName);
+        var splitOrSplits = multi ? validateSplits(log, maybeFeatureFlagNameOrNames, methodName) : validateSplit(log, maybeFeatureFlagNameOrNames, methodName);
         var attributes = validateAttributes(log, maybeAttributes, methodName);
         var isOperational = validateIfNotDestroyed(log, readinessManager, methodName);
         validateIfOperational(log, readinessManager, methodName);
@@ -31,8 +31,8 @@ export function clientInputValidationDecorator(settings, client, readinessManage
     function wrapResult(value) {
         return isSync ? value : Promise.resolve(value);
     }
-    function getTreatment(maybeKey, maybeSplit, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, maybeSplit, maybeAttributes, 'getTreatment');
+    function getTreatment(maybeKey, maybeFeatureFlagName, maybeAttributes) {
+        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagName, maybeAttributes, 'getTreatment');
         if (params.valid) {
             return client.getTreatment(params.key, params.splitOrSplits, params.attributes);
         }
@@ -40,8 +40,8 @@ export function clientInputValidationDecorator(settings, client, readinessManage
             return wrapResult(CONTROL);
         }
     }
-    function getTreatmentWithConfig(maybeKey, maybeSplit, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, maybeSplit, maybeAttributes, 'getTreatmentWithConfig');
+    function getTreatmentWithConfig(maybeKey, maybeFeatureFlagName, maybeAttributes) {
+        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagName, maybeAttributes, 'getTreatmentWithConfig');
         if (params.valid) {
             return client.getTreatmentWithConfig(params.key, params.splitOrSplits, params.attributes);
         }
@@ -49,8 +49,8 @@ export function clientInputValidationDecorator(settings, client, readinessManage
             return wrapResult(objectAssign({}, CONTROL_WITH_CONFIG));
         }
     }
-    function getTreatments(maybeKey, maybeSplits, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, maybeSplits, maybeAttributes, 'getTreatments');
+    function getTreatments(maybeKey, maybeFeatureFlagNames, maybeAttributes) {
+        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagNames, maybeAttributes, 'getTreatments');
         if (params.valid) {
             return client.getTreatments(params.key, params.splitOrSplits, params.attributes);
         }
@@ -61,8 +61,8 @@ export function clientInputValidationDecorator(settings, client, readinessManage
             return wrapResult(res_1);
         }
     }
-    function getTreatmentsWithConfig(maybeKey, maybeSplits, maybeAttributes) {
-        var params = validateEvaluationParams(maybeKey, maybeSplits, maybeAttributes, 'getTreatmentsWithConfig');
+    function getTreatmentsWithConfig(maybeKey, maybeFeatureFlagNames, maybeAttributes) {
+        var params = validateEvaluationParams(maybeKey, maybeFeatureFlagNames, maybeAttributes, 'getTreatmentsWithConfig');
         if (params.valid) {
             return client.getTreatmentsWithConfig(params.key, params.splitOrSplits, params.attributes);
         }

package/esm/sdkClient/sdkClient.js

@@ -49,7 +49,7 @@ export function sdkClientFactory(params, isSharedClient) {
                 // Cleanup event listeners
                 sdkReadinessManager.readinessManager.destroy();
                 signalListener && signalListener.stop();
-                // Release the API Key if it is the main client
+                // Release the SDK Key if it is the main client
                 if (!isSharedClient)
                     releaseApiKey(settings.core.authorizationKey);
                 if (uniqueKeysTracker)

package/esm/sdkFactory/index.js

@@ -18,7 +18,7 @@ import { NONE, OPTIMIZED } from '../utils/constants';
 export 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, filterAdapterFactory = params.filterAdapterFactory;
     var log = settings.log, impressionsMode = settings.sync.impressionsMode;
-    // @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid API Key, etc.
+    // @TODO handle non-recoverable errors, such as, global `fetch` not available, invalid SDK 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.
     validateAndTrackApiKey(log, settings.core.authorizationKey);

package/esm/sdkManager/index.js

@@ -2,6 +2,9 @@ import { objectAssign } from '../utils/lang/objectAssign';
 import { thenable } from '../utils/promise/thenable';
 import { find } from '../utils/lang';
 import { validateSplit, validateSplitExistance, validateIfNotDestroyed, validateIfOperational } from '../utils/inputValidation';
+var SPLIT_FN_LABEL = 'split';
+var SPLITS_FN_LABEL = 'splits';
+var NAMES_FN_LABEL = 'names';
 function collectTreatments(splitObject) {
     var conditions = splitObject.conditions;
     // Rollout conditions are supposed to have the entire partitions list, so we find the first one.
@@ -35,15 +38,14 @@ function objectsToViews(splitObjects) {
 }
 export function sdkManagerFactory(log, splits, _a) {
     var readinessManager = _a.readinessManager, sdkStatus = _a.sdkStatus;
-    var SPLIT_FN_LABEL = 'split';
     return objectAssign(
     // Proto-linkage of the readiness Event Emitter
     Object.create(sdkStatus), {
         /**
-         * Get the Split object corresponding to the given split name if valid
+         * Get the feature flag object corresponding to the given feature flag name if valid
          */
-        split: function (maybeSplitName) {
-            var splitName = validateSplit(log, maybeSplitName, SPLIT_FN_LABEL);
+        split: function (featureFlagName) {
+            var splitName = validateSplit(log, featureFlagName, SPLIT_FN_LABEL);
             if (!validateIfNotDestroyed(log, readinessManager, SPLIT_FN_LABEL) || !validateIfOperational(log, readinessManager, SPLIT_FN_LABEL) || !splitName) {
                 return null;
             }
@@ -58,10 +60,10 @@ export function sdkManagerFactory(log, splits, _a) {
             return objectToView(split);
         },
         /**
-         * Get the Split objects present on the factory storage
+         * Get the feature flag objects present on the factory storage
          */
         splits: function () {
-            if (!validateIfNotDestroyed(log, readinessManager, 'splits') || !validateIfOperational(log, readinessManager, 'splits')) {
+            if (!validateIfNotDestroyed(log, readinessManager, SPLITS_FN_LABEL) || !validateIfOperational(log, readinessManager, SPLITS_FN_LABEL)) {
                 return [];
             }
             var currentSplits = splits.getAll();
@@ -70,10 +72,10 @@ export function sdkManagerFactory(log, splits, _a) {
                 objectsToViews(currentSplits);
         },
         /**
-         * Get the Split names present on the factory storage
+         * Get the feature flag names present on the factory storage
          */
         names: function () {
-            if (!validateIfNotDestroyed(log, readinessManager, 'names') || !validateIfOperational(log, readinessManager, 'names')) {
+            if (!validateIfNotDestroyed(log, readinessManager, NAMES_FN_LABEL) || !validateIfOperational(log, readinessManager, NAMES_FN_LABEL)) {
                 return [];
             }
             var splitNames = splits.getSplitNames();

package/esm/services/splitApi.js

@@ -17,6 +17,7 @@ export function splitApiFactory(settings, platform, telemetryTracker) {
     var SplitSDKImpressionsMode = settings.sync.impressionsMode;
     var splitHttpClient = splitHttpClientFactory(settings, platform.getFetch, platform.getOptions);
     return {
+        // @TODO throw errors if health check requests fail, to log them in the Synchronizer
         getSdkAPIHealthCheck: function () {
             var url = urls.sdk + "/version";
             return splitHttpClient(url).then(function () { return true; }).catch(function () { return false; });

package/esm/services/splitHttpClient.js

@@ -50,7 +50,7 @@ export function splitHttpClientFactory(settings, getFetch, getOptions) {
             if (resp) { // An HTTP error
                 switch (resp.status) {
                     case 404:
-                        msg = 'Invalid API key or resource not found.';
+                        msg = 'Invalid SDK key or resource not found.';
                         break;
                     // Don't use resp.statusText since reason phrase is removed in HTTP/2
                     default:

package/esm/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -34,10 +34,8 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     SplitsCacheInLocal.prototype._decrementCounts = function (split) {
         try {
             if (split) {
-                if (split.trafficTypeName) {
-                    var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-                    this._decrementCount(ttKey);
-                }
+                var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
+                this._decrementCount(ttKey);
                 if (usesSegments(split)) {
                     var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
                     this._decrementCount(segmentsCountKey);
@@ -51,11 +49,9 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     SplitsCacheInLocal.prototype._incrementCounts = function (split) {
         try {
             if (split) {
-                if (split.trafficTypeName) {
-                    var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-                    // @ts-expect-error
-                    localStorage.setItem(ttKey, toNumber(localStorage.getItem(ttKey)) + 1);
-                }
+                var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
+                // @ts-expect-error
+                localStorage.setItem(ttKey, toNumber(localStorage.getItem(ttKey)) + 1);
                 if (usesSegments(split)) {
                     var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
                     // @ts-expect-error
@@ -92,9 +88,9 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             var splitKey = this.keys.buildSplitKey(name);
             var splitFromLocalStorage = localStorage.getItem(splitKey);
             var previousSplit = splitFromLocalStorage ? JSON.parse(splitFromLocalStorage) : null;
-            this._decrementCounts(previousSplit);
             localStorage.setItem(splitKey, JSON.stringify(split));
             this._incrementCounts(split);
+            this._decrementCounts(previousSplit);
             return true;
         }
         catch (e) {

package/esm/storages/inMemory/SplitsCacheInMemory.js

@@ -24,12 +24,10 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
     SplitsCacheInMemory.prototype.addSplit = function (name, split) {
         var previousSplit = this.getSplit(name);
         if (previousSplit) { // We had this Split already
-            if (previousSplit.trafficTypeName) {
-                var previousTtName = previousSplit.trafficTypeName;
-                this.ttCache[previousTtName]--;
-                if (!this.ttCache[previousTtName])
-                    delete this.ttCache[previousTtName];
-            }
+            var previousTtName = previousSplit.trafficTypeName;
+            this.ttCache[previousTtName]--;
+            if (!this.ttCache[previousTtName])
+                delete this.ttCache[previousTtName];
             if (usesSegments(previousSplit)) { // Substract from segments count for the previous version of this Split.
                 this.splitsWithSegmentsCount--;
             }
@@ -39,11 +37,7 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
             this.splitsCache[name] = split;
             // Update TT cache
             var ttName = split.trafficTypeName;
-            if (ttName) { // safeguard
-                if (!this.ttCache[ttName])
-                    this.ttCache[ttName] = 0;
-                this.ttCache[ttName]++;
-            }
+            this.ttCache[ttName] = (this.ttCache[ttName] || 0) + 1;
             // Add to segments count for the new version of the Split
             if (usesSegments(split))
                 this.splitsWithSegmentsCount++;
@@ -59,11 +53,9 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
             // Delete the Split
             delete this.splitsCache[name];
             var ttName = split.trafficTypeName;
-            if (ttName) { // safeguard
-                this.ttCache[ttName]--; // Update tt cache
-                if (!this.ttCache[ttName])
-                    delete this.ttCache[ttName];
-            }
+            this.ttCache[ttName]--; // Update tt cache
+            if (!this.ttCache[ttName])
+                delete this.ttCache[ttName];
             // Update the segments count.
             if (usesSegments(split))
                 this.splitsWithSegmentsCount--;

package/esm/storages/inRedis/SplitsCacheInRedis.js

@@ -35,19 +35,15 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
     }
     SplitsCacheInRedis.prototype._decrementCounts = function (split) {
         var _this = this;
-        if (split.trafficTypeName) {
-            var ttKey_1 = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-            return this.redis.decr(ttKey_1).then(function (count) {
-                if (count === 0)
-                    return _this.redis.del(ttKey_1);
-            });
-        }
+        var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
+        return this.redis.decr(ttKey).then(function (count) {
+            if (count === 0)
+                return _this.redis.del(ttKey);
+        });
     };
     SplitsCacheInRedis.prototype._incrementCounts = function (split) {
-        if (split.trafficTypeName) {
-            var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-            return this.redis.incr(ttKey);
-        }
+        var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
+        return this.redis.incr(ttKey);
     };
     /**
      * Add a given split.
@@ -65,18 +61,19 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
                 newStringifiedSplit = JSON.stringify(split);
             }
             catch (e) {
-                throw new Error('Error parsing split definition: ' + e);
+                throw new Error('Error parsing feature flag definition: ' + e);
             }
-            return Promise.all([
-                _this.redis.set(splitKey, newStringifiedSplit),
-                _this._incrementCounts(split),
-                // If it's an update, we decrement the traffic type of the existing split,
-                parsedPreviousSplit && _this._decrementCounts(parsedPreviousSplit)
-            ]);
-        }).then(function (_a) {
-            var status = _a[0];
-            return status === 'OK';
-        });
+            return _this.redis.set(splitKey, newStringifiedSplit).then(function () {
+                // avoid unnecessary increment/decrement operations
+                if (parsedPreviousSplit && parsedPreviousSplit.trafficTypeName === split.trafficTypeName)
+                    return;
+                // update traffic type counts
+                return _this._incrementCounts(split).then(function () {
+                    if (parsedPreviousSplit)
+                        return _this._decrementCounts(parsedPreviousSplit);
+                });
+            });
+        }).then(function () { return true; });
     };
     /**
      * Add a list of splits.
@@ -226,7 +223,7 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
             return Promise.resolve(splits);
         })
             .catch(function (e) {
-            _this.log.error(LOG_PREFIX + ("Could not grab splits due to an error: " + e + "."));
+            _this.log.error(LOG_PREFIX + ("Could not grab feature flags due to an error: " + e + "."));
             return Promise.reject(e);
         });
     };

package/esm/storages/pluggable/SplitsCachePluggable.js

@@ -22,19 +22,15 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
     }
     SplitsCachePluggable.prototype._decrementCounts = function (split) {
         var _this = this;
-        if (split.trafficTypeName) {
-            var ttKey_1 = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-            return this.wrapper.decr(ttKey_1).then(function (count) {
-                if (count === 0)
-                    return _this.wrapper.del(ttKey_1);
-            });
-        }
+        var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
+        return this.wrapper.decr(ttKey).then(function (count) {
+            if (count === 0)
+                return _this.wrapper.del(ttKey);
+        });
     };
     SplitsCachePluggable.prototype._incrementCounts = function (split) {
-        if (split.trafficTypeName) {
-            var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-            return this.wrapper.incr(ttKey);
-        }
+        var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
+        return this.wrapper.incr(ttKey);
     };
     /**
      * Add a given split.
@@ -52,14 +48,18 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
                 stringifiedNewSplit = JSON.stringify(split);
             }
             catch (e) {
-                throw new Error('Error parsing split definition: ' + e);
+                throw new Error('Error parsing feature flag definition: ' + e);
             }
-            return Promise.all([
-                _this.wrapper.set(splitKey, stringifiedNewSplit),
-                _this._incrementCounts(split),
-                // If it's an update, we decrement the traffic type and segment count of the existing split,
-                parsedPreviousSplit && _this._decrementCounts(parsedPreviousSplit)
-            ]);
+            return _this.wrapper.set(splitKey, stringifiedNewSplit).then(function () {
+                // avoid unnecessary increment/decrement operations
+                if (parsedPreviousSplit && parsedPreviousSplit.trafficTypeName === split.trafficTypeName)
+                    return;
+                // update traffic type counts
+                return _this._incrementCounts(split).then(function () {
+                    if (parsedPreviousSplit)
+                        return _this._decrementCounts(parsedPreviousSplit);
+                });
+            });
         }).then(function () { return true; });
     };
     /**

package/esm/sync/polling/updaters/segmentChangesUpdater.js

@@ -81,7 +81,7 @@ export function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segment
                 // @TODO although factory status is destroyed, synchronization is not stopped
                 if (readiness)
                     readiness.destroy();
-                log.error(LOG_PREFIX_INSTANTIATION + ": you passed a client-side type authorizationKey, please grab an Api Key from the Split web console that is of type Server-side.");
+                log.error(LOG_PREFIX_INSTANTIATION + ": you passed a client-side type authorizationKey, please grab an SDK Key from the Split user interface that is of type server-side.");
             }
             else {
                 log.warn(LOG_PREFIX_SYNC_SEGMENTS + "Error while doing fetch of segments. " + error);

package/esm/sync/polling/updaters/splitChangesUpdater.js

@@ -2,7 +2,6 @@ import { _Set, setToArray } from '../../../utils/lang/sets';
 import { timeout } from '../../../utils/promise/timeout';
 import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED } from '../../../readiness/constants';
 import { SYNC_SPLITS_FETCH, SYNC_SPLITS_NEW, SYNC_SPLITS_REMOVED, SYNC_SPLITS_SEGMENTS, SYNC_SPLITS_FETCH_FAILS, SYNC_SPLITS_FETCH_RETRY } from '../../../logger/constants';
-import { _Map } from '../../../utils/lang/maps';
 // Checks that all registered segments have been fetched (changeNumber !== -1 for every segment).
 // Returns a promise that could be rejected.
 // @TODO review together with Segments and MySegments storage APIs
@@ -35,25 +34,19 @@ export function parseSegments(_a) {
  * Exported for testing purposes.
  */
 export function computeSplitsMutation(entries) {
-    var uniqueEntries = new _Map();
-    entries.forEach(function (split) {
-        var prevSplit = uniqueEntries.get(split.name);
-        if (!prevSplit || prevSplit.changeNumber < split.changeNumber)
-            uniqueEntries.set(split.name, split);
-    });
     var segments = new _Set();
-    var computed = { added: [], removed: [], segments: [] };
-    uniqueEntries.forEach(function (split) {
+    var computed = entries.reduce(function (accum, split) {
         if (split.status === 'ACTIVE') {
-            computed.added.push([split.name, split]);
+            accum.added.push([split.name, split]);
             parseSegments(split).forEach(function (segmentName) {
                 segments.add(segmentName);
             });
         }
         else {
-            computed.removed.push(split.name);
+            accum.removed.push(split.name);
         }
-    });
+        return accum;
+    }, { added: [], removed: [], segments: [] });
     computed.segments = setToArray(segments);
     return computed;
 }

package/esm/sync/streaming/pushManager.js

@@ -110,7 +110,7 @@ export function pushManagerFactory(params, pollingManager) {
             if (disconnected)
                 return;
             log.error(ERROR_STREAMING_AUTH, [error.message]);
-            // Handle 4XX HTTP errors: 401 (invalid API Key) or 400 (using incorrect API Key, i.e., client-side API Key on server-side)
+            // Handle 4XX HTTP errors: 401 (invalid SDK Key) or 400 (using incorrect SDK Key, i.e., client-side SDK Key on server-side)
             if (error.statusCode >= 400 && error.statusCode < 500) {
                 telemetryTracker.streamingEvent(AUTH_REJECTION);
                 pushEmitter.emit(PUSH_NONRETRYABLE_ERROR);

package/esm/sync/submitters/telemetrySubmitter.js

@@ -25,8 +25,8 @@ function getActiveFactories() {
     return Object.keys(usedKeysMap).length;
 }
 function getRedundantActiveFactories() {
-    return Object.keys(usedKeysMap).reduce(function (acum, apiKey) {
-        return acum + usedKeysMap[apiKey] - 1;
+    return Object.keys(usedKeysMap).reduce(function (acum, sdkKey) {
+        return acum + usedKeysMap[sdkKey] - 1;
     }, 0);
 }
 export function getTelemetryConfigStats(mode, storageType) {

package/esm/utils/inputValidation/apiKey.js

@@ -1,47 +1,48 @@
-import { ERROR_NULL, ERROR_EMPTY, ERROR_INVALID, WARN_API_KEY, LOG_PREFIX_INSTANTIATION } from '../../logger/constants';
+import { ERROR_NULL, ERROR_EMPTY, ERROR_INVALID, WARN_SDK_KEY, LOG_PREFIX_INSTANTIATION } from '../../logger/constants';
 import { isString } from '../lang';
-var item = 'api_key';
-/** validates the given api key */
-export function validateApiKey(log, maybeApiKey) {
-    var apiKey = false;
-    if (maybeApiKey == undefined) { // eslint-disable-line eqeqeq
+var item = 'sdk_key';
+// @TODO replace ApiKey with SdkKey in function names
+/** validates the given SDK key */
+export function validateApiKey(log, maybeSdkKey) {
+    var sdkKey = false;
+    if (maybeSdkKey == undefined) { // eslint-disable-line eqeqeq
         log.error(ERROR_NULL, [LOG_PREFIX_INSTANTIATION, item]);
     }
-    else if (isString(maybeApiKey)) {
-        if (maybeApiKey.length > 0)
-            apiKey = maybeApiKey;
+    else if (isString(maybeSdkKey)) {
+        if (maybeSdkKey.length > 0)
+            sdkKey = maybeSdkKey;
         else
             log.error(ERROR_EMPTY, [LOG_PREFIX_INSTANTIATION, item]);
     }
     else {
         log.error(ERROR_INVALID, [LOG_PREFIX_INSTANTIATION, item]);
     }
-    return apiKey;
+    return sdkKey;
 }
 // Exported for telemetry
 export var usedKeysMap = {};
-/** validates the given api key and also warns if it is in use */
-export function validateAndTrackApiKey(log, maybeApiKey) {
-    var apiKey = validateApiKey(log, maybeApiKey);
-    // If the apiKey is correct, we'll save it as the instance creation should work.
-    if (apiKey) {
-        if (!usedKeysMap[apiKey]) {
+/** validates the given SDK key and also warns if it is in use */
+export function validateAndTrackApiKey(log, maybeSdkKey) {
+    var sdkKey = validateApiKey(log, maybeSdkKey);
+    // If sdkKey is correct, we'll save it as the instance creation should work.
+    if (sdkKey) {
+        if (!usedKeysMap[sdkKey]) {
             // If this key is not present, only warning scenarios is that we have factories for other keys.
-            usedKeysMap[apiKey] = 1;
+            usedKeysMap[sdkKey] = 1;
             if (Object.keys(usedKeysMap).length > 1) {
-                log.warn(WARN_API_KEY, ['an instance of the Split factory']);
+                log.warn(WARN_SDK_KEY, ['an instance of the Split factory']);
             }
         }
         else {
-            log.warn(WARN_API_KEY, [usedKeysMap[apiKey] + " factory/ies with this API Key"]);
-            usedKeysMap[apiKey]++;
+            log.warn(WARN_SDK_KEY, [usedKeysMap[sdkKey] + " factory/ies with this SDK Key"]);
+            usedKeysMap[sdkKey]++;
         }
     }
-    return apiKey;
+    return sdkKey;
 }
-export function releaseApiKey(apiKey) {
-    if (usedKeysMap[apiKey])
-        usedKeysMap[apiKey]--;
-    if (usedKeysMap[apiKey] === 0)
-        delete usedKeysMap[apiKey];
+export function releaseApiKey(sdkKey) {
+    if (usedKeysMap[sdkKey])
+        usedKeysMap[sdkKey]--;
+    if (usedKeysMap[sdkKey] === 0)
+        delete usedKeysMap[sdkKey];
 }

package/esm/utils/inputValidation/preloadedData.js

@@ -10,12 +10,12 @@ function validateSplitsData(log, maybeSplitsData, method) {
     if (isObject(maybeSplitsData)) {
         var splitNames = Object.keys(maybeSplitsData);
         if (splitNames.length === 0)
-            log.warn(method + ": preloadedData.splitsData doesn't contain split definitions.");
+            log.warn(method + ": preloadedData.splitsData doesn't contain feature flag definitions.");
         // @TODO in the future, consider handling the possibility of having parsed definitions of splits
         if (splitNames.every(function (splitName) { return validateSplit(log, splitName, method) && isString(maybeSplitsData[splitName]); }))
             return true;
     }
-    log.error(method + ": preloadedData.splitsData must be a map of split names to their serialized definitions.");
+    log.error(method + ": preloadedData.splitsData must be a map of feature flag names to their stringified definitions.");
     return false;
 }
 function validateMySegmentsData(log, maybeMySegmentsData, method) {
@@ -37,7 +37,7 @@ function validateSegmentsData(log, maybeSegmentsData, method) {
         if (segmentNames.every(function (segmentName) { return isString(maybeSegmentsData[segmentName]); }))
             return true;
     }
-    log.error(method + ": preloadedData.segmentsData must be a map of segment names to their serialized definitions.");
+    log.error(method + ": preloadedData.segmentsData must be a map of segment names to their stringified definitions.");
     return false;
 }
 export function validatePreloadedData(log, maybePreloadedData, method) {

package/esm/utils/inputValidation/split.js

@@ -3,7 +3,7 @@ import { isString } from '../lang';
 // include BOM and nbsp
 var TRIMMABLE_SPACES_REGEX = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/;
 export function validateSplit(log, maybeSplit, method, item) {
-    if (item === void 0) { item = 'split name'; }
+    if (item === void 0) { item = 'feature flag name'; }
     if (maybeSplit == undefined) { // eslint-disable-line eqeqeq
         log.error(ERROR_NULL, [method, item]);
     }

package/esm/utils/inputValidation/splits.js

@@ -2,8 +2,8 @@ import { ERROR_EMPTY_ARRAY } from '../../logger/constants';
 import { uniq } from '../lang';
 import { validateSplit } from './split';
 export function validateSplits(log, maybeSplits, method, listName, item) {
-    if (listName === void 0) { listName = 'split_names'; }
-    if (item === void 0) { item = 'split name'; }
+    if (listName === void 0) { listName = 'feature flag names'; }
+    if (item === void 0) { item = 'feature flag name'; }
     if (Array.isArray(maybeSplits) && maybeSplits.length > 0) {
         var validatedArray_1 = [];
         // Remove invalid values

package/esm/utils/settingsValidation/index.js

@@ -81,7 +81,7 @@ function fromSecondsToMillis(n) {
 }
 /**
  * Validates the given config and use it to build a settings object.
- * NOTE: it doesn't validate the Api Key. Call `validateApikey` or `validateAndTrackApiKey` for that after settings validation.
+ * NOTE: it doesn't validate the SDK Key. Call `validateApiKey` or `validateAndTrackApiKey` for that after settings validation.
  *
  * @param config user defined configuration
  * @param validationParams defaults and fields validators used to validate and creates a settings object from a given config

package/package.json

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

package/src/logger/constants.ts

@@ -94,7 +94,7 @@ export const WARN_INTEGRATION_INVALID = 218;
 export const WARN_SPLITS_FILTER_IGNORED = 219;
 export const WARN_SPLITS_FILTER_INVALID = 220;
 export const WARN_SPLITS_FILTER_EMPTY = 221;
-export const WARN_API_KEY = 222;
+export const WARN_SDK_KEY = 222;
 export const STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
 
 export const ERROR_ENGINE_COMBINER_IFELSEIF = 300;
@@ -136,7 +136,7 @@ export const LOG_PREFIX_SYNC = 'sync';
 export const LOG_PREFIX_SYNC_MANAGER = LOG_PREFIX_SYNC + ':sync-manager: ';
 export const LOG_PREFIX_SYNC_OFFLINE = LOG_PREFIX_SYNC + ':offline: ';
 export const LOG_PREFIX_SYNC_STREAMING = LOG_PREFIX_SYNC + ':streaming: ';
-export const LOG_PREFIX_SYNC_SPLITS = LOG_PREFIX_SYNC + ':split-changes: ';
+export const LOG_PREFIX_SYNC_SPLITS = LOG_PREFIX_SYNC + ':featureflag-changes: ';
 export const LOG_PREFIX_SYNC_SEGMENTS = LOG_PREFIX_SYNC + ':segment-changes: ';
 export const LOG_PREFIX_SYNC_MYSEGMENTS = LOG_PREFIX_SYNC + ':my-segments: ';
 export const LOG_PREFIX_SYNC_POLLING = LOG_PREFIX_SYNC + ':polling-manager: ';

package/src/logger/messages/debug.ts

@@ -13,8 +13,8 @@ export const codesDebug: [number, string][] = codesInfo.concat([
   [c.ENGINE_MATCHER_CONTAINS_ALL, c.LOG_PREFIX_ENGINE_MATCHER + '[containsAllMatcher] %s contains all elements of %s? %s'],
   [c.ENGINE_MATCHER_CONTAINS_ANY, c.LOG_PREFIX_ENGINE_MATCHER + '[containsAnyMatcher] %s contains at least an element of %s? %s'],
   [c.ENGINE_MATCHER_CONTAINS_STRING, c.LOG_PREFIX_ENGINE_MATCHER + '[containsStringMatcher] %s contains %s? %s'],
-  [c.ENGINE_MATCHER_DEPENDENCY, c.LOG_PREFIX_ENGINE_MATCHER + '[dependencyMatcher] parent split "%s" evaluated to "%s" with label "%s". %s evaluated treatment is part of [%s] ? %s.'],
-  [c.ENGINE_MATCHER_DEPENDENCY_PRE, c.LOG_PREFIX_ENGINE_MATCHER + '[dependencyMatcher] will evaluate parent split: "%s" with key: %s %s'],
+  [c.ENGINE_MATCHER_DEPENDENCY, c.LOG_PREFIX_ENGINE_MATCHER + '[dependencyMatcher] parent feature flag "%s" evaluated to "%s" with label "%s". %s evaluated treatment is part of [%s] ? %s.'],
+  [c.ENGINE_MATCHER_DEPENDENCY_PRE, c.LOG_PREFIX_ENGINE_MATCHER + '[dependencyMatcher] will evaluate parent feature flag: "%s" with key: %s %s'],
   [c.ENGINE_MATCHER_EQUAL, c.LOG_PREFIX_ENGINE_MATCHER + '[equalToMatcher] is %s equal to %s? %s'],
   [c.ENGINE_MATCHER_EQUAL_TO_SET, c.LOG_PREFIX_ENGINE_MATCHER + '[equalToSetMatcher] is %s equal to set %s? %s'],
   [c.ENGINE_MATCHER_ENDS_WITH, c.LOG_PREFIX_ENGINE_MATCHER + '[endsWithMatcher] %s ends with %s? %s'],
@@ -35,15 +35,15 @@ export const codesDebug: [number, string][] = codesInfo.concat([
   [c.RETRIEVE_CLIENT_EXISTING, 'Retrieving existing SDK client.'],
   [c.RETRIEVE_MANAGER, 'Retrieving manager instance.'],
   // synchronizer
-  [c.SYNC_OFFLINE_DATA, c.LOG_PREFIX_SYNC_OFFLINE + 'Splits data: \n%s'],
-  [c.SYNC_SPLITS_FETCH, c.LOG_PREFIX_SYNC_SPLITS + 'Spin up split update using since = %s'],
-  [c.SYNC_SPLITS_NEW, c.LOG_PREFIX_SYNC_SPLITS + 'New splits %s'],
-  [c.SYNC_SPLITS_REMOVED, c.LOG_PREFIX_SYNC_SPLITS + 'Removed splits %s'],
+  [c.SYNC_OFFLINE_DATA, c.LOG_PREFIX_SYNC_OFFLINE + 'Feature flags data: \n%s'],
+  [c.SYNC_SPLITS_FETCH, c.LOG_PREFIX_SYNC_SPLITS + 'Spin up feature flags update using since = %s'],
+  [c.SYNC_SPLITS_NEW, c.LOG_PREFIX_SYNC_SPLITS + 'New feature flags %s'],
+  [c.SYNC_SPLITS_REMOVED, c.LOG_PREFIX_SYNC_SPLITS + 'Removed feature flags %s'],
   [c.SYNC_SPLITS_SEGMENTS, c.LOG_PREFIX_SYNC_SPLITS + 'Segment names collected %s'],
   [c.STREAMING_NEW_MESSAGE, c.LOG_PREFIX_SYNC_STREAMING + 'New SSE message received, with data: %s.'],
   [c.SYNC_TASK_START, c.LOG_PREFIX_SYNC + ': Starting %s. Running each %s millis'],
   [c.SYNC_TASK_EXECUTE, c.LOG_PREFIX_SYNC + ': Running %s'],
   [c.SYNC_TASK_STOP, c.LOG_PREFIX_SYNC + ': Stopping %s'],
   // initialization / settings validation
-  [c.SETTINGS_SPLITS_FILTER, c.LOG_PREFIX_SETTINGS + ': splits filtering criteria is "%s".']
+  [c.SETTINGS_SPLITS_FILTER, c.LOG_PREFIX_SETTINGS + ': feature flags filtering criteria is "%s".']
 ]);