Skip to content

Commit 4e235e3

Browse files
JPeer264JPeer264
committed
fixup! feat(core): Export a reusable function to add tracing headers
1 parent 1622527 commit 4e235e3

File tree

3 files changed

+34
-34
lines changed

3 files changed

+34
-34
lines changed

‎packages/core/src/fetch.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ export function instrumentFetchRequest(
125125
// Examples: users re-using same options object for multiple fetch calls, frozen objects
126126
const options: { [key: string]: unknown } = { ...(handlerData.args[1] || {}) };
127127

128-
const headers = getTracingHeadersForFetchRequest(
128+
const headers = _INTERNAL_getTracingHeadersForFetchRequest(
129129
request,
130130
options,
131131
// If performance is disabled (TWP) or there's no active root span (pageload/navigation/interaction),
@@ -191,7 +191,7 @@ export function _callOnRequestSpanEnd(
191191
* 3. Previous baggage already has Sentry entries → leave as-is (may be user-defined)
192192
*/
193193
// eslint-disable-next-line complexity -- yup it's this complicated :(
194-
export function getTracingHeadersForFetchRequest(
194+
export function _INTERNAL_getTracingHeadersForFetchRequest(
195195
request: string | URL | Request,
196196
fetchOptionsObj: {
197197
headers?:

‎packages/core/src/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ export { profiler } from './profiling';
142142
// eslint thinks the entire function is deprecated (while only one overload is actually deprecated)
143143
// Therefore:
144144
// eslint-disable-next-line deprecation/deprecation
145-
export { instrumentFetchRequest, getTracingHeadersForFetchRequest } from './fetch';
145+
export { instrumentFetchRequest, _INTERNAL_getTracingHeadersForFetchRequest } from './fetch';
146146
export { trpcMiddleware } from './trpc';
147147
export { wrapMcpServerWithSentry } from './integrations/mcp-server';
148148
export { captureFeedback } from './feedback';

‎packages/core/test/lib/fetch.test.ts‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { beforeEach, describe, expect, it, vi } from 'vitest';
22
import type { HandlerDataFetch } from '../../src';
3-
import { getTracingHeadersForFetchRequest, instrumentFetchRequest } from '../../src/fetch';
3+
import { _INTERNAL_getTracingHeadersForFetchRequest, instrumentFetchRequest } from '../../src/fetch';
44
import type { Span } from '../../src/types-hoist/span';
55

66
const { DEFAULT_SENTRY_TRACE, DEFAULT_BAGGAGE, hasSpansEnabled } = vi.hoisted(() => ({
@@ -31,7 +31,7 @@ vi.mock('../../src/utils/hasSpansEnabled', () => {
3131
};
3232
});
3333

34-
describe('getTracingHeadersForFetchRequest', () => {
34+
describe('_INTERNAL_getTracingHeadersForFetchRequest', () => {
3535
beforeEach(() => {
3636
vi.clearAllMocks();
3737
hasSpansEnabled.mockReturnValue(false);
@@ -47,7 +47,7 @@ describe('getTracingHeadersForFetchRequest', () => {
4747
options: { headers: {} },
4848
},
4949
])('attaches sentry headers (options: $options)', ({ options }) => {
50-
expect(getTracingHeadersForFetchRequest('/api/test', options)).toEqual({
50+
expect(_INTERNAL_getTracingHeadersForFetchRequest('/api/test', options)).toEqual({
5151
'sentry-trace': DEFAULT_SENTRY_TRACE,
5252
baggage: DEFAULT_BAGGAGE,
5353
});
@@ -56,17 +56,17 @@ describe('getTracingHeadersForFetchRequest', () => {
5656

5757
describe('and request headers are set in options', () => {
5858
it('attaches sentry headers to headers object', () => {
59-
expect(getTracingHeadersForFetchRequest('/api/test', { headers: { 'custom-header': 'custom-value' } })).toEqual(
60-
{
61-
'sentry-trace': DEFAULT_SENTRY_TRACE,
62-
baggage: DEFAULT_BAGGAGE,
63-
'custom-header': 'custom-value',
64-
},
65-
);
59+
expect(
60+
_INTERNAL_getTracingHeadersForFetchRequest('/api/test', { headers: { 'custom-header': 'custom-value' } }),
61+
).toEqual({
62+
'sentry-trace': DEFAULT_SENTRY_TRACE,
63+
baggage: DEFAULT_BAGGAGE,
64+
'custom-header': 'custom-value',
65+
});
6666
});
6767

6868
it('attaches sentry headers to a Headers instance', () => {
69-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
69+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
7070
headers: new Headers({ 'custom-header': 'custom-value' }),
7171
});
7272

@@ -81,7 +81,7 @@ describe('getTracingHeadersForFetchRequest', () => {
8181
});
8282

8383
it('attaches sentry headers to headers array', () => {
84-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
84+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
8585
headers: [['custom-header', 'custom-value']],
8686
});
8787

@@ -94,7 +94,7 @@ describe('getTracingHeadersForFetchRequest', () => {
9494
});
9595

9696
it('treats array with non-tuple items as headers object', () => {
97-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
97+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
9898
headers: ['not-a-tuple', 'also-not-a-tuple'],
9999
});
100100

@@ -111,7 +111,7 @@ describe('getTracingHeadersForFetchRequest', () => {
111111

112112
describe('and 3rd party baggage header is set', () => {
113113
it('adds additional sentry baggage values to Headers instance', () => {
114-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
114+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
115115
headers: new Headers({
116116
baggage: 'custom-baggage=1,someVal=bar',
117117
}),
@@ -127,7 +127,7 @@ describe('getTracingHeadersForFetchRequest', () => {
127127
});
128128

129129
it('adds additional sentry baggage values to headers array', () => {
130-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
130+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
131131
headers: [['baggage', 'custom-baggage=1,someVal=bar']],
132132
});
133133

@@ -141,7 +141,7 @@ describe('getTracingHeadersForFetchRequest', () => {
141141
});
142142

143143
it('adds additional sentry baggage values to headers object', () => {
144-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
144+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
145145
headers: {
146146
baggage: 'custom-baggage=1,someVal=bar',
147147
},
@@ -156,7 +156,7 @@ describe('getTracingHeadersForFetchRequest', () => {
156156
});
157157

158158
it('adds additional sentry baggage values to headers object with arrays', () => {
159-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
159+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
160160
headers: {
161161
baggage: ['custom-baggage=1,someVal=bar', 'other-vendor-key=value'],
162162
},
@@ -173,7 +173,7 @@ describe('getTracingHeadersForFetchRequest', () => {
173173

174174
describe('and Sentry values are already set', () => {
175175
it('does not override them (Headers instance)', () => {
176-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
176+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
177177
headers: new Headers({
178178
'sentry-trace': CUSTOM_SENTRY_TRACE,
179179
baggage: CUSTOM_BAGGAGE,
@@ -192,7 +192,7 @@ describe('getTracingHeadersForFetchRequest', () => {
192192
});
193193

194194
it('does not override them (headers array)', () => {
195-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
195+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
196196
headers: [
197197
['sentry-trace', CUSTOM_SENTRY_TRACE],
198198
['baggage', CUSTOM_BAGGAGE],
@@ -210,7 +210,7 @@ describe('getTracingHeadersForFetchRequest', () => {
210210
});
211211

212212
it('does not override them (headers object)', () => {
213-
const returnedHeaders = getTracingHeadersForFetchRequest('/api/test', {
213+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest('/api/test', {
214214
headers: {
215215
'sentry-trace': CUSTOM_SENTRY_TRACE,
216216
baggage: CUSTOM_BAGGAGE,
@@ -233,7 +233,7 @@ describe('getTracingHeadersForFetchRequest', () => {
233233
describe('and no request headers are set', () => {
234234
it('attaches sentry headers', () => {
235235
const request = new Request('http://locahlost:3000/api/test');
236-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
236+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
237237

238238
expect(returnedHeaders).toBeInstanceOf(Headers);
239239

@@ -251,7 +251,7 @@ describe('getTracingHeadersForFetchRequest', () => {
251251
headers: new Headers({ 'custom-header': 'custom-value' }),
252252
});
253253

254-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
254+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
255255

256256
expect(returnedHeaders).toBeInstanceOf(Headers);
257257

@@ -268,7 +268,7 @@ describe('getTracingHeadersForFetchRequest', () => {
268268
headers: { 'custom-header': 'custom-value' },
269269
});
270270

271-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
271+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
272272

273273
expect(returnedHeaders).toBeInstanceOf(Headers);
274274

@@ -285,7 +285,7 @@ describe('getTracingHeadersForFetchRequest', () => {
285285
headers: [['custom-header', 'custom-value']],
286286
});
287287

288-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
288+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
289289

290290
expect(returnedHeaders).toBeInstanceOf(Headers);
291291

@@ -307,7 +307,7 @@ describe('getTracingHeadersForFetchRequest', () => {
307307
}),
308308
});
309309

310-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
310+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
311311

312312
expect(returnedHeaders).toBeInstanceOf(Headers);
313313

@@ -324,7 +324,7 @@ describe('getTracingHeadersForFetchRequest', () => {
324324
headers: [['baggage', 'custom-baggage=1,someVal=bar']],
325325
});
326326

327-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
327+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
328328

329329
expect(returnedHeaders).toBeInstanceOf(Headers);
330330

@@ -342,7 +342,7 @@ describe('getTracingHeadersForFetchRequest', () => {
342342
},
343343
});
344344

345-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
345+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
346346

347347
expect(returnedHeaders).toBeInstanceOf(Headers);
348348

@@ -360,7 +360,7 @@ describe('getTracingHeadersForFetchRequest', () => {
360360
},
361361
});
362362

363-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
363+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
364364

365365
expect(returnedHeaders).toBeInstanceOf(Headers);
366366

@@ -382,7 +382,7 @@ describe('getTracingHeadersForFetchRequest', () => {
382382
}),
383383
});
384384

385-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
385+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
386386

387387
expect(returnedHeaders).toBeInstanceOf(Headers);
388388

@@ -403,7 +403,7 @@ describe('getTracingHeadersForFetchRequest', () => {
403403
],
404404
});
405405

406-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
406+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
407407

408408
expect(returnedHeaders).toBeInstanceOf(Headers);
409409

@@ -424,7 +424,7 @@ describe('getTracingHeadersForFetchRequest', () => {
424424
},
425425
});
426426

427-
const returnedHeaders = getTracingHeadersForFetchRequest(request, {});
427+
const returnedHeaders = _INTERNAL_getTracingHeadersForFetchRequest(request, {});
428428

429429
expect(returnedHeaders).toBeInstanceOf(Headers);
430430

0 commit comments

Comments
 (0)