Repository navigation
feat(browser): Extract XHR request instrumentation into xhrTracingIntegration
#26261
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
logaretm
merged 2 commits into
awad/long-tasks-integration
from
awad/xhr-tracing-integration
Nov 17, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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,35 @@ | ||
| import { isBotUserAgent } from '@sentry/browser-utils'; | ||
| import type { IntegrationFn } from '@sentry/core'; | ||
| import { defineIntegration } from '@sentry/core'; | ||
| import type { RequestInstrumentationOptions } from '../tracing/request'; | ||
| import { instrumentXhrRequests } from '../tracing/request'; | ||
|
|
||
| const INTEGRATION_NAME = 'XhrTracing'; | ||
|
|
||
| type XhrTracingOptions = Partial< | ||
| Pick< | ||
| RequestInstrumentationOptions, | ||
| 'shouldCreateSpanForRequest' | 'enableHTTPTimings' | 'onRequestSpanStart' | 'onRequestSpanEnd' | ||
| > | ||
| >; | ||
|
|
||
| const _xhrTracingIntegration = ((options: XhrTracingOptions = {}) => { | ||
| return { | ||
| name: INTEGRATION_NAME, | ||
| setup(client) { | ||
| if (isBotUserAgent()) { | ||
| return; | ||
| } | ||
|
|
||
| instrumentXhrRequests(client, { | ||
| ...options, | ||
| tracePropagationTargets: client.getOptions().tracePropagationTargets, | ||
| }); | ||
| }, | ||
| }; | ||
| }) satisfies IntegrationFn; | ||
|
|
||
| /** | ||
| * Creates spans for outgoing XHR requests and attaches trace propagation headers to them. | ||
| */ | ||
| export const xhrTracingIntegration = defineIntegration(_xhrTracingIntegration); |
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
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
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,31 @@ | ||
| /** | ||
| * @vitest-environment jsdom | ||
| */ | ||
|
|
||
| import { afterEach, describe, expect, it, vi } from 'vitest'; | ||
| import { BrowserClient } from '../../src/client'; | ||
| import { xhrTracingIntegration } from '../../src/integrations/xhrTracing'; | ||
| import * as requestModule from '../../src/tracing/request'; | ||
| import { getDefaultBrowserClientOptions } from '../helper/browser-client-options'; | ||
|
|
||
| describe('xhrTracingIntegration', () => { | ||
| afterEach(() => { | ||
| vi.restoreAllMocks(); | ||
| }); | ||
|
|
||
| it.each([ | ||
| [ | ||
| 'instruments XHR requests for normal user agents', | ||
| 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Chrome/120.0.0.0', | ||
| 1, | ||
| ], | ||
| ['does not instrument XHR requests for bot user agents', 'Mozilla/5.0 (compatible; Googlebot/2.1)', 0], | ||
| ])('%s', (_name, userAgent, calls) => { | ||
| const instrumentSpy = vi.spyOn(requestModule, 'instrumentXhrRequests').mockImplementation(() => {}); | ||
| vi.spyOn(window.navigator, 'userAgent', 'get').mockReturnValue(userAgent); | ||
|
|
||
| xhrTracingIntegration().setup?.(new BrowserClient(getDefaultBrowserClientOptions())); | ||
|
|
||
| expect(instrumentSpy).toHaveBeenCalledTimes(calls); | ||
| }); | ||
| }); | ||
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
Oops, something went wrong.
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.
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.
Missing integration test coverage
Low Severity
This feat PR only adds unit tests that mock
instrumentXhrRequestsand check registration by name. There is no integration or E2E test for the documentedbrowserTracingCoreIntegration()plusxhrTracingIntegration()setup. Flagged because the testing conventions require at least one integration or E2E test on feat PRs.Additional Locations (1)
packages/browser/test/tracing/browserTracingIntegration.test.ts#L247-L262Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit 9c59c53. Configure here.