feat(totp): add totp as an experiment and enable for mozilla/softvision (#6141) r=@shane-tomlinson

Author: vbudhram

app/scripts/lib/experiments/grouping-rules/index.js

@@ -18,7 +18,8 @@ const experimentGroupingRules = [
   require('./send-sms-install-link'),
   require('./sentry'),
   require('./sessions'),
-  require('./token-code')
+  require('./token-code'),
+  require('./totp'),
 ].map(ExperimentGroupingRule => new ExperimentGroupingRule());
 
 class ExperimentChoiceIndex {

app/scripts/lib/experiments/grouping-rules/totp.js

@@ -0,0 +1,42 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+'use strict';
+
+const BaseGroupingRule = require('./base');
+const GROUPS = ['control', 'treatment'];
+const ENABLED_EMAIL_REGEX = /(.+@mozilla\.(com|org)$)|(.+@softvision\.(com|ro)$)/;
+
+module.exports = class TotpGroupingRule extends BaseGroupingRule {
+  constructor() {
+    super();
+    this.name = 'totp';
+    this.ROLLOUT_RATE = 0.00;
+  }
+
+  choose(subject) {
+    if (! subject || ! subject.account || ! subject.uniqueUserId) {
+      return false;
+    }
+
+    // Is feature enabled explicitly? ex. from `?showTwoStepAuthentication=true` feature flag?
+    if (subject.showTwoStepAuthentication) {
+      return true;
+    }
+
+    // Is this a Mozilla/Softvision based email?
+    const email = subject.account.get('email');
+    if (ENABLED_EMAIL_REGEX.test(email)) {
+      return true;
+    }
+
+    // Are they apart of rollout?
+    if (this.bernoulliTrial(this.ROLLOUT_RATE, subject.uniqueUserId)) {
+      return this.uniformChoice(GROUPS, subject.uniqueUserId);
+    }
+
+    // Otherwise don't show panel
+    return false;
+  }
+};

app/scripts/views/mixins/totp-experiment-mixin.js

@@ -0,0 +1,62 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+/**
+ * An TotpExperimentMixin factory.
+ *
+ * @mixin TotpExperimentMixin
+ */
+'use strict';
+
+const ExperimentMixin = require('./experiment-mixin');
+const EXPERIMENT_NAME = 'totp';
+
+/**
+ * Creates the mixin
+ *
+ * @returns {Object} mixin
+ */
+module.exports = {
+  dependsOn: [ExperimentMixin],
+
+  beforeRender() {
+    if (this.isInTotpExperiment()) {
+      const experimentGroup = this.getTotpExperimentGroup();
+      this.createExperiment(EXPERIMENT_NAME, experimentGroup);
+    }
+  },
+
+  /**
+   * Get TOTP experiment group
+   *
+   * @returns {String}
+   */
+  getTotpExperimentGroup() {
+    return this.getExperimentGroup(EXPERIMENT_NAME, this._getTotpExperimentSubject());
+  },
+
+
+  /**
+   * Is the user in the TOTP experiment?
+   *
+   * @returns {Boolean}
+   */
+  isInTotpExperiment() {
+    return this.isInExperiment(EXPERIMENT_NAME, this._getTotpExperimentSubject());
+  },
+
+  /**
+   * Get the TOTP experiment choice subject
+   *
+   * @returns {Object}
+   * @private
+   */
+  _getTotpExperimentSubject() {
+    const subject = {
+      account: this.getSignedInAccount(),
+      showTwoStepAuthentication: this.broker.getCapability('showTwoStepAuthentication'),
+    };
+    return subject;
+  }
+};

app/scripts/views/settings/two_step_authentication.js

@@ -15,6 +15,7 @@ const UpgradeSessionMixin = require('../mixins/upgrade-session-mixin');
 const Template = require('templates/settings/two_step_authentication.mustache');
 const preventDefaultThen = require('../base').preventDefaultThen;
 const showProgressIndicator = require('../decorators/progress_indicator');
+const TotpExperimentMixin = require('../mixins/totp-experiment-mixin');
 
 var t = BaseView.t;
 
@@ -66,6 +67,11 @@ const View = FormView.extend({
     if (this.broker.hasCapability('showTwoStepAuthentication')) {
       return true;
     }
+
+    if (this.isInTotpExperiment()) {
+      return true;
+    }
+
     return false;
   },
 
@@ -175,7 +181,8 @@ Cocktail.mixin(
   }),
   AvatarMixin,
   SettingsPanelMixin,
-  FloatingPlaceholderMixin
+  FloatingPlaceholderMixin,
+  TotpExperimentMixin
 );
 
 module.exports = View;

app/tests/spec/lib/experiments/grouping-rules/index.js

@@ -12,7 +12,7 @@ define(function (require, exports, module) {
 
   describe('lib/experiments/grouping-rules/index', () => {
     it('EXPERIMENT_NAMES is exported', () => {
-      assert.lengthOf(ExperimentGroupingRules.EXPERIMENT_NAMES, 8);
+      assert.lengthOf(ExperimentGroupingRules.EXPERIMENT_NAMES, 9);
     });
 
     describe('choose', () => {

app/tests/spec/lib/experiments/grouping-rules/totp.js

@@ -0,0 +1,54 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+'use strict';
+
+const {assert} = require('chai');
+const Account = require('models/account');
+const Experiment = require('lib/experiments/grouping-rules/totp');
+const sinon = require('sinon');
+
+describe('lib/experiments/grouping-rules/totp', () => {
+  describe('choose', () => {
+    let account;
+    let experiment;
+    let subject;
+
+    beforeEach(() => {
+      account = new Account();
+      experiment = new Experiment();
+      subject = {
+        account: account,
+        experimentGroupingRules: {},
+        showTwoStepAuthentication: false,
+        uniqueUserId: 'user-id'
+      };
+    });
+
+    it('returns true experiment if broker has capability', () => {
+      subject.showTwoStepAuthentication = true;
+      assert.equal(experiment.choose(subject), true);
+    });
+
+    ['a@mozilla.org', 'a@softvision.com', 'a@softvision.ro', 'a@softvision.com'].forEach((email) => {
+      it(`returns true experiment for ${email} email`, () => {
+        subject.account.set('email', email);
+        assert.equal(experiment.choose(subject), true);
+      });
+    });
+
+    it('delegates to uniformChoice if in rollout', () => {
+      experiment.ROLLOUT_RATE = 1.0;
+      sinon.stub(experiment, 'uniformChoice').callsFake(() => 'control');
+      experiment.choose(subject);
+      assert.isTrue(experiment.uniformChoice.calledOnce);
+      assert.isTrue(experiment.uniformChoice.calledWith(['control', 'treatment'], 'user-id'));
+    });
+
+    it('returns false if not in rollout', () => {
+      experiment.ROLLOUT_RATE = 0.0;
+      assert.equal(experiment.choose(subject), false);
+    });
+  });
+});

app/tests/spec/views/settings/two_step_authentication.js

@@ -4,34 +4,40 @@
 
 const $ = require('jquery');
 const assert = require('chai').assert;
+const Broker = require('models/auth_brokers/base');
 const Metrics = require('lib/metrics');
 const Notifier = require('lib/channels/notifier');
+const SentryMetrics = require('lib/sentry');
 const sinon = require('sinon');
 const TestHelpers = require('../../../lib/helpers');
 const User = require('models/user');
 const View = require('views/settings/two_step_authentication');
 
 describe('views/settings/two_step_authentication', () => {
   let account;
+  let broker;
   let email;
   let metrics;
   let notifier;
   let featureEnabled;
   let hasToken;
+  let inTotpExperiment;
+  let sentryMetrics;
   let validCode;
   const UID = '123';
   let user;
   let view;
 
   function initView() {
     view = new View({
+      broker: broker,
       metrics: metrics,
       notifier: notifier,
       user: user
     });
 
-    sinon.stub(view, '_isPanelEnabled').callsFake(() => featureEnabled);
     sinon.stub(view, 'setupSessionGateIfRequired').callsFake(() => Promise.resolve(featureEnabled));
+    sinon.stub(view, 'isInTotpExperiment').callsFake(() => inTotpExperiment);
     sinon.stub(view, 'getSignedInAccount').callsFake(() => account);
     sinon.spy(view, 'remove');
 
@@ -40,9 +46,11 @@ describe('views/settings/two_step_authentication', () => {
   }
 
   beforeEach(() => {
+    broker = new Broker();
     email = TestHelpers.createEmail();
     notifier = new Notifier();
-    metrics = new Metrics({notifier});
+    sentryMetrics = new SentryMetrics();
+    metrics = new Metrics({notifier, sentryMetrics});
     user = new User();
     account = user.initAccount({
       email: email,
@@ -70,6 +78,7 @@ describe('views/settings/two_step_authentication', () => {
 
     featureEnabled = true;
     hasToken = true;
+    inTotpExperiment = true;
   });
 
   afterEach(() => {
@@ -80,21 +89,42 @@ describe('views/settings/two_step_authentication', () => {
 
   describe('feature disabled', () => {
     beforeEach(() => {
-      featureEnabled = false;
+      inTotpExperiment = false;
       return initView();
     });
 
-    it('should remove panel if `showTwoStepAuthentication` query is not specified', () => {
+    it('should not display panel if `isInTotpExperiment` is false', () => {
       assert.equal(view.remove.callCount, 1);
     });
   });
 
   describe('feature enabled', () => {
     beforeEach(() => {
-      featureEnabled = true;
       return initView();
     });
 
+    describe('should show panel when broker capability `showTwoStepAuthentication` is true', () => {
+      beforeEach(() => {
+        view.broker.setCapability('showTwoStepAuthentication', true);
+        return initView();
+      });
+
+      it('should show panel when broker has capability', () => {
+        assert.equal(view.remove.callCount, 0);
+      });
+    });
+
+    describe('should show panel when `inTotpExperiment` is true', () => {
+      beforeEach(() => {
+        inTotpExperiment = true;
+        return initView();
+      });
+
+      it('should show panel when in experiment', () => {
+        assert.equal(view.remove.callCount, 0);
+      });
+    });
+
     describe('should show token status', () => {
       beforeEach(() => {
         hasToken = true;

app/tests/test_start.js

@@ -47,6 +47,7 @@ require('./spec/lib/experiments/grouping-rules/send-sms-install-link');
 require('./spec/lib/experiments/grouping-rules/sentry');
 require('./spec/lib/experiments/grouping-rules/sessions');
 require('./spec/lib/experiments/grouping-rules/token-code');
+require('./spec/lib/experiments/grouping-rules/totp');
 require('./spec/lib/fxa-client');
 require('./spec/lib/height-observer');
 require('./spec/lib/image-loader');