@splitsoftware/splitio-commons 2.12.0 → 3.0.0-rc.1

package/esm/sync/polling/pollingManagerCS.js

@@ -1,18 +1,18 @@
 import { forOwn } from '../../utils/lang';
 import { mySegmentsSyncTaskFactory } from './syncTasks/mySegmentsSyncTask';
-import { splitsSyncTaskFactory } from './syncTasks/splitsSyncTask';
+import { definitionsSyncTaskFactory } from './syncTasks/definitionsSyncTask';
 import { getMatching } from '../../utils/key';
-import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../../readiness/constants';
+import { SDK_DEFINITIONS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../../readiness/constants';
 import { POLLING_SMART_PAUSING, POLLING_START, POLLING_STOP } from '../../logger/constants';
-import { usesSegmentsSync } from '../../storages/AbstractSplitsCacheSync';
+import { usesSegmentsSync } from '../../storages/AbstractDefinitionsCacheSync';
 /**
  * Expose start / stop mechanism for polling data from services.
  * For client-side API with multiple clients.
  */
-export function pollingManagerCSFactory(params) {
+export function pollingManagerCSFactory(params, definitionChangesFetcher) {
     var splitApi = params.splitApi, storage = params.storage, readiness = params.readiness, settings = params.settings;
     var log = settings.log;
-    var splitsSyncTask = splitsSyncTaskFactory(splitApi.fetchSplitChanges, storage, readiness, settings, true);
+    var definitionsSyncTask = definitionsSyncTaskFactory(definitionChangesFetcher, storage, readiness, settings, true);
     // Map of matching keys to their corresponding MySegmentsSyncTask.
     var mySegmentsSyncTasks = {};
     var matchingKey = getMatching(settings.core.key);
@@ -29,8 +29,8 @@ export function pollingManagerCSFactory(params) {
         });
     }
     // smart pausing
-    readiness.splits.on(SDK_SPLITS_ARRIVED, function () {
-        if (!splitsSyncTask.isRunning())
+    readiness.definitions.on(SDK_DEFINITIONS_ARRIVED, function () {
+        if (!definitionsSyncTask.isRunning())
             return; // noop if not doing polling
         var usingSegments = usesSegmentsSync(storage);
         if (usingSegments !== mySegmentsSyncTask.isRunning()) {
@@ -53,32 +53,32 @@ export function pollingManagerCSFactory(params) {
         if (!usesSegmentsSync(storage))
             setTimeout(smartReady, 0);
         else
-            readiness.splits.once(SDK_SPLITS_ARRIVED, smartReady);
+            readiness.definitions.once(SDK_DEFINITIONS_ARRIVED, smartReady);
         mySegmentsSyncTasks[matchingKey] = mySegmentsSyncTask;
         return mySegmentsSyncTask;
     }
     return {
-        splitsSyncTask: splitsSyncTask,
+        definitionsSyncTask: definitionsSyncTask,
         segmentsSyncTask: mySegmentsSyncTask,
         // Start periodic fetching (polling)
         start: function () {
             log.info(POLLING_START);
-            splitsSyncTask.start();
+            definitionsSyncTask.start();
             if (usesSegmentsSync(storage))
                 startMySegmentsSyncTasks();
         },
         // Stop periodic fetching (polling)
         stop: function () {
             log.info(POLLING_STOP);
-            if (splitsSyncTask.isRunning())
-                splitsSyncTask.stop();
+            if (definitionsSyncTask.isRunning())
+                definitionsSyncTask.stop();
             stopMySegmentsSyncTasks();
         },
         // Used by SyncManager to know if running in polling mode.
-        isRunning: splitsSyncTask.isRunning,
-        // fetch splits and segments
+        isRunning: definitionsSyncTask.isRunning,
+        // fetch definitions and segments
         syncAll: function () {
-            var promises = [splitsSyncTask.execute()];
+            var promises = [definitionsSyncTask.execute()];
             forOwn(mySegmentsSyncTasks, function (mySegmentsSyncTask) {
                 promises.push(mySegmentsSyncTask.execute());
             });

package/esm/sync/polling/pollingManagerSS.js

@@ -1,26 +1,26 @@
-import { splitsSyncTaskFactory } from './syncTasks/splitsSyncTask';
+import { definitionsSyncTaskFactory } from './syncTasks/definitionsSyncTask';
 import { segmentsSyncTaskFactory } from './syncTasks/segmentsSyncTask';
 import { POLLING_START, POLLING_STOP, LOG_PREFIX_SYNC_POLLING } from '../../logger/constants';
 /**
  * Expose start / stop mechanism for pulling data from services.
  */
-export function pollingManagerSSFactory(params) {
+export function pollingManagerSSFactory(params, definitionChangesFetcher) {
     var splitApi = params.splitApi, storage = params.storage, readiness = params.readiness, settings = params.settings;
     var log = settings.log;
-    var splitsSyncTask = splitsSyncTaskFactory(splitApi.fetchSplitChanges, storage, readiness, settings);
+    var definitionsSyncTask = definitionsSyncTaskFactory(definitionChangesFetcher, storage, readiness, settings);
     var segmentsSyncTask = segmentsSyncTaskFactory(splitApi.fetchSegmentChanges, storage, readiness, settings);
     return {
-        splitsSyncTask: splitsSyncTask,
+        definitionsSyncTask: definitionsSyncTask,
         segmentsSyncTask: segmentsSyncTask,
         // Start periodic fetching (polling)
         start: function () {
             log.info(POLLING_START);
-            log.debug(LOG_PREFIX_SYNC_POLLING + ("Splits will be refreshed each " + settings.scheduler.featuresRefreshRate + " millis"));
-            log.debug(LOG_PREFIX_SYNC_POLLING + ("Segments will be refreshed each " + settings.scheduler.segmentsRefreshRate + " millis"));
-            var startingUp = splitsSyncTask.start();
+            log.debug(LOG_PREFIX_SYNC_POLLING + "".concat(definitionChangesFetcher.type, " will be refreshed each ").concat(settings.scheduler.featuresRefreshRate, " millis"));
+            log.debug(LOG_PREFIX_SYNC_POLLING + "segments will be refreshed each ".concat(settings.scheduler.segmentsRefreshRate, " millis"));
+            var startingUp = definitionsSyncTask.start();
             if (startingUp) {
                 startingUp.then(function () {
-                    if (splitsSyncTask.isRunning())
+                    if (definitionsSyncTask.isRunning())
                         segmentsSyncTask.start();
                 });
             }
@@ -28,16 +28,16 @@ export function pollingManagerSSFactory(params) {
         // Stop periodic fetching (polling)
         stop: function () {
             log.info(POLLING_STOP);
-            if (splitsSyncTask.isRunning())
-                splitsSyncTask.stop();
+            if (definitionsSyncTask.isRunning())
+                definitionsSyncTask.stop();
             if (segmentsSyncTask.isRunning())
                 segmentsSyncTask.stop();
         },
         // Used by SyncManager to know if running in polling mode.
-        isRunning: splitsSyncTask.isRunning,
+        isRunning: definitionsSyncTask.isRunning,
         syncAll: function () {
-            // fetch splits and segments. There is no need to catch this promise (`SplitChangesUpdater` is always resolved with a boolean value)
-            return splitsSyncTask.execute().then(function () {
+            // fetch definitions and segments. There is no need to catch this promise (`DefinitionChangesUpdater` is always resolved with a boolean value)
+            return definitionsSyncTask.execute().then(function () {
                 return segmentsSyncTask.execute();
             });
         }

package/esm/sync/polling/syncTasks/definitionsSyncTask.js

@@ -0,0 +1,8 @@
+import { syncTaskFactory } from '../../syncTask';
+import { definitionChangesUpdaterFactory } from '../updaters/definitionChangesUpdater';
+/**
+ * Creates a sync task that periodically executes a `definitionChangesUpdater` task
+ */
+export function definitionsSyncTaskFactory(definitionChangesFetcher, storage, readiness, settings, isClientSide) {
+    return syncTaskFactory(settings.log, definitionChangesUpdaterFactory(settings.log, definitionChangesFetcher, storage, settings.sync.__splitFiltersValidation, readiness.definitions, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady, isClientSide), settings.scheduler.featuresRefreshRate, 'definitionChangesUpdater');
+}

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

@@ -0,0 +1,200 @@
+import { timeout } from '../../../utils/promise/timeout';
+import { SDK_DEFINITIONS_ARRIVED, FLAGS_UPDATE, SEGMENTS_UPDATE, CONFIGS_UPDATE } from '../../../readiness/constants';
+import { SYNC_FETCH, SYNC_UPDATE, SYNC_FETCH_FAILS, SYNC_FETCH_RETRY } from '../../../logger/constants';
+import { startsWith } from '../../../utils/lang';
+import { IN_RULE_BASED_SEGMENT, IN_SEGMENT, RULE_BASED_SEGMENT, STANDARD_SEGMENT } from '../../../utils/constants';
+import { setToArray } from '../../../utils/lang/sets';
+import { SPLIT_UPDATE } from '../../streaming/constants';
+// 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
+function checkAllSegmentsExist(segments) {
+    var registeredSegments = Promise.resolve(segments.getRegisteredSegments());
+    return registeredSegments.then(function (segmentNames) {
+        return Promise.all(segmentNames.map(function (segmentName) { return segments.getChangeNumber(segmentName); }))
+            .then(function (changeNumbers) { return changeNumbers.every(function (changeNumber) { return changeNumber !== undefined; }); });
+    });
+}
+/**
+ * Collect segments from a raw FF or RBS definition.
+ * Exported for testing purposes.
+ */
+export function parseSegments(ruleEntity, matcherType) {
+    if (matcherType === void 0) { matcherType = IN_SEGMENT; }
+    var _a = ruleEntity, conditions = _a.conditions, excluded = _a.excluded;
+    var segments = new Set();
+    if (excluded && excluded.segments) {
+        excluded.segments.forEach(function (_a) {
+            var type = _a.type, name = _a.name;
+            if ((type === STANDARD_SEGMENT && matcherType === IN_SEGMENT) || (type === RULE_BASED_SEGMENT && matcherType === IN_RULE_BASED_SEGMENT)) {
+                segments.add(name);
+            }
+        });
+    }
+    if (conditions) {
+        for (var i = 0; i < conditions.length; i++) {
+            var matchers = conditions[i].matcherGroup.matchers;
+            matchers.forEach(function (matcher) {
+                if (matcher.matcherType === matcherType)
+                    segments.add(matcher.userDefinedSegmentMatcherData.segmentName);
+            });
+        }
+    }
+    return segments;
+}
+/**
+ * If there are defined filters and one definition doesn't match with them, its status is changed to 'ARCHIVE' to avoid storing it
+ * If there is `bySet` filter, `byName` and `byPrefix` filters are ignored
+ *
+ * @param definition - definition to be evaluated
+ * @param filters - splitFiltersValidation bySet | byName
+ */
+function matchFilters(definition, filters) {
+    var _a = filters.groupedFilters, setsFilter = _a.bySet, namesFilter = _a.byName, prefixFilter = _a.byPrefix;
+    if (setsFilter.length > 0)
+        return definition.sets && definition.sets.some(function (definitionSet) { return setsFilter.indexOf(definitionSet) > -1; });
+    var namesFilterConfigured = namesFilter.length > 0;
+    var prefixFilterConfigured = prefixFilter.length > 0;
+    if (!namesFilterConfigured && !prefixFilterConfigured)
+        return true;
+    var matchNames = namesFilterConfigured && namesFilter.indexOf(definition.name) > -1;
+    var matchPrefix = prefixFilterConfigured && prefixFilter.some(function (prefix) { return startsWith(definition.name, prefix); });
+    return matchNames || matchPrefix;
+}
+/**
+ * Given the list of definitions from /splitChanges or /configs endpoint, it returns the mutations,
+ * i.e., an object with added definitions, removed definitions, and used segments.
+ * Exported for testing purposes.
+ */
+export function computeMutation(update, segments, filters) {
+    return update.updated.reduce(function (accum, ruleEntity) {
+        if (!filters || matchFilters(ruleEntity, filters)) {
+            accum.added.push(ruleEntity);
+            parseSegments(ruleEntity).forEach(function (segmentName) {
+                segments.add(segmentName);
+            });
+        }
+        else {
+            accum.removed.push(ruleEntity.name);
+        }
+        accum.names.push(ruleEntity.name);
+        return accum;
+    }, { added: [], removed: update.removed, names: update.removed.slice() });
+}
+function convertInstantUpdateToDefinitionChanges(instantUpdate) {
+    var payload = instantUpdate.payload, changeNumber = instantUpdate.changeNumber;
+    return payload.status === 'ARCHIVED' ?
+        { till: changeNumber, updated: [], removed: [payload.name] } :
+        { till: changeNumber, updated: [payload], removed: [] };
+}
+/**
+ * Factory of DefinitionChanges updater, a task that:
+ *  - fetches definition changes using `definitionChangesFetcher`
+ *  - updates definitions storage
+ *  - uses `definitionsEventEmitter` to emit events related to definition data updates
+ *
+ * @param log -  Logger instance
+ * @param definitionChangesFetcher -  Fetcher of `/splitChanges` or `/configs`
+ * @param definitions -  Definitions storage, with sync or async methods
+ * @param segments -  Segments storage, with sync or async methods
+ * @param definitionsEventEmitter -  Optional readiness manager. Not required for synchronizer or producer mode.
+ * @param requestTimeoutBeforeReady -  How long the updater will wait for the request to timeout. Default 0, i.e., never timeout.
+ * @param retriesOnFailureBeforeReady -  How many retries on `/splitChanges` or `/configs` we the updater do in case of failure or timeout. Default 0, i.e., no retries.
+ */
+export function definitionChangesUpdaterFactory(log, definitionChangesFetcher, storage, splitFiltersValidation, definitionsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, isClientSide) {
+    if (requestTimeoutBeforeReady === void 0) { requestTimeoutBeforeReady = 0; }
+    if (retriesOnFailureBeforeReady === void 0) { retriesOnFailureBeforeReady = 0; }
+    var definitions = storage.definitions, rbSegments = storage.rbSegments, segments = storage.segments;
+    var startingUp = true;
+    /** timeout decorator for `definitionChangesFetcher` promise  */
+    function _promiseDecorator(promise) {
+        if (startingUp && requestTimeoutBeforeReady)
+            promise = timeout(requestTimeoutBeforeReady, promise);
+        return promise;
+    }
+    /**
+     * DefinitionChanges updater returns a promise that resolves with a `false` boolean value if it fails to fetch definitions or synchronize them with the storage.
+     * Returned promise will not be rejected.
+     *
+     * @param noCache - true to revalidate data to fetch
+     * @param till - query param to bypass CDN requests
+     */
+    return function definitionChangesUpdater(noCache, till, instantUpdate) {
+        /**
+         * @param since - current changeNumber at definitionsCache
+         * @param retry - current number of retry attempts
+         */
+        function _definitionChangesUpdater(sinces, retry) {
+            if (retry === void 0) { retry = 0; }
+            var since = sinces[0], rbSince = sinces[1];
+            log.debug(SYNC_FETCH, [definitionChangesFetcher.type, since, rbSince]);
+            return Promise.resolve(instantUpdate ?
+                instantUpdate.type === SPLIT_UPDATE ?
+                    // IFFU edge case: a change to definition that adds an IN_RULE_BASED_SEGMENT matcher that is not present yet
+                    Promise.resolve(rbSegments.contains(parseSegments(instantUpdate.payload, IN_RULE_BASED_SEGMENT))).then(function (contains) {
+                        return contains ?
+                            { d: convertInstantUpdateToDefinitionChanges(instantUpdate) } :
+                            definitionChangesFetcher(since, noCache, till, rbSince, _promiseDecorator);
+                    }) :
+                    { rbs: convertInstantUpdateToDefinitionChanges(instantUpdate) } :
+                definitionChangesFetcher(since, noCache, till, rbSince, _promiseDecorator))
+                .then(function (definitionChanges) {
+                var usedSegments = new Set();
+                var updatedDefinitions = [];
+                var ffUpdate = false;
+                if (definitionChanges.d) {
+                    var _a = computeMutation(definitionChanges.d, usedSegments, splitFiltersValidation), added = _a.added, removed = _a.removed, names = _a.names;
+                    updatedDefinitions = names;
+                    log.debug(SYNC_UPDATE, [definitionChangesFetcher.type, added.length, removed.length]);
+                    ffUpdate = definitions.update(added, removed, definitionChanges.d.till);
+                }
+                var rbsUpdate = false;
+                if (definitionChanges.rbs) {
+                    var _b = computeMutation(definitionChanges.rbs, usedSegments), added = _b.added, removed = _b.removed;
+                    log.debug(SYNC_UPDATE, ['rule-based segments', added.length, removed.length]);
+                    rbsUpdate = rbSegments.update(added, removed, definitionChanges.rbs.till);
+                }
+                return Promise.all([ffUpdate, rbsUpdate,
+                    // @TODO if at least 1 segment fetch fails due to 404 and other segments are updated in the storage, SDK_UPDATE is not emitted
+                    segments.registerSegments(setToArray(usedSegments))
+                ]).then(function (_a) {
+                    var ffChanged = _a[0], rbsChanged = _a[1];
+                    if (storage.save)
+                        storage.save();
+                    startingUp = false;
+                    if (definitionsEventEmitter) {
+                        // To emit SDK_DEFINITIONS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
+                        return Promise.resolve(!definitionsEventEmitter.definitionsArrived || ((ffChanged || rbsChanged) && (isClientSide || checkAllSegmentsExist(segments))))
+                            .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
+                            .then(function (emitSplitsArrivedEvent) {
+                            // emit SDK events
+                            if (emitSplitsArrivedEvent) {
+                                var metadata = {
+                                    type: updatedDefinitions.length > 0 ? definitionChangesFetcher.type === 'configs' ? CONFIGS_UPDATE : FLAGS_UPDATE : SEGMENTS_UPDATE,
+                                    names: updatedDefinitions.length > 0 ? updatedDefinitions : []
+                                };
+                                definitionsEventEmitter.emit(SDK_DEFINITIONS_ARRIVED, metadata);
+                            }
+                            return true;
+                        });
+                    }
+                    return true;
+                });
+            })
+                .catch(function (error) {
+                if (startingUp && retriesOnFailureBeforeReady > retry) {
+                    retry += 1;
+                    log.warn(SYNC_FETCH_RETRY, [definitionChangesFetcher.type, retry, error]);
+                    return _definitionChangesUpdater(sinces, retry);
+                }
+                else {
+                    startingUp = false;
+                    log.warn(SYNC_FETCH_FAILS, [definitionChangesFetcher.type, error]);
+                }
+                return false;
+            });
+        }
+        // `getChangeNumber` never rejects or throws error
+        return Promise.all([definitions.getChangeNumber(), rbSegments.getChangeNumber()]).then(_definitionChangesUpdater);
+    };
+}

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

@@ -1,8 +1,8 @@
 import { timeout } from '../../../utils/promise/timeout';
 import { SDK_SEGMENTS_ARRIVED, SEGMENTS_UPDATE } from '../../../readiness/constants';
-import { SYNC_MYSEGMENTS_FETCH_RETRY } from '../../../logger/constants';
+import { SYNC_FETCH_RETRY } from '../../../logger/constants';
 import { MEMBERSHIPS_LS_UPDATE } from '../../streaming/constants';
-import { usesSegmentsSync } from '../../../storages/AbstractSplitsCacheSync';
+import { usesSegmentsSync } from '../../../storages/AbstractDefinitionsCacheSync';
 /**
  * factory of MySegments updater, a task that:
  *  - fetches mySegments using `mySegmentsFetcher`
@@ -53,7 +53,7 @@ export function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmen
         return updaterPromise.catch(function (error) {
             if (startingUp && retriesOnFailureBeforeReady > retry) {
                 retry += 1;
-                log.warn(SYNC_MYSEGMENTS_FETCH_RETRY, [retry, error]);
+                log.warn(SYNC_FETCH_RETRY, ['memberships', retry, error]);
                 return _mySegmentsUpdater(retry); // no need to forward `segmentList` and `noCache` params
             }
             else {

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

@@ -1,5 +1,5 @@
 import { SDK_SEGMENTS_ARRIVED, SEGMENTS_UPDATE } from '../../../readiness/constants';
-import { LOG_PREFIX_INSTANTIATION, LOG_PREFIX_SYNC_SEGMENTS } from '../../../logger/constants';
+import { LOG_PREFIX_INSTANTIATION, LOG_PREFIX_SYNC } from '../../../logger/constants';
 import { timeout } from '../../../utils/promise/timeout';
 /**
  * Factory of SegmentChanges updater, a task that:
@@ -20,7 +20,7 @@ export function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segment
         return promise;
     }
     function updateSegment(segmentName, noCache, till, fetchOnlyNew, retries) {
-        log.debug(LOG_PREFIX_SYNC_SEGMENTS + "Processing segment " + segmentName);
+        log.debug("".concat(LOG_PREFIX_SYNC, "Processing segment ").concat(segmentName));
         var sincePromise = Promise.resolve(segments.getChangeNumber(segmentName));
         return sincePromise.then(function (since) {
             // if fetchOnlyNew flag, avoid processing already fetched segments
@@ -28,14 +28,14 @@ export function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segment
                 false :
                 segmentChangesFetcher(since || -1, segmentName, noCache, till, _promiseDecorator).then(function (changes) {
                     return Promise.all(changes.map(function (x) {
-                        log.debug(LOG_PREFIX_SYNC_SEGMENTS + "Processing " + segmentName + " with till = " + x.till + ". Added: " + x.added.length + ". Removed: " + x.removed.length);
+                        log.debug("".concat(LOG_PREFIX_SYNC, "Processing ").concat(segmentName, " with till = ").concat(x.till, ". Added: ").concat(x.added.length, ". Removed: ").concat(x.removed.length));
                         return segments.update(segmentName, x.added, x.removed, x.till);
                     })).then(function (updates) {
                         return updates.some(function (update) { return update; });
                     });
                 }).catch(function (error) {
                     if (retries) {
-                        log.warn(LOG_PREFIX_SYNC_SEGMENTS + "Retrying fetch of segment " + segmentName + " (attempt #" + retries + "). Reason: " + error);
+                        log.warn("".concat(LOG_PREFIX_SYNC, "Retrying fetch of segment ").concat(segmentName, " (attempt #").concat(retries, "). Reason: ").concat(error));
                         return updateSegment(segmentName, noCache, till, fetchOnlyNew, retries - 1);
                     }
                     throw error;
@@ -54,7 +54,7 @@ export function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segment
      * @param till - till target for the provided segmentName, for CDN bypass.
      */
     return function segmentChangesUpdater(fetchOnlyNew, segmentName, noCache, till) {
-        log.debug(LOG_PREFIX_SYNC_SEGMENTS + "Started segments update");
+        log.debug("".concat(LOG_PREFIX_SYNC, "Started segments update"));
         // If not a segment name provided, read list of available segments names to be updated.
         var segmentsPromise = Promise.resolve(segmentName ? [segmentName] : segments.getRegisteredSegments());
         return segmentsPromise.then(function (segmentNames) {
@@ -81,10 +81,10 @@ export function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segment
                 // @TODO although factory status is destroyed, synchronization is not stopped
                 if (readiness)
                     readiness.setDestroyed();
-                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.");
+                log.error("".concat(LOG_PREFIX_INSTANTIATION, ": you passed a client-side type authorizationKey, please grab an SDK Key from Harness UI that is of type server-side."));
             }
             else {
-                log.warn(LOG_PREFIX_SYNC_SEGMENTS + "Error while doing fetch of segments. " + error);
+                log.warn("".concat(LOG_PREFIX_SYNC, "Error while doing fetch of segments. ").concat(error));
             }
             return false;
         });

package/esm/sync/streaming/SSEClient/index.js

@@ -57,11 +57,11 @@ var SSEClient = /** @class */ (function () {
             var params = CONTROL_CHANNEL_REGEX.test(channel) ? '[?occupancy=metrics.publishers]' : '';
             return encodeURIComponent(params + channel);
         }).join(',');
-        var url = this.settings.urls.streaming + "/sse?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + ABLY_API_VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
+        var url = "".concat(this.settings.urls.streaming, "/sse?channels=").concat(channelsQueryParam, "&accessToken=").concat(authToken.token, "&v=").concat(ABLY_API_VERSION, "&heartbeats=true"); // same results using `&heartbeats=false`
         var isServerSide = checkIfServerSide(this.settings);
         this.connection = new this.eventSource(
         // For client-side SDKs, metadata is passed as query param to avoid CORS issues and because native EventSource implementations in browsers do not support headers
-        isServerSide ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
+        isServerSide ? url : url + "&SplitSDKVersion=".concat(this.headers.SplitSDKVersion, "&SplitSDKClientKey=").concat(this.headers.SplitSDKClientKey), 
         // For server-side SDKs, metadata is passed via headers
         objectAssign(isServerSide ?
             { headers: decorateHeaders(this.settings, this.headers) } :

package/esm/sync/streaming/SSEHandler/NotificationKeeper.js

@@ -1,5 +1,5 @@
 import { CONNECTION_ESTABLISHED, DISABLED, ENABLED, OCCUPANCY_PRI, OCCUPANCY_SEC, PAUSED, STREAMING_STATUS } from '../../../utils/constants';
-import { ControlType, PUSH_SUBSYSTEM_UP, PUSH_NONRETRYABLE_ERROR, PUSH_SUBSYSTEM_DOWN } from '../constants';
+import { ControlType, PUSH_SUBSYSTEM_UP, PUSH_NON_RETRYABLE_ERROR, PUSH_SUBSYSTEM_DOWN } from '../constants';
 var CONTROL_CHANNEL_REGEXS = [/control_pri$/, /control_sec$/];
 var STREAMING_EVENT_TYPES = [OCCUPANCY_PRI, OCCUPANCY_SEC];
 /**
@@ -70,7 +70,7 @@ export function notificationKeeperFactory(pushEmitter, telemetryTracker) {
                         c.cTime = timestamp;
                         if (controlType === ControlType.STREAMING_DISABLED) {
                             telemetryTracker.streamingEvent(STREAMING_STATUS, DISABLED);
-                            pushEmitter.emit(PUSH_NONRETRYABLE_ERROR);
+                            pushEmitter.emit(PUSH_NON_RETRYABLE_ERROR);
                         }
                         else if (hasPublishers) {
                             if (controlType === ControlType.STREAMING_PAUSED && hasResumed) {

package/esm/sync/streaming/SSEHandler/index.js

@@ -1,6 +1,6 @@
 import { errorParser, messageParser } from './NotificationParser';
 import { notificationKeeperFactory } from './NotificationKeeper';
-import { PUSH_RETRYABLE_ERROR, PUSH_NONRETRYABLE_ERROR, OCCUPANCY, CONTROL, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE, MEMBERSHIPS_MS_UPDATE, MEMBERSHIPS_LS_UPDATE, RB_SEGMENT_UPDATE } from '../constants';
+import { PUSH_RETRYABLE_ERROR, PUSH_NON_RETRYABLE_ERROR, OCCUPANCY, CONTROL, SEGMENT_UPDATE, SPLIT_KILL, SPLIT_UPDATE, MEMBERSHIPS_MS_UPDATE, MEMBERSHIPS_LS_UPDATE, RB_SEGMENT_UPDATE } from '../constants';
 import { STREAMING_PARSING_ERROR_FAILS, ERROR_STREAMING_SSE, STREAMING_PARSING_MESSAGE_FAILS, STREAMING_NEW_MESSAGE } from '../../../logger/constants';
 import { ABLY_ERROR, NON_REQUESTED, SSE_CONNECTION_ERROR } from '../../../utils/constants';
 /**
@@ -48,7 +48,7 @@ export function SSEHandlerFactory(log, pushEmitter, telemetryTracker) {
                 pushEmitter.emit(PUSH_RETRYABLE_ERROR);
             }
             else {
-                pushEmitter.emit(PUSH_NONRETRYABLE_ERROR);
+                pushEmitter.emit(PUSH_NON_RETRYABLE_ERROR);
             }
         },
         /* NotificationProcessor */

package/esm/sync/streaming/UpdateWorkers/{SplitsUpdateWorker.js → DefinitionsUpdateWorker.js}

@@ -1,33 +1,33 @@
 import { STREAMING_PARSING_SPLIT_UPDATE } from '../../../logger/constants';
-import { SDK_SPLITS_ARRIVED } from '../../../readiness/constants';
+import { SDK_DEFINITIONS_ARRIVED } from '../../../readiness/constants';
 import { Backoff } from '../../../utils/Backoff';
 import { SPLITS } from '../../../utils/constants';
 import { RB_SEGMENT_UPDATE } from '../constants';
 import { parseFFUpdatePayload } from '../parseUtils';
 import { FETCH_BACKOFF_BASE, FETCH_BACKOFF_MAX_WAIT, FETCH_BACKOFF_MAX_RETRIES } from './constants';
 /**
- * SplitsUpdateWorker factory
+ * DefinitionsUpdateWorker factory
  */
-export function SplitsUpdateWorker(log, storage, splitsSyncTask, splitsEventEmitter, telemetryTracker, segmentsSyncTask) {
-    var ff = SplitsUpdateWorker(storage.splits);
-    var rbs = SplitsUpdateWorker(storage.rbSegments);
-    function SplitsUpdateWorker(cache) {
+export function DefinitionsUpdateWorker(log, storage, definitionsSyncTask, definitionsEventEmitter, telemetryTracker, segmentsSyncTask) {
+    var ff = DefinitionsUpdateWorker(storage.definitions);
+    var rbs = DefinitionsUpdateWorker(storage.rbSegments);
+    function DefinitionsUpdateWorker(cache) {
         var maxChangeNumber = -1;
         var handleNewEvent = false;
         var isHandlingEvent;
         var cdnBypass;
         var instantUpdate;
-        var backoff = new Backoff(__handleSplitUpdateCall, FETCH_BACKOFF_BASE, FETCH_BACKOFF_MAX_WAIT);
-        function __handleSplitUpdateCall() {
+        var backoff = new Backoff(__handleDefinitionUpdateCall, FETCH_BACKOFF_BASE, FETCH_BACKOFF_MAX_WAIT);
+        function __handleDefinitionUpdateCall() {
             isHandlingEvent = true;
             if (maxChangeNumber > cache.getChangeNumber()) {
                 handleNewEvent = false;
                 // fetch splits revalidating data if cached
-                splitsSyncTask.execute(true, cdnBypass ? maxChangeNumber : undefined, instantUpdate).then(function () {
+                definitionsSyncTask.execute(true, cdnBypass ? maxChangeNumber : undefined, instantUpdate).then(function () {
                     if (!isHandlingEvent)
                         return; // halt if `stop` has been called
                     if (handleNewEvent) {
-                        __handleSplitUpdateCall();
+                        __handleDefinitionUpdateCall();
                     }
                     else {
                         if (instantUpdate)
@@ -37,7 +37,7 @@ export function SplitsUpdateWorker(log, storage, splitsSyncTask, splitsEventEmit
                             segmentsSyncTask.execute(true);
                         var attempts = backoff.attempts + 1;
                         if (ff.isSync() && rbs.isSync()) {
-                            log.debug("Refresh completed" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
+                            log.debug("Refresh completed".concat(cdnBypass ? ' bypassing the CDN' : '', " in ").concat(attempts, " attempts."));
                             isHandlingEvent = false;
                             return;
                         }
@@ -46,13 +46,13 @@ export function SplitsUpdateWorker(log, storage, splitsSyncTask, splitsEventEmit
                             return;
                         }
                         if (cdnBypass) {
-                            log.debug("No changes fetched after " + attempts + " attempts with CDN bypassed.");
+                            log.debug("No changes fetched after ".concat(attempts, " attempts with CDN bypassed."));
                             isHandlingEvent = false;
                         }
                         else {
                             backoff.reset();
                             cdnBypass = true;
-                            __handleSplitUpdateCall();
+                            __handleDefinitionUpdateCall();
                         }
                     }
                 });
@@ -80,7 +80,7 @@ export function SplitsUpdateWorker(log, storage, splitsSyncTask, splitsEventEmit
                     instantUpdate = { payload: payload, changeNumber: changeNumber, type: type };
                 }
                 if (backoff.timeoutID || !isHandlingEvent)
-                    __handleSplitUpdateCall();
+                    __handleDefinitionUpdateCall();
                 backoff.reset();
             },
             stop: function () {
@@ -115,11 +115,11 @@ export function SplitsUpdateWorker(log, storage, splitsSyncTask, splitsEventEmit
          * @param splitName - name of split to kill
          * @param defaultTreatment - default treatment value
          */
-        killSplit: function (_a) {
+        killDefinition: function (_a) {
             var changeNumber = _a.changeNumber, splitName = _a.splitName, defaultTreatment = _a.defaultTreatment;
-            if (storage.splits.killLocally(splitName, defaultTreatment, changeNumber)) {
+            if (storage.definitions.killLocally(splitName, defaultTreatment, changeNumber)) {
                 // trigger an SDK_UPDATE if Split was killed locally
-                splitsEventEmitter.emit(SDK_SPLITS_ARRIVED, true);
+                definitionsEventEmitter.emit(SDK_DEFINITIONS_ARRIVED, true);
             }
             // queues the SplitChanges fetch (only if changeNumber is newer)
             ff.put({ changeNumber: changeNumber });

package/esm/sync/streaming/UpdateWorkers/MySegmentsUpdateWorker.js

@@ -48,7 +48,7 @@ export function MySegmentsUpdateWorker(log, storage, mySegmentsSyncTask, telemet
                             telemetryTracker.trackUpdatesFromSSE(MEMBERSHIPS);
                         var attempts = backoff.attempts + 1;
                         if (maxChangeNumber <= currentChangeNumber) {
-                            log.debug("Refresh completed" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
+                            log.debug("Refresh completed".concat(cdnBypass ? ' bypassing the CDN' : '', " in ").concat(attempts, " attempts."));
                             isHandlingEvent = false;
                             return;
                         }
@@ -57,7 +57,7 @@ export function MySegmentsUpdateWorker(log, storage, mySegmentsSyncTask, telemet
                             return;
                         }
                         if (cdnBypass) {
-                            log.debug("No changes fetched after " + attempts + " attempts with CDN bypassed.");
+                            log.debug("No changes fetched after ".concat(attempts, " attempts with CDN bypassed."));
                             isHandlingEvent = false;
                         }
                         else {

package/esm/sync/streaming/UpdateWorkers/SegmentsUpdateWorker.js

@@ -25,7 +25,7 @@ export function SegmentsUpdateWorker(log, segmentsSyncTask, segmentsCache) {
                     else {
                         var attempts = backoff.attempts + 1;
                         if (maxChangeNumber <= (segmentsCache.getChangeNumber(segment) || -1)) {
-                            log.debug("Refresh completed" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
+                            log.debug("Refresh completed".concat(cdnBypass ? ' bypassing the CDN' : '', " in ").concat(attempts, " attempts."));
                             isHandlingEvent = false;
                             return;
                         }
@@ -34,7 +34,7 @@ export function SegmentsUpdateWorker(log, segmentsSyncTask, segmentsCache) {
                             return;
                         }
                         if (cdnBypass) {
-                            log.debug("No changes fetched after " + attempts + " attempts with CDN bypassed.");
+                            log.debug("No changes fetched after ".concat(attempts, " attempts with CDN bypassed."));
                             isHandlingEvent = false;
                         }
                         else {

package/esm/sync/streaming/constants.js

@@ -5,7 +5,7 @@ export var SECONDS_BEFORE_EXPIRATION = 600;
  * emitted on SSE and Authenticate non-recoverable errors, STREAMING_DISABLED control notification and authentication with pushEnabled false
  * triggers `handleNonRetryableError` call
  */
-export var PUSH_NONRETRYABLE_ERROR = 'PUSH_NONRETRYABLE_ERROR';
+export var PUSH_NON_RETRYABLE_ERROR = 'PUSH_NON_RETRYABLE_ERROR';
 /**
  * emitted on SSE and Authenticate recoverable errors
  * triggers `handleRetryableError` call
@@ -17,7 +17,7 @@ export var PUSH_RETRYABLE_ERROR = 'PUSH_RETRYABLE_ERROR';
  */
 export var PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP';
 /**
- * emitted on STREAMING_PAUSED control notification, OCCUPANCY equal to 0, PUSH_NONRETRYABLE_ERROR and PUSH_RETRYABLE_ERROR events.
+ * emitted on STREAMING_PAUSED control notification, OCCUPANCY equal to 0, PUSH_NON_RETRYABLE_ERROR and PUSH_RETRYABLE_ERROR events.
  * triggers `startPolling` and `stopWorkers` calls
  */
 export var PUSH_SUBSYSTEM_DOWN = 'PUSH_SUBSYSTEM_DOWN';