DO NOT REVIEW - SEE https://github.com/optimizely/javascript-sdk/pull/288

packages/optimizely-sdk/lib/core/audience_evaluator/index.js

@@ -15,55 +15,68 @@
  */
 var conditionTreeEvaluator = require('../condition_tree_evaluator');
 var customAttributeConditionEvaluator = require('../custom_attribute_condition_evaluator');
+var ERROR_MESSAGES = require('../../utils/enums').ERROR_MESSAGES;
 var enums = require('../../utils/enums');
 var sprintf = require('sprintf-js').sprintf;
 
 var LOG_LEVEL = enums.LOG_LEVEL;
 var LOG_MESSAGES = enums.LOG_MESSAGES;
 var MODULE_NAME = 'AUDIENCE_EVALUATOR';
 
-module.exports = {
-  /**
-   * Determine if the given user attributes satisfy the given audience conditions
-   * @param  {Array|String|null|undefined}  audienceConditions    Audience conditions to match the user attributes against - can be an array
-   *                                                              of audience IDs, a nested array of conditions, or a single leaf condition.
-   *                                                              Examples: ["5", "6"], ["and", ["or", "1", "2"], "3"], "1"
-   * @param  {Object}                       audiencesById         Object providing access to full audience objects for audience IDs
-   *                                                              contained in audienceConditions. Keys should be audience IDs, values
-   *                                                              should be full audience objects with conditions properties
-   * @param  {Object}                       [userAttributes]      User attributes which will be used in determining if audience conditions
-   *                                                              are met. If not provided, defaults to an empty object
-   * @param  {Object}                       logger                Logger instance.
-   * @return {Boolean}                                            true if the user attributes match the given audience conditions, false
-   *                                                              otherwise
-   */
-  evaluate: function(audienceConditions, audiencesById, userAttributes, logger) {
-    // if there are no audiences, return true because that means ALL users are included in the experiment
-    if (!audienceConditions || audienceConditions.length === 0) {
-      return true;
-    }
 
-    if (!userAttributes) {
-      userAttributes = {};
-    }
+function AudienceEvaluator(conditionEvaluators) {
+  this.typeToEvaluatorMap = Object.assign({
+    'custom_attribute': customAttributeConditionEvaluator
+  }, conditionEvaluators);
+}
 
-    var evaluateConditionWithUserAttributes = function(condition) {
-      return customAttributeConditionEvaluator.evaluate(condition, userAttributes, logger);
-    };
+/**
+ * Determine if the given user attributes satisfy the given audience conditions
+ * @param  {Array|String|null|undefined}  audienceConditions    Audience conditions to match the user attributes against - can be an array
+ *                                                              of audience IDs, a nested array of conditions, or a single leaf condition.
+ *                                                              Examples: ["5", "6"], ["and", ["or", "1", "2"], "3"], "1"
+ * @param  {Object}                       audiencesById         Object providing access to full audience objects for audience IDs
+ *                                                              contained in audienceConditions. Keys should be audience IDs, values
+ *                                                              should be full audience objects with conditions properties
+ * @param  {Object}                       [userAttributes]      User attributes which will be used in determining if audience conditions
+ *                                                              are met. If not provided, defaults to an empty object
+ * @param  {Object}                       logger                Logger instance.
+ * @return {Boolean}                                            true if the user attributes match the given audience conditions, false
+ *                                                              otherwise
+ */
+AudienceEvaluator.prototype.evaluate = function(audienceConditions, audiencesById, userAttributes, logger) {
+  // if there are no audiences, return true because that means ALL users are included in the experiment
+  if (!audienceConditions || audienceConditions.length === 0) {
+    return true;
+  }
 
-    var evaluateAudience = function(audienceId) {
-      var audience = audiencesById[audienceId];
-      if (audience) {
-        logger.log(LOG_LEVEL.DEBUG, sprintf(LOG_MESSAGES.EVALUATING_AUDIENCE, MODULE_NAME, audienceId, JSON.stringify(audience.conditions)));
-        var result = conditionTreeEvaluator.evaluate(audience.conditions, evaluateConditionWithUserAttributes);
-        var resultText = result === null ? 'UNKNOWN' : result.toString().toUpperCase();
-        logger.log(LOG_LEVEL.INFO, sprintf(LOG_MESSAGES.AUDIENCE_EVALUATION_RESULT, MODULE_NAME, audienceId, resultText));
-        return result;
-      }
+  if (!userAttributes) {
+    userAttributes = {};
+  }
 
-      return null;
-    };
+  var evaluateConditionWithUserAttributes = function(condition) {
+    var evaluator = this.typeToEvaluatorMap[condition.type];
+    if (!evaluator) {
+      logger.log(LOG_LEVEL.WARNING, sprintf(ERROR_MESSAGES.AUDIENCE_EVALUATOR_EXPECTED, MODULE_NAME, condition.type));
+      return false;
+    }
+    return evaluator.evaluate(condition, userAttributes, logger);
+  }.bind(this);
 
-    return conditionTreeEvaluator.evaluate(audienceConditions, evaluateAudience) || false;
-  },
+  var evaluateAudience = function(audienceId) {
+    var audience = audiencesById[audienceId];
+    if (audience) {
+      logger.log(LOG_LEVEL.DEBUG, sprintf(LOG_MESSAGES.EVALUATING_AUDIENCE, MODULE_NAME, audienceId, JSON.stringify(audience.conditions)));
+      var result = conditionTreeEvaluator.evaluate(audience.conditions, evaluateConditionWithUserAttributes);
+      var resultText = result === null ? 'UNKNOWN' : result.toString().toUpperCase();
+      logger.log(LOG_LEVEL.INFO, sprintf(LOG_MESSAGES.AUDIENCE_EVALUATION_RESULT, MODULE_NAME, audienceId, resultText));
+      return result;
+    }
+
+    return null;
+  };
+
+  return conditionTreeEvaluator.evaluate(audienceConditions, evaluateAudience) || false;
 };
+
+module.exports = AudienceEvaluator;

packages/optimizely-sdk/lib/core/audience_evaluator/index.tests.js

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var audienceEvaluator = require('./');
+var AudienceEvaluator = require('./');
 var chai = require('chai');
 var sprintf = require('sprintf-js').sprintf;
 var conditionTreeEvaluator = require('../condition_tree_evaluator');
@@ -53,6 +53,11 @@ var audiencesById = {
 };
 
 describe('lib/core/audience_evaluator', function() {
+  var audienceEvaluator;
+  beforeEach(function() {
+    audienceEvaluator = new AudienceEvaluator();
+  });
+
   describe('APIs', function() {
     describe('evaluate', function() {
       var mockLogger = logger.createLogger({logLevel: LOG_LEVEL.INFO});

packages/optimizely-sdk/lib/core/decision_service/index.js

@@ -14,7 +14,7 @@
  * limitations under the License.                                           *
  ***************************************************************************/
 
-var audienceEvaluator = require('../audience_evaluator');
+var AudienceEvaluator = require('../audience_evaluator');
 var bucketer = require('../bucketer');
 var enums = require('../../utils/enums');
 var fns = require('../../utils/fns');
@@ -52,6 +52,7 @@ function DecisionService(options) {
   this.configObj = options.configObj;
   this.userProfileService = options.userProfileService || null;
   this.logger = options.logger;
+  this.audienceEvaluator = new AudienceEvaluator(options.conditionEvaluators);
 }
 
 /**
@@ -168,9 +169,9 @@ DecisionService.prototype.__checkIfUserIsInAudience = function(experimentKey, us
   var experimentAudienceConditions = projectConfig.getExperimentAudienceConditions(this.configObj, experimentKey);
   var audiencesById = projectConfig.getAudiencesById(this.configObj);
   this.logger.log(LOG_LEVEL.DEBUG, sprintf(LOG_MESSAGES.EVALUATING_AUDIENCES_COMBINED, MODULE_NAME, experimentKey, JSON.stringify(experimentAudienceConditions)));
-  var result = audienceEvaluator.evaluate(experimentAudienceConditions, audiencesById, attributes, this.logger);
+  var result = this.audienceEvaluator.evaluate(experimentAudienceConditions, audiencesById, attributes, this.logger);
   this.logger.log(LOG_LEVEL.INFO, sprintf(LOG_MESSAGES.AUDIENCE_EVALUATION_RESULT_COMBINED, MODULE_NAME, experimentKey, result.toString().toUpperCase()));
-  
+
   if (!result) {
     var userDoesNotMeetConditionsLogMessage = sprintf(LOG_MESSAGES.USER_NOT_IN_EXPERIMENT, MODULE_NAME, userId, experimentKey);
     this.logger.log(LOG_LEVEL.INFO, userDoesNotMeetConditionsLogMessage);

packages/optimizely-sdk/lib/core/decision_service/index.tests.js

@@ -27,7 +27,7 @@ var sprintf = require('sprintf-js').sprintf;
 var testData = require('../../tests/test_data').getTestProjectConfig();
 var testDataWithFeatures = require('../../tests/test_data').getTestProjectConfigWithFeatures();
 var jsonSchemaValidator = require('../../utils/json_schema_validator');
-var audienceEvaluator = require('../audience_evaluator');
+var AudienceEvaluator = require('../audience_evaluator');
 
 var chai = require('chai');
 var sinon = require('sinon');
@@ -421,7 +421,7 @@ describe('lib/core/decision_service', function() {
       var __audienceEvaluateSpy;
 
       beforeEach(function() {
-        __audienceEvaluateSpy = sinon.spy(audienceEvaluator, 'evaluate');
+        __audienceEvaluateSpy = sinon.spy(AudienceEvaluator.prototype, 'evaluate');
       });
 
       afterEach(function() {

packages/optimizely-sdk/lib/optimizely/index.js

@@ -98,6 +98,7 @@ function Optimizely(config) {
     configObj: this.configObj,
     userProfileService: userProfileService,
     logger: this.logger,
+    conditionEvaluators: config.conditionEvaluators
   });
 
   this.notificationCenter = notificationCenter.createNotificationCenter({

packages/optimizely-sdk/lib/optimizely/index.tests.js

@@ -15,7 +15,7 @@
  ***************************************************************************/
 
 var Optimizely = require('./');
-var audienceEvaluator = require('../core/audience_evaluator');
+var AudienceEvaluator = require('../core/audience_evaluator');
 var bluebird = require('bluebird');
 var bucketer = require('../core/bucketer');
 var enums = require('../utils/enums');
@@ -238,6 +238,7 @@ describe('lib/optimizely', function() {
             configObj: optlyInstance.configObj,
             userProfileService: userProfileServiceInstance,
             logger: createdLogger,
+            conditionEvaluators: undefined
           });
 
           // Checking the second log message as the first one just says "Datafile is valid"
@@ -262,6 +263,7 @@ describe('lib/optimizely', function() {
             configObj: optlyInstance.configObj,
             userProfileService: null,
             logger: createdLogger,
+            conditionEvaluators: undefined
           });
 
           // Checking the second log message as the first one just says "Datafile is valid"
@@ -3503,6 +3505,7 @@ describe('lib/optimizely', function() {
       logToConsole: false,
     });
     var optlyInstance;
+    var audienceEvaluator;
     beforeEach(function() {
       optlyInstance = new Optimizely({
         clientEngine: 'node-sdk',
@@ -3514,6 +3517,7 @@ describe('lib/optimizely', function() {
         logger: createdLogger,
         isValidInstance: true,
       });
+      audienceEvaluator = AudienceEvaluator.prototype;
 
       sandbox.stub(eventDispatcher, 'dispatchEvent');
       sandbox.stub(errorHandler, 'handleError');

packages/optimizely-sdk/lib/utils/enums/index.js

@@ -26,6 +26,7 @@ exports.LOG_LEVEL = {
 };
 
 exports.ERROR_MESSAGES = {
+  AUDIENCE_EVALUATOR_EXPECTED: '%s: No audience evaluator present for condition type: %s.',
   EXPERIMENT_KEY_NOT_IN_DATAFILE: '%s: Experiment key %s is not in datafile.',
   FEATURE_NOT_IN_DATAFILE: '%s: Feature key %s is not in datafile.',
   IMPROPERLY_FORMATTED_EXPERIMENT: '%s: Experiment key %s is improperly formatted.',