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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
# frozen_string_literal: true
require "spec_helper"
RSpec.describe Gitlab::InternalEvents, :snowplow, feature_category: :product_analytics_data_management do
include TrackingHelpers
include SnowplowHelpers
before do
allow(Gitlab::AppJsonLogger).to receive(:warn)
allow(Gitlab::ErrorTracking).to receive(:track_and_raise_for_dev_exception)
allow(Gitlab::UsageDataCounters::HLLRedisCounter).to receive(:track_event)
allow(redis).to receive(:incr)
allow(Gitlab::Redis::SharedState).to receive(:with).and_yield(redis)
allow(Gitlab::Tracking).to receive(:tracker).and_return(fake_snowplow)
allow(Gitlab::InternalEvents::EventDefinitions).to receive(:unique_property).and_return(unique_property)
allow(fake_snowplow).to receive(:event)
end
shared_examples 'an event that logs an error' do
it 'logs an error' do
described_class.track_event(event_name, **event_kwargs)
expect(Gitlab::ErrorTracking).to have_received(:track_and_raise_for_dev_exception)
.with(described_class::InvalidPropertyTypeError,
event_name: event_name,
kwargs: event_kwargs
)
end
end
def expect_redis_hll_tracking
expect(Gitlab::UsageDataCounters::HLLRedisCounter).to have_received(:track_event)
.with(event_name, values: unique_value)
end
def expect_redis_tracking
call_index = 0
expect(redis).to have_received(:incr).twice do |redis_key|
expect(redis_key).to end_with(redis_arguments[call_index])
call_index += 1
end
end
def expect_snowplow_tracking(expected_namespace = nil)
service_ping_context = Gitlab::Tracking::ServicePingContext
.new(data_source: :redis_hll, event: event_name)
.to_context
.to_json
expect(SnowplowTracker::SelfDescribingJson).to have_received(:new)
.with(service_ping_context[:schema], service_ping_context[:data]).at_least(:once)
expect(fake_snowplow).to have_received(:event) do |provided_category, provided_event_name, args|
expect(provided_category).to eq(category)
expect(provided_event_name).to eq(event_name)
contexts = args[:context]&.map(&:to_json)
# Verify Standard Context
standard_context = contexts.find do |c|
c[:schema] == Gitlab::Tracking::StandardContext::GITLAB_STANDARD_SCHEMA_URL
end
validate_standard_context(standard_context, expected_namespace)
# Verify Service Ping context
service_ping_context = contexts.find { |c| c[:schema] == Gitlab::Tracking::ServicePingContext::SCHEMA_URL }
validate_service_ping_context(service_ping_context)
end
end
def validate_standard_context(standard_context, expected_namespace)
namespace = expected_namespace || project&.namespace
expect(standard_context).not_to eq(nil)
expect(standard_context[:data][:user_id]).to eq(user&.id)
expect(standard_context[:data][:namespace_id]).to eq(namespace&.id)
expect(standard_context[:data][:project_id]).to eq(project&.id)
end
def validate_service_ping_context(service_ping_context)
expect(service_ping_context).not_to eq(nil)
expect(service_ping_context[:data][:data_source]).to eq(:redis_hll)
expect(service_ping_context[:data][:event_name]).to eq(event_name)
end
let_it_be(:user) { build(:user, id: 1) }
let_it_be(:project_namespace) { build(:namespace, id: 2) }
let_it_be(:project) { build(:project, id: 3, namespace: project_namespace) }
let(:redis) { instance_double('Redis') }
let(:fake_snowplow) { instance_double(Gitlab::Tracking::Destinations::Snowplow) }
let(:event_name) { 'g_edit_by_web_ide' }
let(:category) { 'InternalEventTracking' }
let(:unique_property) { :user }
let(:unique_value) { user.id }
let(:redis_arguments) { [event_name, Date.today.strftime('%G-%V')] }
context 'when only user is passed' do
let(:project) { nil }
let(:namespace) { nil }
it 'updated all tracking methods' do
described_class.track_event(event_name, user: user)
expect_redis_tracking
expect_redis_hll_tracking
expect_snowplow_tracking
end
end
context 'when namespace is passed' do
let(:namespace) { build(:namespace, id: 4) }
it 'uses id from namespace' do
described_class.track_event(event_name, user: user, project: project, namespace: namespace)
expect_redis_tracking
expect_redis_hll_tracking
expect_snowplow_tracking(namespace)
end
end
context 'when namespace is not passed' do
let(:unique_property) { :namespace }
let(:unique_value) { project.namespace.id }
it 'uses id from projects namespace' do
described_class.track_event(event_name, user: user, project: project)
expect_redis_tracking
expect_redis_hll_tracking
expect_snowplow_tracking(project.namespace)
end
end
context 'when category is passed' do
let(:category) { 'SomeCategory' }
it 'is sent to Snowplow' do
described_class.track_event(event_name, category: category, user: user, project: project)
expect_snowplow_tracking
end
end
context 'when arguments are invalid' do
context 'when user is not an instance of User' do
let(:user) { 'a_string' }
it_behaves_like 'an event that logs an error' do
let(:event_kwargs) { { user: user, project: project.id } }
end
end
context 'when project is not an instance of Project' do
let(:project) { 42 }
it_behaves_like 'an event that logs an error' do
let(:event_kwargs) { { user: user.id, project: project } }
end
end
context 'when namespace is not an instance of Namespace' do
let(:namespace) { false }
it_behaves_like 'an event that logs an error' do
let(:event_kwargs) { { user: user.id, namespace: namespace } }
end
end
end
it 'updates Redis, RedisHLL and Snowplow', :aggregate_failures do
described_class.track_event(event_name, user: user, project: project)
expect_redis_tracking
expect_redis_hll_tracking
expect_snowplow_tracking
end
it 'rescues error', :aggregate_failures do
params = { user: user, project: project }
error = StandardError.new("something went wrong")
allow(fake_snowplow).to receive(:event).and_raise(error)
expect(Gitlab::ErrorTracking).to receive(:track_and_raise_for_dev_exception)
.with(
error,
snowplow_category: 'InternalEventTracking',
snowplow_action: event_name
)
expect { described_class.track_event(event_name, **params) }.not_to raise_error
end
it 'logs error on unknown event', :aggregate_failures do
expect(Gitlab::ErrorTracking).to receive(:track_and_raise_for_dev_exception)
.with(described_class::UnknownEventError, event_name: 'unknown_event', kwargs: {})
expect { described_class.track_event('unknown_event') }.not_to raise_error
end
it 'logs warning on missing property', :aggregate_failures do
expect { described_class.track_event(event_name, merge_request_id: 1) }.not_to raise_error
expect_redis_tracking
expect(Gitlab::AppJsonLogger).to have_received(:warn)
.with(message: /should be triggered with a named parameter/)
end
context 'when unique property is missing' do
before do
allow(Gitlab::InternalEvents::EventDefinitions).to receive(:unique_property)
.and_raise(Gitlab::InternalEvents::EventDefinitions::InvalidMetricConfiguration)
end
it 'logs error on missing unique property', :aggregate_failures do
expect { described_class.track_event(event_name, merge_request_id: 1) }.not_to raise_error
expect_redis_tracking
expect(Gitlab::ErrorTracking).to have_received(:track_and_raise_for_dev_exception)
end
end
context 'when unique key is defined' do
let(:event_name) { 'p_ci_templates_terraform_base_latest' }
let(:unique_value) { project.id }
let(:property_name) { :project }
before do
allow(Gitlab::InternalEvents::EventDefinitions).to receive(:unique_property)
.with(event_name)
.and_return(property_name)
end
it 'is used when logging to RedisHLL', :aggregate_failures do
described_class.track_event(event_name, user: user, project: project)
expect_redis_tracking
expect_redis_hll_tracking
expect_snowplow_tracking
end
context 'when property is missing' do
it 'logs error' do
expect { described_class.track_event(event_name, merge_request_id: 1) }.not_to raise_error
expect(Gitlab::AppJsonLogger).to have_received(:warn)
.with(message: /should be triggered with a named parameter/)
end
end
context 'when send_snowplow_event is false' do
it 'logs to Redis and RedisHLL but not Snowplow' do
described_class.track_event(event_name, send_snowplow_event: false, user: user, project: project)
expect_redis_tracking
expect_redis_hll_tracking
expect(fake_snowplow).not_to have_received(:event)
end
end
end
context 'when unique key is not defined' do
let(:event_name) { 'p_ci_templates_terraform_base_latest' }
before do
allow(Gitlab::InternalEvents::EventDefinitions).to receive(:unique_property)
.with(event_name)
.and_return(nil)
end
it 'logs to Redis and Snowplow but not RedisHLL', :aggregate_failures do
described_class.track_event(event_name, user: user, project: project)
expect_redis_tracking
expect_snowplow_tracking(project.namespace)
expect(Gitlab::UsageDataCounters::HLLRedisCounter).not_to have_received(:track_event)
end
end
describe 'Product Analytics tracking' do
let(:app_id) { 'foobar' }
let(:url) { 'http://localhost:4000' }
let(:sdk_client) { instance_double('GitlabSDK::Client') }
let(:event_kwargs) { { user: user, project: project } }
before do
described_class.clear_memoization(:gitlab_sdk_client)
stub_env('GITLAB_ANALYTICS_ID', app_id)
stub_env('GITLAB_ANALYTICS_URL', url)
end
subject(:track_event) { described_class.track_event(event_name, **event_kwargs) }
shared_examples 'does not send a Product Analytics event' do
it 'does not call the Product Analytics Ruby SDK' do
expect(GitlabSDK::Client).not_to receive(:new)
track_event
end
end
context 'when internal_events_for_product_analytics FF is enabled' do
before do
stub_feature_flags(internal_events_for_product_analytics: true)
allow(GitlabSDK::Client)
.to receive(:new)
.with(app_id: app_id, host: url)
.and_return(sdk_client)
end
it 'calls Product Analytics Ruby SDK', :aggregate_failures do
expect(sdk_client).to receive(:identify).with(user.id)
expect(sdk_client).to receive(:track)
.with(event_name, { project_id: project.id, namespace_id: project.namespace.id })
track_event
end
context 'when GITLAB_ANALYTICS_ID is nil' do
let(:app_id) { nil }
it_behaves_like 'does not send a Product Analytics event'
end
context 'when GITLAB_ANALYTICS_URL is nil' do
let(:url) { nil }
it_behaves_like 'does not send a Product Analytics event'
end
end
context 'when internal_events_for_product_analytics FF is disabled' do
let(:app_id) { 'foobar' }
let(:url) { 'http://localhost:4000' }
before do
stub_feature_flags(internal_events_for_product_analytics: false)
end
it_behaves_like 'does not send a Product Analytics event'
end
end
end
|