1 files changed, 171 insertions, 0 deletions
diff --git a/spec/controllers/concerns/product_analytics_tracking_spec.rb b/spec/controllers/concerns/product_analytics_tracking_spec.rb
new file mode 100644
index 00000000000..250cc3cf2cf
--- /dev/null
+++ b/spec/controllers/concerns/product_analytics_tracking_spec.rb
@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe ProductAnalyticsTracking, :snowplow do
+  include TrackingHelpers
+  include SnowplowHelpers
+
+  let(:user) { create(:user) }
+  let!(:group) { create(:group) }
+
+  before do
+    allow(Gitlab::UsageDataCounters::HLLRedisCounter).to receive(:track_event)
+  end
+
+  controller(ApplicationController) do
+    include ProductAnalyticsTracking
+
+    skip_before_action :authenticate_user!, only: :show
+    track_event(:index, :show, name: 'g_analytics_valuestream', destinations: [:redis_hll, :snowplow],
+                          conditions: [:custom_condition_one?, :custom_condition_two?]) { |controller| controller.get_custom_id }
+
+    def index
+      render html: 'index'
+    end
+
+    def new
+      render html: 'new'
+    end
+
+    def show
+      render html: 'show'
+    end
+
+    def get_custom_id
+      'some_custom_id'
+    end
+
+    private
+
+    def tracking_namespace_source
+      Group.first
+    end
+
+    def custom_condition_one?
+      true
+    end
+
+    def custom_condition_two?
+      true
+    end
+  end
+
+  def expect_tracking(user: self.user)
+    expect(Gitlab::UsageDataCounters::HLLRedisCounter).to have_received(:track_event)
+                                                            .with('g_analytics_valuestream', values: instance_of(String))
+
+    expect_snowplow_event(
+      category: anything,
+      action: 'g_analytics_valuestream',
+      namespace: group,
+      user: user
+    )
+  end
+
+  def expect_no_tracking
+    expect(Gitlab::UsageDataCounters::HLLRedisCounter).not_to receive(:track_event)
+
+    expect_no_snowplow_event
+  end
+
+  context 'when user is logged in' do
+    before do
+      sign_in(user)
+    end
+
+    it 'tracks the event' do
+      get :index
+
+      expect_tracking
+    end
+
+    context 'when FF is disabled' do
+      before do
+        stub_feature_flags(route_hll_to_snowplow: false)
+      end
+
+      it 'doesnt track snowplow event' do
+        get :index
+
+        expect_no_snowplow_event
+      end
+    end
+
+    it 'tracks the event if DNT is not enabled' do
+      stub_do_not_track('0')
+
+      get :index
+
+      expect_tracking
+    end
+
+    it 'does not track the event if DNT is enabled' do
+      stub_do_not_track('1')
+
+      get :index
+
+      expect_no_tracking
+    end
+
+    it 'does not track the event if the format is not HTML' do
+      get :index, format: :json
+
+      expect_no_tracking
+    end
+
+    it 'does not track the event if a custom condition returns false' do
+      allow(controller).to receive(:custom_condition_two?).and_return(false)
+
+      get :index
+
+      expect_no_tracking
+    end
+
+    it 'does not track the event for untracked actions' do
+      get :new
+
+      expect_no_tracking
+    end
+  end
+
+  context 'when user is not logged in' do
+    let(:visitor_id) { SecureRandom.uuid }
+
+    it 'tracks the event when there is a visitor id' do
+      cookies[:visitor_id] = { value: visitor_id, expires: 24.months }
+
+      get :show, params: { id: 1 }
+
+      expect_tracking(user: nil)
+    end
+  end
+
+  context 'when user is not logged in and there is no visitor_id' do
+    it 'does not track the event' do
+      get :index
+
+      expect_no_tracking
+    end
+
+    it 'tracks the event when there is custom id' do
+      get :show, params: { id: 1 }
+
+      expect_tracking(user: nil)
+    end
+
+    it 'does not track the HLL event when there is no custom id' do
+      allow(controller).to receive(:get_custom_id).and_return(nil)
+
+      get :show, params: { id: 2 }
+
+      expect(Gitlab::UsageDataCounters::HLLRedisCounter).not_to receive(:track_event)
+      expect_snowplow_event(
+        category: anything,
+        action: 'g_analytics_valuestream',
+        namespace: group,
+        user: nil
+      )
+    end
+  end
+end