This repository was archived by the owner on Sep 9, 2022. It is now read-only.
forked from github/docs
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathevents.js
More file actions
476 lines (407 loc) · 11.2 KB
/
Copy pathevents.js
File metadata and controls
476 lines (407 loc) · 11.2 KB
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
import { expect, jest } from '@jest/globals'
import { post } from '../helpers/e2etest.js'
describe('POST /events', () => {
jest.setTimeout(60 * 1000)
async function checkEvent(data, code) {
const body = JSON.stringify(data)
const res = await post('/api/events', {
body,
headers: {
'content-type': 'application/json',
},
})
expect(res.statusCode).toBe(code)
}
const baseExample = {
context: {
// Primitives
event_id: 'a35d7f88-3f48-4f36-ad89-5e3c8ebc3df7',
user: '703d32a8-ed0f-45f9-8d78-a913d4dc6f19',
version: '1.0.0',
created: '2020-10-02T17:12:18.620Z',
// Content information
path: '/github/docs/issues',
hostname: 'github.com',
referrer: 'https://github.com/github/docs',
search: '?q=is%3Aissue+is%3Aopen+example+',
href: 'https://github.com/github/docs/issues?q=is%3Aissue+is%3Aopen+example+',
path_language: 'en',
// Device information
os: 'linux',
os_version: '18.04',
browser: 'chrome',
browser_version: '85.0.4183.121',
viewport_width: 1418,
viewport_height: 501,
// Location information
timezone: -7,
user_language: 'en-US',
},
}
describe('page', () => {
const pageExample = { ...baseExample, type: 'page' }
it('should record a page event', () => checkEvent(pageExample, 200))
it('should require a type', () => checkEvent(baseExample, 400))
it('should require an event_id in uuid', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
event_id: 'asdfghjkl',
},
},
400
))
it('should require a user in uuid', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
user: 'asdfghjkl',
},
},
400
))
it('should require a version', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
version: undefined,
},
},
400
))
it('should require created timestamp', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
timestamp: 1234,
},
},
400
))
it('should allow page_event_id', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
page_event_id: baseExample.context.event_id,
},
},
200
))
it('should not allow a honeypot token', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
token: 'zxcv',
},
},
400
))
it('should path be uri-reference', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
path: ' ',
},
},
400
))
it('should hostname be uri-reference', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
hostname: ' ',
},
},
400
))
it('should referrer be uri-reference', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
referrer: ' ',
},
},
400
))
it('should search a string', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
search: 1234,
},
},
400
))
it('should href be uri', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
href: '/example',
},
},
400
))
it('should path_language is a valid option', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
path_language: 'nl',
},
},
400
))
it('should os a valid os option', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
os: 'ubuntu',
},
},
400
))
it('should os_version a string', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
os_version: 25,
},
},
400
))
it('should browser a valid option', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
browser: 'opera',
},
},
400
))
it('should browser_version a string', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
browser_version: 25,
},
},
400
))
it('should viewport_width a number', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
viewport_width: -500,
},
},
400
))
it('should viewport_height a number', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
viewport_height: '53px',
},
},
400
))
it('should timezone in number', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
timezone: 'GMT-0700',
},
},
400
))
it('should user_language is a string', () =>
checkEvent(
{
...pageExample,
context: {
...pageExample.context,
user_language: true,
},
},
400
))
})
describe('exit', () => {
const exitExample = {
...baseExample,
type: 'exit',
exit_render_duration: 0.9,
exit_first_paint: 0.1,
exit_dom_interactive: 0.2,
exit_dom_complete: 0.3,
exit_visit_duration: 5,
exit_scroll_length: 0.5,
}
it('should record an exit event', () => checkEvent(exitExample, 200))
it('should exit_render_duration is a positive number', () =>
checkEvent(
{
...exitExample,
exit_render_duration: -0.5,
},
400
))
it('exit_first_paint is a number', () =>
checkEvent({ ...exitExample, exit_first_paint: 'afjdkl' }, 400))
it('exit_dom_interactive is a number', () =>
checkEvent({ ...exitExample, exit_dom_interactive: '202' }, 400))
it('exit_visit_duration is a number', () =>
checkEvent({ ...exitExample, exit_visit_duration: '75' }, 400))
it('exit_scroll_length is a number between 0 and 1', () =>
checkEvent({ ...exitExample, exit_scroll_length: 1.1 }, 400))
})
describe('link', () => {
const linkExample = {
...baseExample,
type: 'link',
link_url: 'https://example.com',
}
it('should send a link event', () => checkEvent(linkExample, 200))
it('link_url is a required uri formatted string', () =>
checkEvent({ ...linkExample, link_url: 'foo' }, 400))
})
describe('search', () => {
const searchExample = {
...baseExample,
type: 'search',
search_query: 'github private instances',
search_context: 'private',
}
it('should record a search event', () => checkEvent(searchExample, 200))
it('search_query is required string', () =>
checkEvent({ ...searchExample, search_query: undefined }, 400))
it('search_context is optional string', () =>
checkEvent({ ...searchExample, search_context: undefined }, 200))
})
describe('navigate', () => {
const navigateExample = {
...baseExample,
type: 'navigate',
navigate_label: 'drop down',
}
it('should record a navigate event', () => checkEvent(navigateExample, 200))
it('navigate_label is optional string', () =>
checkEvent({ ...navigateExample, navigate_label: undefined }, 200))
})
describe('survey', () => {
const surveyExample = {
...baseExample,
type: 'survey',
survey_vote: true,
survey_comment: 'I love this site.',
survey_email: 'daisy@example.com',
}
it('should record a survey event', () => checkEvent(surveyExample, 200))
it('survey_vote is boolean', () =>
checkEvent({ ...surveyExample, survey_vote: undefined }, 400))
it('survey_comment is string', () => {
checkEvent({ ...surveyExample, survey_comment: 1234 }, 400)
})
it('survey_email is email', () => {
checkEvent({ ...surveyExample, survey_email: 'daisy' }, 400)
})
})
describe('experiment', () => {
const experimentExample = {
...baseExample,
type: 'experiment',
experiment_name: 'change-button-copy',
experiment_variation: 'treatment',
experiment_success: true,
}
it('should record an experiment event', () => checkEvent(experimentExample, 200))
it('experiment_name is required string', () =>
checkEvent({ ...experimentExample, experiment_name: undefined }, 400))
it('experiment_variation is required string', () =>
checkEvent({ ...experimentExample, experiment_variation: undefined }, 400))
it('experiment_success is optional boolean', () =>
checkEvent({ ...experimentExample, experiment_success: undefined }, 200))
})
describe('redirect', () => {
const redirectExample = {
...baseExample,
type: 'redirect',
redirect_from: 'http://example.com/a',
redirect_to: 'http://example.com/b',
}
it('should record an redirect event', () => checkEvent(redirectExample, 200))
it('redirect_from is required url', () =>
checkEvent({ ...redirectExample, redirect_from: ' ' }, 400))
it('redirect_to is required url', () =>
checkEvent({ ...redirectExample, redirect_to: undefined }, 400))
})
describe('clipboard', () => {
const clipboardExample = {
...baseExample,
type: 'clipboard',
clipboard_operation: 'copy',
}
it('should record an clipboard event', () => checkEvent(clipboardExample, 200))
it('clipboard_operation is required copy, paste, cut', () =>
checkEvent({ ...clipboardExample, clipboard_operation: 'destroy' }, 400))
})
describe('print', () => {
const printExample = {
...baseExample,
type: 'print',
}
it('should record a print event', () => checkEvent(printExample, 200))
})
describe('preference', () => {
const preferenceExample = {
...baseExample,
type: 'preference',
preference_name: 'application',
preference_value: 'cli',
}
it('should record an application event', () => checkEvent(preferenceExample, 200))
it('preference_name is string', () => {
checkEvent({ ...preferenceExample, preference_name: null }, 400)
})
it('preference_value is string', () => {
checkEvent({ ...preferenceExample, preference_value: null }, 400)
})
})
})