Add latest changes from gitlab-org/gitlab@master

1 files changed, 190 insertions, 63 deletions

diff --git a/spec/lib/gitlab/experimentation_spec.rb b/spec/lib/gitlab/experimentation_spec.rb
index 2e5fd16d370..a7d3f628741 100644
--- a/spec/lib/gitlab/experimentation_spec.rb
+++ b/spec/lib/gitlab/experimentation_spec.rb
@@ -2,81 +2,186 @@
 
 require 'spec_helper'
 
-describe Gitlab::Experimentation::ControllerConcern, type: :controller do
-  controller(ApplicationController) do
-    include Gitlab::Experimentation::ControllerConcern
+describe Gitlab::Experimentation do
+  before do
+    stub_const('Gitlab::Experimentation::EXPERIMENTS', {
+      test_experiment: {
+        feature_toggle: feature_toggle,
+        environment: environment,
+        enabled_ratio: enabled_ratio,
+        tracking_category: 'Team'
+      }
+    })
 
-    def index
-      head :ok
-    end
+    stub_feature_flags(feature_toggle => true)
   end
 
-  describe '#set_experimentation_subject_id_cookie' do
-    before do
-      get :index
+  let(:feature_toggle) { :test_experiment_toggle }
+  let(:environment) { Rails.env.test? }
+  let(:enabled_ratio) { 0.1 }
+
+  describe Gitlab::Experimentation::ControllerConcern, type: :controller do
+    controller(ApplicationController) do
+      include Gitlab::Experimentation::ControllerConcern
+
+      def index
+        head :ok
+      end
     end
 
-    context 'cookie is present' do
+    describe '#set_experimentation_subject_id_cookie' do
       before do
-        cookies[:experimentation_subject_id] = 'test'
+        get :index
       end
 
-      it 'does not change the cookie' do
-        expect(cookies[:experimentation_subject_id]).to eq 'test'
+      context 'cookie is present' do
+        before do
+          cookies[:experimentation_subject_id] = 'test'
+        end
+
+        it 'does not change the cookie' do
+          expect(cookies[:experimentation_subject_id]).to eq 'test'
+        end
       end
-    end
 
-    context 'cookie is not present' do
-      it 'sets a permanent signed cookie' do
-        expect(cookies.permanent.signed[:experimentation_subject_id]).to be_present
+      context 'cookie is not present' do
+        it 'sets a permanent signed cookie' do
+          expect(cookies.permanent.signed[:experimentation_subject_id]).to be_present
+        end
       end
     end
-  end
 
-  describe '#experiment_enabled?' do
-    context 'cookie is not present' do
-      it 'calls Gitlab::Experimentation.enabled? with the name of the experiment and an experimentation_subject_index of nil' do
-        expect(Gitlab::Experimentation).to receive(:enabled?).with(:test_experiment, nil)
-        controller.experiment_enabled?(:test_experiment)
+    describe '#experiment_enabled?' do
+      context 'cookie is not present' do
+        it 'calls Gitlab::Experimentation.enabled_for_user? with the name of the experiment and an experimentation_subject_index of nil' do
+          expect(Gitlab::Experimentation).to receive(:enabled_for_user?).with(:test_experiment, nil) # rubocop:disable RSpec/DescribedClass
+          controller.experiment_enabled?(:test_experiment)
+        end
+      end
+
+      context 'cookie is present' do
+        before do
+          cookies.permanent.signed[:experimentation_subject_id] = 'abcd-1234'
+          get :index
+        end
+
+        it 'calls Gitlab::Experimentation.enabled_for_user? with the name of the experiment and an experimentation_subject_index of the modulo 100 of the hex value of the uuid' do
+          # 'abcd1234'.hex % 100 = 76
+          expect(Gitlab::Experimentation).to receive(:enabled_for_user?).with(:test_experiment, 76) # rubocop:disable RSpec/DescribedClass
+          controller.experiment_enabled?(:test_experiment)
+        end
       end
     end
 
-    context 'cookie is present' do
-      before do
-        cookies.permanent.signed[:experimentation_subject_id] = 'abcd-1234'
-        get :index
+    describe '#track_experiment_event' do
+      context 'when the experiment is enabled' do
+        before do
+          stub_experiment(test_experiment: true)
+        end
+
+        context 'the user is part of the experimental group' do
+          before do
+            stub_experiment_for_user(test_experiment: true)
+          end
+
+          it 'tracks the event with the right parameters' do
+            expect(Gitlab::Tracking).to receive(:event).with(
+              'Team',
+              'start',
+              label: nil,
+              property: 'experimental_group'
+            )
+            controller.track_experiment_event(:test_experiment, 'start')
+          end
+        end
+
+        context 'the user is part of the control group' do
+          before do
+            stub_experiment_for_user(test_experiment: false)
+          end
+
+          it 'tracks the event with the right parameters' do
+            expect(Gitlab::Tracking).to receive(:event).with(
+              'Team',
+              'start',
+              label: nil,
+              property: 'control_group'
+            )
+            controller.track_experiment_event(:test_experiment, 'start')
+          end
+        end
       end
 
-      it 'calls Gitlab::Experimentation.enabled? with the name of the experiment and an experimentation_subject_index of the modulo 100 of the hex value of the uuid' do
-        # 'abcd1234'.hex % 100 = 76
-        expect(Gitlab::Experimentation).to receive(:enabled?).with(:test_experiment, 76)
-        controller.experiment_enabled?(:test_experiment)
+      context 'when the experiment is disabled' do
+        before do
+          stub_experiment(test_experiment: false)
+        end
+
+        it 'does not track the event' do
+          expect(Gitlab::Tracking).not_to receive(:event)
+          controller.track_experiment_event(:test_experiment, 'start')
+        end
       end
     end
-  end
-end
 
-describe Gitlab::Experimentation do
-  before do
-    stub_const('Gitlab::Experimentation::EXPERIMENTS', {
-      test_experiment: {
-        feature_toggle: feature_toggle,
-        environment: environment,
-        enabled_ratio: enabled_ratio
-      }
-    })
+    describe '#frontend_experimentation_tracking_data' do
+      context 'when the experiment is enabled' do
+        before do
+          stub_experiment(test_experiment: true)
+        end
 
-    stub_feature_flags(feature_toggle => true)
-  end
+        context 'the user is part of the experimental group' do
+          before do
+            stub_experiment_for_user(test_experiment: true)
+          end
+
+          it 'pushes the right parameters to gon' do
+            controller.frontend_experimentation_tracking_data(:test_experiment, 'start')
+            expect(Gon.tracking_data).to eq(
+              {
+                category: 'Team',
+                action: 'start',
+                label: nil,
+                property: 'experimental_group'
+              }
+            )
+          end
+        end
 
-  let(:feature_toggle) { :test_experiment_toggle }
-  let(:environment) { Rails.env.test? }
-  let(:enabled_ratio) { 0.1 }
+        context 'the user is part of the control group' do
+          before do
+            allow_any_instance_of(described_class).to receive(:experiment_enabled?).with(:test_experiment).and_return(false)
+          end
+
+          it 'pushes the right parameters to gon' do
+            controller.frontend_experimentation_tracking_data(:test_experiment, 'start')
+            expect(Gon.tracking_data).to eq(
+              {
+                category: 'Team',
+                action: 'start',
+                label: nil,
+                property: 'control_group'
+              }
+            )
+          end
+        end
+      end
 
-  describe '.enabled?' do
-    subject { described_class.enabled?(:test_experiment, experimentation_subject_index) }
+      context 'when the experiment is disabled' do
+        before do
+          stub_experiment(test_experiment: false)
+        end
 
-    let(:experimentation_subject_index) { 9 }
+        it 'does not push data to gon' do
+          expect(Gon.method_defined?(:tracking_data)).to be_falsey
+          controller.track_experiment_event(:test_experiment, 'start')
+        end
+      end
+    end
+  end
+
+  describe '.enabled?' do
+    subject { described_class.enabled?(:test_experiment) }
 
     context 'feature toggle is enabled, we are on the right environment and we are selected' do
       it { is_expected.to be_truthy }
@@ -84,7 +189,7 @@ describe Gitlab::Experimentation do
 
     describe 'experiment is not defined' do
       it 'returns false' do
-        expect(described_class.enabled?(:missing_experiment, experimentation_subject_index)).to be_falsey
+        expect(described_class.enabled?(:missing_experiment)).to be_falsey
       end
     end
 
@@ -127,30 +232,52 @@ describe Gitlab::Experimentation do
         it { is_expected.to be_falsey }
       end
     end
+  end
 
-    describe 'enabled ratio' do
-      context 'enabled ratio is not set' do
-        let(:enabled_ratio) { nil }
+  describe '.enabled_for_user?' do
+    subject { described_class.enabled_for_user?(:test_experiment, experimentation_subject_index) }
 
-        it { is_expected.to be_falsey }
+    let(:experimentation_subject_index) { 9 }
+
+    context 'experiment is disabled' do
+      before do
+        allow(described_class).to receive(:enabled?).and_return(false)
       end
 
-      context 'experimentation_subject_index is not set' do
-        let(:experimentation_subject_index) { nil }
+      it { is_expected.to be_falsey }
+    end
 
-        it { is_expected.to be_falsey }
+    context 'experiment is enabled' do
+      before do
+        allow(described_class).to receive(:enabled?).and_return(true)
       end
 
-      context 'experimentation_subject_index is an empty string' do
-        let(:experimentation_subject_index) { '' }
+      it { is_expected.to be_truthy }
+
+      context 'enabled ratio is not set' do
+        let(:enabled_ratio) { nil }
 
         it { is_expected.to be_falsey }
       end
 
-      context 'experimentation_subject_index outside enabled ratio' do
-        let(:experimentation_subject_index) { 11 }
+      describe 'experimentation_subject_index' do
+        context 'experimentation_subject_index is not set' do
+          let(:experimentation_subject_index) { nil }
 
-        it { is_expected.to be_falsey }
+          it { is_expected.to be_falsey }
+        end
+
+        context 'experimentation_subject_index is an empty string' do
+          let(:experimentation_subject_index) { '' }
+
+          it { is_expected.to be_falsey }
+        end
+
+        context 'experimentation_subject_index outside enabled ratio' do
+          let(:experimentation_subject_index) { 11 }
+
+          it { is_expected.to be_falsey }
+        end
       end
     end
   end