@splitsoftware/splitio-commons 2.3.0 → 2.4.0

package/cjs/storages/inLocalStorage/RBSegmentsCacheInLocal.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RBSegmentsCacheInLocal = void 0;
+var lang_1 = require("../../utils/lang");
+var sets_1 = require("../../utils/lang/sets");
+var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
+var constants_1 = require("./constants");
+var RBSegmentsCacheInLocal = /** @class */ (function () {
+    function RBSegmentsCacheInLocal(settings, keys) {
+        this.keys = keys;
+        this.log = settings.log;
+    }
+    RBSegmentsCacheInLocal.prototype.clear = function () {
+        var _this = this;
+        this.getNames().forEach(function (name) { return _this.remove(name); });
+        localStorage.removeItem(this.keys.buildRBSegmentsTillKey());
+    };
+    RBSegmentsCacheInLocal.prototype.update = function (toAdd, toRemove, changeNumber) {
+        var _this = this;
+        this.setChangeNumber(changeNumber);
+        var updated = toAdd.map(function (toAdd) { return _this.add(toAdd); }).some(function (result) { return result; });
+        return toRemove.map(function (toRemove) { return _this.remove(toRemove.name); }).some(function (result) { return result; }) || updated;
+    };
+    RBSegmentsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
+        try {
+            localStorage.setItem(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
+            localStorage.setItem(this.keys.buildLastUpdatedKey(), Date.now() + '');
+        }
+        catch (e) {
+            this.log.error(constants_1.LOG_PREFIX + e);
+        }
+    };
+    RBSegmentsCacheInLocal.prototype.updateSegmentCount = function (diff) {
+        var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
+        var count = (0, lang_1.toNumber)(localStorage.getItem(segmentsCountKey)) + diff;
+        // @ts-expect-error
+        if (count > 0)
+            localStorage.setItem(segmentsCountKey, count);
+        else
+            localStorage.removeItem(segmentsCountKey);
+    };
+    RBSegmentsCacheInLocal.prototype.add = function (rbSegment) {
+        try {
+            var name_1 = rbSegment.name;
+            var rbSegmentKey = this.keys.buildRBSegmentKey(name_1);
+            var rbSegmentFromLocalStorage = localStorage.getItem(rbSegmentKey);
+            var previous = rbSegmentFromLocalStorage ? JSON.parse(rbSegmentFromLocalStorage) : null;
+            localStorage.setItem(rbSegmentKey, JSON.stringify(rbSegment));
+            var usesSegmentsDiff = 0;
+            if (previous && (0, AbstractSplitsCacheSync_1.usesSegments)(previous))
+                usesSegmentsDiff--;
+            if ((0, AbstractSplitsCacheSync_1.usesSegments)(rbSegment))
+                usesSegmentsDiff++;
+            if (usesSegmentsDiff !== 0)
+                this.updateSegmentCount(usesSegmentsDiff);
+            return true;
+        }
+        catch (e) {
+            this.log.error(constants_1.LOG_PREFIX + e);
+            return false;
+        }
+    };
+    RBSegmentsCacheInLocal.prototype.remove = function (name) {
+        try {
+            var rbSegment = this.get(name);
+            if (!rbSegment)
+                return false;
+            localStorage.removeItem(this.keys.buildRBSegmentKey(name));
+            if ((0, AbstractSplitsCacheSync_1.usesSegments)(rbSegment))
+                this.updateSegmentCount(-1);
+            return true;
+        }
+        catch (e) {
+            this.log.error(constants_1.LOG_PREFIX + e);
+            return false;
+        }
+    };
+    RBSegmentsCacheInLocal.prototype.getNames = function () {
+        var len = localStorage.length;
+        var accum = [];
+        var cur = 0;
+        while (cur < len) {
+            var key = localStorage.key(cur);
+            if (key != null && this.keys.isRBSegmentKey(key))
+                accum.push(this.keys.extractKey(key));
+            cur++;
+        }
+        return accum;
+    };
+    RBSegmentsCacheInLocal.prototype.get = function (name) {
+        var item = localStorage.getItem(this.keys.buildRBSegmentKey(name));
+        return item && JSON.parse(item);
+    };
+    RBSegmentsCacheInLocal.prototype.contains = function (names) {
+        var namesArray = (0, sets_1.setToArray)(names);
+        var namesInStorage = this.getNames();
+        return namesArray.every(function (name) { return namesInStorage.indexOf(name) !== -1; });
+    };
+    RBSegmentsCacheInLocal.prototype.getChangeNumber = function () {
+        var n = -1;
+        var value = localStorage.getItem(this.keys.buildRBSegmentsTillKey());
+        if (value !== null) {
+            value = parseInt(value, 10);
+            return (0, lang_1.isNaNNumber)(value) ? n : value;
+        }
+        return n;
+    };
+    RBSegmentsCacheInLocal.prototype.usesSegments = function () {
+        var storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
+        var splitsWithSegmentsCount = storedCount === null ? 0 : (0, lang_1.toNumber)(storedCount);
+        return (0, lang_1.isFiniteNumber)(splitsWithSegmentsCount) ?
+            splitsWithSegmentsCount > 0 :
+            true;
+    };
+    return RBSegmentsCacheInLocal;
+}());
+exports.RBSegmentsCacheInLocal = RBSegmentsCacheInLocal;

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -41,15 +41,13 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     };
     SplitsCacheInLocal.prototype._incrementCounts = function (split) {
         try {
-            if (split) {
-                var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
+            var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
+            // @ts-expect-error
+            localStorage.setItem(ttKey, (0, lang_1.toNumber)(localStorage.getItem(ttKey)) + 1);
+            if ((0, AbstractSplitsCacheSync_1.usesSegments)(split)) {
+                var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
                 // @ts-expect-error
-                localStorage.setItem(ttKey, (0, lang_1.toNumber)(localStorage.getItem(ttKey)) + 1);
-                if ((0, AbstractSplitsCacheSync_1.usesSegments)(split)) {
-                    var segmentsCountKey = this.keys.buildSplitsWithSegmentCountKey();
-                    // @ts-expect-error
-                    localStorage.setItem(segmentsCountKey, (0, lang_1.toNumber)(localStorage.getItem(segmentsCountKey)) + 1);
-                }
+                localStorage.setItem(segmentsCountKey, (0, lang_1.toNumber)(localStorage.getItem(segmentsCountKey)) + 1);
             }
         }
         catch (e) {
@@ -158,12 +156,9 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
             return true;
         var storedCount = localStorage.getItem(this.keys.buildSplitsWithSegmentCountKey());
         var splitsWithSegmentsCount = storedCount === null ? 0 : (0, lang_1.toNumber)(storedCount);
-        if ((0, lang_1.isFiniteNumber)(splitsWithSegmentsCount)) {
-            return splitsWithSegmentsCount > 0;
-        }
-        else {
-            return true;
-        }
+        return (0, lang_1.isFiniteNumber)(splitsWithSegmentsCount) ?
+            splitsWithSegmentsCount > 0 :
+            true;
     };
     SplitsCacheInLocal.prototype.getNamesByFlagSets = function (flagSets) {
         var _this = this;

package/cjs/storages/inLocalStorage/index.js

@@ -8,6 +8,7 @@ var KeyBuilder_1 = require("../KeyBuilder");
 var KeyBuilderCS_1 = require("../KeyBuilderCS");
 var isLocalStorageAvailable_1 = require("../../utils/env/isLocalStorageAvailable");
 var SplitsCacheInLocal_1 = require("./SplitsCacheInLocal");
+var RBSegmentsCacheInLocal_1 = require("./RBSegmentsCacheInLocal");
 var MySegmentsCacheInLocal_1 = require("./MySegmentsCacheInLocal");
 var InMemoryStorageCS_1 = require("../inMemory/InMemoryStorageCS");
 var constants_1 = require("./constants");
@@ -32,10 +33,12 @@ function InLocalStorage(options) {
         var matchingKey = (0, key_1.getMatching)(settings.core.key);
         var keys = new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey);
         var splits = new SplitsCacheInLocal_1.SplitsCacheInLocal(settings, keys);
+        var rbSegments = new RBSegmentsCacheInLocal_1.RBSegmentsCacheInLocal(settings, keys);
         var segments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, keys);
         var largeSegments = new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey));
         return {
             splits: splits,
+            rbSegments: rbSegments,
             segments: segments,
             largeSegments: largeSegments,
             impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(impressionsQueueSize),
@@ -44,13 +47,14 @@ function InLocalStorage(options) {
             telemetry: (0, TelemetryCacheInMemory_1.shouldRecordTelemetry)(params) ? new TelemetryCacheInMemory_1.TelemetryCacheInMemory(splits, segments) : undefined,
             uniqueKeys: new UniqueKeysCacheInMemoryCS_1.UniqueKeysCacheInMemoryCS(),
             validateCache: function () {
-                return (0, validateCache_1.validateCache)(options, settings, keys, splits, segments, largeSegments);
+                return (0, validateCache_1.validateCache)(options, settings, keys, splits, rbSegments, segments, largeSegments);
             },
             destroy: function () { },
             // When using shared instantiation with MEMORY we reuse everything but segments (they are customer per key).
             shared: function (matchingKey) {
                 return {
                     splits: this.splits,
+                    rbSegments: this.rbSegments,
                     segments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, new KeyBuilderCS_1.KeyBuilderCS(prefix, matchingKey)),
                     largeSegments: new MySegmentsCacheInLocal_1.MySegmentsCacheInLocal(log, (0, KeyBuilderCS_1.myLargeSegmentsKeyBuilder)(prefix, matchingKey)),
                     impressions: this.impressions,

package/cjs/storages/inLocalStorage/validateCache.js

@@ -57,11 +57,12 @@ function validateExpiration(options, settings, keys, currentTimestamp, isThereCa
  *
  * @returns `true` if cache is ready to be used, `false` otherwise (cache was cleared or there is no cache)
  */
-function validateCache(options, settings, keys, splits, segments, largeSegments) {
+function validateCache(options, settings, keys, splits, rbSegments, segments, largeSegments) {
     var currentTimestamp = Date.now();
     var isThereCache = splits.getChangeNumber() > -1;
     if (validateExpiration(options, settings, keys, currentTimestamp, isThereCache)) {
         splits.clear();
+        rbSegments.clear();
         segments.clear();
         largeSegments.clear();
         // Update last clear timestamp

package/cjs/storages/inMemory/InMemoryStorage.js

@@ -9,6 +9,7 @@ var ImpressionCountsCacheInMemory_1 = require("./ImpressionCountsCacheInMemory")
 var constants_1 = require("../../utils/constants");
 var TelemetryCacheInMemory_1 = require("./TelemetryCacheInMemory");
 var UniqueKeysCacheInMemory_1 = require("./UniqueKeysCacheInMemory");
+var RBSegmentsCacheInMemory_1 = require("./RBSegmentsCacheInMemory");
 /**
  * InMemory storage factory for standalone server-side SplitFactory
  *
@@ -17,9 +18,11 @@ var UniqueKeysCacheInMemory_1 = require("./UniqueKeysCacheInMemory");
 function InMemoryStorageFactory(params) {
     var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, __splitFiltersValidation = _a.sync.__splitFiltersValidation;
     var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
+    var rbSegments = new RBSegmentsCacheInMemory_1.RBSegmentsCacheInMemory();
     var segments = new SegmentsCacheInMemory_1.SegmentsCacheInMemory();
     var storage = {
         splits: splits,
+        rbSegments: rbSegments,
         segments: segments,
         impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(impressionsQueueSize),
         impressionCounts: new ImpressionCountsCacheInMemory_1.ImpressionCountsCacheInMemory(),

package/cjs/storages/inMemory/InMemoryStorageCS.js

@@ -9,6 +9,7 @@ var ImpressionCountsCacheInMemory_1 = require("./ImpressionCountsCacheInMemory")
 var constants_1 = require("../../utils/constants");
 var TelemetryCacheInMemory_1 = require("./TelemetryCacheInMemory");
 var UniqueKeysCacheInMemoryCS_1 = require("./UniqueKeysCacheInMemoryCS");
+var RBSegmentsCacheInMemory_1 = require("./RBSegmentsCacheInMemory");
 /**
  * InMemory storage factory for standalone client-side SplitFactory
  *
@@ -17,10 +18,12 @@ var UniqueKeysCacheInMemoryCS_1 = require("./UniqueKeysCacheInMemoryCS");
 function InMemoryStorageCSFactory(params) {
     var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, __splitFiltersValidation = _a.sync.__splitFiltersValidation;
     var splits = new SplitsCacheInMemory_1.SplitsCacheInMemory(__splitFiltersValidation);
+    var rbSegments = new RBSegmentsCacheInMemory_1.RBSegmentsCacheInMemory();
     var segments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
     var largeSegments = new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory();
     var storage = {
         splits: splits,
+        rbSegments: rbSegments,
         segments: segments,
         largeSegments: largeSegments,
         impressions: new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(impressionsQueueSize),
@@ -33,6 +36,7 @@ function InMemoryStorageCSFactory(params) {
         shared: function () {
             return {
                 splits: this.splits,
+                rbSegments: this.rbSegments,
                 segments: new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory(),
                 largeSegments: new MySegmentsCacheInMemory_1.MySegmentsCacheInMemory(),
                 impressions: this.impressions,

package/cjs/storages/inMemory/RBSegmentsCacheInMemory.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RBSegmentsCacheInMemory = void 0;
+var sets_1 = require("../../utils/lang/sets");
+var AbstractSplitsCacheSync_1 = require("../AbstractSplitsCacheSync");
+var RBSegmentsCacheInMemory = /** @class */ (function () {
+    function RBSegmentsCacheInMemory() {
+        this.cache = {};
+        this.changeNumber = -1;
+        this.segmentsCount = 0;
+    }
+    RBSegmentsCacheInMemory.prototype.clear = function () {
+        this.cache = {};
+        this.changeNumber = -1;
+        this.segmentsCount = 0;
+    };
+    RBSegmentsCacheInMemory.prototype.update = function (toAdd, toRemove, changeNumber) {
+        var _this = this;
+        this.changeNumber = changeNumber;
+        var updated = toAdd.map(function (toAdd) { return _this.add(toAdd); }).some(function (result) { return result; });
+        return toRemove.map(function (toRemove) { return _this.remove(toRemove.name); }).some(function (result) { return result; }) || updated;
+    };
+    RBSegmentsCacheInMemory.prototype.add = function (rbSegment) {
+        var name = rbSegment.name;
+        var previous = this.get(name);
+        if (previous && (0, AbstractSplitsCacheSync_1.usesSegments)(previous))
+            this.segmentsCount--;
+        this.cache[name] = rbSegment;
+        if ((0, AbstractSplitsCacheSync_1.usesSegments)(rbSegment))
+            this.segmentsCount++;
+        return true;
+    };
+    RBSegmentsCacheInMemory.prototype.remove = function (name) {
+        var rbSegment = this.get(name);
+        if (!rbSegment)
+            return false;
+        delete this.cache[name];
+        if ((0, AbstractSplitsCacheSync_1.usesSegments)(rbSegment))
+            this.segmentsCount--;
+        return true;
+    };
+    RBSegmentsCacheInMemory.prototype.getNames = function () {
+        return Object.keys(this.cache);
+    };
+    RBSegmentsCacheInMemory.prototype.get = function (name) {
+        return this.cache[name] || null;
+    };
+    RBSegmentsCacheInMemory.prototype.contains = function (names) {
+        var namesArray = (0, sets_1.setToArray)(names);
+        var namesInStorage = this.getNames();
+        return namesArray.every(function (name) { return namesInStorage.indexOf(name) !== -1; });
+    };
+    RBSegmentsCacheInMemory.prototype.getChangeNumber = function () {
+        return this.changeNumber;
+    };
+    RBSegmentsCacheInMemory.prototype.usesSegments = function () {
+        return this.segmentsCount > 0;
+    };
+    return RBSegmentsCacheInMemory;
+}());
+exports.RBSegmentsCacheInMemory = RBSegmentsCacheInMemory;

package/cjs/storages/inMemory/SplitsCacheInMemory.js

@@ -24,6 +24,7 @@ var SplitsCacheInMemory = /** @class */ (function (_super) {
         this.ttCache = {};
         this.changeNumber = -1;
         this.segmentsCount = 0;
+        this.flagSetsCache = {};
     };
     SplitsCacheInMemory.prototype.addSplit = function (split) {
         var name = split.name;

package/cjs/storages/inRedis/RBSegmentsCacheInRedis.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RBSegmentsCacheInRedis = void 0;
+var lang_1 = require("../../utils/lang");
+var constants_1 = require("./constants");
+var sets_1 = require("../../utils/lang/sets");
+var RBSegmentsCacheInRedis = /** @class */ (function () {
+    function RBSegmentsCacheInRedis(log, keys, redis) {
+        this.log = log;
+        this.keys = keys;
+        this.redis = redis;
+    }
+    RBSegmentsCacheInRedis.prototype.get = function (name) {
+        return this.redis.get(this.keys.buildRBSegmentKey(name))
+            .then(function (maybeRBSegment) { return maybeRBSegment && JSON.parse(maybeRBSegment); });
+    };
+    RBSegmentsCacheInRedis.prototype.getNames = function () {
+        var _this = this;
+        return this.redis.keys(this.keys.searchPatternForRBSegmentKeys()).then(function (listOfKeys) { return listOfKeys.map(_this.keys.extractKey); });
+    };
+    RBSegmentsCacheInRedis.prototype.contains = function (names) {
+        var namesArray = (0, sets_1.setToArray)(names);
+        return this.getNames().then(function (namesInStorage) {
+            return namesArray.every(function (name) { return namesInStorage.includes(name); });
+        });
+    };
+    RBSegmentsCacheInRedis.prototype.update = function (toAdd, toRemove, changeNumber) {
+        var _this = this;
+        return Promise.all([
+            this.setChangeNumber(changeNumber),
+            Promise.all(toAdd.map(function (toAdd) {
+                var key = _this.keys.buildRBSegmentKey(toAdd.name);
+                var stringifiedNewRBSegment = JSON.stringify(toAdd);
+                return _this.redis.set(key, stringifiedNewRBSegment).then(function () { return true; });
+            })),
+            Promise.all(toRemove.map(function (toRemove) {
+                var key = _this.keys.buildRBSegmentKey(toRemove.name);
+                return _this.redis.del(key).then(function (status) { return status === 1; });
+            }))
+        ]).then(function (_a) {
+            var added = _a[1], removed = _a[2];
+            return added.some(function (result) { return result; }) || removed.some(function (result) { return result; });
+        });
+    };
+    RBSegmentsCacheInRedis.prototype.setChangeNumber = function (changeNumber) {
+        return this.redis.set(this.keys.buildRBSegmentsTillKey(), changeNumber + '').then(function (status) { return status === 'OK'; });
+    };
+    RBSegmentsCacheInRedis.prototype.getChangeNumber = function () {
+        var _this = this;
+        return this.redis.get(this.keys.buildRBSegmentsTillKey()).then(function (value) {
+            var i = parseInt(value, 10);
+            return (0, lang_1.isNaNNumber)(i) ? -1 : i;
+        }).catch(function (e) {
+            _this.log.error(constants_1.LOG_PREFIX + 'Could not retrieve changeNumber from storage. Error: ' + e);
+            return -1;
+        });
+    };
+    // @TODO implement if required by DataLoader or producer mode
+    RBSegmentsCacheInRedis.prototype.clear = function () {
+        return Promise.resolve();
+    };
+    return RBSegmentsCacheInRedis;
+}());
+exports.RBSegmentsCacheInRedis = RBSegmentsCacheInRedis;

package/cjs/storages/inRedis/index.js

@@ -12,6 +12,7 @@ var TelemetryCacheInRedis_1 = require("./TelemetryCacheInRedis");
 var UniqueKeysCacheInRedis_1 = require("./UniqueKeysCacheInRedis");
 var ImpressionCountsCacheInRedis_1 = require("./ImpressionCountsCacheInRedis");
 var utils_1 = require("../utils");
+var RBSegmentsCacheInRedis_1 = require("./RBSegmentsCacheInRedis");
 var RD;
 try {
     // Using `require` to prevent error when bundling or importing the SDK in a .mjs file, since ioredis is a CommonJS module.
@@ -48,6 +49,7 @@ function InRedisStorage(options) {
         });
         return {
             splits: new SplitsCacheInRedis_1.SplitsCacheInRedis(log, keys, redisClient, settings.sync.__splitFiltersValidation),
+            rbSegments: new RBSegmentsCacheInRedis_1.RBSegmentsCacheInRedis(log, keys, redisClient),
             segments: new SegmentsCacheInRedis_1.SegmentsCacheInRedis(log, keys, redisClient),
             impressions: new ImpressionsCacheInRedis_1.ImpressionsCacheInRedis(log, keys.buildImpressionsKey(), redisClient, metadata),
             impressionCounts: impressionCountsCache,

package/cjs/storages/pluggable/RBSegmentsCachePluggable.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RBSegmentsCachePluggable = void 0;
+var lang_1 = require("../../utils/lang");
+var constants_1 = require("./constants");
+var sets_1 = require("../../utils/lang/sets");
+var RBSegmentsCachePluggable = /** @class */ (function () {
+    function RBSegmentsCachePluggable(log, keys, wrapper) {
+        this.log = log;
+        this.keys = keys;
+        this.wrapper = wrapper;
+    }
+    RBSegmentsCachePluggable.prototype.get = function (name) {
+        return this.wrapper.get(this.keys.buildRBSegmentKey(name))
+            .then(function (maybeRBSegment) { return maybeRBSegment && JSON.parse(maybeRBSegment); });
+    };
+    RBSegmentsCachePluggable.prototype.getNames = function () {
+        var _this = this;
+        return this.wrapper.getKeysByPrefix(this.keys.buildRBSegmentKeyPrefix()).then(function (listOfKeys) { return listOfKeys.map(_this.keys.extractKey); });
+    };
+    RBSegmentsCachePluggable.prototype.contains = function (names) {
+        var namesArray = (0, sets_1.setToArray)(names);
+        return this.getNames().then(function (namesInStorage) {
+            return namesArray.every(function (name) { return namesInStorage.includes(name); });
+        });
+    };
+    RBSegmentsCachePluggable.prototype.update = function (toAdd, toRemove, changeNumber) {
+        var _this = this;
+        return Promise.all([
+            this.setChangeNumber(changeNumber),
+            Promise.all(toAdd.map(function (toAdd) {
+                var key = _this.keys.buildRBSegmentKey(toAdd.name);
+                var stringifiedNewRBSegment = JSON.stringify(toAdd);
+                return _this.wrapper.set(key, stringifiedNewRBSegment).then(function () { return true; });
+            })),
+            Promise.all(toRemove.map(function (toRemove) {
+                var key = _this.keys.buildRBSegmentKey(toRemove.name);
+                return _this.wrapper.del(key);
+            }))
+        ]).then(function (_a) {
+            var added = _a[1], removed = _a[2];
+            return added.some(function (result) { return result; }) || removed.some(function (result) { return result; });
+        });
+    };
+    RBSegmentsCachePluggable.prototype.setChangeNumber = function (changeNumber) {
+        return this.wrapper.set(this.keys.buildRBSegmentsTillKey(), changeNumber + '');
+    };
+    RBSegmentsCachePluggable.prototype.getChangeNumber = function () {
+        var _this = this;
+        return this.wrapper.get(this.keys.buildRBSegmentsTillKey()).then(function (value) {
+            var i = parseInt(value, 10);
+            return (0, lang_1.isNaNNumber)(i) ? -1 : i;
+        }).catch(function (e) {
+            _this.log.error(constants_1.LOG_PREFIX + 'Could not retrieve changeNumber from storage. Error: ' + e);
+            return -1;
+        });
+    };
+    // @TODO implement if required by DataLoader or producer mode
+    RBSegmentsCachePluggable.prototype.clear = function () {
+        return Promise.resolve();
+    };
+    return RBSegmentsCachePluggable;
+}());
+exports.RBSegmentsCachePluggable = RBSegmentsCachePluggable;

package/cjs/storages/pluggable/index.js

@@ -22,6 +22,7 @@ var UniqueKeysCacheInMemory_1 = require("../inMemory/UniqueKeysCacheInMemory");
 var UniqueKeysCacheInMemoryCS_1 = require("../inMemory/UniqueKeysCacheInMemoryCS");
 var utils_1 = require("../utils");
 var constants_2 = require("../pluggable/constants");
+var RBSegmentsCachePluggable_1 = require("./RBSegmentsCachePluggable");
 var NO_VALID_WRAPPER = 'Expecting pluggable storage `wrapper` in options, but no valid wrapper instance was provided.';
 var NO_VALID_WRAPPER_INTERFACE = 'The provided wrapper instance doesn’t follow the expected interface. Check our docs.';
 /**
@@ -105,6 +106,7 @@ function PluggableStorage(options) {
         });
         return {
             splits: new SplitsCachePluggable_1.SplitsCachePluggable(log, keys, wrapper, settings.sync.__splitFiltersValidation),
+            rbSegments: new RBSegmentsCachePluggable_1.RBSegmentsCachePluggable(log, keys, wrapper),
             segments: new SegmentsCachePluggable_1.SegmentsCachePluggable(log, keys, wrapper),
             impressions: isPartialConsumer ? new ImpressionsCacheInMemory_1.ImpressionsCacheInMemory(impressionsQueueSize) : new ImpressionsCachePluggable_1.ImpressionsCachePluggable(log, keys.buildImpressionsKey(), wrapper, metadata),
             impressionCounts: impressionCountsCache,

package/cjs/sync/polling/fetchers/splitChangesFetcher.js

@@ -1,18 +1,68 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.splitChangesFetcherFactory = void 0;
+var constants_1 = require("../../../utils/constants");
+var settingsValidation_1 = require("../../../utils/settingsValidation");
+var constants_2 = require("../../../logger/constants");
+var PROXY_CHECK_INTERVAL_MILLIS_CS = 60 * 60 * 1000; // 1 hour in Client Side
+var PROXY_CHECK_INTERVAL_MILLIS_SS = 24 * PROXY_CHECK_INTERVAL_MILLIS_CS; // 24 hours in Server Side
+function sdkEndpointOverridden(settings) {
+    return settings.urls.sdk !== settingsValidation_1.base.urls.sdk;
+}
 /**
  * Factory of SplitChanges fetcher.
  * SplitChanges fetcher is a wrapper around `splitChanges` API service that parses the response and handle errors.
  */
-function splitChangesFetcherFactory(fetchSplitChanges) {
-    return function splitChangesFetcher(since, noCache, till, 
+// @TODO breaking: drop support for Split Proxy below v5.10.0 and simplify the implementation
+function splitChangesFetcherFactory(fetchSplitChanges, settings, storage) {
+    var log = settings.log;
+    var PROXY_CHECK_INTERVAL_MILLIS = settings.core.key !== undefined ? PROXY_CHECK_INTERVAL_MILLIS_CS : PROXY_CHECK_INTERVAL_MILLIS_SS;
+    var lastProxyCheckTimestamp;
+    return function splitChangesFetcher(since, noCache, till, rbSince, 
     // Optional decorator for `fetchSplitChanges` promise, such as timeout or time tracker
     decorator) {
-        var splitsPromise = fetchSplitChanges(since, noCache, till);
+        // Recheck proxy
+        if (lastProxyCheckTimestamp && (Date.now() - lastProxyCheckTimestamp) > PROXY_CHECK_INTERVAL_MILLIS) {
+            settings.sync.flagSpecVersion = constants_1.FLAG_SPEC_VERSION;
+        }
+        var splitsPromise = fetchSplitChanges(since, noCache, till, settings.sync.flagSpecVersion === constants_1.FLAG_SPEC_VERSION ? rbSince : undefined)
+            // Handle proxy error with spec 1.3
+            .catch(function (err) {
+            if (err.statusCode === 400 && sdkEndpointOverridden(settings) && settings.sync.flagSpecVersion === constants_1.FLAG_SPEC_VERSION) {
+                log.error(constants_2.LOG_PREFIX_SYNC_SPLITS + 'Proxy error detected. Retrying with spec 1.2. If you are using Split Proxy, please upgrade to latest version');
+                lastProxyCheckTimestamp = Date.now();
+                settings.sync.flagSpecVersion = '1.2'; // fallback to 1.2 spec
+                return fetchSplitChanges(since, noCache, till); // retry request without rbSince
+            }
+            throw err;
+        });
         if (decorator)
             splitsPromise = decorator(splitsPromise);
-        return splitsPromise.then(function (resp) { return resp.json(); });
+        return splitsPromise
+            .then(function (resp) { return resp.json(); })
+            .then(function (data) {
+            // Using flag spec version 1.2 or below
+            if (data.splits) {
+                return {
+                    ff: {
+                        d: data.splits,
+                        s: data.since,
+                        t: data.till
+                    }
+                };
+            }
+            // Proxy recovery
+            if (lastProxyCheckTimestamp) {
+                log.info(constants_2.LOG_PREFIX_SYNC_SPLITS + 'Proxy error recovered');
+                lastProxyCheckTimestamp = undefined;
+                return splitChangesFetcher(-1, undefined, undefined, -1)
+                    .then(function (splitChangesResponse) {
+                    return Promise.all([storage.splits.clear(), storage.rbSegments.clear()])
+                        .then(function () { return splitChangesResponse; });
+                });
+            }
+            return data;
+        });
     };
 }
 exports.splitChangesFetcherFactory = splitChangesFetcherFactory;

package/cjs/sync/polling/pollingManagerCS.js

@@ -34,10 +34,10 @@ function pollingManagerCSFactory(params) {
     readiness.splits.on(constants_1.SDK_SPLITS_ARRIVED, function () {
         if (!splitsSyncTask.isRunning())
             return; // noop if not doing polling
-        var splitsHaveSegments = storage.splits.usesSegments();
-        if (splitsHaveSegments !== mySegmentsSyncTask.isRunning()) {
-            log.info(constants_2.POLLING_SMART_PAUSING, [splitsHaveSegments ? 'ON' : 'OFF']);
-            if (splitsHaveSegments) {
+        var usingSegments = storage.splits.usesSegments() || storage.rbSegments.usesSegments();
+        if (usingSegments !== mySegmentsSyncTask.isRunning()) {
+            log.info(constants_2.POLLING_SMART_PAUSING, [usingSegments ? 'ON' : 'OFF']);
+            if (usingSegments) {
                 startMySegmentsSyncTasks();
             }
             else {
@@ -49,10 +49,10 @@ function pollingManagerCSFactory(params) {
         var mySegmentsSyncTask = (0, mySegmentsSyncTask_1.mySegmentsSyncTaskFactory)(splitApi.fetchMemberships, storage, readiness, settings, matchingKey);
         // smart ready
         function smartReady() {
-            if (!readiness.isReady() && !storage.splits.usesSegments())
+            if (!readiness.isReady() && !storage.splits.usesSegments() && !storage.rbSegments.usesSegments())
                 readiness.segments.emit(constants_1.SDK_SEGMENTS_ARRIVED);
         }
-        if (!storage.splits.usesSegments())
+        if (!storage.splits.usesSegments() && !storage.rbSegments.usesSegments())
             setTimeout(smartReady, 0);
         else
             readiness.splits.once(constants_1.SDK_SPLITS_ARRIVED, smartReady);
@@ -66,7 +66,7 @@ function pollingManagerCSFactory(params) {
         start: function () {
             log.info(constants_2.POLLING_START);
             splitsSyncTask.start();
-            if (storage.splits.usesSegments())
+            if (storage.splits.usesSegments() || storage.rbSegments.usesSegments())
                 startMySegmentsSyncTasks();
         },
         // Stop periodic fetching (polling)

package/cjs/sync/polling/syncTasks/splitsSyncTask.js

@@ -8,6 +8,6 @@ var splitChangesUpdater_1 = require("../updaters/splitChangesUpdater");
  * Creates a sync task that periodically executes a `splitChangesUpdater` task
  */
 function splitsSyncTaskFactory(fetchSplitChanges, storage, readiness, settings, isClientSide) {
-    return (0, syncTask_1.syncTaskFactory)(settings.log, (0, splitChangesUpdater_1.splitChangesUpdaterFactory)(settings.log, (0, splitChangesFetcher_1.splitChangesFetcherFactory)(fetchSplitChanges), storage, settings.sync.__splitFiltersValidation, readiness.splits, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady, isClientSide), settings.scheduler.featuresRefreshRate, 'splitChangesUpdater');
+    return (0, syncTask_1.syncTaskFactory)(settings.log, (0, splitChangesUpdater_1.splitChangesUpdaterFactory)(settings.log, (0, splitChangesFetcher_1.splitChangesFetcherFactory)(fetchSplitChanges, settings, storage), storage, settings.sync.__splitFiltersValidation, readiness.splits, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady, isClientSide), settings.scheduler.featuresRefreshRate, 'splitChangesUpdater');
 }
 exports.splitsSyncTaskFactory = splitsSyncTaskFactory;

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

@@ -12,7 +12,7 @@ var constants_3 = require("../../streaming/constants");
  *  - uses `segmentsEventEmitter` to emit events related to segments data updates
  */
 function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmentsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, matchingKey) {
-    var splits = storage.splits, segments = storage.segments, largeSegments = storage.largeSegments;
+    var splits = storage.splits, rbSegments = storage.rbSegments, segments = storage.segments, largeSegments = storage.largeSegments;
     var readyOnAlreadyExistentState = true;
     var startingUp = true;
     /** timeout and telemetry decorator for `splitChangesFetcher` promise  */
@@ -34,7 +34,7 @@ function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmentsEvent
             shouldNotifyUpdate = largeSegments.resetSegments(segmentsData.ls || {}) || shouldNotifyUpdate;
         }
         // Notify update if required
-        if (splits.usesSegments() && (shouldNotifyUpdate || readyOnAlreadyExistentState)) {
+        if ((splits.usesSegments() || rbSegments.usesSegments()) && (shouldNotifyUpdate || readyOnAlreadyExistentState)) {
             readyOnAlreadyExistentState = false;
             segmentsEventEmitter.emit(constants_1.SDK_SEGMENTS_ARRIVED);
         }

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

@@ -39,7 +39,7 @@ function segmentChangesUpdaterFactory(log, segmentChangesFetcher, segments, read
      * Returned promise will not be rejected.
      *
      * @param fetchOnlyNew - if true, only fetch the segments that not exists, i.e., which `changeNumber` is equal to -1.
-     * This param is used by SplitUpdateWorker on server-side SDK, to fetch new registered segments on SPLIT_UPDATE notifications.
+     * This param is used by SplitUpdateWorker on server-side SDK, to fetch new registered segments on SPLIT_UPDATE or RB_SEGMENT_UPDATE notifications.
      * @param segmentName - segment name to fetch. By passing `undefined` it fetches the list of segments registered at the storage
      * @param noCache - true to revalidate data to fetch on a SEGMENT_UPDATE notifications.
      * @param till - till target for the provided segmentName, for CDN bypass.