feat: Added caching for optimizelyConfig object (optimizely#376)

* Added cache of optimizely config until revision is updated

Author: fayyazarshad

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

@@ -16,7 +16,7 @@
 
 // Get Experiment Ids which are part of rollouts
 function getRolloutExperimentIds(rollouts) {
-  return rollouts.reduce(function(experimentIds, rollout) {
+  return (rollouts || []).reduce(function(experimentIds, rollout) {
     rollout.experiments.forEach(function(e) {
       experimentIds[e.id] = true;
     });
@@ -27,17 +27,17 @@ function getRolloutExperimentIds(rollouts) {
 // Gets Map of all experiments except rollouts
 function getExperimentsMap(configObj) {
   var rolloutExperimentIds = getRolloutExperimentIds(configObj.rollouts);
-  var featureVariablesMap = configObj.featureFlags.reduce(function(resultMap, feature){
+  var featureVariablesMap = (configObj.featureFlags || []).reduce(function(resultMap, feature){
     resultMap[feature.id] = feature.variables;
     return resultMap;
   }, {});
-  return configObj.experiments.reduce(function(experiments, experiment) {
+  return (configObj.experiments || []).reduce(function(experiments, experiment) {
     // skip experiments that are part of a rollout
     if (!rolloutExperimentIds[experiment.id]) {
       experiments[experiment.key] = {
         id: experiment.id,
         key: experiment.key,
-        variationsMap: experiment.variations.reduce(function(variations, variation) {
+        variationsMap: (experiment.variations || []).reduce(function(variations, variation) {
           variations[variation.key] = {
             id: variation.id,
             key: variation.key,
@@ -59,14 +59,14 @@ function getMergedVariablesMap(configObj, variation, experimentId, featureVariab
   if (featureId) {
     var experimentFeatureVariables = featureVariablesMap[featureId];
     // Temporary variation variables map to get values to merge.
-    var tempVariablesIdMap = variation.variables.reduce(function(variablesMap, variable) {
+    var tempVariablesIdMap = (variation.variables || []).reduce(function(variablesMap, variable) {
       variablesMap[variable.id] = {
         id: variable.id,
         value: variable.value,
       };
       return variablesMap;
     }, {});
-    variablesObject = experimentFeatureVariables.reduce(function(variablesMap, featureVariable) {
+    variablesObject = (experimentFeatureVariables || []).reduce(function(variablesMap, featureVariable) {
       var variationVariable = tempVariablesIdMap[featureVariable.id];
       var variableValue = variation.featureEnabled && variationVariable ? variationVariable.value : featureVariable.defaultValue;
       variablesMap[featureVariable.key] = {
@@ -83,16 +83,16 @@ function getMergedVariablesMap(configObj, variation, experimentId, featureVariab
 
 // Gets map of all experiments
 function getFeaturesMap(configObj, allExperiments) {
-  return configObj.featureFlags.reduce(function(features, feature) {
+  return (configObj.featureFlags || []).reduce(function(features, feature) {
     features[feature.key] = {
       id: feature.id,
       key: feature.key,
-      experimentsMap: feature.experimentIds.reduce(function(experiments, experimentId) {
+      experimentsMap: (feature.experimentIds || []).reduce(function(experiments, experimentId) {
         var experimentKey = configObj.experimentIdMap[experimentId].key;
         experiments[experimentKey] = allExperiments[experimentKey];
         return experiments;
       }, {}),
-      variablesMap: feature.variables.reduce(function(variables, variable) {
+      variablesMap: (feature.variables || []).reduce(function(variables, variable) {
         variables[variable.key] = {
           id: variable.id,
           key: variable.key,

packages/optimizely-sdk/lib/core/project_config/project_config_manager.js

@@ -21,6 +21,7 @@ var configValidator = require('../../utils/config_validator');
 var datafileManager = require('@optimizely/js-sdk-datafile-manager');
 var enums = require('../../utils/enums');
 var projectConfig = require('../../core/project_config');
+var optimizelyConfig = require('../optimizely_config');
 
 var logger = logging.getLogger();
 
@@ -62,6 +63,7 @@ function ProjectConfigManager(config) {
     logger.error(ex);
     this.__updateListeners = [];
     this.__configObj = null;
+    this.__optimizelyConfigObj = null;
     this.__readyPromise = Promise.resolve({
       success: false,
       reason: getErrorMessage(ex, 'Error in initialize'),
@@ -106,6 +108,7 @@ ProjectConfigManager.prototype.__initialize = function(config) {
         logger: logger,
         skipJSONValidation: this.skipJSONValidation,
       });
+      this.__optimizelyConfigObj = optimizelyConfig.getOptimizelyConfig(this.__configObj);
     } catch (ex) {
       logger.error(ex);
       projectConfigCreationEx = ex;
@@ -269,6 +272,7 @@ ProjectConfigManager.prototype.__handleNewConfigObj = function(newConfigObj) {
   }
 
   this.__configObj = newConfigObj;
+  this.__optimizelyConfigObj = optimizelyConfig.getOptimizelyConfig(newConfigObj);
 
   this.__updateListeners.forEach(function(listener) {
     listener(newConfigObj);
@@ -282,6 +286,14 @@ ProjectConfigManager.prototype.__handleNewConfigObj = function(newConfigObj) {
  */
 ProjectConfigManager.prototype.getConfig = function() {
   return this.__configObj;
+}
+
+/**
+ * Returns the optimizely config object
+ * @return {Object}
+ */
+ProjectConfigManager.prototype.getOptimizelyConfig = function() {
+  return this.__optimizelyConfigObj;
 };
 
 /**

packages/optimizely-sdk/lib/core/project_config/project_config_manager.tests.js

@@ -22,6 +22,7 @@ var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var enums = require('../../utils/enums');
 var jsonSchemaValidator = require('../../utils/json_schema_validator');
 var projectConfig = require('./index');
+var optimizelyConfig = require('../optimizely_config/index');
 var projectConfigManager = require('./project_config_manager');
 var testData = require('../../tests/test_data');
 
@@ -407,5 +408,36 @@ describe('lib/core/project_config/project_config_manager', function() {
         });
       });
     });
+
+    describe('test caching of optimizely config', function() {
+      beforeEach(function() {
+        sinon.stub(optimizelyConfig, "getOptimizelyConfig");
+      });
+
+      afterEach(function() {
+        optimizelyConfig.getOptimizelyConfig.restore();
+      });
+
+      it('should return the same config until revision is changed', function() {
+        var manager = new projectConfigManager.ProjectConfigManager({
+          datafile: testData.getTestProjectConfig(),
+          sdkKey: '12345',
+        });
+        // creating optimizely config once project config manager for the first time
+        sinon.assert.calledOnce(optimizelyConfig.getOptimizelyConfig);
+        // validate it should return the existing optimizely config
+        manager.getOptimizelyConfig();
+        sinon.assert.calledOnce(optimizelyConfig.getOptimizelyConfig);
+        // create config with new revision
+        var fakeDatafileManager = datafileManager.HttpPollingDatafileManager.getCall(0).returnValue;
+        var updateListener = fakeDatafileManager.on.getCall(0).args[1];
+        var newDatafile = testData.getTestProjectConfigWithFeatures();
+        newDatafile.revision = '36';
+        fakeDatafileManager.get.returns(newDatafile);
+        updateListener({ datafile: newDatafile });
+        // verify the optimizely config is updated
+        sinon.assert.calledTwice(optimizelyConfig.getOptimizelyConfig);
+      });
+    });
   });
 });

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

@@ -24,7 +24,6 @@ var eventProcessor = require('@optimizely/js-sdk-event-processor');
 var eventTagsValidator = require('../utils/event_tags_validator');
 var notificationCenter = require('../core/notification_center');
 var projectConfig = require('../core/project_config');
-var optimizelyConfig = require('../core/optimizely_config');
 var sprintf = require('@optimizely/js-sdk-utils').sprintf;
 var userProfileServiceValidator = require('../utils/user_profile_service_validator');
 var stringValidator = require('../utils/string_value_validator');
@@ -880,8 +879,8 @@ Optimizely.prototype.getFeatureVariableString = function(featureKey, variableKey
 
 /**
  * Returns OptimizelyConfig object containing experiments and features data
- * @return {Object} 
- * 
+ * @return {Object}
+ *
  * OptimizelyConfig Object Schema
  * {
  *   'experimentsMap': {
@@ -901,26 +900,26 @@ Optimizely.prototype.getFeatureVariableString = function(featureKey, variableKey
  *             }
  *           }
  *         }
- *       } 
+ *       }
  *     }
  *   },
  *   'featuresMap': {
  *     'awesome-feature': {
  *       'id': '333333',
  *       'key': 'awesome-feature',
  *       'experimentsMap': Object,
- *       'variationsMap': Object, 
- *     } 
+ *       'variationsMap': Object,
+ *     }
  *   }
- * }      
+ * }
  */
 Optimizely.prototype.getOptimizelyConfig = function() {
   try {
     var configObj = this.projectConfigManager.getConfig();
     if (!configObj) {
       return null;
     }
-    return optimizelyConfig.getOptimizelyConfig(configObj);
+    return this.projectConfigManager.getOptimizelyConfig();
   } catch (e) {
     this.logger.log(LOG_LEVEL.ERROR, e.message);
     this.errorHandler.handleError(e);