@splitsoftware/splitio-commons 2.1.0-rc.2 → 2.1.1-rc.0

package/CHANGES.txt

@@ -1,10 +1,5 @@
-2.1.0 (January XX, 2025)
- - Added `impressionsDisabled` property to SDK Manager's `SplitView` type.
- - Added two new configuration options for the SDK storage in browsers when using storage type `LOCALSTORAGE`:
-    - `storage.expirationDays` to specify the validity period of the rollout cache.
-    - `storage.clearOnInit` to clear the rollout cache on SDK initialization.
- - Updated implementation of the impressions tracker and strategies to support feature flags with impressions tracking disabled.
- - Updated SDK_READY_FROM_CACHE event when using the `LOCALSTORAGE` storage type to be emitted alongside the SDK_READY event if it has not already been emitted.
+2.1.0 (January 17, 2025)
+ - Added support for the new impressions tracking toggle available on feature flags, both respecting the setting and including the new field being returned on `SplitView` type objects. Read more in our docs.
 
 2.0.3 (January 9, 2025)
  - Bugfixing - Properly handle rejected promises when using targeting rules with segment matchers in consumer modes (e.g., Redis and Pluggable storages).

package/README.md

@@ -27,6 +27,7 @@ Split has built and maintains SDKs for:
 * .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
 * Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
+* Elixir thin-client [Github](https://github.com/splitio/elixir-thin-client) [Docs](https://help.split.io/hc/en-us/articles/26988707417869-Elixir-Thin-Client-SDK)
 * Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/8096158017165-Flutter-plugin)
 * GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
 * iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)

package/cjs/evaluator/combiners/and.js

@@ -11,12 +11,8 @@ function andCombinerContext(log, matchers) {
         log.debug(constants_1.ENGINE_COMBINER_AND, [hasMatchedAll]);
         return hasMatchedAll;
     }
-    return function andCombiner() {
-        var params = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            params[_i] = arguments[_i];
-        }
-        var matcherResults = matchers.map(function (matcher) { return matcher.apply(void 0, params); });
+    return function andCombiner(key, attributes, splitEvaluator) {
+        var matcherResults = matchers.map(function (matcher) { return matcher(key, attributes, splitEvaluator); });
         // If any matching result is a thenable we should use Promise.all
         if ((0, lang_1.findIndex)(matcherResults, thenable_1.thenable) !== -1) {
             return Promise.all(matcherResults).then(andResults);

package/cjs/evaluator/combiners/ifelseif.js

@@ -14,12 +14,12 @@ function ifElseIfCombinerContext(log, predicates) {
             label: labels_1.UNSUPPORTED_MATCHER_TYPE
         };
     }
-    function computeTreatment(predicateResults) {
-        var len = predicateResults.length;
-        for (var i = 0; i < len; i++) {
+    function computeEvaluation(predicateResults) {
+        for (var i = 0, len = predicateResults.length; i < len; i++) {
             var evaluation = predicateResults[i];
             if (evaluation !== undefined) {
-                log.debug(constants_2.ENGINE_COMBINER_IFELSEIF, [evaluation.treatment]);
+                if (!(0, lang_1.isBoolean)(evaluation))
+                    log.debug(constants_2.ENGINE_COMBINER_IFELSEIF, [evaluation.treatment]);
                 return evaluation;
             }
         }
@@ -33,9 +33,9 @@ function ifElseIfCombinerContext(log, predicates) {
         var predicateResults = predicates.map(function (evaluator) { return evaluator(key, seed, trafficAllocation, trafficAllocationSeed, attributes, splitEvaluator); });
         // if we find a thenable
         if ((0, lang_1.findIndex)(predicateResults, thenable_1.thenable) !== -1) {
-            return Promise.all(predicateResults).then(function (results) { return computeTreatment(results); });
+            return Promise.all(predicateResults).then(function (results) { return computeEvaluation(results); });
         }
-        return computeTreatment(predicateResults);
+        return computeEvaluation(predicateResults);
     }
     // if there is none predicates, then there was an error in parsing phase
     if (!Array.isArray(predicates) || predicates.length === 0) {

package/cjs/evaluator/condition/index.js

@@ -7,11 +7,12 @@ var labels_1 = require("../../utils/labels");
 // Build Evaluation object if and only if matchingResult is true
 function match(log, matchingResult, bucketingKey, seed, treatments, label) {
     if (matchingResult) {
-        var treatment = (0, engineUtils_1.getTreatment)(log, bucketingKey, seed, treatments);
-        return {
-            treatment: treatment,
-            label: label
-        };
+        return treatments ? // Feature flag
+            {
+                treatment: (0, engineUtils_1.getTreatment)(log, bucketingKey, seed, treatments),
+                label: label
+            } : // Rule-based segment
+            true;
     }
     // else we should notify the engine to continue evaluating
     return undefined;

package/cjs/evaluator/index.js

@@ -29,12 +29,12 @@ function evaluateFeature(log, key, splitName, attributes, storage) {
         return treatmentException;
     }
     if ((0, thenable_1.thenable)(parsedSplit)) {
-        return parsedSplit.then(function (split) { return getEvaluation(log, split, key, attributes, storage); }).catch(
+        return parsedSplit.then(function (split) { return getEvaluation(log, key, split, attributes, storage); }).catch(
         // Exception on async `getSplit` storage. For example, when the storage is redis or
         // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
         function () { return treatmentException; });
     }
-    return getEvaluation(log, parsedSplit, key, attributes, storage);
+    return getEvaluation(log, key, parsedSplit, attributes, storage);
 }
 exports.evaluateFeature = evaluateFeature;
 function evaluateFeatures(log, key, splitNames, attributes, storage) {
@@ -47,13 +47,13 @@ function evaluateFeatures(log, key, splitNames, attributes, storage) {
         return treatmentsException(splitNames);
     }
     return (0, thenable_1.thenable)(parsedSplits) ?
-        parsedSplits.then(function (splits) { return getEvaluations(log, splitNames, splits, key, attributes, storage); })
+        parsedSplits.then(function (splits) { return getEvaluations(log, key, splitNames, splits, attributes, storage); })
             .catch(function () {
             // Exception on async `getSplits` storage. For example, when the storage is redis or
             // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
             return treatmentsException(splitNames);
         }) :
-        getEvaluations(log, splitNames, parsedSplits, key, attributes, storage);
+        getEvaluations(log, key, splitNames, parsedSplits, attributes, storage);
 }
 exports.evaluateFeatures = evaluateFeatures;
 function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, method) {
@@ -90,7 +90,7 @@ function evaluateFeaturesByFlagSets(log, key, flagSets, attributes, storage, met
         evaluate(storedFlagNames);
 }
 exports.evaluateFeaturesByFlagSets = evaluateFeaturesByFlagSets;
-function getEvaluation(log, splitJSON, key, attributes, storage) {
+function getEvaluation(log, key, splitJSON, attributes, storage) {
     var evaluation = {
         treatment: constants_1.CONTROL,
         label: labels_1.SPLIT_NOT_FOUND,
@@ -116,11 +116,11 @@ function getEvaluation(log, splitJSON, key, attributes, storage) {
     }
     return evaluation;
 }
-function getEvaluations(log, splitNames, splits, key, attributes, storage) {
+function getEvaluations(log, key, splitNames, splits, attributes, storage) {
     var result = {};
     var thenables = [];
     splitNames.forEach(function (splitName) {
-        var evaluation = getEvaluation(log, splits[splitName], key, attributes, storage);
+        var evaluation = getEvaluation(log, key, splits[splitName], attributes, storage);
         if ((0, thenable_1.thenable)(evaluation)) {
             thenables.push(evaluation.then(function (res) {
                 result[splitName] = res;

package/cjs/evaluator/matchers/index.js

@@ -24,6 +24,7 @@ var semver_gte_1 = require("./semver_gte");
 var semver_lte_1 = require("./semver_lte");
 var semver_between_1 = require("./semver_between");
 var semver_inlist_1 = require("./semver_inlist");
+var rbsegment_1 = require("./rbsegment");
 var matchers = [
     undefined,
     all_1.allMatcherContext,
@@ -48,7 +49,8 @@ var matchers = [
     semver_lte_1.lessThanEqualToSemverMatcherContext,
     semver_between_1.betweenSemverMatcherContext,
     semver_inlist_1.inListSemverMatcherContext,
-    large_segment_1.largeSegmentMatcherContext, // IN_LARGE_SEGMENT: 23
+    large_segment_1.largeSegmentMatcherContext,
+    rbsegment_1.ruleBasedSegmentMatcherContext // IN_RULE_BASED_SEGMENT: 24
 ];
 /**
  * Matcher factory.

package/cjs/evaluator/matchers/matcherTypes.js

@@ -26,6 +26,7 @@ exports.matcherTypes = {
     BETWEEN_SEMVER: 21,
     IN_LIST_SEMVER: 22,
     IN_LARGE_SEGMENT: 23,
+    IN_RULE_BASED_SEGMENT: 24,
 };
 exports.matcherDataTypes = {
     BOOLEAN: 'BOOLEAN',

package/cjs/evaluator/matchers/rbsegment.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ruleBasedSegmentMatcherContext = void 0;
+var thenable_1 = require("../../utils/promise/thenable");
+var key_1 = require("../../utils/key");
+var parser_1 = require("../parser");
+function ruleBasedSegmentMatcherContext(segmentName, storage, log) {
+    return function ruleBasedSegmentMatcher(_a, splitEvaluator) {
+        var key = _a.key, attributes = _a.attributes;
+        function matchConditions(rbsegment) {
+            var conditions = rbsegment.conditions;
+            var evaluator = (0, parser_1.parser)(log, conditions, storage);
+            var evaluation = evaluator((0, key_1.keyParser)(key), undefined, undefined, undefined, attributes, splitEvaluator);
+            return (0, thenable_1.thenable)(evaluation) ?
+                evaluation.then(function (evaluation) { return evaluation ? true : false; }) :
+                evaluation ? true : false;
+        }
+        function isExcluded(rbSegment) {
+            var matchingKey = (0, key_1.getMatching)(key);
+            if (rbSegment.excluded.keys.indexOf(matchingKey) !== -1)
+                return true;
+            var isInSegment = rbSegment.excluded.segments.map(function (segmentName) {
+                return storage.segments.isInSegment(segmentName, matchingKey);
+            });
+            return isInSegment.length && (0, thenable_1.thenable)(isInSegment[0]) ?
+                Promise.all(isInSegment).then(function (results) { return results.some(function (result) { return result; }); }) :
+                isInSegment.some(function (result) { return result; });
+        }
+        function isInSegment(rbSegment) {
+            if (!rbSegment)
+                return false;
+            var excluded = isExcluded(rbSegment);
+            return (0, thenable_1.thenable)(excluded) ?
+                excluded.then(function (excluded) { return excluded ? false : matchConditions(rbSegment); }) :
+                excluded ? false : matchConditions(rbSegment);
+        }
+        var rbSegment = storage.rbSegments.get(segmentName);
+        return (0, thenable_1.thenable)(rbSegment) ?
+            rbSegment.then(isInSegment) :
+            isInSegment(rbSegment);
+    };
+}
+exports.ruleBasedSegmentMatcherContext = ruleBasedSegmentMatcherContext;

package/cjs/evaluator/matchersTransform/index.js

@@ -81,6 +81,10 @@ function matchersTransform(matchers) {
             type === matcherTypes_1.matcherTypes.LESS_THAN_OR_EQUAL_TO_SEMVER) {
             value = stringMatcherData;
         }
+        else if (type === matcherTypes_1.matcherTypes.IN_RULE_BASED_SEGMENT) {
+            value = (0, segment_1.segmentTransform)(userDefinedSegmentMatcherData);
+            dataType = matcherTypes_1.matcherDataTypes.NOT_SPECIFIED;
+        }
         return {
             attribute: attribute,
             negate: negate,

package/cjs/evaluator/parser/index.js

@@ -53,9 +53,9 @@ function parser(log, conditions, storage) {
             // and break the loop
             break;
         }
-        predicates.push((0, condition_1.conditionContext)(log, (0, and_1.andCombinerContext)(log, expressions), treatments_1.Treatments.parse(partitions), label, conditionType));
+        predicates.push((0, condition_1.conditionContext)(log, (0, and_1.andCombinerContext)(log, expressions), partitions && treatments_1.Treatments.parse(partitions), label, conditionType));
     }
-    // Instanciate evaluator given the set of conditions using if else if logic
+    // Instantiate evaluator given the set of conditions using if else if logic
     return (0, ifelseif_1.ifElseIfCombinerContext)(log, predicates);
 }
 exports.parser = parser;

package/cjs/evaluator/value/sanitize.js

@@ -52,6 +52,7 @@ function getProcessingFunction(matcherTypeID, dataType) {
         case matcherTypes_1.matcherTypes.BETWEEN:
             return dataType === 'DATETIME' ? convertions_1.zeroSinceSS : undefined;
         case matcherTypes_1.matcherTypes.IN_SPLIT_TREATMENT:
+        case matcherTypes_1.matcherTypes.IN_RULE_BASED_SEGMENT:
             return dependencyProcessor;
         default:
             return undefined;

package/cjs/logger/constants.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.ENGINE_MATCHER_RESULT = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_SPLITS_SEGMENTS = exports.SYNC_SPLITS_REMOVED = exports.SYNC_SPLITS_NEW = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
-exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.WARN_FLAGSET_WITHOUT_FLAGS = exports.WARN_FLAGSET_NOT_CONFIGURED = exports.WARN_LOWERCASE_FLAGSET = exports.WARN_INVALID_FLAGSET = exports.STREAMING_PARSING_SPLIT_UPDATE = exports.STREAMING_PARSING_MEMBERSHIPS_UPDATE = exports.WARN_SDK_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = void 0;
-exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_CLIENT_INSTANTIATION = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ENGINE_MATCHER_ERROR = exports.ERROR_SETS_FILTER_EXCLUSIVE = exports.ERROR_TOO_MANY_SETS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_HTTP = void 0;
+exports.ENGINE_VALUE_NO_ATTRIBUTES = exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.ENGINE_MATCHER_RESULT = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_RBS_UPDATE = exports.SYNC_SPLITS_UPDATE = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
+exports.ERROR_HTTP = exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.WARN_FLAGSET_WITHOUT_FLAGS = exports.WARN_FLAGSET_NOT_CONFIGURED = exports.WARN_LOWERCASE_FLAGSET = exports.WARN_INVALID_FLAGSET = exports.STREAMING_PARSING_SPLIT_UPDATE = exports.STREAMING_PARSING_MEMBERSHIPS_UPDATE = exports.WARN_SDK_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = void 0;
+exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_CLIENT_INSTANTIATION = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ENGINE_MATCHER_ERROR = exports.ERROR_SETS_FILTER_EXCLUSIVE = exports.ERROR_TOO_MANY_SETS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = void 0;
 /**
  * Message codes used to trim string log messages from commons and client-side API modules,
  * in order to reduce the minimal SDK size for Browser and eventually other client-side environments.
@@ -25,9 +25,8 @@ exports.RETRIEVE_CLIENT_EXISTING = 28;
 exports.RETRIEVE_MANAGER = 29;
 exports.SYNC_OFFLINE_DATA = 30;
 exports.SYNC_SPLITS_FETCH = 31;
-exports.SYNC_SPLITS_NEW = 32;
-exports.SYNC_SPLITS_REMOVED = 33;
-exports.SYNC_SPLITS_SEGMENTS = 34;
+exports.SYNC_SPLITS_UPDATE = 32;
+exports.SYNC_RBS_UPDATE = 33;
 exports.STREAMING_NEW_MESSAGE = 35;
 exports.SYNC_TASK_START = 36;
 exports.SYNC_TASK_EXECUTE = 37;

package/cjs/logger/messages/debug.js

@@ -23,10 +23,9 @@ exports.codesDebug = info_1.codesInfo.concat([
     [c.RETRIEVE_MANAGER, 'Retrieving manager instance.'],
     // synchronizer
     [c.SYNC_OFFLINE_DATA, c.LOG_PREFIX_SYNC_OFFLINE + 'Feature flags data: \n%s'],
-    [c.SYNC_SPLITS_FETCH, c.LOG_PREFIX_SYNC_SPLITS + 'Spin up feature flags update using since = %s'],
-    [c.SYNC_SPLITS_NEW, c.LOG_PREFIX_SYNC_SPLITS + 'New feature flags %s'],
-    [c.SYNC_SPLITS_REMOVED, c.LOG_PREFIX_SYNC_SPLITS + 'Removed feature flags %s'],
-    [c.SYNC_SPLITS_SEGMENTS, c.LOG_PREFIX_SYNC_SPLITS + 'Segment names collected %s'],
+    [c.SYNC_SPLITS_FETCH, c.LOG_PREFIX_SYNC_SPLITS + 'Spin up feature flags update using since = %s and rbSince = %s.'],
+    [c.SYNC_SPLITS_UPDATE, c.LOG_PREFIX_SYNC_SPLITS + 'New feature flags %s. Removed feature flags %s.'],
+    [c.SYNC_RBS_UPDATE, c.LOG_PREFIX_SYNC_SPLITS + 'New rule-based segments %s. Removed rule-based segments %s.'],
     [c.STREAMING_NEW_MESSAGE, c.LOG_PREFIX_SYNC_STREAMING + 'New SSE message received, with data: %s.'],
     [c.SYNC_TASK_START, c.LOG_PREFIX_SYNC + ': Starting %s. Running each %s millis'],
     [c.SYNC_TASK_EXECUTE, c.LOG_PREFIX_SYNC + ': Running %s'],

package/cjs/logger/messages/warn.js

@@ -35,7 +35,7 @@ exports.codesWarn = error_1.codesError.concat([
     [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_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.STREAMING_PARSING_SPLIT_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching SplitChanges due to an error processing %s 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.'],
     [c.WARN_FLAGSET_WITHOUT_FLAGS, '%s: you passed %s flag set that does not contain cached feature flag names. Please double check what flag sets are in use in the Split user interface.'],

package/cjs/readiness/readinessManager.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.readinessManagerFactory = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_1 = require("./constants");
-var constants_2 = require("../utils/constants");
 function splitsEventEmitterFactory(EventEmitter) {
     var splitsEventEmitter = (0, objectAssign_1.objectAssign)(new EventEmitter(), {
         splitsArrived: false,
@@ -84,7 +83,6 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
         }
     }
     function checkIsReadyOrUpdate(diff) {
-        var _a;
         if (isDestroyed)
             return;
         if (isReady) {
@@ -103,10 +101,6 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
                 isReady = true;
                 try {
                     syncLastUpdate();
-                    if (!isReadyFromCache && ((_a = settings.storage) === null || _a === void 0 ? void 0 : _a.type) === constants_2.STORAGE_LOCALSTORAGE) {
-                        isReadyFromCache = true;
-                        gate.emit(constants_1.SDK_READY_FROM_CACHE);
-                    }
                     gate.emit(constants_1.SDK_READY);
                 }
                 catch (e) {

package/cjs/services/splitApi.js

@@ -41,8 +41,8 @@ function splitApiFactory(settings, platform, telemetryTracker) {
             }
             return splitHttpClient(url, undefined, telemetryTracker.trackHttp(constants_1.TOKEN));
         },
-        fetchSplitChanges: function (since, noCache, till) {
-            var url = urls.sdk + "/splitChanges?s=" + flagSpecVersion + "&since=" + since + (filterQueryString || '') + (till ? '&till=' + till : '');
+        fetchSplitChanges: function (since, noCache, till, rbSince) {
+            var url = urls.sdk + "/splitChanges?s=" + flagSpecVersion + "&since=" + since + (rbSince ? '&rbSince=' + rbSince : '') + (filterQueryString || '') + (till ? '&till=' + till : '');
             return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.SPLITS))
                 .catch(function (err) {
                 if (err.statusCode === 414)

package/cjs/storages/AbstractSplitsCacheAsync.js

@@ -9,11 +9,29 @@ var objectAssign_1 = require("../utils/lang/objectAssign");
 var AbstractSplitsCacheAsync = /** @class */ (function () {
     function AbstractSplitsCacheAsync() {
     }
+    AbstractSplitsCacheAsync.prototype.update = function (toAdd, toRemove, changeNumber) {
+        var _this = this;
+        return Promise.all([
+            this.setChangeNumber(changeNumber),
+            Promise.all(toAdd.map(function (addedFF) { return _this.addSplit(addedFF); })),
+            Promise.all(toRemove.map(function (removedFF) { return _this.removeSplit(removedFF.name); }))
+        ]).then(function (_a) {
+            var added = _a[1], removed = _a[2];
+            return added.some(function (result) { return result; }) || removed.some(function (result) { return result; });
+        });
+    };
     // @TODO revisit segment-related methods ('usesSegments', 'getRegisteredSegments', 'registerSegments')
     // noop, just keeping the interface. This is used by standalone client-side API only, and so only implemented by InMemory and InLocalStorage.
     AbstractSplitsCacheAsync.prototype.usesSegments = function () {
         return Promise.resolve(true);
     };
+    /**
+     * Check if the splits information is already stored in cache.
+     * Noop, just keeping the interface. This is used by client-side implementations only.
+     */
+    AbstractSplitsCacheAsync.prototype.checkCache = function () {
+        return Promise.resolve(false);
+    };
     /**
      * Kill `name` split and set `defaultTreatment` and `changeNumber`.
      * Used for SPLIT_KILL push notifications.
@@ -30,7 +48,7 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
                 newSplit.killed = true;
                 newSplit.defaultTreatment = defaultTreatment;
                 newSplit.changeNumber = changeNumber;
-                return _this.addSplit(name, newSplit);
+                return _this.addSplit(newSplit);
             }
             return false;
         }).catch(function () { return false; });

package/cjs/storages/AbstractSplitsCacheSync.js

@@ -10,13 +10,11 @@ var constants_1 = require("../utils/constants");
 var AbstractSplitsCacheSync = /** @class */ (function () {
     function AbstractSplitsCacheSync() {
     }
-    AbstractSplitsCacheSync.prototype.addSplits = function (entries) {
+    AbstractSplitsCacheSync.prototype.update = function (toAdd, toRemove, changeNumber) {
         var _this = this;
-        return entries.map(function (keyValuePair) { return _this.addSplit(keyValuePair[0], keyValuePair[1]); });
-    };
-    AbstractSplitsCacheSync.prototype.removeSplits = function (names) {
-        var _this = this;
-        return names.map(function (name) { return _this.removeSplit(name); });
+        this.setChangeNumber(changeNumber);
+        var updated = toAdd.map(function (addedFF) { return _this.addSplit(addedFF); }).some(function (result) { return result; });
+        return toRemove.map(function (removedFF) { return _this.removeSplit(removedFF.name); }).some(function (result) { return result; }) || updated;
     };
     AbstractSplitsCacheSync.prototype.getSplits = function (names) {
         var _this = this;
@@ -30,6 +28,13 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
         var _this = this;
         return this.getSplitNames().map(function (key) { return _this.getSplit(key); });
     };
+    /**
+     * Check if the splits information is already stored in cache. This data can be preloaded.
+     * It is used as condition to emit SDK_SPLITS_CACHE_LOADED, and then SDK_READY_FROM_CACHE.
+     */
+    AbstractSplitsCacheSync.prototype.checkCache = function () {
+        return false;
+    };
     /**
      * Kill `name` split and set `defaultTreatment` and `changeNumber`.
      * Used for SPLIT_KILL push notifications.
@@ -44,7 +49,7 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
             newSplit.killed = true;
             newSplit.defaultTreatment = defaultTreatment;
             newSplit.changeNumber = changeNumber;
-            return this.addSplit(name, newSplit);
+            return this.addSplit(newSplit);
         }
         return false;
     };
@@ -55,8 +60,8 @@ exports.AbstractSplitsCacheSync = AbstractSplitsCacheSync;
  * Given a parsed split, it returns a boolean flagging if its conditions use segments matchers (rules & whitelists).
  * This util is intended to simplify the implementation of `splitsCache::usesSegments` method
  */
-function usesSegments(split) {
-    var conditions = split.conditions || [];
+function usesSegments(ruleEntity) {
+    var conditions = ruleEntity.conditions || [];
     for (var i = 0; i < conditions.length; i++) {
         var matchers = conditions[i].matcherGroup.matchers;
         for (var j = 0; j < matchers.length; j++) {
@@ -65,6 +70,9 @@ function usesSegments(split) {
                 return true;
         }
     }
+    var excluded = ruleEntity.excluded;
+    if (excluded && excluded.segments && excluded.segments.length > 0)
+        return true;
     return false;
 }
 exports.usesSegments = usesSegments;

package/cjs/storages/KeyBuilder.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getStorageHash = exports.KeyBuilder = exports.validatePrefix = void 0;
-var lang_1 = require("../utils/lang");
 var murmur3_1 = require("../utils/murmur3/murmur3");
 var everythingAtTheEnd = /[^.]+$/;
 var DEFAULT_PREFIX = 'SPLITIO';
@@ -26,19 +25,17 @@ var KeyBuilder = /** @class */ (function () {
     KeyBuilder.prototype.buildSplitsTillKey = function () {
         return this.prefix + ".splits.till";
     };
-    // NOT USED
-    // buildSplitsReady() {
-    //   return `${this.prefix}.splits.ready`;
-    // }
-    KeyBuilder.prototype.isSplitKey = function (key) {
-        return (0, lang_1.startsWith)(key, this.prefix + ".split.");
-    };
     KeyBuilder.prototype.buildSplitKeyPrefix = function () {
         return this.prefix + ".split.";
     };
-    // Only used by InLocalStorage.
-    KeyBuilder.prototype.buildSplitsWithSegmentCountKey = function () {
-        return this.prefix + ".splits.usingSegments";
+    KeyBuilder.prototype.buildRBSegmentKey = function (rbsegmentName) {
+        return this.prefix + ".rbsegment." + rbsegmentName;
+    };
+    KeyBuilder.prototype.buildRBSegmentsTillKey = function () {
+        return this.prefix + ".rbsegments.till";
+    };
+    KeyBuilder.prototype.buildRBSegmentKeyPrefix = function () {
+        return this.prefix + ".rbsegment.";
     };
     KeyBuilder.prototype.buildSegmentNameKey = function (segmentName) {
         return this.prefix + ".segment." + segmentName;
@@ -46,10 +43,6 @@ var KeyBuilder = /** @class */ (function () {
     KeyBuilder.prototype.buildSegmentTillKey = function (segmentName) {
         return this.prefix + ".segment." + segmentName + ".till";
     };
-    // NOT USED
-    // buildSegmentsReady() {
-    //   return `${this.prefix}.segments.ready`;
-    // }
     KeyBuilder.prototype.extractKey = function (builtKey) {
         var s = builtKey.match(everythingAtTheEnd);
         if (s && s.length) {

package/cjs/storages/KeyBuilderCS.js

@@ -9,7 +9,7 @@ var KeyBuilderCS = /** @class */ (function (_super) {
     function KeyBuilderCS(prefix, matchingKey) {
         var _this = _super.call(this, prefix) || this;
         _this.matchingKey = matchingKey;
-        _this.regexSplitsCacheKey = new RegExp("^" + prefix + "\\.(splits?|trafficType|flagSet)\\.");
+        _this.regexSplitsCacheKey = new RegExp("^" + prefix + "\\.(splits?|trafficType|flagSet|rbsegment)\\.");
         return _this;
     }
     /**
@@ -21,7 +21,7 @@ var KeyBuilderCS = /** @class */ (function (_super) {
     KeyBuilderCS.prototype.extractSegmentName = function (builtSegmentKeyName) {
         var prefix = this.prefix + "." + this.matchingKey + ".segment.";
         if ((0, lang_1.startsWith)(builtSegmentKeyName, prefix))
-            return builtSegmentKeyName.substr(prefix.length);
+            return builtSegmentKeyName.slice(prefix.length);
     };
     KeyBuilderCS.prototype.buildLastUpdatedKey = function () {
         return this.prefix + ".splits.lastUpdated";
@@ -32,8 +32,14 @@ var KeyBuilderCS = /** @class */ (function (_super) {
     KeyBuilderCS.prototype.buildTillKey = function () {
         return this.prefix + "." + this.matchingKey + ".segments.till";
     };
-    KeyBuilderCS.prototype.buildLastClear = function () {
-        return this.prefix + ".lastClear";
+    KeyBuilderCS.prototype.isSplitKey = function (key) {
+        return (0, lang_1.startsWith)(key, this.prefix + ".split.");
+    };
+    KeyBuilderCS.prototype.isRBSegmentKey = function (key) {
+        return (0, lang_1.startsWith)(key, this.prefix + ".rbsegment.");
+    };
+    KeyBuilderCS.prototype.buildSplitsWithSegmentCountKey = function () {
+        return this.prefix + ".splits.usingSegments";
     };
     return KeyBuilderCS;
 }(KeyBuilder_1.KeyBuilder));
@@ -46,7 +52,7 @@ function myLargeSegmentsKeyBuilder(prefix, matchingKey) {
         extractSegmentName: function (builtSegmentKeyName) {
             var p = prefix + "." + matchingKey + ".largeSegment.";
             if ((0, lang_1.startsWith)(builtSegmentKeyName, p))
-                return builtSegmentKeyName.substr(p.length);
+                return builtSegmentKeyName.slice(p.length);
         },
         buildTillKey: function () {
             return prefix + "." + matchingKey + ".largeSegments.till";

package/cjs/storages/KeyBuilderSS.js

@@ -42,6 +42,9 @@ var KeyBuilderSS = /** @class */ (function (_super) {
     KeyBuilderSS.prototype.searchPatternForSplitKeys = function () {
         return this.buildSplitKeyPrefix() + "*";
     };
+    KeyBuilderSS.prototype.searchPatternForRBSegmentKeys = function () {
+        return this.buildRBSegmentKeyPrefix() + "*";
+    };
     /* Telemetry keys */
     KeyBuilderSS.prototype.buildLatencyKey = function (method, bucket) {
         return this.latencyPrefix + "::" + this.versionablePrefix + "/" + exports.METHOD_NAMES[method] + "/" + bucket;

package/cjs/storages/dataLoader.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dataLoaderFactory = void 0;
-// This value might be eventually set via a config parameter
-var DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days
+var browser_1 = require("../utils/constants/browser");
 /**
  * Factory of client-side storage loader
  *
@@ -26,16 +25,15 @@ function dataLoaderFactory(preloadedData) {
             return;
         var _a = preloadedData.lastUpdated, lastUpdated = _a === void 0 ? -1 : _a, _b = preloadedData.segmentsData, segmentsData = _b === void 0 ? {} : _b, _c = preloadedData.since, since = _c === void 0 ? -1 : _c, _d = preloadedData.splitsData, splitsData = _d === void 0 ? {} : _d;
         var storedSince = storage.splits.getChangeNumber();
-        var expirationTimestamp = Date.now() - DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
+        var expirationTimestamp = Date.now() - browser_1.DEFAULT_CACHE_EXPIRATION_IN_MILLIS;
         // Do not load data if current localStorage data is more recent,
         // or if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
         if (storedSince > since || lastUpdated < expirationTimestamp)
             return;
         // cleaning up the localStorage data, since some cached splits might need be part of the preloaded data
         storage.splits.clear();
-        storage.splits.setChangeNumber(since);
         // splitsData in an object where the property is the split name and the pertaining value is a stringified json of its data
-        storage.splits.addSplits(Object.keys(splitsData).map(function (splitName) { return JSON.parse(splitsData[splitName]); }));
+        storage.splits.update(Object.keys(splitsData).map(function (splitName) { return JSON.parse(splitsData[splitName]); }), [], since);
         // add mySegments data
         var mySegmentsData = preloadedData.mySegmentsData && preloadedData.mySegmentsData[userId];
         if (!mySegmentsData) {