@splitsoftware/splitio-commons 2.3.0 → 2.3.1-rc.0

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

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.splitChangesUpdaterFactory = exports.computeSplitsMutation = exports.parseSegments = void 0;
+exports.splitChangesUpdaterFactory = exports.computeMutation = exports.parseSegments = void 0;
 var timeout_1 = require("../../../utils/promise/timeout");
 var constants_1 = require("../../../readiness/constants");
 var constants_2 = require("../../../logger/constants");
 var lang_1 = require("../../../utils/lang");
 var constants_3 = require("../../../utils/constants");
 var sets_1 = require("../../../utils/lang/sets");
+var constants_4 = require("../../streaming/constants");
 // Checks that all registered segments have been fetched (changeNumber !== -1 for every segment).
 // Returns a promise that could be rejected.
 // @TODO review together with Segments and MySegments storage APIs
@@ -18,16 +19,25 @@ function checkAllSegmentsExist(segments) {
     });
 }
 /**
- * Collect segments from a raw split definition.
+ * Collect segments from a raw FF or RBS definition.
  * Exported for testing purposes.
  */
-function parseSegments(_a) {
-    var conditions = _a.conditions;
+function parseSegments(ruleEntity, matcherType) {
+    if (matcherType === void 0) { matcherType = constants_3.IN_SEGMENT; }
+    var _a = ruleEntity, _b = _a.conditions, conditions = _b === void 0 ? [] : _b, excluded = _a.excluded;
     var segments = new Set();
+    if (excluded && excluded.segments) {
+        excluded.segments.forEach(function (_a) {
+            var type = _a.type, name = _a.name;
+            if ((type === constants_3.STANDARD_SEGMENT && matcherType === constants_3.IN_SEGMENT) || (type === constants_3.RULE_BASED_SEGMENT && matcherType === constants_3.IN_RULE_BASED_SEGMENT)) {
+                segments.add(name);
+            }
+        });
+    }
     for (var i = 0; i < conditions.length; i++) {
         var matchers = conditions[i].matcherGroup.matchers;
         matchers.forEach(function (matcher) {
-            if (matcher.matcherType === constants_3.IN_SEGMENT)
+            if (matcher.matcherType === matcherType)
                 segments.add(matcher.userDefinedSegmentMatcherData.segmentName);
         });
     }
@@ -58,24 +68,21 @@ function matchFilters(featureFlag, filters) {
  * i.e., an object with added splits, removed splits and used segments.
  * Exported for testing purposes.
  */
-function computeSplitsMutation(entries, filters) {
-    var segments = new Set();
-    var computed = entries.reduce(function (accum, split) {
-        if (split.status === 'ACTIVE' && matchFilters(split, filters)) {
-            accum.added.push(split);
-            parseSegments(split).forEach(function (segmentName) {
+function computeMutation(rules, segments, filters) {
+    return rules.reduce(function (accum, ruleEntity) {
+        if (ruleEntity.status === 'ACTIVE' && (!filters || matchFilters(ruleEntity, filters))) {
+            accum.added.push(ruleEntity);
+            parseSegments(ruleEntity).forEach(function (segmentName) {
                 segments.add(segmentName);
             });
         }
         else {
-            accum.removed.push(split);
+            accum.removed.push(ruleEntity);
         }
         return accum;
-    }, { added: [], removed: [], segments: [] });
-    computed.segments = (0, sets_1.setToArray)(segments);
-    return computed;
+    }, { added: [], removed: [] });
 }
-exports.computeSplitsMutation = computeSplitsMutation;
+exports.computeMutation = computeMutation;
 /**
  * factory of SplitChanges updater, a task that:
  *  - fetches split changes using `splitChangesFetcher`
@@ -93,7 +100,7 @@ exports.computeSplitsMutation = computeSplitsMutation;
 function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFiltersValidation, splitsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, isClientSide) {
     if (requestTimeoutBeforeReady === void 0) { requestTimeoutBeforeReady = 0; }
     if (retriesOnFailureBeforeReady === void 0) { retriesOnFailureBeforeReady = 0; }
-    var splits = storage.splits, segments = storage.segments;
+    var splits = storage.splits, rbSegments = storage.rbSegments, segments = storage.segments;
     var startingUp = true;
     /** timeout decorator for `splitChangesFetcher` promise  */
     function _promiseDecorator(promise) {
@@ -108,29 +115,48 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFilt
      * @param noCache - true to revalidate data to fetch
      * @param till - query param to bypass CDN requests
      */
-    return function splitChangesUpdater(noCache, till, splitUpdateNotification) {
+    return function splitChangesUpdater(noCache, till, instantUpdate) {
         /**
          * @param since - current changeNumber at splitsCache
          * @param retry - current number of retry attempts
          */
-        function _splitChangesUpdater(since, retry) {
+        function _splitChangesUpdater(sinces, retry) {
             if (retry === void 0) { retry = 0; }
-            log.debug(constants_2.SYNC_SPLITS_FETCH, [since]);
-            return Promise.resolve(splitUpdateNotification ?
-                { splits: [splitUpdateNotification.payload], till: splitUpdateNotification.changeNumber } :
-                splitChangesFetcher(since, noCache, till, _promiseDecorator))
+            var since = sinces[0], rbSince = sinces[1];
+            log.debug(constants_2.SYNC_SPLITS_FETCH, sinces);
+            return Promise.resolve(instantUpdate ?
+                instantUpdate.type === constants_4.SPLIT_UPDATE ?
+                    // IFFU edge case: a change to a flag that adds an IN_RULE_BASED_SEGMENT matcher that is not present yet
+                    Promise.resolve(rbSegments.contains(parseSegments(instantUpdate.payload, constants_3.IN_RULE_BASED_SEGMENT))).then(function (contains) {
+                        return contains ?
+                            { ff: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
+                            splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator);
+                    }) :
+                    { rbs: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
+                splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator))
                 .then(function (splitChanges) {
                 startingUp = false;
-                var mutation = computeSplitsMutation(splitChanges.splits, splitFiltersValidation);
-                log.debug(constants_2.SYNC_SPLITS_UPDATE, [mutation.added.length, mutation.removed.length, mutation.segments.length]);
-                return Promise.all([
-                    splits.update(mutation.added, mutation.removed, splitChanges.till),
-                    segments.registerSegments(mutation.segments)
+                var usedSegments = new Set();
+                var ffUpdate = false;
+                if (splitChanges.ff) {
+                    var _a = computeMutation(splitChanges.ff.d, usedSegments, splitFiltersValidation), added = _a.added, removed = _a.removed;
+                    log.debug(constants_2.SYNC_SPLITS_UPDATE, [added.length, removed.length]);
+                    ffUpdate = splits.update(added, removed, splitChanges.ff.t);
+                }
+                var rbsUpdate = false;
+                if (splitChanges.rbs) {
+                    var _b = computeMutation(splitChanges.rbs.d, usedSegments), added = _b.added, removed = _b.removed;
+                    log.debug(constants_2.SYNC_RBS_UPDATE, [added.length, removed.length]);
+                    rbsUpdate = rbSegments.update(added, removed, splitChanges.rbs.t);
+                }
+                return Promise.all([ffUpdate, rbsUpdate,
+                    // @TODO if at least 1 segment fetch fails due to 404 and other segments are updated in the storage, SDK_UPDATE is not emitted
+                    segments.registerSegments((0, sets_1.setToArray)(usedSegments))
                 ]).then(function (_a) {
-                    var isThereUpdate = _a[0];
+                    var ffChanged = _a[0], rbsChanged = _a[1];
                     if (splitsEventEmitter) {
                         // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
-                        return Promise.resolve(!splitsEventEmitter.splitsArrived || (since !== splitChanges.till && isThereUpdate && (isClientSide || checkAllSegmentsExist(segments))))
+                        return Promise.resolve(!splitsEventEmitter.splitsArrived || ((ffChanged || rbsChanged) && (isClientSide || checkAllSegmentsExist(segments))))
                             .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
                             .then(function (emitSplitsArrivedEvent) {
                             // emit SDK events
@@ -147,7 +173,7 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFilt
                 if (startingUp && retriesOnFailureBeforeReady > retry) {
                     retry += 1;
                     log.info(constants_2.SYNC_SPLITS_FETCH_RETRY, [retry, error]);
-                    return _splitChangesUpdater(since, retry);
+                    return _splitChangesUpdater(sinces, retry);
                 }
                 else {
                     startingUp = false;
@@ -155,8 +181,8 @@ function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFilt
                 return false;
             });
         }
-        var sincePromise = Promise.resolve(splits.getChangeNumber()); // `getChangeNumber` never rejects or throws error
-        return sincePromise.then(_splitChangesUpdater);
+        // `getChangeNumber` never rejects or throws error
+        return Promise.all([splits.getChangeNumber(), rbSegments.getChangeNumber()]).then(_splitChangesUpdater);
     };
 }
 exports.splitChangesUpdaterFactory = splitChangesUpdaterFactory;

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

@@ -78,6 +78,7 @@ function SSEHandlerFactory(log, pushEmitter, telemetryTracker) {
                 case constants_1.MEMBERSHIPS_MS_UPDATE:
                 case constants_1.MEMBERSHIPS_LS_UPDATE:
                 case constants_1.SPLIT_KILL:
+                case constants_1.RB_SEGMENT_UPDATE:
                     pushEmitter.emit(parsedData.type, parsedData);
                     break;
                 /* occupancy & control events, handled by NotificationManagerKeeper */

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

@@ -1,106 +1,135 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SplitsUpdateWorker = void 0;
-var constants_1 = require("../../../readiness/constants");
+var constants_1 = require("../../../logger/constants");
+var constants_2 = require("../../../readiness/constants");
 var Backoff_1 = require("../../../utils/Backoff");
-var constants_2 = require("../../../utils/constants");
-var constants_3 = require("./constants");
+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, splitsCache, splitsSyncTask, splitsEventEmitter, telemetryTracker, segmentsSyncTask) {
-    var maxChangeNumber = 0;
-    var handleNewEvent = false;
-    var isHandlingEvent;
-    var cdnBypass;
-    var payload;
-    var backoff = new Backoff_1.Backoff(__handleSplitUpdateCall, constants_3.FETCH_BACKOFF_BASE, constants_3.FETCH_BACKOFF_MAX_WAIT);
-    function __handleSplitUpdateCall() {
-        isHandlingEvent = true;
-        if (maxChangeNumber > splitsCache.getChangeNumber()) {
-            handleNewEvent = false;
-            var splitUpdateNotification_1 = payload ? { payload: payload, changeNumber: maxChangeNumber } : undefined;
-            // fetch splits revalidating data if cached
-            splitsSyncTask.execute(true, cdnBypass ? maxChangeNumber : undefined, splitUpdateNotification_1).then(function () {
-                if (!isHandlingEvent)
-                    return; // halt if `stop` has been called
-                if (handleNewEvent) {
-                    __handleSplitUpdateCall();
-                }
-                else {
-                    if (splitUpdateNotification_1)
-                        telemetryTracker.trackUpdatesFromSSE(constants_2.SPLITS);
-                    // fetch new registered segments for server-side API. Not retrying on error
-                    if (segmentsSyncTask)
-                        segmentsSyncTask.execute(true);
-                    var attempts = backoff.attempts + 1;
-                    if (maxChangeNumber <= splitsCache.getChangeNumber()) {
-                        log.debug("Refresh completed" + (cdnBypass ? ' bypassing the CDN' : '') + " in " + attempts + " attempts.");
-                        isHandlingEvent = false;
-                        return;
-                    }
-                    if (attempts < constants_3.FETCH_BACKOFF_MAX_RETRIES) {
-                        backoff.scheduleCall();
-                        return;
-                    }
-                    if (cdnBypass) {
-                        log.debug("No changes fetched after " + attempts + " attempts with CDN bypassed.");
-                        isHandlingEvent = false;
+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 {
-                        backoff.reset();
-                        cdnBypass = true;
-                        __handleSplitUpdateCall();
+                        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;
-        }
-    }
-    /**
-     * Invoked by NotificationProcessor on SPLIT_UPDATE event
-     *
-     * @param changeNumber - change number of the SPLIT_UPDATE notification
-     */
-    function put(_a, _payload) {
-        var changeNumber = _a.changeNumber, pcn = _a.pcn;
-        var currentChangeNumber = splitsCache.getChangeNumber();
-        if (changeNumber <= currentChangeNumber || changeNumber <= maxChangeNumber)
-            return;
-        maxChangeNumber = changeNumber;
-        handleNewEvent = true;
-        cdnBypass = false;
-        payload = undefined;
-        if (_payload && currentChangeNumber === pcn) {
-            payload = _payload;
+                });
+            }
+            else {
+                isHandlingEvent = false;
+            }
         }
-        if (backoff.timeoutID || !isHandlingEvent)
-            __handleSplitUpdateCall();
-        backoff.reset();
+        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: put,
+        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 SPLIT_UPDATE notification
+         * @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 (splitsCache.killLocally(splitName, defaultTreatment, changeNumber)) {
+            if (storage.splits.killLocally(splitName, defaultTreatment, changeNumber)) {
                 // trigger an SDK_UPDATE if Split was killed locally
-                splitsEventEmitter.emit(constants_1.SDK_SPLITS_ARRIVED, true);
+                splitsEventEmitter.emit(constants_2.SDK_SPLITS_ARRIVED, true);
             }
             // queues the SplitChanges fetch (only if changeNumber is newer)
-            put({ changeNumber: changeNumber });
+            ff.put({ changeNumber: changeNumber });
         },
         stop: function () {
-            isHandlingEvent = false;
-            backoff.reset();
+            ff.stop();
+            rbs.stop();
         }
     };
 }

package/cjs/sync/streaming/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControlType = exports.OCCUPANCY = exports.CONTROL = exports.SPLIT_UPDATE = exports.SPLIT_KILL = exports.SEGMENT_UPDATE = exports.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;
+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
@@ -30,6 +30,7 @@ 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';

package/cjs/sync/streaming/pushManager.js

@@ -46,7 +46,7 @@ function pushManagerFactory(params, pollingManager) {
     // MySegmentsUpdateWorker (client-side) are initiated in `add` method
     var segmentsUpdateWorker = userKey ? undefined : (0, SegmentsUpdateWorker_1.SegmentsUpdateWorker)(log, pollingManager.segmentsSyncTask, storage.segments);
     // For server-side we pass the segmentsSyncTask, used by SplitsUpdateWorker to fetch new segments
-    var splitsUpdateWorker = (0, SplitsUpdateWorker_1.SplitsUpdateWorker)(log, storage.splits, pollingManager.splitsSyncTask, readiness.splits, telemetryTracker, userKey ? undefined : pollingManager.segmentsSyncTask);
+    var splitsUpdateWorker = (0, SplitsUpdateWorker_1.SplitsUpdateWorker)(log, storage, pollingManager.splitsSyncTask, readiness.splits, telemetryTracker, userKey ? undefined : pollingManager.segmentsSyncTask);
     // [Only for client-side] map of hashes to user keys, to dispatch membership update events to the corresponding MySegmentsUpdateWorker
     var userKeyHashes = {};
     // [Only for client-side] map of user keys to their corresponding hash64 and MySegmentsUpdateWorkers.
@@ -182,21 +182,8 @@ function pushManagerFactory(params, pollingManager) {
     });
     /** Functions related to synchronization (Queues and Workers in the spec) */
     pushEmitter.on(constants_1.SPLIT_KILL, splitsUpdateWorker.killSplit);
-    pushEmitter.on(constants_1.SPLIT_UPDATE, function (parsedData) {
-        if (parsedData.d && parsedData.c !== undefined) {
-            try {
-                var payload = (0, parseUtils_1.parseFFUpdatePayload)(parsedData.c, parsedData.d);
-                if (payload) {
-                    splitsUpdateWorker.put(parsedData, payload);
-                    return;
-                }
-            }
-            catch (e) {
-                log.warn(constants_2.STREAMING_PARSING_SPLIT_UPDATE, [e]);
-            }
-        }
-        splitsUpdateWorker.put(parsedData);
-    });
+    pushEmitter.on(constants_1.SPLIT_UPDATE, splitsUpdateWorker.put);
+    pushEmitter.on(constants_1.RB_SEGMENT_UPDATE, splitsUpdateWorker.put);
     function handleMySegmentsUpdate(parsedData) {
         switch (parsedData.u) {
             case types_1.UpdateStrategy.BoundedFetchRequest: {

package/cjs/sync/syncManagerOnline.js

@@ -130,7 +130,7 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                         if (pushManager) {
                             if (pollingManager.isRunning()) {
                                 // if doing polling, we must start the periodic fetch of data
-                                if (storage.splits.usesSegments())
+                                if (storage.splits.usesSegments() || storage.rbSegments.usesSegments())
                                     mySegmentsSyncTask.start();
                             }
                             else {
@@ -140,7 +140,7 @@ function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFactory) {
                             }
                         }
                         else {
-                            if (storage.splits.usesSegments())
+                            if (storage.splits.usesSegments() || storage.rbSegments.usesSegments())
                                 mySegmentsSyncTask.start();
                         }
                     }

package/cjs/utils/constants/index.js

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

package/cjs/utils/labels/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UNSUPPORTED_MATCHER_TYPE = exports.NOT_IN_SPLIT = exports.SPLIT_ARCHIVED = exports.EXCEPTION = exports.SDK_NOT_READY = exports.SPLIT_NOT_FOUND = exports.NO_CONDITION_MATCH = exports.SPLIT_KILLED = void 0;
+exports.PREREQUISITES_NOT_MET = exports.UNSUPPORTED_MATCHER_TYPE = exports.NOT_IN_SPLIT = exports.SPLIT_ARCHIVED = exports.EXCEPTION = exports.SDK_NOT_READY = exports.SPLIT_NOT_FOUND = exports.NO_CONDITION_MATCH = exports.SPLIT_KILLED = void 0;
 exports.SPLIT_KILLED = 'killed';
 exports.NO_CONDITION_MATCH = 'default rule';
 exports.SPLIT_NOT_FOUND = 'definition not found';
@@ -9,3 +9,4 @@ exports.EXCEPTION = 'exception';
 exports.SPLIT_ARCHIVED = 'archived';
 exports.NOT_IN_SPLIT = 'not in split';
 exports.UNSUPPORTED_MATCHER_TYPE = 'targeting rule type unsupported by sdk';
+exports.PREREQUISITES_NOT_MET = 'prerequisites not met';

package/esm/evaluator/Engine.js

@@ -1,76 +1,54 @@
-import { get } from '../utils/lang';
+import { get, isString } from '../utils/lang';
 import { parser } from './parser';
 import { keyParser } from '../utils/key';
 import { thenable } from '../utils/promise/thenable';
-import { EXCEPTION, NO_CONDITION_MATCH, SPLIT_ARCHIVED, SPLIT_KILLED } from '../utils/labels';
+import { NO_CONDITION_MATCH, SPLIT_ARCHIVED, SPLIT_KILLED, PREREQUISITES_NOT_MET } from '../utils/labels';
 import { CONTROL } from '../utils/constants';
+import { ENGINE_DEFAULT } from '../logger/constants';
+import { prerequisitesMatcherContext } from './matchers/prerequisites';
 function evaluationResult(result, defaultTreatment) {
     return {
         treatment: get(result, 'treatment', defaultTreatment),
         label: get(result, 'label', NO_CONDITION_MATCH)
     };
 }
-var Engine = /** @class */ (function () {
-    function Engine(baseInfo, evaluator) {
-        this.baseInfo = baseInfo;
-        this.evaluator = evaluator;
-        // in case we don't have a default treatment in the instantiation, use 'control'
-        if (typeof this.baseInfo.defaultTreatment !== 'string') {
-            this.baseInfo.defaultTreatment = CONTROL;
-        }
-    }
-    Engine.parse = function (log, splitFlatStructure, storage) {
-        var conditions = splitFlatStructure.conditions;
-        var evaluator = parser(log, conditions, storage);
-        return new Engine(splitFlatStructure, evaluator);
-    };
-    Engine.prototype.getKey = function () {
-        return this.baseInfo.name;
-    };
-    Engine.prototype.getTreatment = function (key, attributes, splitEvaluator) {
-        var _a = this.baseInfo, killed = _a.killed, seed = _a.seed, defaultTreatment = _a.defaultTreatment, trafficAllocation = _a.trafficAllocation, trafficAllocationSeed = _a.trafficAllocationSeed;
-        var parsedKey;
-        var treatment;
-        var label;
-        try {
-            parsedKey = keyParser(key);
-        }
-        catch (err) {
-            return {
-                treatment: CONTROL,
-                label: EXCEPTION
-            };
-        }
-        if (this.isGarbage()) {
-            treatment = CONTROL;
-            label = SPLIT_ARCHIVED;
-        }
-        else if (killed) {
-            treatment = defaultTreatment;
-            label = SPLIT_KILLED;
-        }
-        else {
-            var evaluation = this.evaluator(parsedKey, seed, trafficAllocation, trafficAllocationSeed, attributes, splitEvaluator);
-            // Evaluation could be async, so we should handle that case checking for a
-            // thenable object
-            if (thenable(evaluation)) {
-                return evaluation.then(function (result) { return evaluationResult(result, defaultTreatment); });
+export function engineParser(log, split, storage) {
+    var killed = split.killed, seed = split.seed, trafficAllocation = split.trafficAllocation, trafficAllocationSeed = split.trafficAllocationSeed, status = split.status, conditions = split.conditions, prerequisites = split.prerequisites;
+    var defaultTreatment = isString(split.defaultTreatment) ? split.defaultTreatment : CONTROL;
+    var evaluator = parser(log, conditions, storage);
+    var prerequisiteMatcher = prerequisitesMatcherContext(prerequisites, storage, log);
+    return {
+        getTreatment: function (key, attributes, splitEvaluator) {
+            var parsedKey = keyParser(key);
+            function evaluate(prerequisitesMet) {
+                if (!prerequisitesMet) {
+                    log.debug(ENGINE_DEFAULT, ['Prerequisite not met']);
+                    return {
+                        treatment: defaultTreatment,
+                        label: PREREQUISITES_NOT_MET
+                    };
+                }
+                var evaluation = evaluator(parsedKey, seed, trafficAllocation, trafficAllocationSeed, attributes, splitEvaluator);
+                return thenable(evaluation) ?
+                    evaluation.then(function (result) { return evaluationResult(result, defaultTreatment); }) :
+                    evaluationResult(evaluation, defaultTreatment);
             }
-            else {
-                return evaluationResult(evaluation, defaultTreatment);
+            if (status === 'ARCHIVED')
+                return {
+                    treatment: CONTROL,
+                    label: SPLIT_ARCHIVED
+                };
+            if (killed) {
+                log.debug(ENGINE_DEFAULT, ['Flag is killed']);
+                return {
+                    treatment: defaultTreatment,
+                    label: SPLIT_KILLED
+                };
             }
+            var prerequisitesMet = prerequisiteMatcher({ key: key, attributes: attributes }, splitEvaluator);
+            return thenable(prerequisitesMet) ?
+                prerequisitesMet.then(evaluate) :
+                evaluate(prerequisitesMet);
         }
-        return {
-            treatment: treatment,
-            label: label
-        };
-    };
-    Engine.prototype.isGarbage = function () {
-        return this.baseInfo.status === 'ARCHIVED';
     };
-    Engine.prototype.getChangeNumber = function () {
-        return this.baseInfo.changeNumber;
-    };
-    return Engine;
-}());
-export { Engine };
+}

package/esm/evaluator/combiners/and.js

@@ -8,12 +8,8 @@ export function andCombinerContext(log, matchers) {
         log.debug(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 (findIndex(matcherResults, thenable) !== -1) {
             return Promise.all(matcherResults).then(andResults);