feat: Implement IGNORE_USER_PROFILE_SERVICE flag in decide options (#642)

* * Check for sticky bucketing if decide options do not include shouldIgnoreUPS

* Update getVariationForFeature method to include options

* Fix existing unit test

* Add unit test for IGNORE_USER_PROFILE_SERVICE flag in decide options

* Fix comments

* Clean up

* Add unit test with IGNORE_USER_PROFILE_SERVICE in default decide options

* Call __saveUserProfile only when shouldIgnoreUPS is true

* Clean up

* Add unit test when no stored bucketing exists

Author: yavorona

packages/optimizely-sdk/lib/core/decision_service/index.d.ts

@@ -39,18 +39,20 @@ export interface DecisionService {
 
   /**
    * Gets a decision response containing variation where visitor will be bucketed and the decide reasons.
-   * @param   {ProjectConfig}     configObj         The parsed project configuration object
-   * @param   {string}            experimentKey
-   * @param   {string}            userId
-   * @param   {UserAttributes}    attributes
-   * @return  {DecisionResponse}  DecisionResponse  DecisionResponse containing variation
-   *                                                the user is bucketed into and the decide reasons.
+   * @param   {ProjectConfig}                     configObj         The parsed project configuration object
+   * @param   {string}                            experimentKey
+   * @param   {string}                            userId
+   * @param   {UserAttributes}                    attributes
+   * @param   {[key: string]: boolean}            options           Optional map of decide options
+   * @return  {DecisionResponse}                  DecisionResponse  DecisionResponse containing variation
+   *                                                                the user is bucketed into and the decide reasons.
    */
   getVariation(
     configObj: ProjectConfig,
     experimentKey: string,
     userId: string,
-    attributes?: UserAttributes
+    attributes?: UserAttributes,
+    options?: { [key: string]: boolean }
   ): DecisionResponse<string | null>;
 
   /**
@@ -60,19 +62,21 @@ export interface DecisionService {
    * experiment properties (both objects), as well as a decisionSource property.
    * decisionSource indicates whether the decision was due to a rollout or an
    * experiment.
-   * @param   {ProjectConfig}     configObj         The parsed project configuration object
-   * @param   {FeatureFlag}       feature           A feature flag object from project configuration
-   * @param   {string}            userId            A string identifying the user, for bucketing
-   * @param   {unknown}           attributes        Optional user attributes
-   * @return  {DecisionResponse}  DecisionResponse  DecisionResponse containing an object with experiment, variation, and decisionSource
-   *                                                properties and the decide reasons. If the user was not bucketed into a variation, the
-   *                                                variation property in decision object is null.
+   * @param   {ProjectConfig}             configObj         The parsed project configuration object
+   * @param   {FeatureFlag}               feature           A feature flag object from project configuration
+   * @param   {string}                    userId            A string identifying the user, for bucketing
+   * @param   {unknown}                   attributes        Optional user attributes
+   * @param   {[key: string]: boolean}    options           Optional map of decide options
+   * @return  {DecisionResponse}          DecisionResponse  DecisionResponse containing an object with experiment, variation, and decisionSource
+   *                                                        properties and the decide reasons. If the user was not bucketed into a variation, the
+   *                                                        variation property in decision object is null.
    */
   getVariationForFeature(
     configObj: ProjectConfig,
     feature: FeatureFlag,
     userId: string,
-    attributes: unknown
+    attributes: unknown,
+    options?: { [key: string]: boolean }
   ): DecisionResponse<DecisionObj>;
 
   /**

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

@@ -21,6 +21,7 @@ import * as enums from '../../utils/enums';
 import projectConfig from '../project_config';
 import AudienceEvaluator from '../audience_evaluator';
 import * as stringValidator from '../../utils/string_value_validator';
+import { OptimizelyDecideOptions } from '../../shared_types';
 
 var MODULE_NAME = 'DECISION_SERVICE';
 var ERROR_MESSAGES = enums.ERROR_MESSAGES;
@@ -55,14 +56,15 @@ function DecisionService(options) {
 
 /**
  * Gets variation where visitor will be bucketed.
- * @param  {Object}                configObj         The parsed project configuration object
- * @param  {string}                experimentKey
- * @param  {string}                userId
- * @param  {Object}                attributes
- * @return {Object}                DecisionResonse   DecisionResonse containing the variation the user is bucketed into
- *                                                   and the decide reasons.
+ * @param  {Object}                                 configObj         The parsed project configuration object
+ * @param  {string}                                 experimentKey
+ * @param  {string}                                 userId
+ * @param  {Object}                                 attributes
+ * @param  {[key: string]: boolean}                 options           Optional map of decide options
+ * @return {Object}                                 DecisionResonse   DecisionResonse containing the variation the user is bucketed into
+ *                                                                    and the decide reasons.
  */
-DecisionService.prototype.getVariation = function(configObj, experimentKey, userId, attributes) {
+DecisionService.prototype.getVariation = function(configObj, experimentKey, userId, attributes, options = {}) {
   // by default, the bucketing ID should be the user ID
   var bucketingId = this._getBucketingId(userId, attributes);
   var decideReasons = [];
@@ -98,26 +100,30 @@ DecisionService.prototype.getVariation = function(configObj, experimentKey, user
     };
   }
 
-  // check for sticky bucketing
-  var experimentBucketMap = this.__resolveExperimentBucketMap(userId, attributes);
-  variation = this.__getStoredVariation(configObj, experiment, userId, experimentBucketMap);
-  if (variation) {
-    var returningStoredVariationMessage = sprintf(
-      LOG_MESSAGES.RETURNING_STORED_VARIATION,
-      MODULE_NAME,
-      variation.key,
-      experimentKey,
-      userId
-    );
-    this.logger.log(
-      LOG_LEVEL.INFO,
-      returningStoredVariationMessage
-    );
-    decideReasons.push(returningStoredVariationMessage);
-    return {
-      result: variation.key,
-      reasons: decideReasons,
-    };
+  var shouldIgnoreUPS = options[OptimizelyDecideOptions.IGNORE_USER_PROFILE_SERVICE];
+
+  // check for sticky bucketing if decide options do not include shouldIgnoreUPS
+  if (!shouldIgnoreUPS) {
+    var experimentBucketMap = this.__resolveExperimentBucketMap(userId, attributes);
+    variation = this.__getStoredVariation(configObj, experiment, userId, experimentBucketMap);
+    if (variation) {
+      var returningStoredVariationMessage = sprintf(
+        LOG_MESSAGES.RETURNING_STORED_VARIATION,
+        MODULE_NAME,
+        variation.key,
+        experimentKey,
+        userId
+      );
+      this.logger.log(
+        LOG_LEVEL.INFO,
+        returningStoredVariationMessage
+      );
+      decideReasons.push(returningStoredVariationMessage);
+      return {
+        result: variation.key,
+        reasons: decideReasons,
+      };
+    }
   }
 
   // Perform regular targeting and bucketing
@@ -174,8 +180,10 @@ DecisionService.prototype.getVariation = function(configObj, experimentKey, user
   );
   this.logger.log(LOG_LEVEL.INFO, userInVariationLogMessage);
   decideReasons.push(userInVariationLogMessage);
-  // persist bucketing
-  this.__saveUserProfile(experiment, variation, userId, experimentBucketMap);
+  // persist bucketing if decide options do not include shouldIgnoreUPS
+  if (!shouldIgnoreUPS) {
+    this.__saveUserProfile(experiment, variation, userId, experimentBucketMap);
+  }
 
   return {
     result: variation.key,
@@ -414,17 +422,18 @@ DecisionService.prototype.__saveUserProfile = function(experiment, variation, us
  * experiment properties (both objects), as well as a decisionSource property.
  * decisionSource indicates whether the decision was due to a rollout or an
  * experiment.
- * @param   {Object}            configObj         The parsed project configuration object
- * @param   {Object}            feature           A feature flag object from project configuration
- * @param   {String}            userId            A string identifying the user, for bucketing
- * @param   {Object}            attributes        Optional user attributes
- * @return  {Object}            DecisionResponse  DecisionResponse containing an object with experiment, variation, and decisionSource
- *                                                properties and decide reasons. If the user was not bucketed into a variation, the variation
- *                                                property in decision object is null.
+ * @param   {Object}                      configObj         The parsed project configuration object
+ * @param   {Object}                      feature           A feature flag object from project configuration
+ * @param   {String}                      userId            A string identifying the user, for bucketing
+ * @param   {Object}                      attributes        Optional user attributes
+ * @param   {[key: string]: boolean}      options           Map of decide options
+ * @return  {Object}                      DecisionResponse  DecisionResponse containing an object with experiment, variation, and decisionSource
+ *                                                          properties and decide reasons. If the user was not bucketed into a variation, the variation
+ *                                                          property in decision object is null.
  */
-DecisionService.prototype.getVariationForFeature = function(configObj, feature, userId, attributes) {
+DecisionService.prototype.getVariationForFeature = function(configObj, feature, userId, attributes, options = {}) {
   var decideReasons = [];
-  var decisionVariation = this._getVariationForFeatureExperiment(configObj, feature, userId, attributes);
+  var decisionVariation = this._getVariationForFeatureExperiment(configObj, feature, userId, attributes, options);
   decideReasons.push(...decisionVariation.reasons);
   var experimentDecision = decisionVariation.result;
 
@@ -457,7 +466,8 @@ DecisionService.prototype.getVariationForFeature = function(configObj, feature,
   };
 };
 
-DecisionService.prototype._getVariationForFeatureExperiment = function(configObj, feature, userId, attributes) {
+
+DecisionService.prototype._getVariationForFeatureExperiment = function(configObj, feature, userId, attributes, options = {}) {
   var decideReasons = [];
   var experiment = null;
   var variationKey = null;
@@ -468,7 +478,7 @@ DecisionService.prototype._getVariationForFeatureExperiment = function(configObj
     if (group) {
       experiment = this._getExperimentInGroup(configObj, group, userId);
       if (experiment && feature.experimentIds.indexOf(experiment.id) !== -1) {
-        decisionVariation = this.getVariation(configObj, experiment.key, userId, attributes);
+        decisionVariation = this.getVariation(configObj, experiment.key, userId, attributes, options);
         decideReasons.push(...decisionVariation.reasons);
         variationKey = decisionVariation.result;
       }
@@ -478,7 +488,7 @@ DecisionService.prototype._getVariationForFeatureExperiment = function(configObj
     // with one experiment, so we look at the first experiment ID only
     experiment = projectConfig.getExperimentFromId(configObj, feature.experimentIds[0], this.logger);
     if (experiment) {
-      decisionVariation = this.getVariation(configObj, experiment.key, userId, attributes);
+      decisionVariation = this.getVariation(configObj, experiment.key, userId, attributes, options);
       decideReasons.push(...decisionVariation.reasons);
       variationKey = decisionVariation.result;
     }

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

@@ -155,8 +155,8 @@ describe('lib/core/decision_service', function() {
         var userProfileLookupStub;
         var userProfileSaveStub;
         var fakeDecisionWhitelistedVariation = {
-          getResult: sinon.stub().returns(null),
-          getReasons: sinon.stub().returns([])
+          result: null,
+          reasons: [],
         }
         beforeEach(function() {
           userProfileServiceInstance = {
@@ -1364,9 +1364,15 @@ describe('lib/core/decision_service', function() {
               decisionSource: DECISION_SOURCES.FEATURE_TEST,
             };
             assert.deepEqual(decision, expectedDecision);
-            sinon.assert.calledWithExactly(getVariationStub, configObj, 'testing_my_feature', 'user1', {
-              test_attribute: 'test_value',
-            });
+            sinon.assert.calledWithExactly(
+              getVariationStub,
+              configObj,
+              'testing_my_feature', 'user1',
+              {
+                test_attribute: 'test_value',
+              },
+              {}
+            );
           });
         });