summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/usage_data_counters/vscode_extenion_activity_unique_counter_spec.rb
blob: 7593d51fe769ddef3e7715d31cecba2c849400f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# frozen_string_literal: true

require 'spec_helper'

RSpec.shared_examples 'a tracked vs code unique action' do |event|
  before do
    stub_application_setting(usage_ping_enabled: true)
  end

  def count_unique(date_from:, date_to:)
    Gitlab::UsageDataCounters::HLLRedisCounter.unique_events(event_names: action, start_date: date_from, end_date: date_to)
  end

  it 'tracks when the user agent is from vs code' do
    aggregate_failures do
      user_agent = { user_agent: 'vs-code-gitlab-workflow/3.11.1 VSCode/1.52.1 Node.js/12.14.1 (darwin; x64)' }

      expect(track_action(user: user1, **user_agent)).to be_truthy
      expect(track_action(user: user1, **user_agent)).to be_truthy
      expect(track_action(user: user2, **user_agent)).to be_truthy

      expect(count_unique(date_from: time - 1.week, date_to: time + 1.week)).to eq(2)
    end
  end

  it 'does not track when the user agent is not from vs code' do
    aggregate_failures do
      user_agent = { user_agent: 'normal_user_agent' }

      expect(track_action(user: user1, **user_agent)).to be_falsey
      expect(track_action(user: user1, **user_agent)).to be_falsey
      expect(track_action(user: user2, **user_agent)).to be_falsey

      expect(count_unique(date_from: time - 1.week, date_to: time + 1.week)).to eq(0)
    end
  end

  it 'does not track if user agent is not present' do
    expect(track_action(user: nil, user_agent: nil)).to be_nil
  end

  it 'does not track if user is not present' do
    user_agent = { user_agent: 'vs-code-gitlab-workflow/3.11.1 VSCode/1.52.1 Node.js/12.14.1 (darwin; x64)' }

    expect(track_action(user: nil, **user_agent)).to be_nil
  end
end

RSpec.describe Gitlab::UsageDataCounters::VSCodeExtensionActivityUniqueCounter, :clean_gitlab_redis_shared_state do
  let(:user1) { build(:user, id: 1) }
  let(:user2) { build(:user, id: 2) }
  let(:time) { Time.current }

  context 'when tracking a vs code api request' do
    it_behaves_like 'a tracked vs code unique action' do
      let(:action) { described_class::VS_CODE_API_REQUEST_ACTION }

      def track_action(params)
        described_class.track_api_request_when_trackable(**params)
      end
    end
  end
end