@splitsoftware/splitio-commons 2.4.2-rc.3 → 11.5.0-rc.0

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

@@ -1,124 +0,0 @@
-"use strict";
-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(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 {
-        put: function (mySegmentsData, payload, delay) {
-            updateWorkers[mySegmentsData.type].put(mySegmentsData, payload, delay);
-        },
-        stop: function () {
-            updateWorkers[constants_3.MEMBERSHIPS_MS_UPDATE].stop();
-            updateWorkers[constants_3.MEMBERSHIPS_LS_UPDATE].stop();
-        }
-    };
-}
-exports.MySegmentsUpdateWorker = MySegmentsUpdateWorker;

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

@@ -1,92 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SegmentsUpdateWorker = void 0;
-var Backoff_1 = require("../../../utils/Backoff");
-var constants_1 = require("./constants");
-/**
- * SegmentsUpdateWorker factory
- */
-function SegmentsUpdateWorker(log, segmentsSyncTask, segmentsCache) {
-    // Handles retries with CDN bypass per segment name
-    function SegmentUpdateWorker(segment) {
-        var maxChangeNumber = 0;
-        var handleNewEvent = false;
-        var isHandlingEvent;
-        var cdnBypass;
-        var backoff = new Backoff_1.Backoff(__handleSegmentUpdateCall, constants_1.FETCH_BACKOFF_BASE, constants_1.FETCH_BACKOFF_MAX_WAIT);
-        function __handleSegmentUpdateCall() {
-            isHandlingEvent = true;
-            if (maxChangeNumber > (segmentsCache.getChangeNumber(segment) || -1)) {
-                handleNewEvent = false;
-                // fetch segments revalidating data if cached
-                segmentsSyncTask.execute(false, segment, true, cdnBypass ? maxChangeNumber : undefined).then(function () {
-                    if (!isHandlingEvent)
-                        return; // halt if `stop` has been called
-                    if (handleNewEvent) {
-                        __handleSegmentUpdateCall();
-                    }
-                    else {
-                        var attempts = backoff.attempts + 1;
-                        if (maxChangeNumber <= (segmentsCache.getChangeNumber(segment) || -1)) {
-                            log.debug("Refresh completed" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
-                            isHandlingEvent = false;
-                            return;
-                        }
-                        if (attempts < constants_1.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;
-                            __handleSegmentUpdateCall();
-                        }
-                    }
-                });
-            }
-            else {
-                isHandlingEvent = false;
-            }
-        }
-        return {
-            put: function (changeNumber) {
-                var currentChangeNumber = segmentsCache.getChangeNumber(segment) || -1;
-                if (changeNumber <= currentChangeNumber || changeNumber <= maxChangeNumber)
-                    return;
-                maxChangeNumber = changeNumber;
-                handleNewEvent = true;
-                cdnBypass = false;
-                if (backoff.timeoutID || !isHandlingEvent)
-                    __handleSegmentUpdateCall();
-                backoff.reset();
-            },
-            stop: function () {
-                isHandlingEvent = false;
-                backoff.reset();
-            }
-        };
-    }
-    var segments = {};
-    return {
-        /**
-         * Invoked by NotificationProcessor on SEGMENT_UPDATE event
-         *
-         * @param changeNumber - change number of the SEGMENT_UPDATE notification
-         * @param segmentName - segment name of the SEGMENT_UPDATE notification
-         */
-        put: function (_a) {
-            var changeNumber = _a.changeNumber, segmentName = _a.segmentName;
-            if (!segments[segmentName])
-                segments[segmentName] = SegmentUpdateWorker(segmentName);
-            segments[segmentName].put(changeNumber);
-        },
-        stop: function () {
-            Object.keys(segments).forEach(function (segmentName) { return segments[segmentName].stop(); });
-        }
-    };
-}
-exports.SegmentsUpdateWorker = SegmentsUpdateWorker;

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

@@ -1,136 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SplitsUpdateWorker = void 0;
-var constants_1 = require("../../../logger/constants");
-var constants_2 = require("../../../readiness/constants");
-var Backoff_1 = require("../../../utils/Backoff");
-var constants_3 = require("../../../utils/constants");
-var constants_4 = require("../constants");
-var parseUtils_1 = require("../parseUtils");
-var constants_5 = require("./constants");
-/**
- * SplitsUpdateWorker factory
- */
-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(__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
-                splitsSyncTask.execute(true, cdnBypass ? maxChangeNumber : undefined, instantUpdate).then(function () {
-                    if (!isHandlingEvent)
-                        return; // halt if `stop` has been called
-                    if (handleNewEvent) {
-                        __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" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
-                            isHandlingEvent = false;
-                            return;
-                        }
-                        if (attempts < constants_5.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;
-                            __handleSplitUpdateCall();
-                        }
-                    }
-                });
-            }
-            else {
-                isHandlingEvent = false;
-            }
-        }
-        return {
-            /**
-             * Invoked by NotificationProcessor on SPLIT_UPDATE or RB_SEGMENT_UPDATE event
-             *
-             * @param changeNumber - change number of the notification
-             */
-            put: function (_a, payload) {
-                var changeNumber = _a.changeNumber, pcn = _a.pcn, type = _a.type;
-                var currentChangeNumber = cache.getChangeNumber();
-                if (changeNumber <= currentChangeNumber || changeNumber <= maxChangeNumber)
-                    return;
-                maxChangeNumber = changeNumber;
-                handleNewEvent = true;
-                cdnBypass = false;
-                instantUpdate = undefined;
-                if (payload && currentChangeNumber === pcn) {
-                    instantUpdate = { payload: payload, changeNumber: changeNumber, type: type };
-                }
-                if (backoff.timeoutID || !isHandlingEvent)
-                    __handleSplitUpdateCall();
-                backoff.reset();
-            },
-            stop: function () {
-                isHandlingEvent = false;
-                backoff.reset();
-            },
-            isSync: function () {
-                return maxChangeNumber <= cache.getChangeNumber();
-            }
-        };
-    }
-    return {
-        put: function (parsedData) {
-            if (parsedData.d && parsedData.c !== undefined) {
-                try {
-                    var payload = (0, parseUtils_1.parseFFUpdatePayload)(parsedData.c, parsedData.d);
-                    if (payload) {
-                        (parsedData.type === constants_4.RB_SEGMENT_UPDATE ? rbs : ff).put(parsedData, payload);
-                        return;
-                    }
-                }
-                catch (e) {
-                    log.warn(constants_1.STREAMING_PARSING_SPLIT_UPDATE, [parsedData.type, e]);
-                }
-            }
-            (parsedData.type === constants_4.RB_SEGMENT_UPDATE ? rbs : ff).put(parsedData);
-        },
-        /**
-         * Invoked by NotificationProcessor on SPLIT_KILL event
-         *
-         * @param changeNumber - change number of the notification
-         * @param splitName - name of split to kill
-         * @param defaultTreatment - default treatment value
-         */
-        killSplit: function (_a) {
-            var changeNumber = _a.changeNumber, splitName = _a.splitName, defaultTreatment = _a.defaultTreatment;
-            if (storage.splits.killLocally(splitName, defaultTreatment, changeNumber)) {
-                // trigger an SDK_UPDATE if Split was killed locally
-                splitsEventEmitter.emit(constants_2.SDK_SPLITS_ARRIVED, true);
-            }
-            // queues the SplitChanges fetch (only if changeNumber is newer)
-            ff.put({ changeNumber: changeNumber });
-        },
-        stop: function () {
-            ff.stop();
-            rbs.stop();
-        }
-    };
-}
-exports.SplitsUpdateWorker = SplitsUpdateWorker;

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

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FETCH_BACKOFF_MAX_RETRIES = exports.FETCH_BACKOFF_MAX_WAIT = exports.FETCH_BACKOFF_BASE = void 0;
-exports.FETCH_BACKOFF_BASE = 10000; // backoff base starting at 10 seconds
-exports.FETCH_BACKOFF_MAX_WAIT = 60000; // don't wait for more than 1 minute
-exports.FETCH_BACKOFF_MAX_RETRIES = 10; // max retries

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

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/sync/streaming/constants.js

@@ -1,43 +0,0 @@
-"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_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
-/**
- * emitted on SSE and Authenticate non-recoverable errors, STREAMING_DISABLED control notification and authentication with pushEnabled false
- * triggers `handleNonRetryableError` call
- */
-exports.PUSH_NONRETRYABLE_ERROR = 'PUSH_NONRETRYABLE_ERROR';
-/**
- * emitted on SSE and Authenticate recoverable errors
- * triggers `handleRetryableError` call
- */
-exports.PUSH_RETRYABLE_ERROR = 'PUSH_RETRYABLE_ERROR';
-/**
- * emitted on STREAMING_RESUMED control notification, OCCUPANCY different than 0, and SSE onopen event
- * triggers `stopPollingAndSyncAll` call
- */
-exports.PUSH_SUBSYSTEM_UP = 'PUSH_SUBSYSTEM_UP';
-/**
- * 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';
-// Update-type push notifications, handled by NotificationProcessor
-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';
-exports.RB_SEGMENT_UPDATE = 'RB_SEGMENT_UPDATE';
-// Control-type push notifications, handled by NotificationKeeper
-exports.CONTROL = 'CONTROL';
-exports.OCCUPANCY = 'OCCUPANCY';
-var ControlType;
-(function (ControlType) {
-    ControlType["STREAMING_DISABLED"] = "STREAMING_DISABLED";
-    ControlType["STREAMING_PAUSED"] = "STREAMING_PAUSED";
-    ControlType["STREAMING_RESUMED"] = "STREAMING_RESUMED";
-    ControlType["STREAMING_RESET"] = "STREAMING_RESET";
-})(ControlType = exports.ControlType || (exports.ControlType = {}));

package/cjs/sync/streaming/parseUtils.js

@@ -1,98 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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) {
-    return String.fromCharCode.apply(null, myUint8Arr);
-}
-function StringToUint8Array(myString) {
-    var charCodes = myString.split('').map(function (e) { return e.charCodeAt(0); });
-    return new Uint8Array(charCodes);
-}
-/**
- * Decode and decompress 'data' with 'compression' algorithm
- *
- * @param data - base64 encoded string
- * @param compression - 1 GZIP, 2 ZLIB
- * @returns
- * @throws if data string cannot be decoded, decompressed or the provided compression value is invalid (not 1 or 2)
- */
-function decompress(data, compression) {
-    var compressData = (0, base64_1.decodeFromBase64)(data);
-    var binData = StringToUint8Array(compressData);
-    if (typeof decompress_1.algorithms === 'string')
-        throw new Error(decompress_1.algorithms);
-    if (compression === GZIP)
-        return decompress_1.algorithms.gunzipSync(binData);
-    if (compression === ZLIB)
-        return decompress_1.algorithms.unzlibSync(binData);
-    throw new Error("Invalid compression algorithm #" + compression);
-}
-/**
- * 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 keyList
- * @throws if data string cannot be decoded, decompressed or parsed
- */
-function parseKeyList(data, compression, avoidPrecisionLoss) {
-    if (avoidPrecisionLoss === void 0) { avoidPrecisionLoss = true; }
-    var binKeyList = decompress(data, compression);
-    var strKeyList = Uint8ArrayToString(binKeyList);
-    // replace numbers to strings, to avoid losing precision
-    if (avoidPrecisionLoss)
-        strKeyList = strKeyList.replace(/\d+/g, '"$&"');
-    return JSON.parse(strKeyList);
-}
-exports.parseKeyList = parseKeyList;
-/**
- * Decode, decompress and parse the provided 'data' into a Bitmap object
- *
- * @param data - base64 encoded string
- * @param compression - 1 GZIP, 2 ZLIB
- * @returns Bitmap
- * @throws if data string cannot be decoded or decompressed
- */
-function parseBitmap(data, compression) {
-    return decompress(data, compression);
-}
-exports.parseBitmap = parseBitmap;
-/**
- * Check if the 'bitmap' bit at 'hash64hex' position is 1
- *
- * @param bitmap - Uint8Array bitmap
- * @param hash64hex - 16-chars string, representing a number in hexa
- * @returns whether the provided 'hash64hex' index is set in the bitmap
- */
-function isInBitmap(bitmap, hash64hex) {
-    // using the lowest 32 bits as index, to avoid losing precision when converting to number
-    var index = parseInt(hash64hex.slice(8), 16) % (bitmap.length * 8);
-    var internal = Math.floor(index / 8);
-    var offset = index % 8;
-    return (bitmap[internal] & 1 << offset) > 0;
-}
-exports.isInBitmap = isInBitmap;
-/**
- * Parse feature flags notifications for instant feature flag updates
- */
-function parseFFUpdatePayload(compression, 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;