@splitsoftware/splitio-commons 2.2.1-rc.0 → 2.2.1-rc.1

package/CHANGES.txt

@@ -1,6 +1,5 @@
 2.3.0 (April XXX, 2025)
  - Added support for targeting rules based on rule-based segments.
- - Added support for feature flag prerequisites.
 
 2.2.0 (March 28, 2025)
  - Added a new optional argument to the client `getTreatment` methods to allow passing additional evaluation options, such as a map of properties to append to the generated impressions sent to Split backend. Read more in our docs.

package/cjs/evaluator/Engine.js

@@ -1,58 +1,79 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.engineParser = void 0;
+exports.Engine = void 0;
 var lang_1 = require("../utils/lang");
 var parser_1 = require("./parser");
 var key_1 = require("../utils/key");
 var thenable_1 = require("../utils/promise/thenable");
 var labels_1 = require("../utils/labels");
 var constants_1 = require("../utils/constants");
-var constants_2 = require("../logger/constants");
-var prerequisites_1 = require("./matchers/prerequisites");
 function evaluationResult(result, defaultTreatment) {
     return {
         treatment: (0, lang_1.get)(result, 'treatment', defaultTreatment),
         label: (0, lang_1.get)(result, 'label', labels_1.NO_CONDITION_MATCH)
     };
 }
-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 = (0, lang_1.isString)(split.defaultTreatment) ? split.defaultTreatment : constants_1.CONTROL;
-    var evaluator = (0, parser_1.parser)(log, conditions, storage);
-    var prerequisiteMatcher = (0, prerequisites_1.prerequisitesMatcherContext)(prerequisites, storage, log);
-    return {
-        getTreatment: function (key, attributes, splitEvaluator) {
-            var parsedKey = (0, key_1.keyParser)(key);
-            function evaluate(prerequisitesMet) {
-                if (!prerequisitesMet) {
-                    log.debug(constants_2.ENGINE_DEFAULT, ['Prerequisite not met']);
-                    return {
-                        treatment: defaultTreatment,
-                        label: labels_1.PREREQUISITES_NOT_MET
-                    };
-                }
-                var evaluation = evaluator(parsedKey, seed, trafficAllocation, trafficAllocationSeed, attributes, splitEvaluator);
-                return (0, thenable_1.thenable)(evaluation) ?
-                    evaluation.then(function (result) { return evaluationResult(result, defaultTreatment); }) :
-                    evaluationResult(evaluation, defaultTreatment);
+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 = constants_1.CONTROL;
+        }
+    }
+    Engine.parse = function (log, splitFlatStructure, storage) {
+        var conditions = splitFlatStructure.conditions;
+        var evaluator = (0, parser_1.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 = (0, key_1.keyParser)(key);
+        }
+        catch (err) {
+            return {
+                treatment: constants_1.CONTROL,
+                label: labels_1.EXCEPTION
+            };
+        }
+        if (this.isGarbage()) {
+            treatment = constants_1.CONTROL;
+            label = labels_1.SPLIT_ARCHIVED;
+        }
+        else if (killed) {
+            treatment = defaultTreatment;
+            label = labels_1.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 ((0, thenable_1.thenable)(evaluation)) {
+                return evaluation.then(function (result) { return evaluationResult(result, defaultTreatment); });
             }
-            if (status === 'ARCHIVED')
-                return {
-                    treatment: constants_1.CONTROL,
-                    label: labels_1.SPLIT_ARCHIVED
-                };
-            if (killed) {
-                log.debug(constants_2.ENGINE_DEFAULT, ['Flag is killed']);
-                return {
-                    treatment: defaultTreatment,
-                    label: labels_1.SPLIT_KILLED
-                };
+            else {
+                return evaluationResult(evaluation, defaultTreatment);
             }
-            var prerequisitesMet = prerequisiteMatcher({ key: key, attributes: attributes }, splitEvaluator);
-            return (0, thenable_1.thenable)(prerequisitesMet) ?
-                prerequisitesMet.then(evaluate) :
-                evaluate(prerequisitesMet);
         }
+        return {
+            treatment: treatment,
+            label: label
+        };
     };
-}
-exports.engineParser = engineParser;
+    Engine.prototype.isGarbage = function () {
+        return this.baseInfo.status === 'ARCHIVED';
+    };
+    Engine.prototype.getChangeNumber = function () {
+        return this.baseInfo.changeNumber;
+    };
+    return Engine;
+}());
+exports.Engine = Engine;

package/cjs/evaluator/index.js

@@ -97,19 +97,19 @@ function getEvaluation(log, key, splitJSON, attributes, storage) {
         config: null
     };
     if (splitJSON) {
-        var split = (0, Engine_1.engineParser)(log, splitJSON, storage);
-        evaluation = split.getTreatment(key, attributes, evaluateFeature);
+        var split_1 = Engine_1.Engine.parse(log, splitJSON, storage);
+        evaluation = split_1.getTreatment(key, attributes, evaluateFeature);
         // If the storage is async and the evaluated flag uses segments or dependencies, evaluation is thenable
         if ((0, thenable_1.thenable)(evaluation)) {
             return evaluation.then(function (result) {
-                result.changeNumber = splitJSON.changeNumber;
+                result.changeNumber = split_1.getChangeNumber();
                 result.config = splitJSON.configurations && splitJSON.configurations[result.treatment] || null;
                 result.impressionsDisabled = splitJSON.impressionsDisabled;
                 return result;
             });
         }
         else {
-            evaluation.changeNumber = splitJSON.changeNumber;
+            evaluation.changeNumber = split_1.getChangeNumber(); // Always sync and optional
             evaluation.config = splitJSON.configurations && splitJSON.configurations[evaluation.treatment] || null;
             evaluation.impressionsDisabled = splitJSON.impressionsDisabled;
         }

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_DEFAULT = 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_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.
@@ -33,7 +33,6 @@ exports.SYNC_TASK_EXECUTE = 37;
 exports.SYNC_TASK_STOP = 38;
 exports.SETTINGS_SPLITS_FILTER = 39;
 exports.ENGINE_MATCHER_RESULT = 40;
-exports.ENGINE_DEFAULT = 41;
 exports.CLIENT_READY_FROM_CACHE = 100;
 exports.CLIENT_READY = 101;
 exports.IMPRESSION = 102;

package/cjs/logger/messages/debug.js

@@ -15,7 +15,6 @@ exports.codesDebug = info_1.codesInfo.concat([
     [c.ENGINE_VALUE, c.LOG_PREFIX_ENGINE_VALUE + 'Extracted attribute `%s`. %s will be used for matching.'],
     [c.ENGINE_SANITIZE, c.LOG_PREFIX_ENGINE + ':sanitize: Attempted to sanitize %s which should be of type %s. Sanitized and processed value => %s'],
     [c.ENGINE_MATCHER_RESULT, c.LOG_PREFIX_ENGINE_MATCHER + '[%s] Result: %s. Rule value: %s. Evaluation value: %s'],
-    [c.ENGINE_DEFAULT, c.LOG_PREFIX_ENGINE + 'Evaluates to default treatment. %s'],
     // SDK
     [c.CLEANUP_REGISTERING, c.LOG_PREFIX_CLEANUP + 'Registering cleanup handler %s'],
     [c.CLEANUP_DEREGISTERING, c.LOG_PREFIX_CLEANUP + 'Deregistering cleanup handler %s'],

package/cjs/sdkManager/index.js

@@ -29,8 +29,7 @@ function objectToView(splitObject) {
         configs: splitObject.configurations || {},
         sets: splitObject.sets || [],
         defaultTreatment: splitObject.defaultTreatment,
-        impressionsDisabled: splitObject.impressionsDisabled === true,
-        prerequisites: (splitObject.prerequisites || []).map(function (p) { return ({ flagName: p.n, treatments: p.ts }); }),
+        impressionsDisabled: splitObject.impressionsDisabled === true
     };
 }
 function objectsToViews(splitObjects) {

package/cjs/utils/labels/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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,4 +9,3 @@ 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,54 +1,76 @@
-import { get, isString } from '../utils/lang';
+import { get } from '../utils/lang';
 import { parser } from './parser';
 import { keyParser } from '../utils/key';
 import { thenable } from '../utils/promise/thenable';
-import { NO_CONDITION_MATCH, SPLIT_ARCHIVED, SPLIT_KILLED, PREREQUISITES_NOT_MET } from '../utils/labels';
+import { EXCEPTION, NO_CONDITION_MATCH, SPLIT_ARCHIVED, SPLIT_KILLED } 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)
     };
 }
-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);
+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); });
             }
-            if (status === 'ARCHIVED')
-                return {
-                    treatment: CONTROL,
-                    label: SPLIT_ARCHIVED
-                };
-            if (killed) {
-                log.debug(ENGINE_DEFAULT, ['Flag is killed']);
-                return {
-                    treatment: defaultTreatment,
-                    label: SPLIT_KILLED
-                };
+            else {
+                return evaluationResult(evaluation, defaultTreatment);
             }
-            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/index.js

@@ -1,4 +1,4 @@
-import { engineParser } from './Engine';
+import { Engine } from './Engine';
 import { thenable } from '../utils/promise/thenable';
 import { EXCEPTION, SPLIT_NOT_FOUND } from '../utils/labels';
 import { CONTROL } from '../utils/constants';
@@ -91,19 +91,19 @@ function getEvaluation(log, key, splitJSON, attributes, storage) {
         config: null
     };
     if (splitJSON) {
-        var split = engineParser(log, splitJSON, storage);
-        evaluation = split.getTreatment(key, attributes, evaluateFeature);
+        var split_1 = Engine.parse(log, splitJSON, storage);
+        evaluation = split_1.getTreatment(key, attributes, evaluateFeature);
         // If the storage is async and the evaluated flag uses segments or dependencies, evaluation is thenable
         if (thenable(evaluation)) {
             return evaluation.then(function (result) {
-                result.changeNumber = splitJSON.changeNumber;
+                result.changeNumber = split_1.getChangeNumber();
                 result.config = splitJSON.configurations && splitJSON.configurations[result.treatment] || null;
                 result.impressionsDisabled = splitJSON.impressionsDisabled;
                 return result;
             });
         }
         else {
-            evaluation.changeNumber = splitJSON.changeNumber;
+            evaluation.changeNumber = split_1.getChangeNumber(); // Always sync and optional
             evaluation.config = splitJSON.configurations && splitJSON.configurations[evaluation.treatment] || null;
             evaluation.impressionsDisabled = splitJSON.impressionsDisabled;
         }

package/esm/logger/constants.js

@@ -28,7 +28,6 @@ export var SYNC_TASK_EXECUTE = 37;
 export var SYNC_TASK_STOP = 38;
 export var SETTINGS_SPLITS_FILTER = 39;
 export var ENGINE_MATCHER_RESULT = 40;
-export var ENGINE_DEFAULT = 41;
 export var CLIENT_READY_FROM_CACHE = 100;
 export var CLIENT_READY = 101;
 export var IMPRESSION = 102;

package/esm/logger/messages/debug.js

@@ -11,7 +11,6 @@ export var codesDebug = codesInfo.concat([
     [c.ENGINE_VALUE, c.LOG_PREFIX_ENGINE_VALUE + 'Extracted attribute `%s`. %s will be used for matching.'],
     [c.ENGINE_SANITIZE, c.LOG_PREFIX_ENGINE + ':sanitize: Attempted to sanitize %s which should be of type %s. Sanitized and processed value => %s'],
     [c.ENGINE_MATCHER_RESULT, c.LOG_PREFIX_ENGINE_MATCHER + '[%s] Result: %s. Rule value: %s. Evaluation value: %s'],
-    [c.ENGINE_DEFAULT, c.LOG_PREFIX_ENGINE + 'Evaluates to default treatment. %s'],
     // SDK
     [c.CLEANUP_REGISTERING, c.LOG_PREFIX_CLEANUP + 'Registering cleanup handler %s'],
     [c.CLEANUP_DEREGISTERING, c.LOG_PREFIX_CLEANUP + 'Deregistering cleanup handler %s'],

package/esm/sdkManager/index.js

@@ -26,8 +26,7 @@ function objectToView(splitObject) {
         configs: splitObject.configurations || {},
         sets: splitObject.sets || [],
         defaultTreatment: splitObject.defaultTreatment,
-        impressionsDisabled: splitObject.impressionsDisabled === true,
-        prerequisites: (splitObject.prerequisites || []).map(function (p) { return ({ flagName: p.n, treatments: p.ts }); }),
+        impressionsDisabled: splitObject.impressionsDisabled === true
     };
 }
 function objectsToViews(splitObjects) {

package/esm/utils/labels/index.js

@@ -6,4 +6,3 @@ export var EXCEPTION = 'exception';
 export var SPLIT_ARCHIVED = 'archived';
 export var NOT_IN_SPLIT = 'not in split';
 export var UNSUPPORTED_MATCHER_TYPE = 'targeting rule type unsupported by sdk';
-export var PREREQUISITES_NOT_MET = 'prerequisites not met';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "2.2.1-rc.0",
+  "version": "2.2.1-rc.1",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/dtos/types.ts

@@ -215,10 +215,6 @@ export interface ISplit {
   changeNumber: number,
   status: 'ACTIVE' | 'ARCHIVED',
   conditions: ISplitCondition[],
-  prerequisites?: {
-    n: string,
-    ts: string[]
-  }[]
   killed: boolean,
   defaultTreatment: string,
   trafficTypeName: string,

package/src/evaluator/Engine.ts

@@ -1,16 +1,14 @@
-import { get, isString } from '../utils/lang';
+import { get } from '../utils/lang';
 import { parser } from './parser';
 import { keyParser } from '../utils/key';
 import { thenable } from '../utils/promise/thenable';
-import { NO_CONDITION_MATCH, SPLIT_ARCHIVED, SPLIT_KILLED, PREREQUISITES_NOT_MET } from '../utils/labels';
+import { EXCEPTION, NO_CONDITION_MATCH, SPLIT_ARCHIVED, SPLIT_KILLED } from '../utils/labels';
 import { CONTROL } from '../utils/constants';
 import { ISplit, MaybeThenable } from '../dtos/types';
 import SplitIO from '../../types/splitio';
 import { IStorageAsync, IStorageSync } from '../storages/types';
-import { IEvaluation, IEvaluationResult, ISplitEvaluator } from './types';
+import { IEvaluation, IEvaluationResult, IEvaluator, ISplitEvaluator } from './types';
 import { ILogger } from '../logger/types';
-import { ENGINE_DEFAULT } from '../logger/constants';
-import { prerequisitesMatcherContext } from './matchers/prerequisites';
 
 function evaluationResult(result: IEvaluation | undefined, defaultTreatment: string): IEvaluationResult {
   return {
@@ -19,55 +17,84 @@ function evaluationResult(result: IEvaluation | undefined, defaultTreatment: str
   };
 }
 
-export function engineParser(log: ILogger, split: ISplit, storage: IStorageSync | IStorageAsync) {
-  const { killed, seed, trafficAllocation, trafficAllocationSeed, status, conditions, prerequisites } = split;
+export class Engine {
 
-  const defaultTreatment = isString(split.defaultTreatment) ? split.defaultTreatment : CONTROL;
+  constructor(private baseInfo: ISplit, private evaluator: IEvaluator) {
 
-  const evaluator = parser(log, conditions, storage);
-  const prerequisiteMatcher = prerequisitesMatcherContext(prerequisites, storage, log);
-
-  return {
-
-    getTreatment(key: SplitIO.SplitKey, attributes: SplitIO.Attributes | undefined, splitEvaluator: ISplitEvaluator): MaybeThenable<IEvaluationResult> {
+    // in case we don't have a default treatment in the instantiation, use 'control'
+    if (typeof this.baseInfo.defaultTreatment !== 'string') {
+      this.baseInfo.defaultTreatment = CONTROL;
+    }
+  }
 
-      const parsedKey = keyParser(key);
+  static parse(log: ILogger, splitFlatStructure: ISplit, storage: IStorageSync | IStorageAsync) {
+    const conditions = splitFlatStructure.conditions;
+    const evaluator = parser(log, conditions, storage);
 
-      function evaluate(prerequisitesMet: boolean) {
-        if (!prerequisitesMet) {
-          log.debug(ENGINE_DEFAULT, ['Prerequisite not met']);
-          return {
-            treatment: defaultTreatment,
-            label: PREREQUISITES_NOT_MET
-          };
-        }
+    return new Engine(splitFlatStructure, evaluator);
+  }
 
-        const evaluation = evaluator(parsedKey, seed, trafficAllocation, trafficAllocationSeed, attributes, splitEvaluator) as MaybeThenable<IEvaluation>;
+  getKey() {
+    return this.baseInfo.name;
+  }
 
-        return thenable(evaluation) ?
-          evaluation.then(result => evaluationResult(result, defaultTreatment)) :
-          evaluationResult(evaluation, defaultTreatment);
-      }
+  getTreatment(key: SplitIO.SplitKey, attributes: SplitIO.Attributes | undefined, splitEvaluator: ISplitEvaluator): MaybeThenable<IEvaluationResult> {
+    const {
+      killed,
+      seed,
+      defaultTreatment,
+      trafficAllocation,
+      trafficAllocationSeed
+    } = this.baseInfo;
+    let parsedKey;
+    let treatment;
+    let label;
 
-      if (status === 'ARCHIVED') return {
+    try {
+      parsedKey = keyParser(key);
+    } catch (err) {
+      return {
         treatment: CONTROL,
-        label: SPLIT_ARCHIVED
+        label: EXCEPTION
       };
+    }
+
+    if (this.isGarbage()) {
+      treatment = CONTROL;
+      label = SPLIT_ARCHIVED;
+    } else if (killed) {
+      treatment = defaultTreatment;
+      label = SPLIT_KILLED;
+    } else {
+      const evaluation = this.evaluator(
+        parsedKey,
+        seed,
+        trafficAllocation,
+        trafficAllocationSeed,
+        attributes,
+        splitEvaluator
+      ) as MaybeThenable<IEvaluation>;
 
-      if (killed) {
-        log.debug(ENGINE_DEFAULT, ['Flag is killed']);
-        return {
-          treatment: defaultTreatment,
-          label: SPLIT_KILLED
-        };
+      // Evaluation could be async, so we should handle that case checking for a
+      // thenable object
+      if (thenable(evaluation)) {
+        return evaluation.then(result => evaluationResult(result, defaultTreatment));
+      } else {
+        return evaluationResult(evaluation, defaultTreatment);
       }
+    }
 
-      const prerequisitesMet = prerequisiteMatcher({ key, attributes }, splitEvaluator);
+    return {
+      treatment,
+      label
+    };
+  }
 
-      return thenable(prerequisitesMet) ?
-        prerequisitesMet.then(evaluate) :
-        evaluate(prerequisitesMet);
-    }
-  };
+  isGarbage() {
+    return this.baseInfo.status === 'ARCHIVED';
+  }
 
+  getChangeNumber() {
+    return this.baseInfo.changeNumber;
+  }
 }

package/src/evaluator/index.ts

@@ -1,4 +1,4 @@
-import { engineParser } from './Engine';
+import { Engine } from './Engine';
 import { thenable } from '../utils/promise/thenable';
 import { EXCEPTION, SPLIT_NOT_FOUND } from '../utils/labels';
 import { CONTROL } from '../utils/constants';
@@ -99,7 +99,9 @@ export function evaluateFeaturesByFlagSets(
 ): MaybeThenable<Record<string, IEvaluationResult>> {
   let storedFlagNames: MaybeThenable<Set<string>[]>;
 
-  function evaluate(featureFlagsByFlagSets: Set<string>[]) {
+  function evaluate(
+    featureFlagsByFlagSets: Set<string>[],
+  ) {
     let featureFlags = new Set<string>();
     for (let i = 0; i < flagSets.length; i++) {
       const featureFlagByFlagSet = featureFlagsByFlagSets[i];
@@ -146,20 +148,20 @@ function getEvaluation(
   };
 
   if (splitJSON) {
-    const split = engineParser(log, splitJSON, storage);
+    const split = Engine.parse(log, splitJSON, storage);
     evaluation = split.getTreatment(key, attributes, evaluateFeature);
 
     // If the storage is async and the evaluated flag uses segments or dependencies, evaluation is thenable
     if (thenable(evaluation)) {
       return evaluation.then(result => {
-        result.changeNumber = splitJSON.changeNumber;
+        result.changeNumber = split.getChangeNumber();
         result.config = splitJSON.configurations && splitJSON.configurations[result.treatment] || null;
         result.impressionsDisabled = splitJSON.impressionsDisabled;
 
         return result;
       });
     } else {
-      evaluation.changeNumber = splitJSON.changeNumber;
+      evaluation.changeNumber = split.getChangeNumber(); // Always sync and optional
       evaluation.config = splitJSON.configurations && splitJSON.configurations[evaluation.treatment] || null;
       evaluation.impressionsDisabled = splitJSON.impressionsDisabled;
     }

package/src/logger/constants.ts

@@ -28,7 +28,6 @@ export const SYNC_TASK_EXECUTE = 37;
 export const SYNC_TASK_STOP = 38;
 export const SETTINGS_SPLITS_FILTER = 39;
 export const ENGINE_MATCHER_RESULT = 40;
-export const ENGINE_DEFAULT = 41;
 
 export const CLIENT_READY_FROM_CACHE = 100;
 export const CLIENT_READY = 101;

package/src/logger/messages/debug.ts

@@ -12,7 +12,6 @@ export const codesDebug: [number, string][] = codesInfo.concat([
   [c.ENGINE_VALUE, c.LOG_PREFIX_ENGINE_VALUE + 'Extracted attribute `%s`. %s will be used for matching.'],
   [c.ENGINE_SANITIZE, c.LOG_PREFIX_ENGINE + ':sanitize: Attempted to sanitize %s which should be of type %s. Sanitized and processed value => %s'],
   [c.ENGINE_MATCHER_RESULT, c.LOG_PREFIX_ENGINE_MATCHER + '[%s] Result: %s. Rule value: %s. Evaluation value: %s'],
-  [c.ENGINE_DEFAULT, c.LOG_PREFIX_ENGINE + 'Evaluates to default treatment. %s'],
   // SDK
   [c.CLEANUP_REGISTERING, c.LOG_PREFIX_CLEANUP + 'Registering cleanup handler %s'],
   [c.CLEANUP_DEREGISTERING, c.LOG_PREFIX_CLEANUP + 'Deregistering cleanup handler %s'],

package/src/sdkManager/index.ts

@@ -32,8 +32,7 @@ function objectToView(splitObject: ISplit | null): SplitIO.SplitView | null {
     configs: splitObject.configurations || {},
     sets: splitObject.sets || [],
     defaultTreatment: splitObject.defaultTreatment,
-    impressionsDisabled: splitObject.impressionsDisabled === true,
-    prerequisites: (splitObject.prerequisites || []).map(p => ({ flagName: p.n, treatments: p.ts })),
+    impressionsDisabled: splitObject.impressionsDisabled === true
   };
 }
 

package/src/utils/labels/index.ts

@@ -6,4 +6,3 @@ export const EXCEPTION = 'exception';
 export const SPLIT_ARCHIVED = 'archived';
 export const NOT_IN_SPLIT = 'not in split';
 export const UNSUPPORTED_MATCHER_TYPE = 'targeting rule type unsupported by sdk';
-export const PREREQUISITES_NOT_MET = 'prerequisites not met';

package/types/splitio.d.ts

@@ -879,7 +879,7 @@ declare namespace SplitIO {
     /**
      * The list of treatments available for the feature flag.
      */
-    treatments: string[];
+    treatments: Array<string>;
     /**
      * Current change number of the feature flag.
      */
@@ -903,10 +903,6 @@ declare namespace SplitIO {
      * Whether the feature flag has impressions tracking disabled or not.
      */
     impressionsDisabled: boolean;
-    /**
-     * Prerequisites for the feature flag.
-     */
-    prerequisites: Array<{ flagName: string, treatments: string[] }>;
   };
   /**
    * A promise that resolves to a feature flag view or null if the feature flag is not found.

package/cjs/evaluator/matchers/prerequisites.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prerequisitesMatcherContext = void 0;
-var thenable_1 = require("../../utils/promise/thenable");
-function prerequisitesMatcherContext(prerequisites, storage, log) {
-    if (prerequisites === void 0) { prerequisites = []; }
-    return function prerequisitesMatcher(_a, splitEvaluator) {
-        var key = _a.key, attributes = _a.attributes;
-        function evaluatePrerequisite(prerequisite) {
-            var evaluation = splitEvaluator(log, key, prerequisite.n, attributes, storage);
-            return (0, thenable_1.thenable)(evaluation) ?
-                evaluation.then(function (evaluation) { return prerequisite.ts.indexOf(evaluation.treatment) !== -1; }) :
-                prerequisite.ts.indexOf(evaluation.treatment) !== -1;
-        }
-        return prerequisites.reduce(function (prerequisitesMet, prerequisite) {
-            return (0, thenable_1.thenable)(prerequisitesMet) ?
-                prerequisitesMet.then(function (prerequisitesMet) { return prerequisitesMet ? evaluatePrerequisite(prerequisite) : false; }) :
-                prerequisitesMet ? evaluatePrerequisite(prerequisite) : false;
-        }, true);
-    };
-}
-exports.prerequisitesMatcherContext = prerequisitesMatcherContext;

package/esm/evaluator/matchers/prerequisites.js

@@ -1,18 +0,0 @@
-import { thenable } from '../../utils/promise/thenable';
-export function prerequisitesMatcherContext(prerequisites, storage, log) {
-    if (prerequisites === void 0) { prerequisites = []; }
-    return function prerequisitesMatcher(_a, splitEvaluator) {
-        var key = _a.key, attributes = _a.attributes;
-        function evaluatePrerequisite(prerequisite) {
-            var evaluation = splitEvaluator(log, key, prerequisite.n, attributes, storage);
-            return thenable(evaluation) ?
-                evaluation.then(function (evaluation) { return prerequisite.ts.indexOf(evaluation.treatment) !== -1; }) :
-                prerequisite.ts.indexOf(evaluation.treatment) !== -1;
-        }
-        return prerequisites.reduce(function (prerequisitesMet, prerequisite) {
-            return thenable(prerequisitesMet) ?
-                prerequisitesMet.then(function (prerequisitesMet) { return prerequisitesMet ? evaluatePrerequisite(prerequisite) : false; }) :
-                prerequisitesMet ? evaluatePrerequisite(prerequisite) : false;
-        }, true);
-    };
-}

package/src/evaluator/matchers/prerequisites.ts

@@ -1,24 +0,0 @@
-import { ISplit, MaybeThenable } from '../../dtos/types';
-import { IStorageAsync, IStorageSync } from '../../storages/types';
-import { ILogger } from '../../logger/types';
-import { thenable } from '../../utils/promise/thenable';
-import { IDependencyMatcherValue, ISplitEvaluator } from '../types';
-
-export function prerequisitesMatcherContext(prerequisites: ISplit['prerequisites'] = [], storage: IStorageSync | IStorageAsync, log: ILogger) {
-
-  return function prerequisitesMatcher({ key, attributes }: IDependencyMatcherValue, splitEvaluator: ISplitEvaluator): MaybeThenable<boolean> {
-
-    function evaluatePrerequisite(prerequisite: { n: string; ts: string[] }): MaybeThenable<boolean> {
-      const evaluation = splitEvaluator(log, key, prerequisite.n, attributes, storage);
-      return thenable(evaluation) ?
-        evaluation.then(evaluation => prerequisite.ts.indexOf(evaluation.treatment!) !== -1) :
-        prerequisite.ts.indexOf(evaluation.treatment!) !== -1;
-    }
-
-    return prerequisites.reduce<MaybeThenable<boolean>>((prerequisitesMet, prerequisite) => {
-      return thenable(prerequisitesMet) ?
-        prerequisitesMet.then(prerequisitesMet => prerequisitesMet ? evaluatePrerequisite(prerequisite) : false) :
-        prerequisitesMet ? evaluatePrerequisite(prerequisite) : false;
-    }, true);
-  };
-}