/
fetch.test.ts
504 lines (425 loc) · 18.2 KB
/
fetch.test.ts
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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
import { Outcome } from '@sentry/types';
import { SentryError } from '@sentry/utils';
import { Event, Response, Status, Transports } from '../../../src';
const testDsn = 'https://123@sentry.io/42';
const storeUrl = 'https://sentry.io/api/42/store/?sentry_key=123&sentry_version=7';
const tunnel = 'https://hello.com/world';
const eventPayload: Event = {
event_id: '1337',
};
const transactionPayload: Event = {
event_id: '42',
type: 'transaction',
};
const fetch = jest.fn();
let transport: Transports.BaseTransport;
// eslint-disable-next-line no-var
declare var window: any;
jest.mock('@sentry/utils', () => {
return {
...jest.requireActual('@sentry/utils'),
supportsReferrerPolicy(): boolean {
return true;
},
};
});
describe('FetchTransport', () => {
beforeEach(() => {
window.fetch = fetch;
window.Headers = class Headers {
headers: { [key: string]: string } = {};
get(key: string) {
return this.headers[key];
}
set(key: string, value: string) {
this.headers[key] = value;
}
};
transport = new Transports.FetchTransport({ dsn: testDsn }, window.fetch);
});
afterEach(() => {
fetch.mockRestore();
});
it('inherits composeEndpointUrl() implementation', () => {
// eslint-disable-next-line deprecation/deprecation
expect(transport.url).toBe(storeUrl);
});
describe('sendEvent()', () => {
it('sends a request to Sentry servers', async () => {
const response = { status: 200, headers: new Headers() };
window.fetch.mockImplementation(() => Promise.resolve(response));
const res = await transport.sendEvent(eventPayload);
expect((res as Response).status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledWith(storeUrl, {
body: JSON.stringify(eventPayload),
method: 'POST',
referrerPolicy: 'origin',
});
});
it('sends a request to tunnel if configured', async () => {
transport = new Transports.FetchTransport({ dsn: testDsn, tunnel }, window.fetch);
window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
await transport.sendEvent(eventPayload);
expect(fetch.mock.calls[0][0]).toBe(tunnel);
});
it('rejects with non-200 status code', async () => {
const response = { status: 403, headers: new Headers() };
window.fetch.mockImplementation(() => Promise.resolve(response));
try {
await transport.sendEvent(eventPayload);
} catch (res) {
expect((res as Response).status).toBe(403);
expect(fetch).toHaveBeenCalledWith(storeUrl, {
body: JSON.stringify(eventPayload),
method: 'POST',
referrerPolicy: 'origin',
});
}
});
it('pass the error to rejection when fetch fails', async () => {
const response = { status: 403, headers: new Headers() };
window.fetch.mockImplementation(() => Promise.reject(response));
try {
await transport.sendEvent(eventPayload);
} catch (res) {
expect(res).toBe(response);
}
});
it('should record dropped event when fetch fails', async () => {
const response = { status: 403, headers: new Headers() };
window.fetch.mockImplementation(() => Promise.reject(response));
const spy = jest.spyOn(transport, 'recordLostEvent');
try {
await transport.sendEvent(eventPayload);
} catch (_) {
expect(spy).toHaveBeenCalledWith(Outcome.NetworkError, 'event');
}
});
it('should record dropped event when queue buffer overflows', async () => {
// @ts-ignore private method
jest.spyOn(transport._buffer, 'add').mockRejectedValue(new SentryError('Buffer Full'));
const spy = jest.spyOn(transport, 'recordLostEvent');
try {
await transport.sendEvent(transactionPayload);
} catch (_) {
expect(spy).toHaveBeenCalledWith(Outcome.QueueOverflow, 'transaction');
}
});
it('passes in headers', async () => {
transport = new Transports.FetchTransport(
{
dsn: testDsn,
headers: {
Accept: 'application/json',
},
},
window.fetch,
);
const response = { status: 200, headers: new Headers() };
window.fetch.mockImplementation(() => Promise.resolve(response));
const res = await transport.sendEvent(eventPayload);
expect((res as Response).status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledWith(storeUrl, {
body: JSON.stringify(eventPayload),
headers: {
Accept: 'application/json',
},
method: 'POST',
referrerPolicy: 'origin',
});
});
it('passes in fetch parameters', async () => {
transport = new Transports.FetchTransport(
{
dsn: testDsn,
fetchParameters: {
credentials: 'include',
},
},
window.fetch,
);
const response = { status: 200, headers: new Headers() };
window.fetch.mockImplementation(() => Promise.resolve(response));
const res = await transport.sendEvent(eventPayload);
expect((res as Response).status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledWith(storeUrl, {
body: JSON.stringify(eventPayload),
credentials: 'include',
method: 'POST',
referrerPolicy: 'origin',
});
});
describe('Rate-limiting', () => {
it('back-off using Retry-After header', async () => {
const retryAfterSeconds = 10;
const beforeLimit = Date.now();
const withinLimit = beforeLimit + (retryAfterSeconds / 2) * 1000;
const afterLimit = beforeLimit + retryAfterSeconds * 1000;
jest
.spyOn(Date, 'now')
// 1st event - _isRateLimited - false
.mockImplementationOnce(() => beforeLimit)
// 1st event - _handleRateLimit
.mockImplementationOnce(() => beforeLimit)
// 2nd event - _isRateLimited - true
.mockImplementationOnce(() => withinLimit)
// 3rd event - _isRateLimited - false
.mockImplementationOnce(() => afterLimit)
// 3rd event - _handleRateLimit
.mockImplementationOnce(() => afterLimit);
const headers = new Headers();
headers.set('Retry-After', `${retryAfterSeconds}`);
window.fetch.mockImplementation(() => Promise.resolve({ status: 429, headers }));
try {
await transport.sendEvent(eventPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBeUndefined();
expect(fetch).toHaveBeenCalled();
}
try {
await transport.sendEvent(eventPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBe(
`Transport for event requests locked till ${new Date(afterLimit)} due to too many requests.`,
);
expect(fetch).toHaveBeenCalled();
}
window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
const eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledTimes(2);
});
it('back-off using X-Sentry-Rate-Limits with single category', async () => {
const retryAfterSeconds = 10;
const beforeLimit = Date.now();
const withinLimit = beforeLimit + (retryAfterSeconds / 2) * 1000;
const afterLimit = beforeLimit + retryAfterSeconds * 1000;
jest
.spyOn(Date, 'now')
// 1st event - _isRateLimited - false
.mockImplementationOnce(() => beforeLimit)
// 1st event - _handleRateLimit
.mockImplementationOnce(() => beforeLimit)
// 2nd event - _isRateLimited - false (different category)
.mockImplementationOnce(() => withinLimit)
// 2nd event - _handleRateLimit
.mockImplementationOnce(() => withinLimit)
// 3rd event - _isRateLimited - true
.mockImplementationOnce(() => withinLimit)
// 4th event - _isRateLimited - false
.mockImplementationOnce(() => afterLimit)
// 4th event - _handleRateLimit
.mockImplementationOnce(() => afterLimit);
const headers = new Headers();
headers.set('X-Sentry-Rate-Limits', `${retryAfterSeconds}:error:scope`);
window.fetch.mockImplementation(() => Promise.resolve({ status: 429, headers }));
try {
await transport.sendEvent(eventPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBeUndefined();
expect(fetch).toHaveBeenCalled();
}
window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
const transactionRes = await transport.sendEvent(transactionPayload);
expect(transactionRes.status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledTimes(2);
try {
await transport.sendEvent(eventPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBe(
`Transport for event requests locked till ${new Date(afterLimit)} due to too many requests.`,
);
expect(fetch).toHaveBeenCalledTimes(2);
}
const eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledTimes(3);
});
it('back-off using X-Sentry-Rate-Limits with multiple categories', async () => {
const retryAfterSeconds = 10;
const beforeLimit = Date.now();
const withinLimit = beforeLimit + (retryAfterSeconds / 2) * 1000;
const afterLimit = beforeLimit + retryAfterSeconds * 1000;
jest
.spyOn(Date, 'now')
// 1st event - _isRateLimited - false
.mockImplementationOnce(() => beforeLimit)
// 1st event - _handleRateLimit
.mockImplementationOnce(() => beforeLimit)
// 2nd event - _isRateLimited - true (event category)
.mockImplementationOnce(() => withinLimit)
// 3rd event - _isRateLimited - true (transaction category)
.mockImplementationOnce(() => withinLimit)
// 4th event - _isRateLimited - false (event category)
.mockImplementationOnce(() => afterLimit)
// 4th event - _handleRateLimit
.mockImplementationOnce(() => afterLimit)
// 5th event - _isRateLimited - false (transaction category)
.mockImplementationOnce(() => afterLimit)
// 5th event - _handleRateLimit
.mockImplementationOnce(() => afterLimit);
const headers = new Headers();
headers.set('X-Sentry-Rate-Limits', `${retryAfterSeconds}:error;transaction:scope`);
window.fetch.mockImplementation(() => Promise.resolve({ status: 429, headers }));
try {
await transport.sendEvent(eventPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBeUndefined();
expect(fetch).toHaveBeenCalled();
}
try {
await transport.sendEvent(eventPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBe(
`Transport for event requests locked till ${new Date(afterLimit)} due to too many requests.`,
);
expect(fetch).toHaveBeenCalled();
}
try {
await transport.sendEvent(transactionPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBe(
`Transport for transaction requests locked till ${new Date(afterLimit)} due to too many requests.`,
);
expect(fetch).toHaveBeenCalled();
}
window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
const eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledTimes(2);
const transactionRes = await transport.sendEvent(transactionPayload);
expect(transactionRes.status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledTimes(3);
});
it('back-off using X-Sentry-Rate-Limits with missing categories should lock them all', async () => {
const retryAfterSeconds = 10;
const beforeLimit = Date.now();
const withinLimit = beforeLimit + (retryAfterSeconds / 2) * 1000;
const afterLimit = beforeLimit + retryAfterSeconds * 1000;
jest
.spyOn(Date, 'now')
// 1st event - _isRateLimited - false
.mockImplementationOnce(() => beforeLimit)
// 1st event - _handleRateLimit
.mockImplementationOnce(() => beforeLimit)
// 2nd event - _isRateLimited - true (event category)
.mockImplementationOnce(() => withinLimit)
// 3rd event - _isRateLimited - true (transaction category)
.mockImplementationOnce(() => withinLimit)
// 4th event - _isRateLimited - false (event category)
.mockImplementationOnce(() => afterLimit)
// 4th event - _handleRateLimit
.mockImplementationOnce(() => afterLimit)
// 5th event - _isRateLimited - false (transaction category)
.mockImplementationOnce(() => afterLimit)
// 5th event - _handleRateLimit
.mockImplementationOnce(() => afterLimit);
const headers = new Headers();
headers.set('X-Sentry-Rate-Limits', `${retryAfterSeconds}::scope`);
window.fetch.mockImplementation(() => Promise.resolve({ status: 429, headers }));
try {
await transport.sendEvent(eventPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBeUndefined();
expect(fetch).toHaveBeenCalled();
}
try {
await transport.sendEvent(eventPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBe(
`Transport for event requests locked till ${new Date(afterLimit)} due to too many requests.`,
);
expect(fetch).toHaveBeenCalled();
}
try {
await transport.sendEvent(transactionPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBe(
`Transport for transaction requests locked till ${new Date(afterLimit)} due to too many requests.`,
);
expect(fetch).toHaveBeenCalled();
}
window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
const eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledTimes(2);
const transactionRes = await transport.sendEvent(transactionPayload);
expect(transactionRes.status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledTimes(3);
});
it('back-off using X-Sentry-Rate-Limits should also trigger for 200 responses', async () => {
const retryAfterSeconds = 10;
const beforeLimit = Date.now();
const withinLimit = beforeLimit + (retryAfterSeconds / 2) * 1000;
const afterLimit = beforeLimit + retryAfterSeconds * 1000;
jest
.spyOn(Date, 'now')
// 1st event - _isRateLimited - false
.mockImplementationOnce(() => beforeLimit)
// 1st event - _handleRateLimit
.mockImplementationOnce(() => beforeLimit)
// 2nd event - _isRateLimited - true
.mockImplementationOnce(() => withinLimit)
// 3rd event - _isRateLimited - false
.mockImplementationOnce(() => afterLimit)
// 3rd event - _handleRateLimit
.mockImplementationOnce(() => afterLimit);
const headers = new Headers();
headers.set('X-Sentry-Rate-Limits', `${retryAfterSeconds}:error;transaction:scope`);
window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers }));
let eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(fetch).toHaveBeenCalled();
try {
await transport.sendEvent(eventPayload);
throw new Error('unreachable!');
} catch (res) {
expect((res as Response).status).toBe(429);
expect((res as Response).reason).toBe(
`Transport for event requests locked till ${new Date(afterLimit)} due to too many requests.`,
);
expect(fetch).toHaveBeenCalled();
}
window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(fetch).toHaveBeenCalledTimes(2);
});
it('should record dropped event', async () => {
// @ts-ignore private method
jest.spyOn(transport, '_isRateLimited').mockReturnValue(true);
const spy = jest.spyOn(transport, 'recordLostEvent');
try {
await transport.sendEvent(eventPayload);
} catch (_) {
expect(spy).toHaveBeenCalledWith(Outcome.RateLimitBackoff, 'event');
}
try {
await transport.sendEvent(transactionPayload);
} catch (_) {
expect(spy).toHaveBeenCalledWith(Outcome.RateLimitBackoff, 'transaction');
}
});
});
});
});