-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
http.test.ts
567 lines (439 loc) · 20.7 KB
/
http.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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
import type { Span, Transaction } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { addTracingExtensions, Hub } from '@sentry/core';
import type { TransactionContext } from '@sentry/types';
import { logger, parseSemver, TRACEPARENT_REGEXP } from '@sentry/utils';
import * as http from 'http';
import * as https from 'https';
import * as HttpsProxyAgent from 'https-proxy-agent';
import * as nock from 'nock';
import type { Breadcrumb } from '../../src';
import { NodeClient } from '../../src/client';
import { Http as HttpIntegration } from '../../src/integrations/http';
import type { NodeClientOptions } from '../../src/types';
import { getDefaultNodeClientOptions } from '../helper/node-client-options';
const NODE_VERSION = parseSemver(process.versions.node);
const originalHttpGet = http.get;
const originalHttpRequest = http.request;
describe('tracing', () => {
function createTransactionOnScope(
customOptions: Partial<NodeClientOptions> = {},
customContext?: Partial<TransactionContext>,
) {
const options = getDefaultNodeClientOptions({
dsn: 'https://dogsarebadatkeepingsecrets@squirrelchasers.ingest.sentry.io/12312012',
tracesSampleRate: 1.0,
integrations: [new HttpIntegration({ tracing: true })],
release: '1.0.0',
environment: 'production',
...customOptions,
});
const hub = new Hub(new NodeClient(options));
addTracingExtensions();
hub.configureScope(scope =>
scope.setUser({
id: 'uid123',
segment: 'segmentA',
}),
);
jest.spyOn(sentryCore, 'getCurrentHub').mockReturnValue(hub);
const transaction = hub.startTransaction({
name: 'dogpark',
traceId: '12312012123120121231201212312012',
...customContext,
});
hub.getScope()?.setSpan(transaction);
return transaction;
}
it("creates a span for each outgoing non-sentry request when there's a transaction on the scope", () => {
nock('http://dogs.are.great').get('/').reply(200);
const transaction = createTransactionOnScope();
const spans = (transaction as unknown as Span).spanRecorder?.spans as Span[];
http.get('http://dogs.are.great/');
expect(spans.length).toEqual(2);
// our span is at index 1 because the transaction itself is at index 0
expect(spans[1].description).toEqual('GET http://dogs.are.great/');
expect(spans[1].op).toEqual('http.client');
});
it("doesn't create a span for outgoing sentry requests", () => {
nock('http://squirrelchasers.ingest.sentry.io').get('/api/12312012/store/').reply(200);
const transaction = createTransactionOnScope();
const spans = (transaction as unknown as Span).spanRecorder?.spans as Span[];
http.get('http://squirrelchasers.ingest.sentry.io/api/12312012/store/');
// only the transaction itself should be there
expect(spans.length).toEqual(1);
expect((spans[0] as Transaction).name).toEqual('dogpark');
});
it('attaches the sentry-trace header to outgoing non-sentry requests', async () => {
nock('http://dogs.are.great').get('/').reply(200);
createTransactionOnScope();
const request = http.get('http://dogs.are.great/');
const sentryTraceHeader = request.getHeader('sentry-trace') as string;
expect(sentryTraceHeader).toBeDefined();
expect(TRACEPARENT_REGEXP.test(sentryTraceHeader)).toBe(true);
});
it("doesn't attach the sentry-trace header to outgoing sentry requests", () => {
nock('http://squirrelchasers.ingest.sentry.io').get('/api/12312012/store/').reply(200);
createTransactionOnScope();
const request = http.get('http://squirrelchasers.ingest.sentry.io/api/12312012/store/');
const sentryTraceHeader = request.getHeader('sentry-trace');
expect(sentryTraceHeader).not.toBeDefined();
});
it('attaches the baggage header to outgoing non-sentry requests', async () => {
nock('http://dogs.are.great').get('/').reply(200);
createTransactionOnScope();
const request = http.get('http://dogs.are.great/');
const baggageHeader = request.getHeader('baggage') as string;
expect(baggageHeader).toEqual(
'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,' +
'sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,' +
'sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
);
});
it('keeps 3rd party baggage header data to outgoing non-sentry requests', async () => {
nock('http://dogs.are.great').get('/').reply(200);
createTransactionOnScope();
const request = http.get({ host: 'http://dogs.are.great/', headers: { baggage: 'dog=great' } });
const baggageHeader = request.getHeader('baggage') as string;
expect(baggageHeader).toEqual([
'dog=great',
'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
]);
});
it('adds the transaction name to the the baggage header if a valid transaction source is set', async () => {
nock('http://dogs.are.great').get('/').reply(200);
createTransactionOnScope({}, { metadata: { source: 'route' } });
const request = http.get({ host: 'http://dogs.are.great/', headers: { baggage: 'dog=great' } });
const baggageHeader = request.getHeader('baggage') as string;
expect(baggageHeader).toEqual([
'dog=great',
'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=dogpark,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
]);
});
it('does not add the transaction name to the the baggage header if url transaction source is set', async () => {
nock('http://dogs.are.great').get('/').reply(200);
createTransactionOnScope({}, { metadata: { source: 'url' } });
const request = http.get({ host: 'http://dogs.are.great/', headers: { baggage: 'dog=great' } });
const baggageHeader = request.getHeader('baggage') as string;
expect(baggageHeader).toEqual([
'dog=great',
'sentry-environment=production,sentry-release=1.0.0,sentry-user_segment=segmentA,sentry-public_key=dogsarebadatkeepingsecrets,sentry-trace_id=12312012123120121231201212312012,sentry-sample_rate=1',
]);
});
it("doesn't attach the sentry-trace header to outgoing sentry requests", () => {
nock('http://squirrelchasers.ingest.sentry.io').get('/api/12312012/store/').reply(200);
createTransactionOnScope();
const request = http.get('http://squirrelchasers.ingest.sentry.io/api/12312012/store/');
const baggage = request.getHeader('baggage');
expect(baggage).not.toBeDefined();
});
it("doesn't attach when using otel instrumenter", () => {
const loggerLogSpy = jest.spyOn(logger, 'log');
const options = getDefaultNodeClientOptions({
dsn: 'https://dogsarebadatkeepingsecrets@squirrelchasers.ingest.sentry.io/12312012',
tracesSampleRate: 1.0,
integrations: [new HttpIntegration({ tracing: true })],
release: '1.0.0',
environment: 'production',
instrumenter: 'otel',
});
const hub = new Hub(new NodeClient(options));
const integration = new HttpIntegration();
integration.setupOnce(
() => {},
() => hub,
);
expect(loggerLogSpy).toBeCalledWith('HTTP Integration is skipped because of instrumenter configuration.');
});
it('omits query and fragment from description and adds to span data instead', () => {
nock('http://dogs.are.great').get('/spaniel?tail=wag&cute=true#learn-more').reply(200);
const transaction = createTransactionOnScope();
const spans = (transaction as unknown as Span).spanRecorder?.spans as Span[];
http.get('http://dogs.are.great/spaniel?tail=wag&cute=true#learn-more');
expect(spans.length).toEqual(2);
// our span is at index 1 because the transaction itself is at index 0
expect(spans[1].description).toEqual('GET http://dogs.are.great/spaniel');
expect(spans[1].op).toEqual('http.client');
expect(spans[1].data.method).toEqual('GET');
expect(spans[1].data.url).toEqual('http://dogs.are.great/spaniel');
expect(spans[1].data['http.query']).toEqual('tail=wag&cute=true');
expect(spans[1].data['http.fragment']).toEqual('learn-more');
});
it.each([
['user:pwd', '[Filtered]:[Filtered]@'],
['user:', '[Filtered]:@'],
['user', '[Filtered]:@'],
[':pwd', ':[Filtered]@'],
['', ''],
])('filters the authority %s in span description', (auth, redactedAuth) => {
nock(`http://${auth}@dogs.are.great`).get('/').reply(200);
const transaction = createTransactionOnScope();
const spans = (transaction as unknown as Span).spanRecorder?.spans as Span[];
http.get(`http://${auth}@dogs.are.great/`);
expect(spans.length).toEqual(2);
// our span is at index 1 because the transaction itself is at index 0
expect(spans[1].description).toEqual(`GET http://${redactedAuth}dogs.are.great/`);
});
describe('Tracing options', () => {
beforeEach(() => {
// hacky way of restoring monkey patched functions
// @ts-ignore TS doesn't let us assign to this but we want to
http.get = originalHttpGet;
// @ts-ignore TS doesn't let us assign to this but we want to
http.request = originalHttpRequest;
});
function createHub(customOptions: Partial<NodeClientOptions> = {}) {
const options = getDefaultNodeClientOptions({
dsn: 'https://dogsarebadatkeepingsecrets@squirrelchasers.ingest.sentry.io/12312012',
tracesSampleRate: 1.0,
release: '1.0.0',
environment: 'production',
...customOptions,
});
const hub = new Hub();
jest.spyOn(sentryCore, 'getCurrentHub').mockImplementation(() => hub);
const client = new NodeClient(options);
jest.spyOn(hub, 'getClient').mockImplementation(() => client);
hub.bindClient(client);
return hub;
}
function createTransactionAndPutOnScope(hub: Hub) {
addTracingExtensions();
const transaction = hub.startTransaction({ name: 'dogpark' });
hub.getScope()?.setSpan(transaction);
return transaction;
}
// TODO (v8): These can be removed once we remove these properties from client options
describe('as client options', () => {
it("doesn't create span if shouldCreateSpanForRequest returns false", () => {
const url = 'http://dogs.are.great/api/v1/index/';
nock(url).get(/.*/).reply(200);
const httpIntegration = new HttpIntegration({ tracing: true });
const hub = createHub({ shouldCreateSpanForRequest: () => false });
httpIntegration.setupOnce(
() => undefined,
() => hub,
);
const transaction = createTransactionAndPutOnScope(hub);
const spans = (transaction as unknown as Span).spanRecorder?.spans as Span[];
const request = http.get(url);
// There should be no http spans
const httpSpans = spans.filter(span => span.op?.startsWith('http'));
expect(httpSpans.length).toBe(0);
// And headers are not attached without span creation
expect(request.getHeader('sentry-trace')).toBeUndefined();
expect(request.getHeader('baggage')).toBeUndefined();
});
it.each([
['http://dogs.are.great/api/v1/index/', [/.*/]],
['http://dogs.are.great/api/v1/index/', [/\/api/]],
['http://dogs.are.great/api/v1/index/', [/\/(v1|v2)/]],
['http://dogs.are.great/api/v1/index/', [/dogs\.are\.great/, /dogs\.are\.not\.great/]],
['http://dogs.are.great/api/v1/index/', [/http:/]],
['http://dogs.are.great/api/v1/index/', ['dogs.are.great']],
['http://dogs.are.great/api/v1/index/', ['/api/v1']],
['http://dogs.are.great/api/v1/index/', ['http://']],
['http://dogs.are.great/api/v1/index/', ['']],
])(
'attaches trace inforation to header of outgoing requests when url matches tracePropagationTargets (url="%s", tracePropagationTargets=%p)',
(url, tracePropagationTargets) => {
nock(url).get(/.*/).reply(200);
const httpIntegration = new HttpIntegration({ tracing: true });
const hub = createHub({ tracePropagationTargets });
httpIntegration.setupOnce(
() => undefined,
() => hub,
);
createTransactionAndPutOnScope(hub);
const request = http.get(url);
expect(request.getHeader('sentry-trace')).toBeDefined();
expect(request.getHeader('baggage')).toBeDefined();
},
);
it.each([
['http://dogs.are.great/api/v1/index/', []],
['http://cats.are.great/api/v1/index/', [/\/v2/]],
['http://cats.are.great/api/v1/index/', [/\/(v2|v3)/]],
['http://cats.are.great/api/v1/index/', [/dogs\.are\.great/, /dogs\.are\.not\.great/]],
['http://cats.are.great/api/v1/index/', [/https:/]],
['http://cats.are.great/api/v1/index/', ['dogs.are.great']],
['http://cats.are.great/api/v1/index/', ['/api/v2']],
['http://cats.are.great/api/v1/index/', ['https://']],
])(
'doesn\'t attach trace inforation to header of outgoing requests when url doesn\'t match tracePropagationTargets (url="%s", tracePropagationTargets=%p)',
(url, tracePropagationTargets) => {
nock(url).get(/.*/).reply(200);
const httpIntegration = new HttpIntegration({ tracing: true });
const hub = createHub({ tracePropagationTargets });
httpIntegration.setupOnce(
() => undefined,
() => hub,
);
createTransactionAndPutOnScope(hub);
const request = http.get(url);
expect(request.getHeader('sentry-trace')).not.toBeDefined();
expect(request.getHeader('baggage')).not.toBeDefined();
},
);
});
describe('as Http integration constructor options', () => {
it("doesn't create span if shouldCreateSpanForRequest returns false", () => {
const url = 'http://dogs.are.great/api/v1/index/';
nock(url).get(/.*/).reply(200);
const httpIntegration = new HttpIntegration({
tracing: {
shouldCreateSpanForRequest: () => false,
},
});
const hub = createHub();
httpIntegration.setupOnce(
() => undefined,
() => hub,
);
const transaction = createTransactionAndPutOnScope(hub);
const spans = (transaction as unknown as Span).spanRecorder?.spans as Span[];
const request = http.get(url);
// There should be no http spans
const httpSpans = spans.filter(span => span.op?.startsWith('http'));
expect(httpSpans.length).toBe(0);
// And headers are not attached without span creation
expect(request.getHeader('sentry-trace')).toBeUndefined();
expect(request.getHeader('baggage')).toBeUndefined();
});
it.each([
['http://dogs.are.great/api/v1/index/', [/.*/]],
['http://dogs.are.great/api/v1/index/', [/\/api/]],
['http://dogs.are.great/api/v1/index/', [/\/(v1|v2)/]],
['http://dogs.are.great/api/v1/index/', [/dogs\.are\.great/, /dogs\.are\.not\.great/]],
['http://dogs.are.great/api/v1/index/', [/http:/]],
['http://dogs.are.great/api/v1/index/', ['dogs.are.great']],
['http://dogs.are.great/api/v1/index/', ['/api/v1']],
['http://dogs.are.great/api/v1/index/', ['http://']],
['http://dogs.are.great/api/v1/index/', ['']],
])(
'attaches trace inforation to header of outgoing requests when url matches tracePropagationTargets (url="%s", tracePropagationTargets=%p)',
(url, tracePropagationTargets) => {
nock(url).get(/.*/).reply(200);
const httpIntegration = new HttpIntegration({ tracing: { tracePropagationTargets } });
const hub = createHub();
httpIntegration.setupOnce(
() => undefined,
() => hub,
);
createTransactionAndPutOnScope(hub);
const request = http.get(url);
expect(request.getHeader('sentry-trace')).toBeDefined();
expect(request.getHeader('baggage')).toBeDefined();
},
);
it.each([
['http://dogs.are.great/api/v1/index/', []],
['http://cats.are.great/api/v1/index/', [/\/v2/]],
['http://cats.are.great/api/v1/index/', [/\/(v2|v3)/]],
['http://cats.are.great/api/v1/index/', [/dogs\.are\.great/, /dogs\.are\.not\.great/]],
['http://cats.are.great/api/v1/index/', [/https:/]],
['http://cats.are.great/api/v1/index/', ['dogs.are.great']],
['http://cats.are.great/api/v1/index/', ['/api/v2']],
['http://cats.are.great/api/v1/index/', ['https://']],
])(
'doesn\'t attach trace inforation to header of outgoing requests when url doesn\'t match tracePropagationTargets (url="%s", tracePropagationTargets=%p)',
(url, tracePropagationTargets) => {
nock(url).get(/.*/).reply(200);
const httpIntegration = new HttpIntegration({ tracing: { tracePropagationTargets } });
const hub = createHub();
httpIntegration.setupOnce(
() => undefined,
() => hub,
);
createTransactionAndPutOnScope(hub);
const request = http.get(url);
expect(request.getHeader('sentry-trace')).not.toBeDefined();
expect(request.getHeader('baggage')).not.toBeDefined();
},
);
});
});
});
describe('default protocols', () => {
function captureBreadcrumb(key: string): Promise<Breadcrumb> {
const hub = new Hub();
jest.spyOn(sentryCore, 'getCurrentHub').mockReturnValue(hub);
let resolve: (value: Breadcrumb | PromiseLike<Breadcrumb>) => void;
const p = new Promise<Breadcrumb>(r => {
resolve = r;
});
const options = getDefaultNodeClientOptions({
dsn: 'https://dogsarebadatkeepingsecrets@squirrelchasers.ingest.sentry.io/12312012',
integrations: [new HttpIntegration({ breadcrumbs: true })],
beforeBreadcrumb: (b: Breadcrumb) => {
if ((b.data?.url as string).includes(key)) {
resolve(b);
}
return b;
},
});
hub.bindClient(new NodeClient(options));
return p;
}
it('http module', async () => {
const key = 'catrunners';
const p = captureBreadcrumb(key);
nock(`http://${key}.ingest.sentry.io`).get('/api/123122332/store/').reply(200);
http.get({
host: `${key}.ingest.sentry.io`,
path: '/api/123122332/store/',
});
const b = await p;
expect(b.data?.url).toEqual(expect.stringContaining('http://'));
});
it('https module', async () => {
const key = 'catcatchers';
const p = captureBreadcrumb(key);
let nockProtocol = 'https';
// NOTE: Prior to Node 9, `https` used internals of `http` module, so
// the integration doesn't patch the `https` module. However this then
// causes issues with nock, because nock will patch the `https` module
// regardless (if it asked to mock a https:// url), preventing the
// request from reaching the integrations patch of the `http` module.
// The result is test failures in Node v8 and lower.
//
// We can work around this by telling giving nock a http:// url, so it
// only patches the `http` module, then Nodes usage of the `http` module
// in the `https` module results in both nock's and the integrations
// patch being called. All this relies on nock not properly checking
// the agent passed to `http.get` / `http.request`, thus resulting in it
// intercepting a https:// request with http:// mock. It's a safe bet
// because the latest versions of nock no longer support Node v8 and lower,
// so won't bother dealing with this old Node edge case.
if (NODE_VERSION.major && NODE_VERSION.major < 9) {
nockProtocol = 'http';
}
nock(`${nockProtocol}://${key}.ingest.sentry.io`).get('/api/123122332/store/').reply(200);
https.get({
host: `${key}.ingest.sentry.io`,
path: '/api/123122332/store/',
timeout: 300,
});
const b = await p;
expect(b.data?.url).toEqual(expect.stringContaining('https://'));
});
it('makes https request over http proxy', async () => {
const key = 'catcatchers';
const p = captureBreadcrumb(key);
let nockProtocol = 'https';
const proxy = 'http://<PROXY_URL>:3128';
const agent = HttpsProxyAgent(proxy);
if (NODE_VERSION.major && NODE_VERSION.major < 9) {
nockProtocol = 'http';
}
nock(`${nockProtocol}://${key}.ingest.sentry.io`).get('/api/123122332/store/').reply(200);
https.get({
host: `${key}.ingest.sentry.io`,
path: '/api/123122332/store/',
timeout: 300,
agent,
});
const b = await p;
expect(b.data?.url).toEqual(expect.stringContaining('https://'));
});
});