Skip to content

Commit 62e0d94

Browse files
nicohrubeccodex
andcommitted
test(node): Reuse HTTP and Express scenario processes
Co-Authored-By: OpenAI Codex <codex@openai.com>
1 parent a510bde commit 62e0d94

9 files changed

Lines changed: 507 additions & 832 deletions

File tree

‎dev-packages/node-integration-tests/suites/express/sentry-trace/scenario.mjs‎

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ import cors from 'cors';
44
import express from 'express';
55
import http from 'http';
66

7+
function getOutgoingHeaders(options) {
8+
const request = http.get(options);
9+
const headers = request.getHeaders();
10+
// Only header construction is under test; don't leave requests to the placeholder host running.
11+
request.on('error', () => {});
12+
request.destroy();
13+
return headers;
14+
}
15+
716
const app = express();
817

918
// Set globally so we can assert user data is not leaked into propagated baggage.
@@ -13,7 +22,7 @@ app.use(cors());
1322

1423
// Plain outgoing request — used to assert propagated `sentry-trace`/`baggage` headers.
1524
app.get('/test/express', (_req, res) => {
16-
const headers = http.get('http://somewhere.not.sentry/').getHeaders();
25+
const headers = getOutgoingHeaders('http://somewhere.not.sentry/');
1726
res.send({ test_data: headers });
1827
});
1928

@@ -22,7 +31,7 @@ app.get('/test/express', (_req, res) => {
2231
app.get('/test/express-replace-trace-id', (_req, res) => {
2332
const span = Sentry.getActiveSpan();
2433
const traceId = span?.spanContext().traceId;
25-
const headers = http.get('http://somewhere.not.sentry/').getHeaders();
34+
const headers = getOutgoingHeaders('http://somewhere.not.sentry/');
2635
if (traceId) {
2736
headers['baggage'] = headers['baggage'].replace(traceId, '__SENTRY_TRACE_ID__');
2837
}
@@ -32,32 +41,31 @@ app.get('/test/express-replace-trace-id', (_req, res) => {
3241
// Sets a third-party baggage header on the outgoing request, which the SDK should
3342
// merge with the Sentry DSC entries.
3443
app.get('/test/express-third-party-baggage', (_req, res) => {
35-
const headers = http
36-
.get({ hostname: 'somewhere.not.sentry', headers: { baggage: 'other=vendor,foo=bar,third=party' } })
37-
.getHeaders();
44+
const headers = getOutgoingHeaders({
45+
hostname: 'somewhere.not.sentry',
46+
headers: { baggage: 'other=vendor,foo=bar,third=party' },
47+
});
3848
res.send({ test_data: headers });
3949
});
4050

4151
// Sets a third-party baggage header that also contains sentry-* entries, which the
4252
// SDK should ignore/overwrite with the actual DSC.
4353
app.get('/test/express-third-party-baggage-with-sentry', (_req, res) => {
44-
const headers = http
45-
.get({
46-
hostname: 'somewhere.not.sentry',
47-
headers: {
48-
baggage:
49-
'other=vendor,foo=bar,third=party,sentry-release=9.9.9,sentry-environment=staging,sentry-sample_rate=0.54,last=item',
50-
},
51-
})
52-
.getHeaders();
54+
const headers = getOutgoingHeaders({
55+
hostname: 'somewhere.not.sentry',
56+
headers: {
57+
baggage:
58+
'other=vendor,foo=bar,third=party,sentry-release=9.9.9,sentry-environment=staging,sentry-sample_rate=0.54,last=item',
59+
},
60+
});
5361
res.send({ test_data: headers });
5462
});
5563

5664
// Forwards the incoming baggage header to the outgoing request, to assert that
5765
// property values with `=` signs are preserved during parsing & re-serialization.
5866
app.get('/test/express-property-values', (req, res) => {
5967
const incomingBaggage = req.headers.baggage;
60-
const headers = http.get({ hostname: 'somewhere.not.sentry', headers: { baggage: incomingBaggage } }).getHeaders();
68+
const headers = getOutgoingHeaders({ hostname: 'somewhere.not.sentry', headers: { baggage: incomingBaggage } });
6169
res.send({ test_data: headers });
6270
});
6371

‎dev-packages/node-integration-tests/suites/express/sentry-trace/test.ts‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,13 @@ describe('express sentry-trace', () => {
1010
});
1111

1212
createCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
13+
let started: ReturnType<ReturnType<typeof createRunner>['start']> | undefined;
14+
// These cases vary request headers, so the same initialized server can handle each one.
15+
const getRunner = () => (started ??= createRunner().start());
16+
1317
describe('baggage header assignment', () => {
1418
test('Should overwrite baggage if the incoming request already has Sentry baggage data but no sentry-trace', async () => {
15-
const runner = createRunner().start();
19+
const runner = getRunner();
1620

1721
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express', {
1822
headers: {
@@ -30,7 +34,7 @@ describe('express sentry-trace', () => {
3034
});
3135

3236
test('Should propagate sentry trace baggage data from an incoming to an outgoing request.', async () => {
33-
const runner = createRunner().start();
37+
const runner = getRunner();
3438

3539
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express', {
3640
headers: {
@@ -49,7 +53,7 @@ describe('express sentry-trace', () => {
4953
});
5054

5155
test('Should not propagate baggage data from an incoming to an outgoing request if sentry-trace is faulty.', async () => {
52-
const runner = createRunner().start();
56+
const runner = getRunner();
5357

5458
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express', {
5559
headers: {
@@ -68,7 +72,7 @@ describe('express sentry-trace', () => {
6872
});
6973

7074
test('Should not propagate baggage if sentry-trace header is present in incoming request but no baggage header', async () => {
71-
const runner = createRunner().start();
75+
const runner = getRunner();
7276

7377
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express', {
7478
headers: {
@@ -85,7 +89,7 @@ describe('express sentry-trace', () => {
8589
});
8690

8791
test('Should not propagate baggage and ignore original 3rd party baggage entries if sentry-trace header is present', async () => {
88-
const runner = createRunner().start();
92+
const runner = getRunner();
8993

9094
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express', {
9195
headers: {
@@ -103,7 +107,7 @@ describe('express sentry-trace', () => {
103107
});
104108

105109
test('Should populate and propagate sentry baggage if sentry-trace header does not exist', async () => {
106-
const runner = createRunner().start();
110+
const runner = getRunner();
107111

108112
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express');
109113

@@ -126,7 +130,7 @@ describe('express sentry-trace', () => {
126130
});
127131

128132
test('Should populate Sentry and ignore 3rd party content if sentry-trace header does not exist', async () => {
129-
const runner = createRunner().start();
133+
const runner = getRunner();
130134

131135
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express', {
132136
headers: {
@@ -153,7 +157,7 @@ describe('express sentry-trace', () => {
153157
});
154158

155159
test('should attach a baggage header to an outgoing request.', async () => {
156-
const runner = createRunner().start();
160+
const runner = getRunner();
157161

158162
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express-replace-trace-id');
159163

@@ -182,7 +186,7 @@ describe('express sentry-trace', () => {
182186
});
183187

184188
test('should merge `baggage` header of a third party vendor with the Sentry DSC baggage items', async () => {
185-
const runner = createRunner().start();
189+
const runner = getRunner();
186190

187191
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express-third-party-baggage', {
188192
headers: {
@@ -203,7 +207,7 @@ describe('express sentry-trace', () => {
203207

204208
describe('third party baggage with sentry entries', () => {
205209
test('should ignore sentry-values in `baggage` header of a third party vendor and overwrite them with incoming DSC', async () => {
206-
const runner = createRunner().start();
210+
const runner = getRunner();
207211

208212
const response = await runner.makeRequest<TestAPIResponse>(
209213
'get',
@@ -238,7 +242,7 @@ describe('express sentry-trace', () => {
238242
});
239243

240244
test('should ignore sentry-values in `baggage` header of a third party vendor and overwrite them with new DSC', async () => {
241-
const runner = createRunner().start();
245+
const runner = getRunner();
242246

243247
const response = await runner.makeRequest<TestAPIResponse>(
244248
'get',
@@ -278,7 +282,7 @@ describe('express sentry-trace', () => {
278282
});
279283

280284
test('should preserve baggage property values with equal signs (W3C spec compliance)', async () => {
281-
const runner = createRunner().start();
285+
const runner = getRunner();
282286

283287
// W3C spec example: https://www.w3.org/TR/baggage/#example
284288
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express-property-values', {
@@ -299,7 +303,7 @@ describe('express sentry-trace', () => {
299303
});
300304

301305
test('Includes transaction in baggage if the transaction name is parameterized', async () => {
302-
const runner = createRunner().start();
306+
const runner = getRunner();
303307

304308
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express');
305309

@@ -313,7 +317,7 @@ describe('express sentry-trace', () => {
313317
});
314318

315319
test('Should assign `sentry-trace` header which sets parent trace id of an outgoing request.', async () => {
316-
const runner = createRunner().start();
320+
const runner = getRunner();
317321

318322
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express', {
319323
headers: {
@@ -333,7 +337,7 @@ describe('express sentry-trace', () => {
333337
});
334338

335339
test('should attach a `sentry-trace` header to an outgoing request.', async () => {
336-
const runner = createRunner().start();
340+
const runner = getRunner();
337341

338342
const response = await runner.makeRequest<TestAPIResponse>('get', '/test/express');
339343

0 commit comments

Comments
 (0)