@splitsoftware/splitio-commons 3.1.1-rc.1 → 3.1.1-rc.10

package/cjs/sync/polling/updaters/{definitionChangesUpdater.js → splitChangesUpdater.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.definitionChangesUpdaterFactory = exports.computeMutation = exports.parseSegments = void 0;
+exports.splitChangesUpdaterFactory = exports.computeMutation = exports.parseSegments = void 0;
 var timeout_1 = require("../../../utils/promise/timeout");
 var constants_1 = require("../../../readiness/constants");
 var constants_2 = require("../../../logger/constants");
@@ -8,6 +8,16 @@ var lang_1 = require("../../../utils/lang");
 var constants_3 = require("../../../utils/constants");
 var sets_1 = require("../../../utils/lang/sets");
 var constants_4 = require("../../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.
@@ -37,118 +47,111 @@ function parseSegments(ruleEntity, matcherType) {
 }
 exports.parseSegments = parseSegments;
 /**
- * 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 are defined filters and one feature flag 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 featureFlag - feature flag to be evaluated
  * @param filters - splitFiltersValidation bySet | byName
  */
-function matchFilters(definition, filters) {
+function matchFilters(featureFlag, 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; });
+        return featureFlag.sets && featureFlag.sets.some(function (featureFlagSet) { return setsFilter.indexOf(featureFlagSet) > -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 (0, lang_1.startsWith)(definition.name, prefix); });
+    var matchNames = namesFilterConfigured && namesFilter.indexOf(featureFlag.name) > -1;
+    var matchPrefix = prefixFilterConfigured && prefixFilter.some(function (prefix) { return (0, lang_1.startsWith)(featureFlag.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.
+ * Given the list of splits from /splitChanges endpoint, it returns the mutations,
+ * i.e., an object with added splits, removed splits and used segments.
  * Exported for testing purposes.
  */
-function computeMutation(update, segments, filters) {
-    return update.updated.reduce(function (accum, ruleEntity) {
-        if (!filters || matchFilters(ruleEntity, filters)) {
-            accum.updated.push(ruleEntity);
+function computeMutation(rules, segments, filters) {
+    return rules.reduce(function (accum, ruleEntity) {
+        if (ruleEntity.status !== 'ARCHIVED' && (!filters || matchFilters(ruleEntity, filters))) {
+            accum.added.push(ruleEntity);
             parseSegments(ruleEntity).forEach(function (segmentName) {
                 segments.add(segmentName);
             });
         }
         else {
-            accum.removed.push(ruleEntity.name);
+            accum.removed.push(ruleEntity);
         }
         accum.names.push(ruleEntity.name);
         return accum;
-    }, { updated: [], removed: update.removed, names: update.removed.slice() });
+    }, { added: [], removed: [], names: [] });
 }
 exports.computeMutation = computeMutation;
-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
+ * factory of SplitChanges updater, a task that:
+ *  - fetches split changes using `splitChangesFetcher`
+ *  - updates `splitsCache`
+ *  - uses `splitsEventEmitter` to emit events related to split data updates
  *
  * @param log -  Logger instance
- * @param definitionChangesFetcher -  Fetcher of `/splitChanges` or `/configs`
- * @param definitions -  Definitions storage, with sync or async methods
+ * @param splitChangesFetcher -  Fetcher of `/splitChanges`
+ * @param splits -  Splits 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 splitsEventEmitter -  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.
+ * @param retriesOnFailureBeforeReady -  How many retries on `/splitChanges` we the updater do in case of failure or timeout. Default 0, i.e., no retries.
  */
-function definitionChangesUpdaterFactory(log, definitionChangesFetcher, storage, splitFiltersValidation, definitionsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, segmentsSyncTask // undefined for client-side
-) {
+function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFiltersValidation, splitsEventEmitter, 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 splits = storage.splits, rbSegments = storage.rbSegments, segments = storage.segments;
     var startingUp = true;
-    /** timeout decorator for `definitionChangesFetcher` promise  */
+    /** timeout decorator for `splitChangesFetcher` promise  */
     function _promiseDecorator(promise) {
         if (startingUp && requestTimeoutBeforeReady)
             promise = (0, timeout_1.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.
+     * SplitChanges updater returns a promise that resolves with a `false` boolean value if it fails to fetch splits 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) {
+    return function splitChangesUpdater(noCache, till, instantUpdate) {
         /**
-         * @param since - current changeNumber at definitionsCache
+         * @param since - current changeNumber at splitsCache
          * @param retry - current number of retry attempts
          */
-        function _definitionChangesUpdater(sinces, retry) {
+        function _splitChangesUpdater(sinces, retry) {
             if (retry === void 0) { retry = 0; }
             var since = sinces[0], rbSince = sinces[1];
-            log.debug(constants_2.SYNC_FETCH, [definitionChangesFetcher.type, since, rbSince]);
+            log.debug(constants_2.SYNC_SPLITS_FETCH, sinces);
             return Promise.resolve(instantUpdate ?
                 instantUpdate.type === constants_4.SPLIT_UPDATE ?
-                    // IFFU edge case: a change to definition that adds an IN_RULE_BASED_SEGMENT matcher that is not present yet
+                    // IFFU edge case: a change to a flag that adds an IN_RULE_BASED_SEGMENT matcher that is not present yet
                     Promise.resolve(rbSegments.contains(parseSegments(instantUpdate.payload, constants_3.IN_RULE_BASED_SEGMENT))).then(function (contains) {
                         return contains ?
-                            { d: convertInstantUpdateToDefinitionChanges(instantUpdate) } :
-                            definitionChangesFetcher(since, noCache, till, rbSince, _promiseDecorator);
+                            { ff: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
+                            splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator);
                     }) :
-                    { rbs: convertInstantUpdateToDefinitionChanges(instantUpdate) } :
-                definitionChangesFetcher(since, noCache, till, rbSince, _promiseDecorator))
-                .then(function (definitionChanges) {
+                    { rbs: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
+                splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator))
+                .then(function (splitChanges) {
                 var usedSegments = new Set();
-                var updatedDefinitions = [];
+                var updatedFlags = [];
                 var ffUpdate = false;
-                if (definitionChanges.d) {
-                    var _a = computeMutation(definitionChanges.d, usedSegments, splitFiltersValidation), updated = _a.updated, removed = _a.removed, names = _a.names;
-                    updatedDefinitions = names;
-                    log.debug(constants_2.SYNC_UPDATE, [definitionChangesFetcher.type, updated.length, removed.length]);
-                    ffUpdate = definitions.update(updated, removed, definitionChanges.d.till);
+                if (splitChanges.ff) {
+                    var _a = computeMutation(splitChanges.ff.d || [], usedSegments, splitFiltersValidation), added = _a.added, removed = _a.removed, names = _a.names;
+                    updatedFlags = names;
+                    log.debug(constants_2.SYNC_SPLITS_UPDATE, [added.length, removed.length]);
+                    ffUpdate = splits.update(added, removed, splitChanges.ff.t);
                 }
                 var rbsUpdate = false;
-                if (definitionChanges.rbs) {
-                    var _b = computeMutation(definitionChanges.rbs, usedSegments), updated = _b.updated, removed = _b.removed;
-                    log.debug(constants_2.SYNC_UPDATE, ['rule-based segments', updated.length, removed.length]);
-                    rbsUpdate = rbSegments.update(updated, removed, definitionChanges.rbs.till);
+                if (splitChanges.rbs) {
+                    var _b = computeMutation(splitChanges.rbs.d || [], usedSegments), added = _b.added, removed = _b.removed;
+                    log.debug(constants_2.SYNC_RBS_UPDATE, [added.length, removed.length]);
+                    rbsUpdate = rbSegments.update(added, removed, splitChanges.rbs.t);
                 }
                 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
@@ -158,18 +161,18 @@ function definitionChangesUpdaterFactory(log, definitionChangesFetcher, storage,
                     if (storage.save)
                         storage.save();
                     startingUp = false;
-                    if (definitionsEventEmitter) {
-                        // To emit SDK_DEFINITIONS_ARRIVED for server-side SDK, we must wait for all registered segments to be fetched
-                        return Promise.resolve(!definitionsEventEmitter.definitionsArrived || ((ffChanged || rbsChanged) && (!segmentsSyncTask || segmentsSyncTask.execute(true))))
+                    if (splitsEventEmitter) {
+                        // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
+                        return Promise.resolve(!splitsEventEmitter.splitsArrived || ((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' ? constants_1.CONFIGS_UPDATE : constants_1.FLAGS_UPDATE : constants_1.SEGMENTS_UPDATE,
-                                    names: updatedDefinitions.length > 0 ? updatedDefinitions : []
+                                    type: updatedFlags.length > 0 ? constants_1.FLAGS_UPDATE : constants_1.SEGMENTS_UPDATE,
+                                    names: updatedFlags.length > 0 ? updatedFlags : []
                                 };
-                                definitionsEventEmitter.emit(constants_1.SDK_DEFINITIONS_ARRIVED, metadata);
+                                splitsEventEmitter.emit(constants_1.SDK_SPLITS_ARRIVED, metadata);
                             }
                             return true;
                         });
@@ -180,18 +183,18 @@ function definitionChangesUpdaterFactory(log, definitionChangesFetcher, storage,
                 .catch(function (error) {
                 if (startingUp && retriesOnFailureBeforeReady > retry) {
                     retry += 1;
-                    log.warn(constants_2.SYNC_FETCH_RETRY, [definitionChangesFetcher.type, retry, error]);
-                    return _definitionChangesUpdater(sinces, retry);
+                    log.warn(constants_2.SYNC_SPLITS_FETCH_RETRY, [retry, error]);
+                    return _splitChangesUpdater(sinces, retry);
                 }
                 else {
                     startingUp = false;
-                    log.warn(constants_2.SYNC_FETCH_FAILS, [definitionChangesFetcher.type, error]);
+                    log.warn(constants_2.SYNC_SPLITS_FETCH_FAILS, [error]);
                 }
                 return false;
             });
         }
         // `getChangeNumber` never rejects or throws error
-        return Promise.all([definitions.getChangeNumber(), rbSegments.getChangeNumber()]).then(_definitionChangesUpdater);
+        return Promise.all([splits.getChangeNumber(), rbSegments.getChangeNumber()]).then(_splitChangesUpdater);
     };
 }
-exports.definitionChangesUpdaterFactory = definitionChangesUpdaterFactory;
+exports.splitChangesUpdaterFactory = splitChangesUpdaterFactory;

package/cjs/sync/streaming/AuthClient/index.js

@@ -8,7 +8,7 @@ var murmur3_1 = require("../../../utils/murmur3/murmur3");
 /**
  * Factory of authentication function.
  *
- * @param fetchAuth - `ServiceApi.fetchAuth` endpoint
+ * @param fetchAuth - `SplitAPI.fetchAuth` endpoint
  */
 function authenticateFactory(fetchAuth) {
     /**

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

@@ -73,7 +73,7 @@ function notificationKeeperFactory(pushEmitter, telemetryTracker) {
                         c.cTime = timestamp;
                         if (controlType === constants_2.ControlType.STREAMING_DISABLED) {
                             telemetryTracker.streamingEvent(constants_1.STREAMING_STATUS, constants_1.DISABLED);
-                            pushEmitter.emit(constants_2.PUSH_NON_RETRYABLE_ERROR);
+                            pushEmitter.emit(constants_2.PUSH_NONRETRYABLE_ERROR);
                         }
                         else if (hasPublishers) {
                             if (controlType === constants_2.ControlType.STREAMING_PAUSED && hasResumed) {

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

@@ -51,7 +51,7 @@ function SSEHandlerFactory(log, pushEmitter, telemetryTracker) {
                 pushEmitter.emit(constants_1.PUSH_RETRYABLE_ERROR);
             }
             else {
-                pushEmitter.emit(constants_1.PUSH_NON_RETRYABLE_ERROR);
+                pushEmitter.emit(constants_1.PUSH_NONRETRYABLE_ERROR);
             }
         },
         /* NotificationProcessor */

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefinitionsUpdateWorker = void 0;
+exports.SplitsUpdateWorker = void 0;
 var constants_1 = require("../../../logger/constants");
 var constants_2 = require("../../../readiness/constants");
 var Backoff_1 = require("../../../utils/Backoff");
@@ -9,32 +9,35 @@ var constants_4 = require("../constants");
 var parseUtils_1 = require("../parseUtils");
 var constants_5 = require("./constants");
 /**
- * DefinitionsUpdateWorker factory
+ * SplitsUpdateWorker factory
  */
-function DefinitionsUpdateWorker(log, storage, definitionsSyncTask, definitionsEventEmitter, telemetryTracker) {
-    var ff = DefinitionsUpdateWorker(storage.definitions);
-    var rbs = DefinitionsUpdateWorker(storage.rbSegments);
-    function DefinitionsUpdateWorker(cache) {
+function SplitsUpdateWorker(log, storage, splitsSyncTask, splitsEventEmitter, telemetryTracker, segmentsSyncTask) {
+    var ff = SplitsUpdateWorker(storage.splits);
+    var rbs = SplitsUpdateWorker(storage.rbSegments);
+    function SplitsUpdateWorker(cache) {
         var maxChangeNumber = -1;
         var handleNewEvent = false;
         var isHandlingEvent;
         var cdnBypass;
         var instantUpdate;
-        var backoff = new Backoff_1.Backoff(__handleDefinitionUpdateCall, constants_5.FETCH_BACKOFF_BASE, constants_5.FETCH_BACKOFF_MAX_WAIT);
-        function __handleDefinitionUpdateCall() {
+        var backoff = new Backoff_1.Backoff(__handleSplitUpdateCall, constants_5.FETCH_BACKOFF_BASE, constants_5.FETCH_BACKOFF_MAX_WAIT);
+        function __handleSplitUpdateCall() {
             isHandlingEvent = true;
             if (maxChangeNumber > cache.getChangeNumber()) {
                 handleNewEvent = false;
                 // fetch splits revalidating data if cached
-                definitionsSyncTask.execute(true, cdnBypass ? maxChangeNumber : undefined, instantUpdate).then(function () {
+                splitsSyncTask.execute(true, cdnBypass ? maxChangeNumber : undefined, instantUpdate).then(function () {
                     if (!isHandlingEvent)
                         return; // halt if `stop` has been called
                     if (handleNewEvent) {
-                        __handleDefinitionUpdateCall();
+                        __handleSplitUpdateCall();
                     }
                     else {
                         if (instantUpdate)
                             telemetryTracker.trackUpdatesFromSSE(constants_3.SPLITS);
+                        // fetch new registered segments for server-side API. Not retrying on error
+                        if (segmentsSyncTask)
+                            segmentsSyncTask.execute(true);
                         var attempts = backoff.attempts + 1;
                         if (ff.isSync() && rbs.isSync()) {
                             log.debug("Refresh completed".concat(cdnBypass ? ' bypassing the CDN' : '', " in ").concat(attempts, " attempts."));
@@ -52,7 +55,7 @@ function DefinitionsUpdateWorker(log, storage, definitionsSyncTask, definitionsE
                         else {
                             backoff.reset();
                             cdnBypass = true;
-                            __handleDefinitionUpdateCall();
+                            __handleSplitUpdateCall();
                         }
                     }
                 });
@@ -80,7 +83,7 @@ function DefinitionsUpdateWorker(log, storage, definitionsSyncTask, definitionsE
                     instantUpdate = { payload: payload, changeNumber: changeNumber, type: type };
                 }
                 if (backoff.timeoutID || !isHandlingEvent)
-                    __handleDefinitionUpdateCall();
+                    __handleSplitUpdateCall();
                 backoff.reset();
             },
             stop: function () {
@@ -115,11 +118,11 @@ function DefinitionsUpdateWorker(log, storage, definitionsSyncTask, definitionsE
          * @param splitName - name of split to kill
          * @param defaultTreatment - default treatment value
          */
-        killDefinition: function (_a) {
+        killSplit: function (_a) {
             var changeNumber = _a.changeNumber, splitName = _a.splitName, defaultTreatment = _a.defaultTreatment;
-            if (storage.definitions.killLocally(splitName, defaultTreatment, changeNumber)) {
+            if (storage.splits.killLocally(splitName, defaultTreatment, changeNumber)) {
                 // trigger an SDK_UPDATE if Split was killed locally
-                definitionsEventEmitter.emit(constants_2.SDK_DEFINITIONS_ARRIVED, true);
+                splitsEventEmitter.emit(constants_2.SDK_SPLITS_ARRIVED, true);
             }
             // queues the SplitChanges fetch (only if changeNumber is newer)
             ff.put({ changeNumber: changeNumber });
@@ -130,4 +133,4 @@ function DefinitionsUpdateWorker(log, storage, definitionsSyncTask, definitionsE
         }
     };
 }
-exports.DefinitionsUpdateWorker = DefinitionsUpdateWorker;
+exports.SplitsUpdateWorker = SplitsUpdateWorker;

package/cjs/sync/streaming/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlType = exports.OCCUPANCY = exports.CONTROL = exports.RB_SEGMENT_UPDATE = exports.SPLIT_UPDATE = exports.SPLIT_KILL = exports.SEGMENT_UPDATE = exports.MEMBERSHIPS_LS_UPDATE = exports.MEMBERSHIPS_MS_UPDATE = exports.PUSH_SUBSYSTEM_DOWN = exports.PUSH_SUBSYSTEM_UP = exports.PUSH_RETRYABLE_ERROR = exports.PUSH_NON_RETRYABLE_ERROR = exports.SECONDS_BEFORE_EXPIRATION = void 0;
+exports.ControlType = exports.OCCUPANCY = exports.CONTROL = exports.RB_SEGMENT_UPDATE = exports.SPLIT_UPDATE = exports.SPLIT_KILL = exports.SEGMENT_UPDATE = exports.MEMBERSHIPS_LS_UPDATE = exports.MEMBERSHIPS_MS_UPDATE = exports.PUSH_SUBSYSTEM_DOWN = exports.PUSH_SUBSYSTEM_UP = exports.PUSH_RETRYABLE_ERROR = exports.PUSH_NONRETRYABLE_ERROR = exports.SECONDS_BEFORE_EXPIRATION = void 0;
 // time for refresh token
 exports.SECONDS_BEFORE_EXPIRATION = 600;
 // Internal SDK events, subscribed by SyncManager and PushManager
@@ -8,7 +8,7 @@ exports.SECONDS_BEFORE_EXPIRATION = 600;
  * emitted on SSE and Authenticate non-recoverable errors, STREAMING_DISABLED control notification and authentication with pushEnabled false
  * triggers `handleNonRetryableError` call
  */
-exports.PUSH_NON_RETRYABLE_ERROR = 'PUSH_NON_RETRYABLE_ERROR';
+exports.PUSH_NONRETRYABLE_ERROR = 'PUSH_NONRETRYABLE_ERROR';
 /**
  * emitted on SSE and Authenticate recoverable errors
  * triggers `handleRetryableError` call
@@ -20,7 +20,7 @@ exports.PUSH_RETRYABLE_ERROR = 'PUSH_RETRYABLE_ERROR';
  */
 exports.PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP';
 /**
- * emitted on STREAMING_PAUSED control notification, OCCUPANCY equal to 0, PUSH_NON_RETRYABLE_ERROR and PUSH_RETRYABLE_ERROR events.
+ * emitted on STREAMING_PAUSED control notification, OCCUPANCY equal to 0, PUSH_NONRETRYABLE_ERROR and PUSH_RETRYABLE_ERROR events.
  * triggers `startPolling` and `stopWorkers` calls
  */
 exports.PUSH_SUBSYSTEM_DOWN = 'PUSH_SUBSYSTEM_DOWN';

package/cjs/sync/streaming/parseUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDelay = exports.parseFFUpdatePayload = exports.isInBitmap = exports.parseBitmap = exports.parseCompressedData = void 0;
+exports.getDelay = exports.parseFFUpdatePayload = exports.isInBitmap = exports.parseBitmap = exports.parseKeyList = void 0;
 var decompress_1 = require("../../utils/decompress");
 var base64_1 = require("../../utils/base64");
 var murmur3_1 = require("../../utils/murmur3/murmur3");
@@ -33,24 +33,24 @@ function decompress(data, compression) {
     throw new Error("Invalid compression algorithm #".concat(compression));
 }
 /**
- * Decode, decompress and parse the provided 'data' into an object of type T
+ * Decode, decompress and parse the provided 'data' into a KeyList object
  *
  * @param data - base64 encoded string
  * @param compression - 1 GZIP, 2 ZLIB
  * @param avoidPrecisionLoss - true as default, set it as false if dont need to avoid precission loss
- * @returns parsed object
+ * @returns keyList
  * @throws if data string cannot be decoded, decompressed or parsed
  */
-function parseCompressedData(data, compression, avoidPrecisionLoss) {
+function parseKeyList(data, compression, avoidPrecisionLoss) {
     if (avoidPrecisionLoss === void 0) { avoidPrecisionLoss = true; }
-    var binData = decompress(data, compression);
-    var str = Uint8ArrayToString(binData);
-    // replace numbers to strings, to avoid losing precision (e.g., 64-bit IDs in KeyList)
+    var binKeyList = decompress(data, compression);
+    var strKeyList = Uint8ArrayToString(binKeyList);
+    // replace numbers to strings, to avoid losing precision
     if (avoidPrecisionLoss)
-        str = str.replace(/\d+/g, '"$&"');
-    return JSON.parse(str);
+        strKeyList = strKeyList.replace(/\d+/g, '"$&"');
+    return JSON.parse(strKeyList);
 }
-exports.parseCompressedData = parseCompressedData;
+exports.parseKeyList = parseKeyList;
 /**
  * Decode, decompress and parse the provided 'data' into a Bitmap object
  *
@@ -83,7 +83,7 @@ exports.isInBitmap = isInBitmap;
  */
 function parseFFUpdatePayload(compression, data) {
     return compression > 0 ?
-        parseCompressedData(data, compression, false) :
+        parseKeyList(data, compression, false) :
         JSON.parse((0, base64_1.decodeFromBase64)(data));
 }
 exports.parseFFUpdatePayload = parseFFUpdatePayload;

package/cjs/sync/streaming/pushManager.js

@@ -6,7 +6,7 @@ var Backoff_1 = require("../../utils/Backoff");
 var SSEHandler_1 = require("./SSEHandler");
 var MySegmentsUpdateWorker_1 = require("./UpdateWorkers/MySegmentsUpdateWorker");
 var SegmentsUpdateWorker_1 = require("./UpdateWorkers/SegmentsUpdateWorker");
-var DefinitionsUpdateWorker_1 = require("./UpdateWorkers/DefinitionsUpdateWorker");
+var SplitsUpdateWorker_1 = require("./UpdateWorkers/SplitsUpdateWorker");
 var AuthClient_1 = require("./AuthClient");
 var lang_1 = require("../../utils/lang");
 var SSEClient_1 = require("./SSEClient");
@@ -23,7 +23,7 @@ var constants_3 = require("../../utils/constants");
  * - for client-side, with support for multiple clients, if key is provided in settings
  */
 function pushManagerFactory(params, pollingManager) {
-    var settings = params.settings, storage = params.storage, serviceApi = params.serviceApi, readiness = params.readiness, platform = params.platform, telemetryTracker = params.telemetryTracker;
+    var settings = params.settings, storage = params.storage, splitApi = params.splitApi, readiness = params.readiness, platform = params.platform, telemetryTracker = params.telemetryTracker;
     // `userKey` is the matching key of main client in client-side SDK.
     // It can be used to check if running on client-side or server-side SDK.
     var userKey = (0, key_1.checkIfServerSide)(settings) ? undefined : (0, key_1.getMatching)(settings.core.key);
@@ -37,7 +37,7 @@ function pushManagerFactory(params, pollingManager) {
         log.warn(constants_2.STREAMING_FALLBACK, [e]);
         return;
     }
-    var authenticate = (0, AuthClient_1.authenticateFactory)(serviceApi.fetchAuth);
+    var authenticate = (0, AuthClient_1.authenticateFactory)(splitApi.fetchAuth);
     // init feedback loop
     var pushEmitter = new platform.EventEmitter();
     var sseHandler = (0, SSEHandler_1.SSEHandlerFactory)(log, pushEmitter, telemetryTracker);
@@ -45,8 +45,8 @@ function pushManagerFactory(params, pollingManager) {
     // init workers
     // MySegmentsUpdateWorker (client-side) are initiated in `add` method
     var segmentsUpdateWorker = userKey ? undefined : (0, SegmentsUpdateWorker_1.SegmentsUpdateWorker)(log, pollingManager.segmentsSyncTask, storage.segments);
-    // For server-side we pass the segmentsSyncTask, used by DefinitionsUpdateWorker to fetch new segments
-    var definitionsUpdateWorker = (0, DefinitionsUpdateWorker_1.DefinitionsUpdateWorker)(log, storage, pollingManager.definitionsSyncTask, readiness.definitions, telemetryTracker);
+    // For server-side we pass the segmentsSyncTask, used by SplitsUpdateWorker to fetch new segments
+    var splitsUpdateWorker = (0, SplitsUpdateWorker_1.SplitsUpdateWorker)(log, storage, pollingManager.splitsSyncTask, readiness.splits, telemetryTracker, userKey ? undefined : pollingManager.segmentsSyncTask);
     // [Only for client-side] map of hashes to user keys, to dispatch membership update events to the corresponding MySegmentsUpdateWorker
     var userKeyHashes = {};
     // [Only for client-side] map of user keys to their corresponding hash64 and MySegmentsUpdateWorkers.
@@ -54,10 +54,10 @@ function pushManagerFactory(params, pollingManager) {
     var clients = {};
     // [Only for client-side] variable to flag that a new client was added. It is needed to reconnect streaming.
     var connectForNewClient = false;
-    // flag that indicates if `stop/disconnectPush` was called, either by the SyncManager, when the client is destroyed, or due to a PUSH_NON_RETRYABLE_ERROR error.
+    // flag that indicates if `stop/disconnectPush` was called, either by the SyncManager, when the client is destroyed, or due to a PUSH_NONRETRYABLE_ERROR error.
     // It is used to halt the `connectPush` process if it was in progress.
     var disconnected;
-    // flag that indicates a PUSH_NON_RETRYABLE_ERROR, condition with which starting pushManager again is ignored.
+    // flag that indicates a PUSH_NONRETRYABLE_ERROR, condition with which starting pushManager again is ignored.
     // true if STREAMING_DISABLED control event, or 'pushEnabled: false', or non-recoverable SSE or Auth errors.
     var disabled; // `disabled` implies `disconnected === true`
     /** PushManager functions related to initialization */
@@ -96,11 +96,11 @@ function pushManagerFactory(params, pollingManager) {
         authenticate(userKeys).then(function (authData) {
             if (disconnected)
                 return;
-            // 'pushEnabled: false' is handled as a PUSH_NON_RETRYABLE_ERROR instead of PUSH_SUBSYSTEM_DOWN, in order to
+            // 'pushEnabled: false' is handled as a PUSH_NONRETRYABLE_ERROR instead of PUSH_SUBSYSTEM_DOWN, in order to
             // close the sseClient in case the org has been bloqued while the instance was connected to streaming
             if (!authData.pushEnabled) {
                 log.info(constants_2.STREAMING_DISABLED);
-                pushEmitter.emit(constants_1.PUSH_NON_RETRYABLE_ERROR);
+                pushEmitter.emit(constants_1.PUSH_NONRETRYABLE_ERROR);
                 return;
             }
             // [Only for client-side] don't open SSE connection if a new shared client was added, since it means that a new authentication is taking place
@@ -115,7 +115,7 @@ function pushManagerFactory(params, pollingManager) {
             // 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(constants_3.AUTH_REJECTION);
-                pushEmitter.emit(constants_1.PUSH_NON_RETRYABLE_ERROR);
+                pushEmitter.emit(constants_1.PUSH_NONRETRYABLE_ERROR);
                 return;
             }
             // Handle other HTTP and network errors as recoverable errors
@@ -139,7 +139,7 @@ function pushManagerFactory(params, pollingManager) {
     }
     // cancel scheduled fetch retries of Splits, Segments, and MySegments Update Workers
     function stopWorkers() {
-        definitionsUpdateWorker.stop();
+        splitsUpdateWorker.stop();
         if (userKey)
             (0, lang_1.forOwn)(clients, function (_a) {
                 var worker = _a.worker;
@@ -155,7 +155,7 @@ function pushManagerFactory(params, pollingManager) {
         connectPushRetryBackoff.reset();
     });
     /** Fallback to polling without retry due to: STREAMING_DISABLED control event, or 'pushEnabled: false', or non-recoverable SSE and Authentication errors */
-    pushEmitter.on(constants_1.PUSH_NON_RETRYABLE_ERROR, function handleNonRetryableError() {
+    pushEmitter.on(constants_1.PUSH_NONRETRYABLE_ERROR, function handleNonRetryableError() {
         disabled = true;
         // Note: `stopWorkers` is been called twice, but it is not harmful
         disconnectPush();
@@ -181,9 +181,9 @@ function pushManagerFactory(params, pollingManager) {
         connectPush();
     });
     /** Functions related to synchronization (Queues and Workers in the spec) */
-    pushEmitter.on(constants_1.SPLIT_KILL, definitionsUpdateWorker.killDefinition);
-    pushEmitter.on(constants_1.SPLIT_UPDATE, definitionsUpdateWorker.put);
-    pushEmitter.on(constants_1.RB_SEGMENT_UPDATE, definitionsUpdateWorker.put);
+    pushEmitter.on(constants_1.SPLIT_KILL, splitsUpdateWorker.killSplit);
+    pushEmitter.on(constants_1.SPLIT_UPDATE, splitsUpdateWorker.put);
+    pushEmitter.on(constants_1.RB_SEGMENT_UPDATE, splitsUpdateWorker.put);
     function handleMySegmentsUpdate(parsedData) {
         switch (parsedData.u) {
             case types_1.UpdateStrategy.BoundedFetchRequest: {
@@ -206,7 +206,7 @@ function pushManagerFactory(params, pollingManager) {
             case types_1.UpdateStrategy.KeyList: {
                 var keyList = void 0, added_1, removed_1;
                 try {
-                    keyList = (0, parseUtils_1.parseCompressedData)(parsedData.d, parsedData.c);
+                    keyList = (0, parseUtils_1.parseKeyList)(parsedData.d, parsedData.c);
                     added_1 = new Set(keyList.a);
                     removed_1 = new Set(keyList.r);
                 }

package/cjs/sync/submitters/eventsSubmitter.js

@@ -7,7 +7,7 @@ var constants_1 = require("../../logger/constants");
  * Submitter that periodically posts tracked events
  */
 function eventsSubmitterFactory(params) {
-    var _a = params.settings, log = _a.log, eventsPushRate = _a.scheduler.eventsPushRate, eventsFirstPushWindow = _a.startup.eventsFirstPushWindow, postEventsBulk = params.serviceApi.postEventsBulk, events = params.storage.events;
+    var _a = params.settings, log = _a.log, eventsPushRate = _a.scheduler.eventsPushRate, eventsFirstPushWindow = _a.startup.eventsFirstPushWindow, postEventsBulk = params.splitApi.postEventsBulk, events = params.storage.events;
     // don't retry events.
     var submitter = (0, submitter_1.submitterFactory)(log, postEventsBulk, events, eventsPushRate);
     // Set a timer for the first push window of events.

package/cjs/sync/submitters/impressionCountsSubmitter.js

@@ -29,7 +29,7 @@ var IMPRESSIONS_COUNT_RATE = 1800000; // 30 minutes
  * Submitter that periodically posts impression counts
  */
 function impressionCountsSubmitterFactory(params) {
-    var log = params.settings.log, postTestImpressionsCount = params.serviceApi.postTestImpressionsCount, impressionCounts = params.storage.impressionCounts;
+    var log = params.settings.log, postTestImpressionsCount = params.splitApi.postTestImpressionsCount, impressionCounts = params.storage.impressionCounts;
     // retry impressions counts only once.
     return (0, submitter_1.submitterFactory)(log, postTestImpressionsCount, impressionCounts, IMPRESSIONS_COUNT_RATE, fromImpressionCountsCollector, 1);
 }

package/cjs/sync/submitters/impressionsSubmitter.js

@@ -14,7 +14,7 @@ function fromImpressionsCollector(sendLabels, data) {
         dto.push({
             f: name,
             i: value.map(function (entry) {
-                return {
+                var keyImpression = {
                     k: entry.keyName,
                     t: entry.treatment,
                     m: entry.time,
@@ -22,10 +22,9 @@ function fromImpressionsCollector(sendLabels, data) {
                     r: sendLabels ? entry.label : undefined,
                     b: entry.bucketingKey,
                     pt: entry.pt,
-                    properties: entry.properties,
-                    // @ts-expect-error - entityType is not yet public. @TODO: add to SplitIO.ImpressionDTO type
-                    et: entry.entityType, // Definition type
+                    properties: entry.properties // Properties
                 };
+                return keyImpression;
             })
         });
     });
@@ -36,7 +35,7 @@ exports.fromImpressionsCollector = fromImpressionsCollector;
  * Submitter that periodically posts impressions data
  */
 function impressionsSubmitterFactory(params) {
-    var _a = params.settings, log = _a.log, impressionsRefreshRate = _a.scheduler.impressionsRefreshRate, labelsEnabled = _a.core.labelsEnabled, postTestImpressionsBulk = params.serviceApi.postTestImpressionsBulk, impressions = params.storage.impressions;
+    var _a = params.settings, log = _a.log, impressionsRefreshRate = _a.scheduler.impressionsRefreshRate, labelsEnabled = _a.core.labelsEnabled, postTestImpressionsBulk = params.splitApi.postTestImpressionsBulk, impressions = params.storage.impressions;
     // retry impressions only once.
     var syncTask = (0, submitter_1.submitterFactory)(log, postTestImpressionsBulk, impressions, impressionsRefreshRate, fromImpressionsCollector.bind(undefined, labelsEnabled), 1);
     // register impressions submitter to be executed when impressions cache is full