Crubin/forced bucketing (#70)

* added tests for forced bucketing

* added testing for not running experiment

* version bump, changelog change

Author: caitlinrubin-optimizely

CHANGELOG

@@ -1,3 +1,12 @@
+-------------------------------------------------------------------------------
+1.5.0
+-------------------------------------------------------------------------------
+* Bump optimizely-server-sdk to version 1.4.0, which includes:
+  - Add support for numeric metrics.
+  - Add getForcedVariation and setForcedVariation methods for client-side variation setting
+  - Bug fix for filtering out null attribute and event tag values
+-------------------------------------------------------------------------------
+
 -------------------------------------------------------------------------------
 1.4.3
 -------------------------------------------------------------------------------

index.js

@@ -21,7 +21,7 @@ var enums = require('optimizely-server-sdk/lib/utils/enums');
 var logger = require('optimizely-server-sdk/lib/plugins/logger');
 var Optimizely = require('optimizely-server-sdk/lib/optimizely');
 
-var JAVASCRIPT_CLIENT_VERSION = '1.4.3';
+var JAVASCRIPT_CLIENT_VERSION = '1.5.0';
 var MODULE_NAME = 'INDEX';
 
 /**

package.json

@@ -1,6 +1,6 @@
 {
   "name": "optimizely-client-sdk",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "description": "JavaScript SDK for Optimizely X Full Stack",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,7 @@
   },
   "homepage": "https://github.com/optimizely/javascript-sdk#readme",
   "dependencies": {
-    "optimizely-server-sdk": "~1.3.3"
+    "optimizely-server-sdk": "~1.4.0"
   },
   "devDependencies": {
     "chai": "^3.5.0",

tests.js

@@ -112,6 +112,155 @@ describe('javascript-sdk', function() {
         done();
       });
 
+      it('should be able to set and get a forced variation', function(done) {
+        var optlyInstance = optimizelyFactory.createInstance({
+          datafile: testData.getTestProjectConfig(),
+          errorHandler: fakeErrorHandler,
+          eventDispatcher: eventDispatcher,
+          logger: fakeLogger,
+        });
+
+        var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
+        assert.strictEqual(didSetVariation, true);
+
+        var variation = optlyInstance.getForcedVariation('testExperiment', 'testUser');
+        assert.strictEqual(variation, 'control')
+        done();
+      });
+
+      it('should be able to set and unset a forced variation', function(done) {
+        var optlyInstance = optimizelyFactory.createInstance({
+          datafile: testData.getTestProjectConfig(),
+          errorHandler: fakeErrorHandler,
+          eventDispatcher: eventDispatcher,
+          logger: fakeLogger,
+        });
+
+        var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
+        assert.strictEqual(didSetVariation, true);
+
+        var variation = optlyInstance.getForcedVariation('testExperiment', 'testUser');
+        assert.strictEqual(variation, 'control')
+
+        var didSetVariation2 = optlyInstance.setForcedVariation('testExperiment', 'testUser', null);
+        assert.strictEqual(didSetVariation2, true);
+
+        var variation2 = optlyInstance.getForcedVariation('testExperiment', 'testUser');
+        assert.strictEqual(variation2, null)
+        done();
+      });
+
+      it('should be able to set multiple experiments for one user', function(done) {
+        var optlyInstance = optimizelyFactory.createInstance({
+          datafile: testData.getTestProjectConfig(),
+          errorHandler: fakeErrorHandler,
+          eventDispatcher: eventDispatcher,
+          logger: fakeLogger,
+        });
+
+        var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
+        assert.strictEqual(didSetVariation, true);
+
+        var didSetVariation2 = optlyInstance.setForcedVariation('testExperimentLaunched', 'testUser', 'controlLaunched');
+        assert.strictEqual(didSetVariation2, true);
+
+
+        var variation = optlyInstance.getForcedVariation('testExperiment', 'testUser');
+        assert.strictEqual(variation, 'control')
+
+        var variation2 = optlyInstance.getForcedVariation('testExperimentLaunched', 'testUser');
+        assert.strictEqual(variation2, 'controlLaunched')
+        done();
+      });
+
+      it('should be able to set multiple experiments for one user, and unset one', function(done) {
+        var optlyInstance = optimizelyFactory.createInstance({
+          datafile: testData.getTestProjectConfig(),
+          errorHandler: fakeErrorHandler,
+          eventDispatcher: eventDispatcher,
+          logger: fakeLogger,
+        });
+
+        var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
+        assert.strictEqual(didSetVariation, true);
+
+        var didSetVariation2 = optlyInstance.setForcedVariation('testExperimentLaunched', 'testUser', 'controlLaunched');
+        assert.strictEqual(didSetVariation2, true);
+
+        var didSetVariation2 = optlyInstance.setForcedVariation('testExperimentLaunched', 'testUser', null);
+        assert.strictEqual(didSetVariation2, true);
+
+        var variation = optlyInstance.getForcedVariation('testExperiment', 'testUser');
+        assert.strictEqual(variation, 'control')
+
+        var variation2 = optlyInstance.getForcedVariation('testExperimentLaunched', 'testUser');
+        assert.strictEqual(variation2, null)
+        done();
+      });
+
+      it('should be able to set multiple experiments for one user, and reset one', function(done) {
+        var optlyInstance = optimizelyFactory.createInstance({
+          datafile: testData.getTestProjectConfig(),
+          errorHandler: fakeErrorHandler,
+          eventDispatcher: eventDispatcher,
+          logger: fakeLogger,
+        });
+
+        var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
+        assert.strictEqual(didSetVariation, true);
+
+        var didSetVariation2 = optlyInstance.setForcedVariation('testExperimentLaunched', 'testUser', 'controlLaunched');
+        assert.strictEqual(didSetVariation2, true);
+
+        var didSetVariation2 = optlyInstance.setForcedVariation('testExperimentLaunched', 'testUser', 'variationLaunched');
+        assert.strictEqual(didSetVariation2, true);
+
+        var variation = optlyInstance.getForcedVariation('testExperiment', 'testUser');
+        assert.strictEqual(variation, 'control')
+
+        var variation2 = optlyInstance.getForcedVariation('testExperimentLaunched', 'testUser');
+        assert.strictEqual(variation2, 'variationLaunched')
+        done();
+      });
+
+      it('should override bucketing when setForcedVariation is called', function(done) {
+        var optlyInstance = optimizelyFactory.createInstance({
+          datafile: testData.getTestProjectConfig(),
+          errorHandler: fakeErrorHandler,
+          eventDispatcher: eventDispatcher,
+          logger: fakeLogger,
+        });
+
+        var didSetVariation = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'control');
+        assert.strictEqual(didSetVariation, true);
+
+        var variation = optlyInstance.getVariation('testExperiment', 'testUser');
+        assert.strictEqual(variation, 'control')
+
+        var didSetVariation2 = optlyInstance.setForcedVariation('testExperiment', 'testUser', 'variation');
+        assert.strictEqual(didSetVariation2, true);
+
+        var variation = optlyInstance.getVariation('testExperiment', 'testUser');
+        assert.strictEqual(variation, 'variation')
+        done();
+      });
+
+      it('should override bucketing when setForcedVariation is called for a not running experiment', function(done) {
+        var optlyInstance = optimizelyFactory.createInstance({
+          datafile: testData.getTestProjectConfig(),
+          errorHandler: fakeErrorHandler,
+          eventDispatcher: eventDispatcher,
+          logger: fakeLogger,
+        });
+
+        var didSetVariation = optlyInstance.setForcedVariation('testExperimentNotRunning', 'testUser', 'controlNotRunning');
+        assert.strictEqual(didSetVariation, true);
+
+        var variation = optlyInstance.getVariation('testExperimentNotRunning', 'testUser');
+        assert.strictEqual(variation, null)
+
+        done();
+      });
     });
   });
 });