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
|
import { v4 as uuidv4 } from 'uuid';
import { logError } from '~/lib/logger';
const SKU_PREMIUM = '2c92a00d76f0d5060176f2fb0a5029ff';
const SKU_ULTIMATE = '2c92a0ff76f0d5250176f2f8c86f305a';
const PRODUCT_INFO = {
[SKU_PREMIUM]: {
// eslint-disable-next-line @gitlab/require-i18n-strings
name: 'Premium',
id: '0002',
price: '228',
variant: 'SaaS',
},
[SKU_ULTIMATE]: {
// eslint-disable-next-line @gitlab/require-i18n-strings
name: 'Ultimate',
id: '0001',
price: '1188',
variant: 'SaaS',
},
};
const EMPTY_NAMESPACE_ID_VALUE = 'not available';
const generateProductInfo = (sku, quantity) => {
const product = PRODUCT_INFO[sku];
if (!product) {
logError('Unexpected product sku provided to generateProductInfo');
return {};
}
const productInfo = {
...product,
brand: 'GitLab',
category: 'DevOps',
quantity,
};
return productInfo;
};
const isSupported = () => Boolean(window.dataLayer) && gon.features?.gitlabGtmDatalayer;
// gon.features.gitlabGtmDatalayer is set by writing
// `push_frontend_feature_flag(:gitlab_gtm_datalayer, type: :ops)`
// to the appropriate controller
// window.dataLayer is set by adding partials to the appropriate view found in
// views/layouts/_google_tag_manager_body.html.haml and _google_tag_manager_head.html.haml
const pushEvent = (event, args = {}) => {
if (!window.dataLayer) {
return;
}
try {
window.dataLayer.push({
event,
...args,
});
} catch (e) {
logError('Unexpected error while pushing to dataLayer', e);
}
};
const pushEnhancedEcommerceEvent = (event, args = {}) => {
if (!window.dataLayer) {
return;
}
try {
window.dataLayer.push({ ecommerce: null }); // Clear the previous ecommerce object
window.dataLayer.push({
event,
...args,
});
} catch (e) {
logError('Unexpected error while pushing to dataLayer', e);
}
};
const pushAccountSubmit = (accountType, accountMethod) =>
pushEvent('accountSubmit', { accountType, accountMethod });
const trackFormSubmission = (accountType) => {
const form = document.getElementById('new_new_user');
form.addEventListener('submit', () => {
pushAccountSubmit(accountType, 'form');
});
};
const trackOmniAuthSubmission = (accountType) => {
const links = document.querySelectorAll('.js-oauth-login');
links.forEach((link) => {
const { provider } = link.dataset;
link.addEventListener('click', () => {
pushAccountSubmit(accountType, provider);
});
});
};
export const trackFreeTrialAccountSubmissions = () => {
if (!isSupported()) {
return;
}
trackFormSubmission('freeThirtyDayTrial');
trackOmniAuthSubmission('freeThirtyDayTrial');
};
export const trackNewRegistrations = () => {
if (!isSupported()) {
return;
}
trackFormSubmission('standardSignUp');
trackOmniAuthSubmission('standardSignUp');
};
export const trackSaasTrialSubmit = () => {
if (!isSupported()) {
return;
}
pushEvent('saasTrialSubmit');
};
export const trackSaasTrialGroup = () => {
if (!isSupported()) {
return;
}
const form = document.querySelector('.js-saas-trial-group');
form.addEventListener('submit', () => {
pushEvent('saasTrialGroup');
});
};
export const trackProjectImport = () => {
if (!isSupported()) {
return;
}
const importButtons = document.querySelectorAll('.js-import-project-btn');
importButtons.forEach((button) => {
button.addEventListener('click', () => {
const { platform } = button.dataset;
pushEvent('projectImport', { platform });
});
});
};
export const trackSaasTrialGetStarted = () => {
if (!isSupported()) {
return;
}
const getStartedButton = document.querySelector('.js-get-started-btn');
getStartedButton.addEventListener('click', () => {
pushEvent('saasTrialGetStarted');
});
};
export const trackTrialAcceptTerms = () => {
if (!isSupported()) {
return;
}
pushEvent('saasTrialAcceptTerms');
};
export const trackCheckout = (selectedPlan, quantity) => {
if (!isSupported()) {
return;
}
const product = generateProductInfo(selectedPlan, quantity);
if (Object.keys(product).length === 0) {
return;
}
const eventData = {
ecommerce: {
currencyCode: 'USD',
checkout: {
actionField: { step: 1 },
products: [product],
},
},
};
// eslint-disable-next-line @gitlab/require-i18n-strings
pushEnhancedEcommerceEvent('EECCheckout', eventData);
};
export const getNamespaceId = () => {
return window.gl.snowplowStandardContext?.data?.namespace_id || EMPTY_NAMESPACE_ID_VALUE;
};
export const trackTransaction = (transactionDetails) => {
if (!isSupported()) {
return;
}
const transactionId = uuidv4();
const { paymentOption, revenue, tax, selectedPlan, quantity } = transactionDetails;
const product = generateProductInfo(selectedPlan, quantity);
const namespaceId = getNamespaceId();
if (Object.keys(product).length === 0) {
return;
}
const eventData = {
ecommerce: {
currencyCode: 'USD',
purchase: {
actionField: {
id: transactionId,
affiliation: 'GitLab',
option: paymentOption,
revenue: revenue.toString(),
tax: tax.toString(),
},
products: [{ ...product, dimension36: namespaceId }],
},
},
};
pushEnhancedEcommerceEvent('EECtransactionSuccess', eventData);
};
export const pushEECproductAddToCartEvent = () => {
if (!isSupported()) {
return;
}
window.dataLayer.push({
event: 'EECproductAddToCart',
ecommerce: {
currencyCode: 'USD',
add: {
products: [
{
name: 'CI/CD Minutes',
id: '0003',
price: '10',
brand: 'GitLab',
category: 'DevOps',
variant: 'add-on',
quantity: 1,
},
],
},
},
});
};
export const trackAddToCartUsageTab = () => {
const getStartedButton = document.querySelector('.js-buy-additional-minutes');
if (!getStartedButton) {
return;
}
getStartedButton.addEventListener('click', pushEECproductAddToCartEvent);
};
export const trackCombinedGroupProjectForm = () => {
if (!isSupported()) {
return;
}
const form = document.querySelector('.js-groups-projects-form');
form.addEventListener('submit', () => {
pushEvent('combinedGroupProjectFormSubmit');
});
};
export const trackCompanyForm = (aboutYourCompanyType) => {
if (!isSupported()) {
return;
}
pushEvent('aboutYourCompanyFormSubmit', { aboutYourCompanyType });
};
export const saasTrialWelcome = () => {
if (!isSupported()) {
return;
}
const saasTrialWelcomeButton = document.querySelector('.js-trial-welcome-btn');
saasTrialWelcomeButton?.addEventListener('click', () => {
pushEvent('saasTrialWelcome');
});
};
export const saasTrialContinuousOnboarding = () => {
if (!isSupported()) {
return;
}
const getStartedButton = document.querySelector('.js-get-started-btn');
getStartedButton?.addEventListener('click', () => {
pushEvent('saasTrialContinuousOnboarding');
});
};
|