@splitsoftware/splitio-commons 1.17.0 → 1.17.1-rc.1

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

@@ -3,62 +3,121 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MySegmentsUpdateWorker = void 0;
 var Backoff_1 = require("../../../utils/Backoff");
 var constants_1 = require("../../../utils/constants");
+var constants_2 = require("./constants");
+var constants_3 = require("../constants");
 /**
  * MySegmentsUpdateWorker factory
  */
-function MySegmentsUpdateWorker(mySegmentsSyncTask, telemetryTracker) {
-    var maxChangeNumber = 0; // keeps the maximum changeNumber among queued events
-    var currentChangeNumber = -1;
-    var handleNewEvent = false;
-    var isHandlingEvent;
-    var _segmentsData; // keeps the segmentsData (if included in notification payload) from the queued event with maximum changeNumber
-    var backoff = new Backoff_1.Backoff(__handleMySegmentsUpdateCall);
-    function __handleMySegmentsUpdateCall() {
-        isHandlingEvent = true;
-        if (maxChangeNumber > currentChangeNumber) {
-            handleNewEvent = false;
-            var currentMaxChangeNumber_1 = maxChangeNumber;
-            // fetch mySegments revalidating data if cached
-            mySegmentsSyncTask.execute(_segmentsData, true).then(function (result) {
-                if (!isHandlingEvent)
-                    return; // halt if `stop` has been called
-                if (result !== false) { // Unlike `Splits|SegmentsUpdateWorker`, we cannot use `mySegmentsCache.getChangeNumber` since `/mySegments` endpoint doesn't provide this value.
-                    if (_segmentsData)
-                        telemetryTracker.trackUpdatesFromSSE(constants_1.MY_SEGMENT);
-                    currentChangeNumber = Math.max(currentChangeNumber, currentMaxChangeNumber_1); // use `currentMaxChangeNumber`, in case that `maxChangeNumber` was updated during fetch.
-                }
-                if (handleNewEvent) {
-                    __handleMySegmentsUpdateCall();
-                }
-                else {
-                    backoff.scheduleCall();
-                }
-            });
-        }
-        else {
-            isHandlingEvent = false;
+function MySegmentsUpdateWorker(log, storage, mySegmentsSyncTask, telemetryTracker) {
+    var _a;
+    var _delay;
+    var _delayTimeoutID;
+    function createUpdateWorker(mySegmentsCache) {
+        var maxChangeNumber = 0; // keeps the maximum changeNumber among queued events
+        var currentChangeNumber = -1;
+        var handleNewEvent = false;
+        var isHandlingEvent;
+        var cdnBypass;
+        var _segmentsData; // keeps the segmentsData (if included in notification payload) from the queued event with maximum changeNumber
+        var backoff = new Backoff_1.Backoff(__handleMySegmentsUpdateCall);
+        function __handleMySegmentsUpdateCall() {
+            isHandlingEvent = true;
+            if (maxChangeNumber > Math.max(currentChangeNumber, mySegmentsCache.getChangeNumber())) {
+                handleNewEvent = false;
+                var currentMaxChangeNumber_1 = maxChangeNumber;
+                // fetch mySegments revalidating data if cached
+                var syncTask = _delay ?
+                    new Promise(function (res) {
+                        _delayTimeoutID = setTimeout(function () {
+                            _delay = undefined;
+                            mySegmentsSyncTask.execute(_segmentsData, true, cdnBypass ? maxChangeNumber : undefined).then(res);
+                        }, _delay);
+                    }) :
+                    mySegmentsSyncTask.execute(_segmentsData, true, cdnBypass ? maxChangeNumber : undefined);
+                syncTask.then(function (result) {
+                    if (!isHandlingEvent)
+                        return; // halt if `stop` has been called
+                    if (result !== false) { // Unlike `Splits|SegmentsUpdateWorker`, `mySegmentsCache.getChangeNumber` can be -1, since `/memberships` change number is optional
+                        var storageChangeNumber = mySegmentsCache.getChangeNumber();
+                        currentChangeNumber = storageChangeNumber > -1 ?
+                            storageChangeNumber :
+                            Math.max(currentChangeNumber, currentMaxChangeNumber_1); // use `currentMaxChangeNumber`, in case that `maxChangeNumber` was updated during fetch.
+                    }
+                    if (handleNewEvent) {
+                        __handleMySegmentsUpdateCall();
+                    }
+                    else {
+                        if (_segmentsData)
+                            telemetryTracker.trackUpdatesFromSSE(constants_1.MEMBERSHIPS);
+                        var attempts = backoff.attempts + 1;
+                        if (maxChangeNumber <= currentChangeNumber) {
+                            log.debug("Refresh completed" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
+                            isHandlingEvent = false;
+                            return;
+                        }
+                        if (attempts < constants_2.FETCH_BACKOFF_MAX_RETRIES) {
+                            backoff.scheduleCall();
+                            return;
+                        }
+                        if (cdnBypass) {
+                            log.debug("No changes fetched after " + attempts + " attempts with CDN bypassed.");
+                            isHandlingEvent = false;
+                        }
+                        else {
+                            backoff.reset();
+                            cdnBypass = true;
+                            __handleMySegmentsUpdateCall();
+                        }
+                    }
+                });
+            }
+            else {
+                isHandlingEvent = false;
+            }
         }
+        return {
+            /**
+             * Invoked by NotificationProcessor on MY_(LARGE)_SEGMENTS_UPDATE notifications
+             *
+             * @param changeNumber change number of the notification
+             * @param segmentsData data for KeyList or SegmentRemoval instant updates
+             * @param delay optional time to wait for BoundedFetchRequest or BoundedFetchRequest updates
+             */
+            put: function (mySegmentsData, payload, delay) {
+                var type = mySegmentsData.type, cn = mySegmentsData.cn;
+                // Discard event if it is outdated or there is a pending fetch request (_delay is set), but update target change number
+                if (cn <= Math.max(currentChangeNumber, mySegmentsCache.getChangeNumber()) || cn <= maxChangeNumber)
+                    return;
+                maxChangeNumber = cn;
+                if (_delay)
+                    return;
+                handleNewEvent = true;
+                cdnBypass = false;
+                _segmentsData = payload && { type: type, cn: cn, added: payload.added, removed: payload.removed };
+                _delay = delay;
+                if (backoff.timeoutID || !isHandlingEvent)
+                    __handleMySegmentsUpdateCall();
+                backoff.reset();
+            },
+            stop: function () {
+                clearTimeout(_delayTimeoutID);
+                _delay = undefined;
+                isHandlingEvent = false;
+                backoff.reset();
+            }
+        };
     }
+    var updateWorkers = (_a = {},
+        _a[constants_3.MEMBERSHIPS_MS_UPDATE] = createUpdateWorker(storage.segments),
+        _a[constants_3.MEMBERSHIPS_LS_UPDATE] = createUpdateWorker(storage.largeSegments),
+        _a);
     return {
-        /**
-         * Invoked by NotificationProcessor on MY_SEGMENTS_UPDATE event
-         *
-         * @param {number} changeNumber change number of the MY_SEGMENTS_UPDATE notification
-         * @param {SegmentsData | undefined} segmentsData might be undefined
-         */
-        put: function (changeNumber, segmentsData) {
-            if (changeNumber <= currentChangeNumber || changeNumber <= maxChangeNumber)
-                return;
-            maxChangeNumber = changeNumber;
-            handleNewEvent = true;
-            _segmentsData = segmentsData;
-            if (backoff.timeoutID || !isHandlingEvent)
-                __handleMySegmentsUpdateCall();
-            backoff.reset();
+        put: function (mySegmentsData, payload, delay) {
+            updateWorkers[mySegmentsData.type].put(mySegmentsData, payload, delay);
         },
         stop: function () {
-            isHandlingEvent = false;
-            backoff.reset();
+            updateWorkers[constants_3.MEMBERSHIPS_MS_UPDATE].stop();
+            updateWorkers[constants_3.MEMBERSHIPS_LS_UPDATE].stop();
         }
     };
 }

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.SPLIT_UPDATE = exports.SPLIT_KILL = exports.SEGMENT_UPDATE = exports.MY_SEGMENTS_UPDATE_V2 = exports.MY_SEGMENTS_UPDATE = exports.PUSH_SUBSYSTEM_DOWN = exports.PUSH_SUBSYSTEM_UP = exports.PUSH_RETRYABLE_ERROR = exports.PUSH_NONRETRYABLE_ERROR = exports.SECONDS_BEFORE_EXPIRATION = void 0;
+exports.ControlType = exports.OCCUPANCY = exports.CONTROL = 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
@@ -25,8 +25,8 @@ exports.PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP';
  */
 exports.PUSH_SUBSYSTEM_DOWN = 'PUSH_SUBSYSTEM_DOWN';
 // Update-type push notifications, handled by NotificationProcessor
-exports.MY_SEGMENTS_UPDATE = 'MY_SEGMENTS_UPDATE';
-exports.MY_SEGMENTS_UPDATE_V2 = 'MY_SEGMENTS_UPDATE_V2';
+exports.MEMBERSHIPS_MS_UPDATE = 'MEMBERSHIPS_MS_UPDATE';
+exports.MEMBERSHIPS_LS_UPDATE = 'MEMBERSHIPS_LS_UPDATE';
 exports.SEGMENT_UPDATE = 'SEGMENT_UPDATE';
 exports.SPLIT_KILL = 'SPLIT_KILL';
 exports.SPLIT_UPDATE = 'SPLIT_UPDATE';

package/cjs/sync/streaming/parseUtils.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseFFUpdatePayload = exports.isInBitmap = exports.parseBitmap = exports.parseKeyList = 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");
 var GZIP = 1;
 var ZLIB = 2;
 function Uint8ArrayToString(myUint8Arr) {
@@ -80,15 +81,19 @@ function isInBitmap(bitmap, hash64hex) {
 exports.isInBitmap = isInBitmap;
 /**
  * Parse feature flags notifications for instant feature flag updates
- *
- * @param {ISplitUpdateData} data
- * @returns {KeyList}
  */
 function parseFFUpdatePayload(compression, data) {
-    var avoidPrecisionLoss = false;
-    if (compression > 0)
-        return parseKeyList(data, compression, avoidPrecisionLoss);
-    else
-        return JSON.parse((0, base64_1.decodeFromBase64)(data));
+    return compression > 0 ?
+        parseKeyList(data, compression, false) :
+        JSON.parse((0, base64_1.decodeFromBase64)(data));
 }
 exports.parseFFUpdatePayload = parseFFUpdatePayload;
+var DEFAULT_MAX_INTERVAL = 60000;
+function getDelay(parsedData, matchingKey) {
+    if (parsedData.h === 0)
+        return 0;
+    var interval = parsedData.i || DEFAULT_MAX_INTERVAL;
+    var seed = parsedData.s || 0;
+    return (0, murmur3_1.hash)(matchingKey, seed) % interval;
+}
+exports.getDelay = getDelay;

package/cjs/sync/streaming/pushManager.js

@@ -48,10 +48,10 @@ function pushManagerFactory(params, pollingManager) {
     var segmentsUpdateWorker = userKey ? undefined : (0, SegmentsUpdateWorker_1.SegmentsUpdateWorker)(log, pollingManager.segmentsSyncTask, storage.segments);
     // For server-side we pass the segmentsSyncTask, used by SplitsUpdateWorker to fetch new segments
     var splitsUpdateWorker = (0, SplitsUpdateWorker_1.SplitsUpdateWorker)(log, storage.splits, pollingManager.splitsSyncTask, readiness.splits, telemetryTracker, userKey ? undefined : pollingManager.segmentsSyncTask);
-    // [Only for client-side] map of hashes to user keys, to dispatch MY_SEGMENTS_UPDATE events to the corresponding MySegmentsUpdateWorker
+    // [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.
-    // Hash64 is used to process MY_SEGMENTS_UPDATE_V2 events and dispatch actions to the corresponding MySegmentsUpdateWorker.
+    // Hash64 is used to process membership update events and dispatch actions to the corresponding MySegmentsUpdateWorker.
     var clients = {};
     // [Only for client-side] variable to flag that a new client was added. It is needed to reconnect streaming.
     var connectForNewClient = false;
@@ -198,77 +198,76 @@ function pushManagerFactory(params, pollingManager) {
         }
         splitsUpdateWorker.put(parsedData);
     });
-    if (userKey) {
-        pushEmitter.on(constants_1.MY_SEGMENTS_UPDATE, function handleMySegmentsUpdate(parsedData, channel) {
-            var userKeyHash = channel.split('_')[2];
-            var userKey = userKeyHashes[userKeyHash];
-            if (userKey && clients[userKey]) { // check existence since it can be undefined if client has been destroyed
-                clients[userKey].worker.put(parsedData.changeNumber, parsedData.includesPayload ? parsedData.segmentList ? parsedData.segmentList : [] : undefined);
-            }
-        });
-        pushEmitter.on(constants_1.MY_SEGMENTS_UPDATE_V2, function handleMySegmentsUpdate(parsedData) {
-            switch (parsedData.u) {
-                case types_1.UpdateStrategy.BoundedFetchRequest: {
-                    var bitmap_1;
-                    try {
-                        bitmap_1 = (0, parseUtils_1.parseBitmap)(parsedData.d, parsedData.c);
-                    }
-                    catch (e) {
-                        log.warn(constants_2.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, ['BoundedFetchRequest', e]);
-                        break;
-                    }
-                    (0, lang_1.forOwn)(clients, function (_a) {
-                        var hash64 = _a.hash64, worker = _a.worker;
-                        if ((0, parseUtils_1.isInBitmap)(bitmap_1, hash64.hex)) {
-                            worker.put(parsedData.changeNumber); // fetch mySegments
-                        }
-                    });
-                    return;
+    function handleMySegmentsUpdate(parsedData) {
+        switch (parsedData.u) {
+            case types_1.UpdateStrategy.BoundedFetchRequest: {
+                var bitmap_1;
+                try {
+                    bitmap_1 = (0, parseUtils_1.parseBitmap)(parsedData.d, parsedData.c);
                 }
-                case types_1.UpdateStrategy.KeyList: {
-                    var keyList = void 0, added_1, removed_1;
-                    try {
-                        keyList = (0, parseUtils_1.parseKeyList)(parsedData.d, parsedData.c);
-                        added_1 = new sets_1._Set(keyList.a);
-                        removed_1 = new sets_1._Set(keyList.r);
-                    }
-                    catch (e) {
-                        log.warn(constants_2.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, ['KeyList', e]);
-                        break;
-                    }
-                    (0, lang_1.forOwn)(clients, function (_a) {
-                        var hash64 = _a.hash64, worker = _a.worker;
-                        var add = added_1.has(hash64.dec) ? true : removed_1.has(hash64.dec) ? false : undefined;
-                        if (add !== undefined) {
-                            worker.put(parsedData.changeNumber, {
-                                name: parsedData.segmentName,
-                                add: add
-                            });
-                        }
-                    });
-                    return;
+                catch (e) {
+                    log.warn(constants_2.STREAMING_PARSING_MEMBERSHIPS_UPDATE, ['BoundedFetchRequest', e]);
+                    break;
                 }
-                case types_1.UpdateStrategy.SegmentRemoval:
-                    if (!parsedData.segmentName) {
-                        log.warn(constants_2.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, ['SegmentRemoval', 'No segment name was provided']);
-                        break;
+                (0, lang_1.forOwn)(clients, function (_a, matchingKey) {
+                    var hash64 = _a.hash64, worker = _a.worker;
+                    if ((0, parseUtils_1.isInBitmap)(bitmap_1, hash64.hex)) {
+                        worker.put(parsedData, undefined, (0, parseUtils_1.getDelay)(parsedData, matchingKey));
                     }
-                    (0, lang_1.forOwn)(clients, function (_a) {
-                        var worker = _a.worker;
-                        return worker.put(parsedData.changeNumber, {
-                            name: parsedData.segmentName,
-                            add: false
+                });
+                return;
+            }
+            case types_1.UpdateStrategy.KeyList: {
+                var keyList = void 0, added_1, removed_1;
+                try {
+                    keyList = (0, parseUtils_1.parseKeyList)(parsedData.d, parsedData.c);
+                    added_1 = new sets_1._Set(keyList.a);
+                    removed_1 = new sets_1._Set(keyList.r);
+                }
+                catch (e) {
+                    log.warn(constants_2.STREAMING_PARSING_MEMBERSHIPS_UPDATE, ['KeyList', e]);
+                    break;
+                }
+                if (!parsedData.n || !parsedData.n.length) {
+                    log.warn(constants_2.STREAMING_PARSING_MEMBERSHIPS_UPDATE, ['KeyList', 'No segment name was provided']);
+                    break;
+                }
+                (0, lang_1.forOwn)(clients, function (_a) {
+                    var hash64 = _a.hash64, worker = _a.worker;
+                    var add = added_1.has(hash64.dec) ? true : removed_1.has(hash64.dec) ? false : undefined;
+                    if (add !== undefined) {
+                        worker.put(parsedData, {
+                            added: add ? [parsedData.n[0]] : [],
+                            removed: add ? [] : [parsedData.n[0]]
                         });
-                    });
-                    return;
+                    }
+                });
+                return;
             }
-            // `UpdateStrategy.UnboundedFetchRequest` and fallbacks of other cases
-            (0, lang_1.forOwn)(clients, function (_a) {
-                var worker = _a.worker;
-                worker.put(parsedData.changeNumber);
-            });
+            case types_1.UpdateStrategy.SegmentRemoval:
+                if (!parsedData.n || !parsedData.n.length) {
+                    log.warn(constants_2.STREAMING_PARSING_MEMBERSHIPS_UPDATE, ['SegmentRemoval', 'No segment name was provided']);
+                    break;
+                }
+                (0, lang_1.forOwn)(clients, function (_a) {
+                    var worker = _a.worker;
+                    worker.put(parsedData, {
+                        added: [],
+                        removed: parsedData.n
+                    });
+                });
+                return;
+        }
+        // `UpdateStrategy.UnboundedFetchRequest` and fallbacks of other cases
+        (0, lang_1.forOwn)(clients, function (_a, matchingKey) {
+            var worker = _a.worker;
+            worker.put(parsedData, undefined, (0, parseUtils_1.getDelay)(parsedData, matchingKey));
         });
     }
+    if (userKey) {
+        pushEmitter.on(constants_1.MEMBERSHIPS_MS_UPDATE, handleMySegmentsUpdate);
+        pushEmitter.on(constants_1.MEMBERSHIPS_LS_UPDATE, handleMySegmentsUpdate);
+    }
     else {
         pushEmitter.on(constants_1.SEGMENT_UPDATE, segmentsUpdateWorker.put);
     }
@@ -303,7 +302,10 @@ function pushManagerFactory(params, pollingManager) {
             var hash = (0, AuthClient_1.hashUserKey)(userKey);
             if (!userKeyHashes[hash]) {
                 userKeyHashes[hash] = userKey;
-                clients[userKey] = { hash64: (0, murmur3_64_1.hash64)(userKey), worker: (0, MySegmentsUpdateWorker_1.MySegmentsUpdateWorker)(mySegmentsSyncTask, telemetryTracker) };
+                clients[userKey] = {
+                    hash64: (0, murmur3_64_1.hash64)(userKey),
+                    worker: (0, MySegmentsUpdateWorker_1.MySegmentsUpdateWorker)(log, storage, mySegmentsSyncTask, telemetryTracker)
+                };
                 connectForNewClient = true; // we must reconnect on start, to listen the channel for the new user key
                 // Reconnects in case of a new client.
                 // Run in next event-loop cycle to save authentication calls

package/cjs/utils/constants/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MY_SEGMENT = exports.SEGMENT = exports.TOKEN = exports.TELEMETRY = exports.EVENTS = exports.IMPRESSIONS_COUNT = exports.IMPRESSIONS = exports.SPLITS = exports.NONE_ENUM = exports.DEBUG_ENUM = exports.OPTIMIZED_ENUM = exports.CONSUMER_PARTIAL_ENUM = exports.CONSUMER_ENUM = exports.STANDALONE_ENUM = exports.DEDUPED = exports.DROPPED = exports.QUEUED = exports.NAMES_FN_LABEL = exports.SPLITS_FN_LABEL = exports.SPLIT_FN_LABEL = exports.TRACK_FN_LABEL = exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS = exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET = exports.GET_TREATMENTS_BY_FLAG_SETS = exports.GET_TREATMENTS_BY_FLAG_SET = exports.GET_TREATMENTS_WITH_CONFIG = exports.GET_TREATMENT_WITH_CONFIG = exports.GET_TREATMENTS = exports.GET_TREATMENT = exports.CONSENT_UNKNOWN = exports.CONSENT_DECLINED = exports.CONSENT_GRANTED = exports.STORAGE_PLUGGABLE = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_PARTIAL_MODE = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.NONE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
-exports.IN_SEGMENT = exports.FLAG_SPEC_VERSION = exports.PAUSED = exports.ENABLED = exports.DISABLED = exports.NON_REQUESTED = exports.REQUESTED = exports.POLLING = exports.STREAMING = exports.AUTH_REJECTION = exports.SYNC_MODE_UPDATE = exports.ABLY_ERROR = exports.TOKEN_REFRESH = exports.SSE_CONNECTION_ERROR = exports.STREAMING_STATUS = exports.OCCUPANCY_SEC = exports.OCCUPANCY_PRI = exports.CONNECTION_ESTABLISHED = exports.TRACK = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSETS = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSET = exports.TREATMENTS_BY_FLAGSETS = exports.TREATMENTS_BY_FLAGSET = exports.TREATMENTS_WITH_CONFIG = exports.TREATMENT_WITH_CONFIG = exports.TREATMENTS = exports.TREATMENT = void 0;
+exports.MEMBERSHIPS = exports.SEGMENT = exports.TOKEN = exports.TELEMETRY = exports.EVENTS = exports.IMPRESSIONS_COUNT = exports.IMPRESSIONS = exports.SPLITS = exports.NONE_ENUM = exports.DEBUG_ENUM = exports.OPTIMIZED_ENUM = exports.CONSUMER_PARTIAL_ENUM = exports.CONSUMER_ENUM = exports.STANDALONE_ENUM = exports.DEDUPED = exports.DROPPED = exports.QUEUED = exports.NAMES_FN_LABEL = exports.SPLITS_FN_LABEL = exports.SPLIT_FN_LABEL = exports.TRACK_FN_LABEL = exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SETS = exports.GET_TREATMENTS_WITH_CONFIG_BY_FLAG_SET = exports.GET_TREATMENTS_BY_FLAG_SETS = exports.GET_TREATMENTS_BY_FLAG_SET = exports.GET_TREATMENTS_WITH_CONFIG = exports.GET_TREATMENT_WITH_CONFIG = exports.GET_TREATMENTS = exports.GET_TREATMENT = exports.CONSENT_UNKNOWN = exports.CONSENT_DECLINED = exports.CONSENT_GRANTED = exports.STORAGE_PLUGGABLE = exports.STORAGE_REDIS = exports.STORAGE_LOCALSTORAGE = exports.STORAGE_MEMORY = exports.CONSUMER_PARTIAL_MODE = exports.CONSUMER_MODE = exports.PRODUCER_MODE = exports.STANDALONE_MODE = exports.LOCALHOST_MODE = exports.NONE = exports.OPTIMIZED = exports.DEBUG = exports.SPLIT_EVENT = exports.SPLIT_IMPRESSION = exports.NA = exports.UNKNOWN = exports.CONTROL_WITH_CONFIG = exports.CONTROL = void 0;
+exports.IN_LARGE_SEGMENT = exports.IN_SEGMENT = exports.FLAG_SPEC_VERSION = exports.PAUSED = exports.ENABLED = exports.DISABLED = exports.NON_REQUESTED = exports.REQUESTED = exports.POLLING = exports.STREAMING = exports.AUTH_REJECTION = exports.SYNC_MODE_UPDATE = exports.ABLY_ERROR = exports.TOKEN_REFRESH = exports.SSE_CONNECTION_ERROR = exports.STREAMING_STATUS = exports.OCCUPANCY_SEC = exports.OCCUPANCY_PRI = exports.CONNECTION_ESTABLISHED = exports.TRACK = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSETS = exports.TREATMENTS_WITH_CONFIG_BY_FLAGSET = exports.TREATMENTS_BY_FLAGSETS = exports.TREATMENTS_BY_FLAGSET = exports.TREATMENTS_WITH_CONFIG = exports.TREATMENT_WITH_CONFIG = exports.TREATMENTS = exports.TREATMENT = void 0;
 // Special treatments
 exports.CONTROL = 'control';
 exports.CONTROL_WITH_CONFIG = {
@@ -64,7 +64,7 @@ exports.EVENTS = 'ev';
 exports.TELEMETRY = 'te';
 exports.TOKEN = 'to';
 exports.SEGMENT = 'se';
-exports.MY_SEGMENT = 'ms';
+exports.MEMBERSHIPS = 'ms';
 exports.TREATMENT = 't';
 exports.TREATMENTS = 'ts';
 exports.TREATMENT_WITH_CONFIG = 'tc';
@@ -90,6 +90,7 @@ exports.NON_REQUESTED = 1;
 exports.DISABLED = 0;
 exports.ENABLED = 1;
 exports.PAUSED = 2;
-exports.FLAG_SPEC_VERSION = '1.1';
+exports.FLAG_SPEC_VERSION = '1.2';
 // Matcher types
 exports.IN_SEGMENT = 'IN_SEGMENT';
+exports.IN_LARGE_SEGMENT = 'IN_LARGE_SEGMENT';

package/cjs/utils/settingsValidation/index.js

@@ -186,10 +186,11 @@ function settingsValidation(config, validationParams) {
     var splitFiltersValidation = (0, splitFilters_1.validateSplitFilters)(log, sync.splitFilters, withDefaults.mode);
     sync.splitFilters = splitFiltersValidation.validFilters;
     sync.__splitFiltersValidation = splitFiltersValidation;
+    // ensure a valid flag spec version
     sync.flagSpecVersion = flagSpec ? flagSpec(withDefaults) : constants_1.FLAG_SPEC_VERSION;
     // ensure a valid user consent value
     // @ts-ignore, modify readonly prop
-    withDefaults.userConsent = consent(withDefaults);
+    withDefaults.userConsent = consent ? consent(withDefaults) : undefined;
     return withDefaults;
 }
 exports.settingsValidation = settingsValidation;

package/esm/evaluator/matchers/index.js

@@ -1,5 +1,6 @@
 import { allMatcherContext } from './all';
 import { segmentMatcherContext } from './segment';
+import { largeSegmentMatcherContext } from './large_segment';
 import { whitelistMatcherContext } from './whitelist';
 import { equalToMatcherContext } from './eq';
 import { greaterThanEqualMatcherContext } from './gte';
@@ -43,7 +44,8 @@ var matchers = [
     greaterThanEqualToSemverMatcherContext,
     lessThanEqualToSemverMatcherContext,
     betweenSemverMatcherContext,
-    inListSemverMatcherContext, // IN_LIST_SEMVER: 22
+    inListSemverMatcherContext,
+    largeSegmentMatcherContext, // IN_LARGE_SEGMENT: 23
 ];
 /**
  * Matcher factory.

package/esm/evaluator/matchers/large_segment.js

@@ -0,0 +1,12 @@
+import { thenable } from '../../utils/promise/thenable';
+export function largeSegmentMatcherContext(largeSegmentName, storage) {
+    return function largeSegmentMatcher(key) {
+        var isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
+        if (thenable(isInLargeSegment)) {
+            isInLargeSegment.then(function (result) {
+                return result;
+            });
+        }
+        return isInLargeSegment;
+    };
+}

package/esm/evaluator/matchers/matcherTypes.js

@@ -22,6 +22,7 @@ export var matcherTypes = {
     LESS_THAN_OR_EQUAL_TO_SEMVER: 20,
     BETWEEN_SEMVER: 21,
     IN_LIST_SEMVER: 22,
+    IN_LARGE_SEGMENT: 23,
 };
 export var matcherDataTypes = {
     BOOLEAN: 'BOOLEAN',

package/esm/evaluator/matchersTransform/index.js

@@ -9,7 +9,7 @@ import { zeroSinceHH, zeroSinceSS } from '../convertions';
  */
 export function matchersTransform(matchers) {
     var parsedMatchers = matchers.map(function (matcher) {
-        var matcherType = matcher.matcherType, negate = matcher.negate, keySelector = matcher.keySelector, userDefinedSegmentMatcherData = matcher.userDefinedSegmentMatcherData, whitelistMatcherData = matcher.whitelistMatcherData, /* whitelistObject, provided by 'WHITELIST', 'IN_LIST_SEMVER', set and string matchers */ unaryNumericMatcherData = matcher.unaryNumericMatcherData, betweenMatcherData = matcher.betweenMatcherData, dependencyMatcherData = matcher.dependencyMatcherData, booleanMatcherData = matcher.booleanMatcherData, stringMatcherData = matcher.stringMatcherData, betweenStringMatcherData = matcher.betweenStringMatcherData;
+        var matcherType = matcher.matcherType, negate = matcher.negate, keySelector = matcher.keySelector, userDefinedSegmentMatcherData = matcher.userDefinedSegmentMatcherData, userDefinedLargeSegmentMatcherData = matcher.userDefinedLargeSegmentMatcherData, whitelistMatcherData = matcher.whitelistMatcherData, /* whitelistObject, provided by 'WHITELIST', 'IN_LIST_SEMVER', set and string matchers */ unaryNumericMatcherData = matcher.unaryNumericMatcherData, betweenMatcherData = matcher.betweenMatcherData, dependencyMatcherData = matcher.dependencyMatcherData, booleanMatcherData = matcher.booleanMatcherData, stringMatcherData = matcher.stringMatcherData, betweenStringMatcherData = matcher.betweenStringMatcherData;
         var attribute = keySelector && keySelector.attribute;
         var type = matcherTypesMapper(matcherType);
         // As default input data type we use string (even for ALL_KEYS)
@@ -18,6 +18,9 @@ export function matchersTransform(matchers) {
         if (type === matcherTypes.IN_SEGMENT) {
             value = segmentTransform(userDefinedSegmentMatcherData);
         }
+        else if (type === matcherTypes.IN_LARGE_SEGMENT) {
+            value = segmentTransform(userDefinedLargeSegmentMatcherData);
+        }
         else if (type === matcherTypes.EQUAL_TO) {
             value = numericTransform(unaryNumericMatcherData);
             dataType = matcherDataTypes.NUMBER;

package/esm/evaluator/matchersTransform/segment.js

@@ -2,5 +2,7 @@
  * Extract segment name as a plain string.
  */
 export function segmentTransform(segment) {
-    return segment ? segment.segmentName : undefined;
+    return segment ?
+        segment.segmentName || segment.largeSegmentName :
+        undefined;
 }

package/esm/logger/constants.js

@@ -77,7 +77,7 @@ export var WARN_SPLITS_FILTER_IGNORED = 219;
 export var WARN_SPLITS_FILTER_INVALID = 220;
 export var WARN_SPLITS_FILTER_EMPTY = 221;
 export var WARN_SDK_KEY = 222;
-export var STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
+export var STREAMING_PARSING_MEMBERSHIPS_UPDATE = 223;
 export var STREAMING_PARSING_SPLIT_UPDATE = 224;
 export var WARN_INVALID_FLAGSET = 225;
 export var WARN_LOWERCASE_FLAGSET = 226;

package/esm/logger/messages/info.js

@@ -20,7 +20,7 @@ export var codesInfo = codesWarn.concat([
     [c.POLLING_START, c.LOG_PREFIX_SYNC_POLLING + 'Starting polling'],
     [c.POLLING_STOP, c.LOG_PREFIX_SYNC_POLLING + 'Stopping polling'],
     [c.SYNC_SPLITS_FETCH_RETRY, c.LOG_PREFIX_SYNC_SPLITS + 'Retrying download of feature flags #%s. Reason: %s'],
-    [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and reseting timer.'],
+    [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and resetting timer.'],
     [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s.'],
     [c.STREAMING_REFRESH_TOKEN, c.LOG_PREFIX_SYNC_STREAMING + 'Refreshing streaming token in %s seconds, and connecting streaming in %s seconds.'],
     [c.STREAMING_RECONNECT, c.LOG_PREFIX_SYNC_STREAMING + 'Attempting to reconnect streaming in %s seconds.'],

package/esm/logger/messages/warn.js

@@ -30,7 +30,7 @@ export var codesWarn = codesError.concat([
     [c.WARN_SPLITS_FILTER_INVALID, c.LOG_PREFIX_SETTINGS + ': feature flag filter at position %s is invalid. It must be an object with a valid filter type ("bySet", "byName" or "byPrefix") and a list of "values".'],
     [c.WARN_SPLITS_FILTER_EMPTY, c.LOG_PREFIX_SETTINGS + ': feature flag filter configuration must be a non-empty array of filter objects.'],
     [c.WARN_SDK_KEY, c.LOG_PREFIX_SETTINGS + ': You already have %s. We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'],
-    [c.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching MySegments due to an error processing %s notification: %s'],
+    [c.STREAMING_PARSING_MEMBERSHIPS_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching Memberships due to an error processing %s notification: %s'],
     [c.STREAMING_PARSING_SPLIT_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching SplitChanges due to an error processing SPLIT_UPDATE notification: %s'],
     [c.WARN_INVALID_FLAGSET, '%s: you passed %s, flag set must adhere to the regular expressions %s. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. %s was discarded.'],
     [c.WARN_LOWERCASE_FLAGSET, '%s: flag set %s should be all lowercase - converting string to lowercase.'],

package/esm/readiness/readinessManager.js

@@ -6,7 +6,7 @@ function splitsEventEmitterFactory(EventEmitter) {
         splitsCacheLoaded: false,
     });
     // `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
-    // - `/mySegments` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
+    // - `/memberships` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
     // - storage has cached splits (for which case `splitsStorage.killLocally` can return true)
     splitsEventEmitter.on(SDK_SPLITS_ARRIVED, function (isSplitKill) { if (!isSplitKill)
         splitsEventEmitter.splitsArrived = true; });
@@ -23,9 +23,9 @@ function segmentsEventEmitterFactory(EventEmitter) {
 /**
  * Factory of readiness manager, which handles the ready / update event propagation.
  */
-export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
-    if (readyTimeout === void 0) { readyTimeout = 0; }
+export function readinessManagerFactory(EventEmitter, settings, splits) {
     if (splits === void 0) { splits = splitsEventEmitterFactory(EventEmitter); }
+    var readyTimeout = settings.startup.readyTimeout;
     var segments = segmentsEventEmitterFactory(EventEmitter);
     var gate = new EventEmitter();
     var lastUpdate = 0;
@@ -103,10 +103,9 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         splits: splits,
         segments: segments,
         gate: gate,
-        shared: function (readyTimeout) {
-            if (readyTimeout === void 0) { readyTimeout = 0; }
+        shared: function () {
             refCount++;
-            return readinessManagerFactory(EventEmitter, readyTimeout, splits);
+            return readinessManagerFactory(EventEmitter, settings, splits);
         },
         // @TODO review/remove next methods when non-recoverable errors are reworked
         // Called on consumer mode, when storage fails to connect

package/esm/readiness/sdkReadinessManager.js

@@ -12,9 +12,9 @@ var REMOVE_LISTENER_EVENT = 'removeListener';
  * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
  * @param readinessManager optional readinessManager to use. only used internally for `shared` method
  */
-export function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager) {
-    if (readyTimeout === void 0) { readyTimeout = 0; }
-    if (readinessManager === void 0) { readinessManager = readinessManagerFactory(EventEmitter, readyTimeout); }
+export function sdkReadinessManagerFactory(EventEmitter, settings, readinessManager) {
+    if (readinessManager === void 0) { readinessManager = readinessManagerFactory(EventEmitter, settings); }
+    var log = settings.log;
     /** Ready callback warning */
     var internalReadyCbCount = 0;
     var readyCbCount = 0;
@@ -57,9 +57,8 @@ export function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, read
     }
     return {
         readinessManager: readinessManager,
-        shared: function (readyTimeout) {
-            if (readyTimeout === void 0) { readyTimeout = 0; }
-            return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager.shared(readyTimeout));
+        shared: function () {
+            return sdkReadinessManagerFactory(EventEmitter, settings, readinessManager.shared());
         },
         incInternalReadyCbCount: function () {
             internalReadyCbCount++;

package/esm/sdkClient/identity.js

@@ -0,0 +1,3 @@
+export function buildInstanceId(key, trafficType) {
+    return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType ? trafficType : '');
+}

package/esm/sdkClient/sdkClient.js

@@ -50,11 +50,11 @@ export function sdkClientFactory(params, isSharedClient) {
             // Stop background jobs
             syncManager && syncManager.stop();
             return __flush().then(function () {
-                // Cleanup event listeners
-                signalListener && signalListener.stop();
-                // @TODO stop only if last client is destroyed
-                if (uniqueKeysTracker)
-                    uniqueKeysTracker.stop();
+                // For main client, cleanup event listeners and scheduled jobs
+                if (!isSharedClient) {
+                    signalListener && signalListener.stop();
+                    uniqueKeysTracker && uniqueKeysTracker.stop();
+                }
                 // Cleanup storage
                 return storage.destroy();
             });