Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1.8k
fix(core): Respect manually set sentry tracing headers in fetch calls#16183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 3 additions & 1 deletion
4 ...ace-lifetime/trace-header-merging/test.ts → ...equest/fetch-trace-header-merging/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10 ...browser-integration-tests/suites/tracing/request/fetch-with-custom-sentry-headers/init.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
| window.Sentry = Sentry; | ||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| integrations: [Sentry.browserTracingIntegration()], | ||
| tracePropagationTargets: ['http://sentry-test-site.example'], | ||
| tracesSampleRate: 1, | ||
| }); |
3 changes: 3 additions & 0 deletions
3 ...wser-integration-tests/suites/tracing/request/fetch-with-custom-sentry-headers/subject.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| fetch('http://sentry-test-site.example/api/test/', { | ||
| headers: { 'sentry-trace': 'abc-123-1', baggage: 'sentry-trace_id=abc' }, | ||
| }); |
22 changes: 22 additions & 0 deletions
22 ...browser-integration-tests/suites/tracing/request/fetch-with-custom-sentry-headers/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import { expect } from '@playwright/test'; | ||
| import { sentryTest } from '../../../../utils/fixtures'; | ||
| import { shouldSkipTracingTest } from '../../../../utils/helpers'; | ||
| sentryTest("instrumentation doesn't override manually added sentry headers", async ({ getLocalTestUrl, page }) => { | ||
| if (shouldSkipTracingTest()) { | ||
| sentryTest.skip(); | ||
| } | ||
| const requestPromise = page.waitForRequest('http://sentry-test-site.example/api/test/'); | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| await page.goto(url); | ||
| const request = await requestPromise; | ||
| const headers = await request.allHeaders(); | ||
| expect(headers['sentry-trace']).toBe('abc-123-1'); | ||
| expect(headers.baggage).toBe('sentry-trace_id=abc'); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -103,8 +103,15 @@ export function instrumentFetchRequest( | ||
| /** | ||
| * Adds sentry-trace and baggage headers to the various forms of fetch headers. | ||
| * exported only for testing purposes | ||
| * | ||
| * When we determine if we should add a baggage header, there are 3 cases: | ||
| * 1. No previous baggage header -> add baggage | ||
| * 2. Previous baggage header has no sentry baggage values -> add our baggage | ||
| * 3. Previous baggage header has sentry baggage values -> do nothing (might have been added manually by users) | ||
| */ | ||
| function _addTracingHeadersToFetchRequest( | ||
| // eslint-disable-next-line complexity -- yup it's this complicated :( | ||
| export function _addTracingHeadersToFetchRequest( | ||
| request: string | Request, | ||
| fetchOptionsObj: { | ||
| headers?: | ||
| @@ -124,78 +131,70 @@ function _addTracingHeadersToFetchRequest( | ||
| return undefined; | ||
| } | ||
| const headers = fetchOptionsObj.headers || (isRequest(request) ? request.headers : undefined); | ||
| const originalHeaders = fetchOptionsObj.headers || (isRequest(request) ? request.headers : undefined); | ||
| if (!headers) { | ||
| if (!originalHeaders) { | ||
| return { ...traceHeaders }; | ||
| } else if (isHeaders(headers)) { | ||
| const newHeaders = new Headers(headers); | ||
| newHeaders.set('sentry-trace', sentryTrace); | ||
| } else if (isHeaders(originalHeaders)) { | ||
| const newHeaders = new Headers(originalHeaders); | ||
| // We don't want to override manually added sentry headers | ||
| if (!newHeaders.get('sentry-trace')) { | ||
| newHeaders.set('sentry-trace', sentryTrace); | ||
| } | ||
| if (baggage) { | ||
| const prevBaggageHeader = newHeaders.get('baggage'); | ||
| if (prevBaggageHeader) { | ||
| const prevHeaderStrippedFromSentryBaggage = stripBaggageHeaderOfSentryBaggageValues(prevBaggageHeader); | ||
| newHeaders.set( | ||
| 'baggage', | ||
| // If there are non-sentry entries (i.e. if the stripped string is non-empty/truthy) combine the stripped header and sentry baggage header | ||
| // otherwise just set the sentry baggage header | ||
| prevHeaderStrippedFromSentryBaggage ? `${prevHeaderStrippedFromSentryBaggage},${baggage}` : baggage, | ||
| ); | ||
| } else { | ||
| if (!prevBaggageHeader) { | ||
| newHeaders.set('baggage', baggage); | ||
| } else if (!baggageHeaderHasSentryBaggageValues(prevBaggageHeader)) { | ||
| newHeaders.set('baggage', `${prevBaggageHeader},${baggage}`); | ||
| } | ||
| } | ||
| return newHeaders; | ||
| } else if (Array.isArray(headers)) { | ||
| const newHeaders = [ | ||
| ...headers | ||
| // Remove any existing sentry-trace headers | ||
| .filter(header => { | ||
| return !(Array.isArray(header) && header[0] === 'sentry-trace'); | ||
| }) | ||
| // Get rid of previous sentry baggage values in baggage header | ||
| .map(header => { | ||
| if (Array.isArray(header) && header[0] === 'baggage' && typeof header[1] === 'string') { | ||
| const [headerName, headerValue, ...rest] = header; | ||
| return [headerName, stripBaggageHeaderOfSentryBaggageValues(headerValue), ...rest]; | ||
| } else { | ||
| return header; | ||
| } | ||
| }), | ||
| // Attach the new sentry-trace header | ||
| ['sentry-trace', sentryTrace], | ||
| ]; | ||
| } else if (Array.isArray(originalHeaders)) { | ||
| const newHeaders = [...originalHeaders]; | ||
| if (baggage) { | ||
| if (!originalHeaders.find(header => header[0] === 'sentry-trace')) { | ||
Lms24 marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| newHeaders.push(['sentry-trace', sentryTrace]); | ||
| } | ||
| const prevBaggageHeaderWithSentryValues = originalHeaders.find( | ||
| header => header[0] === 'baggage' && baggageHeaderHasSentryBaggageValues(header[1]), | ||
| ); | ||
| if (baggage && !prevBaggageHeaderWithSentryValues) { | ||
| // If there are multiple entries with the same key, the browser will merge the values into a single request header. | ||
| // Its therefore safe to simply push a "baggage" entry, even though there might already be another baggage header. | ||
| newHeaders.push(['baggage', baggage]); | ||
| } | ||
| return newHeaders as PolymorphicRequestHeaders; | ||
| } else { | ||
| const existingBaggageHeader = 'baggage' in headers ? headers.baggage : undefined; | ||
| let newBaggageHeaders: string[] = []; | ||
| if (Array.isArray(existingBaggageHeader)) { | ||
| newBaggageHeaders = existingBaggageHeader | ||
| .map(headerItem => | ||
| typeof headerItem === 'string' ? stripBaggageHeaderOfSentryBaggageValues(headerItem) : headerItem, | ||
| ) | ||
| .filter(headerItem => headerItem === ''); | ||
| } else if (existingBaggageHeader) { | ||
| newBaggageHeaders.push(stripBaggageHeaderOfSentryBaggageValues(existingBaggageHeader)); | ||
| } | ||
| if (baggage) { | ||
| const existingSentryTraceHeader = 'sentry-trace' in originalHeaders ? originalHeaders['sentry-trace'] : undefined; | ||
| const existingBaggageHeader = 'baggage' in originalHeaders ? originalHeaders.baggage : undefined; | ||
| const newBaggageHeaders: string[] = existingBaggageHeader | ||
| ? Array.isArray(existingBaggageHeader) | ||
| ? [...existingBaggageHeader] | ||
| : [existingBaggageHeader] | ||
| : []; | ||
| const prevBaggageHeaderWithSentryValues = | ||
| existingBaggageHeader && | ||
| (Array.isArray(existingBaggageHeader) | ||
| ? existingBaggageHeader.find(headerItem => baggageHeaderHasSentryBaggageValues(headerItem)) | ||
| : baggageHeaderHasSentryBaggageValues(existingBaggageHeader)); | ||
| if (baggage && !prevBaggageHeaderWithSentryValues) { | ||
| newBaggageHeaders.push(baggage); | ||
| } | ||
| return { | ||
| ...(headers as Exclude<typeof headers, Headers>), | ||
| 'sentry-trace': sentryTrace, | ||
| ...(originalHeaders as Exclude<typeof originalHeaders, Headers>), | ||
| 'sentry-trace': (existingSentryTraceHeader as string | undefined) ?? sentryTrace, | ||
| baggage: newBaggageHeaders.length > 0 ? newBaggageHeaders.join(',') : undefined, | ||
| }; | ||
| } | ||
| @@ -219,14 +218,8 @@ function endSpan(span: Span, handlerData: HandlerDataFetch): void { | ||
| span.end(); | ||
| } | ||
| function stripBaggageHeaderOfSentryBaggageValues(baggageHeader: string): string { | ||
| return ( | ||
| baggageHeader | ||
| .split(',') | ||
| // eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
| .filter(baggageEntry => !baggageEntry.split('=')[0]!.startsWith(SENTRY_BAGGAGE_KEY_PREFIX)) | ||
| .join(',') | ||
| ); | ||
| function baggageHeaderHasSentryBaggageValues(baggageHeader: string): boolean { | ||
| return baggageHeader.split(',').some(baggageEntry => baggageEntry.trim().startsWith(SENTRY_BAGGAGE_KEY_PREFIX)); | ||
| } | ||
| function isHeaders(headers: unknown): headers is Headers { | ||
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this seems harmless but it demonstrates the behaviour change for reused request options:
previously, we'd simple disregard what sentry values were in the request options and always overwrite them. Now:
Result: All requests in this test sharing the same request options have the same sentry tracing headers (and hence their child trace trees have the same trace parent)
I think this is fine but it's still worth noting.