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
|
import { LOAD_ACTION_ATTR_SELECTOR } from './constants';
import { dispatchSnowplowEvent } from './dispatch_snowplow_event';
import getStandardContext from './get_standard_context';
import {
getEventHandlers,
createEventPayload,
renameKey,
getReferrersCache,
addReferrersCacheEntry,
} from './utils';
export const Tracker = {
nonInitializedQueue: [],
initialized: false,
definitionsLoaded: false,
definitionsManifest: {},
definitionsEventsQueue: [],
definitions: [],
ALLOWED_URL_HASHES: ['#diff', '#note'],
/**
* (Legacy) Determines if tracking is enabled at the user level.
* https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/DNT.
*
* @returns {Boolean}
*/
trackable() {
return !['1', 'yes'].includes(
window.doNotTrack || navigator.doNotTrack || navigator.msDoNotTrack,
);
},
/**
* Determines if Snowplow is available/enabled.
*
* @returns {Boolean}
*/
enabled() {
return typeof window.snowplow === 'function' && Tracker.trackable();
},
/**
* Dispatches a structured event per our taxonomy:
* https://docs.gitlab.com/ee/development/snowplow/index.html#structured-event-taxonomy.
*
* If the library is not initialized and events are trying to be
* dispatched (data-attributes, load-events), they will be added
* to a queue to be flushed afterwards.
*
* If there is an error when using the library, it will return ´false´
* and ´true´ otherwise.
*
* @param {...any} eventData defined event taxonomy
* @returns {Boolean}
*/
event(...eventData) {
if (!Tracker.enabled()) {
return false;
}
if (!Tracker.initialized) {
Tracker.nonInitializedQueue.push(eventData);
return false;
}
return dispatchSnowplowEvent(...eventData);
},
/**
* Preloads event definitions.
*
* @returns {undefined}
*/
loadDefinitions() {
// TODO: fetch definitions from the server and flush the queue
// See https://gitlab.com/gitlab-org/gitlab/-/issues/358256
Tracker.definitionsLoaded = true;
while (Tracker.definitionsEventsQueue.length) {
Tracker.dispatchFromDefinition(...Tracker.definitionsEventsQueue.shift());
}
},
/**
* Dispatches a structured event with data from its event definition.
*
* @param {String} basename
* @param {Object} eventData
* @returns {Boolean}
*/
definition(basename, eventData = {}) {
if (!Tracker.enabled()) {
return false;
}
if (!(basename in Tracker.definitionsManifest)) {
throw new Error(`Missing Snowplow event definition "${basename}"`);
}
return Tracker.dispatchFromDefinition(basename, eventData);
},
/**
* Builds an event with data from a valid definition and sends it to
* Snowplow. If the definitions are not loaded, it pushes the data to a queue.
*
* @param {String} basename
* @param {Object} eventData
* @returns {Boolean}
*/
dispatchFromDefinition(basename, eventData) {
if (!Tracker.definitionsLoaded) {
Tracker.definitionsEventsQueue.push([basename, eventData]);
return false;
}
const eventDefinition = Tracker.definitions.find((definition) => definition.key === basename);
return Tracker.event(
eventData.category ?? eventDefinition.category,
eventData.action ?? eventDefinition.action,
eventData,
);
},
/**
* Dispatches any event emitted before initialization.
*
* @returns {undefined}
*/
flushPendingEvents() {
Tracker.initialized = true;
while (Tracker.nonInitializedQueue.length) {
dispatchSnowplowEvent(...Tracker.nonInitializedQueue.shift());
}
},
/**
* Attaches event handlers for data-attributes powered events.
*
* @param {String} category - the default category for all events
* @param {HTMLElement} parent - element containing data-attributes
* @returns {Array}
*/
bindDocument(category = document.body.dataset.page, parent = document) {
if (!Tracker.enabled() || parent.trackingBound) {
return [];
}
// eslint-disable-next-line no-param-reassign
parent.trackingBound = true;
const handlers = getEventHandlers(category, (...args) => Tracker.event(...args));
handlers.forEach((event) => parent.addEventListener(event.name, event.func));
return handlers;
},
/**
* Attaches event handlers for load-events (on render).
*
* @param {String} category - the default category for all events
* @param {HTMLElement} parent - element containing event targets
* @returns {Array}
*/
trackLoadEvents(category = document.body.dataset.page, parent = document) {
if (!Tracker.enabled()) {
return [];
}
const loadEvents = parent.querySelectorAll(LOAD_ACTION_ATTR_SELECTOR);
loadEvents.forEach((element) => {
const { action, data } = createEventPayload(element);
Tracker.event(category, action, data);
});
return loadEvents;
},
/**
* Enable Snowplow automatic form tracking.
* The config param requires at least one array of either forms
* class names, or field name attributes.
* https://docs.gitlab.com/ee/development/snowplow/index.html#form-tracking.
*
* @param {Object} config
* @param {Array} contexts
* @returns {undefined}
*/
enableFormTracking(config, contexts = []) {
if (!Tracker.enabled()) {
return;
}
if (!Array.isArray(config?.forms?.allow) && !Array.isArray(config?.fields?.allow)) {
// eslint-disable-next-line @gitlab/require-i18n-strings
throw new Error('Unable to enable form event tracking without allow rules.');
}
// Ignore default/standard schema
const standardContext = getStandardContext();
const userProvidedContexts = contexts.filter(
(context) => context.schema !== standardContext.schema,
);
const mappedConfig = {};
if (config.forms) {
mappedConfig.forms = renameKey(config.forms, 'allow', 'whitelist');
}
if (config.fields) {
mappedConfig.fields = renameKey(config.fields, 'allow', 'whitelist');
}
const enabler = () => window.snowplow('enableFormTracking', mappedConfig, userProvidedContexts);
if (document.readyState === 'complete') {
enabler();
} else {
document.addEventListener('readystatechange', () => {
if (document.readyState === 'complete') {
enabler();
}
});
}
},
/**
* Replaces the URL and referrer for the default web context
* if the replacements are available.
*
* @returns {undefined}
*/
setAnonymousUrls() {
const { snowplowPseudonymizedPageUrl: pageUrl } = window.gl;
if (!pageUrl) {
return;
}
const referrers = getReferrersCache();
const pageLinks = Object.seal({
url: pageUrl,
referrer: '',
originalUrl: window.location.href,
});
const appendHash = Tracker.ALLOWED_URL_HASHES.some((prefix) =>
window.location.hash.startsWith(prefix),
);
const customUrl = `${pageUrl}${appendHash ? window.location.hash : ''}`;
window.snowplow('setCustomUrl', customUrl);
if (document.referrer) {
const node = referrers.find((links) => links.originalUrl === document.referrer);
if (node) {
pageLinks.referrer = node.url;
window.snowplow('setReferrerUrl', pageLinks.referrer);
}
}
addReferrersCacheEntry(referrers, pageLinks);
},
};
|