Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration'),
gzip: true,
limit: '35 KB',
limit: '36 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay)',
Expand All@@ -29,7 +29,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration'),
gzip: true,
limit: '65 KB',
limit: '66 KB',
modifyWebpackConfig: function (config) {
const webpack = require('webpack');
config.plugins.push(
Expand DownExpand Up@@ -107,7 +107,7 @@ module.exports = [
import: createImport('init', 'ErrorBoundary', 'reactRouterV6BrowserTracingIntegration'),
ignore: ['react/jsx-runtime'],
gzip: true,
limit: '38 KB',
limit: '39 KB',
},
// Vue SDK (ESM)
{
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
"@sentry/react": "latest || *",
"@types/react": "18.0.0",
"@types/react-dom": "18.0.0",
"express": "4.19.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-router-dom": "^6.4.1",
Expand All@@ -14,7 +15,9 @@
},
"scripts": {
"build": "react-scripts build",
"start": "serve -s build",
"start": "run-p start:client start:server",
"start:client": "node server/app.js",
"start:server": "serve -s build",
"test": "playwright test",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand DownExpand Up@@ -43,7 +46,8 @@
"devDependencies": {
"@playwright/test": "^1.44.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"serve": "14.0.1"
"serve": "14.0.1",
"npm-run-all2": "^6.2.0"
},
"volta": {
"extends": "../../package.json"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
return new Promise(resolve => {
setTimeout(() => {
resolve();
}, time);
});
};

async function sseHandler(request, response, timeout = false) {
response.headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
'Access-Control-Allow-Origin': '*',
};

response.setHeader('Cache-Control', 'no-cache');
response.setHeader('Content-Type', 'text/event-stream');
response.setHeader('Access-Control-Allow-Origin', '*');
response.setHeader('Connection', 'keep-alive');

response.flushHeaders();

await wait(2000);

for (let index = 0; index < 10; index++) {
response.write(`data: ${new Date().toISOString()}\n\n`);
if (timeout) {
await wait(10000);
}
}

response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
console.log(`SSE service listening at http://localhost:${PORT}`);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
useNavigationType,
} from 'react-router-dom';
import Index from './pages/Index';
import SSE from './pages/SSE';
import User from './pages/User';

const replay = Sentry.replayIntegration();
Expand DownExpand Up@@ -48,6 +49,7 @@ root.render(
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/user/:id" element={<User />} />
<Route path="/sse" element={<SSE />} />
</SentryRoutes>
</BrowserRouter>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';

const fetchSSE = async ({ timeout }: { timeout: boolean }) => {
Sentry.startSpanManual({ name: 'sse stream using fetch' }, async span => {
const res = await Sentry.startSpan({ name: 'sse fetch call' }, async () => {
const endpoint = `http://localhost:8080/${timeout ? 'sse-timeout' : 'sse'}`;
return await fetch(endpoint);
});

const stream = res.body;
const reader = stream?.getReader();

const readChunk = async () => {
const readRes = await reader?.read();
if (readRes?.done) {
return;
}

new TextDecoder().decode(readRes?.value);

await readChunk();
};

try {
await readChunk();
} catch (error) {
console.error('Could not fetch sse', error);
}

span.end();
});
};

const SSE = () => {
return (
<>
<button id="fetch-button" onClick={() => fetchSSE({ timeout: false })}>
Fetch SSE
</button>
<button id="fetch-timeout-button" onClick={() => fetchSSE({ timeout: true })}>
Fetch timeout SSE
</button>
</>
);
};

export default SSE;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { SpanJSON } from '@sentry/types';

test('Waits for sse streaming when creating spans', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(span => span.description === 'GET http://localhost:8080/sse')[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 2s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(2);
});

test('Aborts when stream takes longer than 5s', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-timeout-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(
span => span.description === 'GET http://localhost:8080/sse-timeout',
)[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 10s but client should abort reading after 5s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(7);
});
2 changes: 1 addition & 1 deletion packages/browser/src/tracing/browserTracingIntegration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,7 +398,7 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
registerInpInteractionListener();
}

instrumentOutgoingRequests({
instrumentOutgoingRequests(client, {
traceFetch,
traceXHR,
tracePropagationTargets: client.getOptions().tracePropagationTargets,
Expand Down
37 changes: 36 additions & 1 deletion packages/browser/src/tracing/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ import {
import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/types';
import {
BAGGAGE_HEADER_NAME,
addFetchEndInstrumentationHandler,
addFetchInstrumentationHandler,
browserPerformanceTimeOrigin,
dynamicSamplingContextToSentryBaggageHeader,
Expand DownExpand Up@@ -93,14 +94,17 @@ export interface RequestInstrumentationOptions {
shouldCreateSpanForRequest?(this: void, url: string): boolean;
}

const responseToSpanId = new WeakMap<object, string>();
const spanIdToEndTimestamp = new Map<string, number>();

export const defaultRequestInstrumentationOptions: RequestInstrumentationOptions = {
traceFetch: true,
traceXHR: true,
enableHTTPTimings: true,
};

/** Registers span creators for xhr and fetch requests */
export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumentationOptions>): void {
export function instrumentOutgoingRequests(client: Client, _options?: Partial<RequestInstrumentationOptions>): void {
const { traceFetch, traceXHR, shouldCreateSpanForRequest, enableHTTPTimings, tracePropagationTargets } = {
traceFetch: defaultRequestInstrumentationOptions.traceFetch,
traceXHR: defaultRequestInstrumentationOptions.traceXHR,
Expand All@@ -115,8 +119,39 @@ export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumenta
const spans: Record<string, Span> = {};

if (traceFetch) {
// Keeping track of http requests, whose body payloads resolved later than the intial resolved request
// e.g. streaming using server sent events (SSE)
client.addEventProcessor(event => {
if (event.type === 'transaction' && event.spans) {
event.spans.forEach(span => {
if (span.op === 'http.client') {
const updatedTimestamp = spanIdToEndTimestamp.get(span.span_id);
if (updatedTimestamp) {
span.timestamp = updatedTimestamp / 1000;
spanIdToEndTimestamp.delete(span.span_id);
}
}
});
}
return event;
});

addFetchEndInstrumentationHandler(handlerData => {
if (handlerData.response) {
const span = responseToSpanId.get(handlerData.response);
if (span && handlerData.endTimestamp) {
spanIdToEndTimestamp.set(span, handlerData.endTimestamp);
}
}
});

addFetchInstrumentationHandler(handlerData => {
const createdSpan = instrumentFetchRequest(handlerData, shouldCreateSpan, shouldAttachHeadersWithTargets, spans);

if (handlerData.response && handlerData.fetchData.__span) {
responseToSpanId.set(handlerData.response, handlerData.fetchData.__span);
}

// We cannot use `window.location` in the generic fetch instrumentation,
// but we need it for reliable `server.address` attribute.
// so we extend this in here
Expand Down
18 changes: 15 additions & 3 deletions packages/browser/test/unit/tracing/request.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as browserUtils from '@sentry-internal/browser-utils';
import type { Client } from '@sentry/types';
import * as utils from '@sentry/utils';
import { WINDOW } from '../../../src/helpers';

Expand All@@ -10,16 +11,27 @@ beforeAll(() => {
global.Request = {};
});

class MockClient implements Partial<Client> {
public addEventProcessor: () => void;
constructor() {
// Mock addEventProcessor function
this.addEventProcessor = jest.fn();
}
}

describe('instrumentOutgoingRequests', () => {
let client: Client;

beforeEach(() => {
jest.clearAllMocks();
client = new MockClient() as unknown as Client;
});

it('instruments fetch and xhr requests', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests();
instrumentOutgoingRequests(client);

expect(addFetchSpy).toHaveBeenCalledWith(expect.any(Function));
expect(addXhrSpy).toHaveBeenCalledWith(expect.any(Function));
Expand All@@ -28,15 +40,15 @@ describe('instrumentOutgoingRequests', () => {
it('does not instrument fetch requests if traceFetch is false', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');

instrumentOutgoingRequests({ traceFetch: false });
instrumentOutgoingRequests(client, { traceFetch: false });

expect(addFetchSpy).not.toHaveBeenCalled();
});

it('does not instrument xhr requests if traceXHR is false', () => {
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests({ traceXHR: false });
instrumentOutgoingRequests(client, { traceXHR: false });

expect(addXhrSpy).not.toHaveBeenCalled();
});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,7 @@ describe('browserTracingIntegration', () => {
return createdRootSpan as Span;
});

const fakeClient = { getOptions: () => ({}), on: () => {} };
const fakeClient = { getOptions: () => ({}), on: () => {}, addEventProcessor: () => {} };

const mockedRoutingSpan = {
end: () => {},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration'),
gzip: true,
limit: '35 KB',
limit: '36 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay)',
Expand All@@ -29,7 +29,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration'),
gzip: true,
limit: '65 KB',
limit: '66 KB',
modifyWebpackConfig: function (config) {
const webpack = require('webpack');
config.plugins.push(
Expand DownExpand Up@@ -107,7 +107,7 @@ module.exports = [
import: createImport('init', 'ErrorBoundary', 'reactRouterV6BrowserTracingIntegration'),
ignore: ['react/jsx-runtime'],
gzip: true,
limit: '38 KB',
limit: '39 KB',
},
// Vue SDK (ESM)
{
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
"@sentry/react": "latest || *",
"@types/react": "18.0.0",
"@types/react-dom": "18.0.0",
"express": "4.19.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-router-dom": "^6.4.1",
Expand All@@ -14,7 +15,9 @@
},
"scripts": {
"build": "react-scripts build",
"start": "serve -s build",
"start": "run-p start:client start:server",
"start:client": "node server/app.js",
"start:server": "serve -s build",
"test": "playwright test",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand DownExpand Up@@ -43,7 +46,8 @@
"devDependencies": {
"@playwright/test": "^1.44.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"serve": "14.0.1"
"serve": "14.0.1",
"npm-run-all2": "^6.2.0"
},
"volta": {
"extends": "../../package.json"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
return new Promise(resolve => {
setTimeout(() => {
resolve();
}, time);
});
};

async function sseHandler(request, response, timeout = false) {
response.headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
'Access-Control-Allow-Origin': '*',
};

response.setHeader('Cache-Control', 'no-cache');
response.setHeader('Content-Type', 'text/event-stream');
response.setHeader('Access-Control-Allow-Origin', '*');
response.setHeader('Connection', 'keep-alive');

response.flushHeaders();

await wait(2000);

for (let index = 0; index < 10; index++) {
response.write(`data: ${new Date().toISOString()}\n\n`);
if (timeout) {
await wait(10000);
}
}

response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
console.log(`SSE service listening at http://localhost:${PORT}`);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
useNavigationType,
} from 'react-router-dom';
import Index from './pages/Index';
import SSE from './pages/SSE';
import User from './pages/User';

const replay = Sentry.replayIntegration();
Expand DownExpand Up@@ -48,6 +49,7 @@ root.render(
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/user/:id" element={<User />} />
<Route path="/sse" element={<SSE />} />
</SentryRoutes>
</BrowserRouter>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';

const fetchSSE = async ({ timeout }: { timeout: boolean }) => {
Sentry.startSpanManual({ name: 'sse stream using fetch' }, async span => {
const res = await Sentry.startSpan({ name: 'sse fetch call' }, async () => {
const endpoint = `http://localhost:8080/${timeout ? 'sse-timeout' : 'sse'}`;
return await fetch(endpoint);
});

const stream = res.body;
const reader = stream?.getReader();

const readChunk = async () => {
const readRes = await reader?.read();
if (readRes?.done) {
return;
}

new TextDecoder().decode(readRes?.value);

await readChunk();
};

try {
await readChunk();
} catch (error) {
console.error('Could not fetch sse', error);
}

span.end();
});
};

const SSE = () => {
return (
<>
<button id="fetch-button" onClick={() => fetchSSE({ timeout: false })}>
Fetch SSE
</button>
<button id="fetch-timeout-button" onClick={() => fetchSSE({ timeout: true })}>
Fetch timeout SSE
</button>
</>
);
};

export default SSE;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { SpanJSON } from '@sentry/types';

test('Waits for sse streaming when creating spans', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(span => span.description === 'GET http://localhost:8080/sse')[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 2s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(2);
});

test('Aborts when stream takes longer than 5s', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-timeout-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(
span => span.description === 'GET http://localhost:8080/sse-timeout',
)[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 10s but client should abort reading after 5s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(7);
});
2 changes: 1 addition & 1 deletion packages/browser/src/tracing/browserTracingIntegration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,7 +398,7 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
registerInpInteractionListener();
}

instrumentOutgoingRequests({
instrumentOutgoingRequests(client, {
traceFetch,
traceXHR,
tracePropagationTargets: client.getOptions().tracePropagationTargets,
Expand Down
37 changes: 36 additions & 1 deletion packages/browser/src/tracing/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ import {
import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/types';
import {
BAGGAGE_HEADER_NAME,
addFetchEndInstrumentationHandler,
addFetchInstrumentationHandler,
browserPerformanceTimeOrigin,
dynamicSamplingContextToSentryBaggageHeader,
Expand DownExpand Up@@ -93,14 +94,17 @@ export interface RequestInstrumentationOptions {
shouldCreateSpanForRequest?(this: void, url: string): boolean;
}

const responseToSpanId = new WeakMap<object, string>();
const spanIdToEndTimestamp = new Map<string, number>();

export const defaultRequestInstrumentationOptions: RequestInstrumentationOptions = {
traceFetch: true,
traceXHR: true,
enableHTTPTimings: true,
};

/** Registers span creators for xhr and fetch requests */
export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumentationOptions>): void {
export function instrumentOutgoingRequests(client: Client, _options?: Partial<RequestInstrumentationOptions>): void {
const { traceFetch, traceXHR, shouldCreateSpanForRequest, enableHTTPTimings, tracePropagationTargets } = {
traceFetch: defaultRequestInstrumentationOptions.traceFetch,
traceXHR: defaultRequestInstrumentationOptions.traceXHR,
Expand All@@ -115,8 +119,39 @@ export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumenta
const spans: Record<string, Span> = {};

if (traceFetch) {
// Keeping track of http requests, whose body payloads resolved later than the intial resolved request
// e.g. streaming using server sent events (SSE)
client.addEventProcessor(event => {
if (event.type === 'transaction' && event.spans) {
event.spans.forEach(span => {
if (span.op === 'http.client') {
const updatedTimestamp = spanIdToEndTimestamp.get(span.span_id);
if (updatedTimestamp) {
span.timestamp = updatedTimestamp / 1000;
spanIdToEndTimestamp.delete(span.span_id);
}
}
});
}
return event;
});

addFetchEndInstrumentationHandler(handlerData => {
if (handlerData.response) {
const span = responseToSpanId.get(handlerData.response);
if (span && handlerData.endTimestamp) {
spanIdToEndTimestamp.set(span, handlerData.endTimestamp);
}
}
});

addFetchInstrumentationHandler(handlerData => {
const createdSpan = instrumentFetchRequest(handlerData, shouldCreateSpan, shouldAttachHeadersWithTargets, spans);

if (handlerData.response && handlerData.fetchData.__span) {
responseToSpanId.set(handlerData.response, handlerData.fetchData.__span);
}

// We cannot use `window.location` in the generic fetch instrumentation,
// but we need it for reliable `server.address` attribute.
// so we extend this in here
Expand Down
18 changes: 15 additions & 3 deletions packages/browser/test/unit/tracing/request.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as browserUtils from '@sentry-internal/browser-utils';
import type { Client } from '@sentry/types';
import * as utils from '@sentry/utils';
import { WINDOW } from '../../../src/helpers';

Expand All@@ -10,16 +11,27 @@ beforeAll(() => {
global.Request = {};
});

class MockClient implements Partial<Client> {
public addEventProcessor: () => void;
constructor() {
// Mock addEventProcessor function
this.addEventProcessor = jest.fn();
}
}

describe('instrumentOutgoingRequests', () => {
let client: Client;

beforeEach(() => {
jest.clearAllMocks();
client = new MockClient() as unknown as Client;
});

it('instruments fetch and xhr requests', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests();
instrumentOutgoingRequests(client);

expect(addFetchSpy).toHaveBeenCalledWith(expect.any(Function));
expect(addXhrSpy).toHaveBeenCalledWith(expect.any(Function));
Expand All@@ -28,15 +40,15 @@ describe('instrumentOutgoingRequests', () => {
it('does not instrument fetch requests if traceFetch is false', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');

instrumentOutgoingRequests({ traceFetch: false });
instrumentOutgoingRequests(client, { traceFetch: false });

expect(addFetchSpy).not.toHaveBeenCalled();
});

it('does not instrument xhr requests if traceXHR is false', () => {
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests({ traceXHR: false });
instrumentOutgoingRequests(client, { traceXHR: false });

expect(addXhrSpy).not.toHaveBeenCalled();
});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,7 @@ describe('browserTracingIntegration', () => {
return createdRootSpan as Span;
});

const fakeClient = { getOptions: () => ({}), on: () => {} };
const fakeClient = { getOptions: () => ({}), on: () => {}, addEventProcessor: () => {} };

const mockedRoutingSpan = {
end: () => {},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration'),
gzip: true,
limit: '35 KB',
limit: '36 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay)',
Expand All@@ -29,7 +29,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration'),
gzip: true,
limit: '65 KB',
limit: '66 KB',
modifyWebpackConfig: function (config) {
const webpack = require('webpack');
config.plugins.push(
Expand DownExpand Up@@ -107,7 +107,7 @@ module.exports = [
import: createImport('init', 'ErrorBoundary', 'reactRouterV6BrowserTracingIntegration'),
ignore: ['react/jsx-runtime'],
gzip: true,
limit: '38 KB',
limit: '39 KB',
},
// Vue SDK (ESM)
{
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
"@sentry/react": "latest || *",
"@types/react": "18.0.0",
"@types/react-dom": "18.0.0",
"express": "4.19.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-router-dom": "^6.4.1",
Expand All@@ -14,7 +15,9 @@
},
"scripts": {
"build": "react-scripts build",
"start": "serve -s build",
"start": "run-p start:client start:server",
"start:client": "node server/app.js",
"start:server": "serve -s build",
"test": "playwright test",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand DownExpand Up@@ -43,7 +46,8 @@
"devDependencies": {
"@playwright/test": "^1.44.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"serve": "14.0.1"
"serve": "14.0.1",
"npm-run-all2": "^6.2.0"
},
"volta": {
"extends": "../../package.json"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
return new Promise(resolve => {
setTimeout(() => {
resolve();
}, time);
});
};

async function sseHandler(request, response, timeout = false) {
response.headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
'Access-Control-Allow-Origin': '*',
};

response.setHeader('Cache-Control', 'no-cache');
response.setHeader('Content-Type', 'text/event-stream');
response.setHeader('Access-Control-Allow-Origin', '*');
response.setHeader('Connection', 'keep-alive');

response.flushHeaders();

await wait(2000);

for (let index = 0; index < 10; index++) {
response.write(`data: ${new Date().toISOString()}\n\n`);
if (timeout) {
await wait(10000);
}
}

response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
console.log(`SSE service listening at http://localhost:${PORT}`);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
useNavigationType,
} from 'react-router-dom';
import Index from './pages/Index';
import SSE from './pages/SSE';
import User from './pages/User';

const replay = Sentry.replayIntegration();
Expand DownExpand Up@@ -48,6 +49,7 @@ root.render(
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/user/:id" element={<User />} />
<Route path="/sse" element={<SSE />} />
</SentryRoutes>
</BrowserRouter>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';

const fetchSSE = async ({ timeout }: { timeout: boolean }) => {
Sentry.startSpanManual({ name: 'sse stream using fetch' }, async span => {
const res = await Sentry.startSpan({ name: 'sse fetch call' }, async () => {
const endpoint = `http://localhost:8080/${timeout ? 'sse-timeout' : 'sse'}`;
return await fetch(endpoint);
});

const stream = res.body;
const reader = stream?.getReader();

const readChunk = async () => {
const readRes = await reader?.read();
if (readRes?.done) {
return;
}

new TextDecoder().decode(readRes?.value);

await readChunk();
};

try {
await readChunk();
} catch (error) {
console.error('Could not fetch sse', error);
}

span.end();
});
};

const SSE = () => {
return (
<>
<button id="fetch-button" onClick={() => fetchSSE({ timeout: false })}>
Fetch SSE
</button>
<button id="fetch-timeout-button" onClick={() => fetchSSE({ timeout: true })}>
Fetch timeout SSE
</button>
</>
);
};

export default SSE;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { SpanJSON } from '@sentry/types';

test('Waits for sse streaming when creating spans', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(span => span.description === 'GET http://localhost:8080/sse')[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 2s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(2);
});

test('Aborts when stream takes longer than 5s', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-timeout-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(
span => span.description === 'GET http://localhost:8080/sse-timeout',
)[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 10s but client should abort reading after 5s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(7);
});
2 changes: 1 addition & 1 deletion packages/browser/src/tracing/browserTracingIntegration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,7 +398,7 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
registerInpInteractionListener();
}

instrumentOutgoingRequests({
instrumentOutgoingRequests(client, {
traceFetch,
traceXHR,
tracePropagationTargets: client.getOptions().tracePropagationTargets,
Expand Down
37 changes: 36 additions & 1 deletion packages/browser/src/tracing/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ import {
import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/types';
import {
BAGGAGE_HEADER_NAME,
addFetchEndInstrumentationHandler,
addFetchInstrumentationHandler,
browserPerformanceTimeOrigin,
dynamicSamplingContextToSentryBaggageHeader,
Expand DownExpand Up@@ -93,14 +94,17 @@ export interface RequestInstrumentationOptions {
shouldCreateSpanForRequest?(this: void, url: string): boolean;
}

const responseToSpanId = new WeakMap<object, string>();
const spanIdToEndTimestamp = new Map<string, number>();

export const defaultRequestInstrumentationOptions: RequestInstrumentationOptions = {
traceFetch: true,
traceXHR: true,
enableHTTPTimings: true,
};

/** Registers span creators for xhr and fetch requests */
export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumentationOptions>): void {
export function instrumentOutgoingRequests(client: Client, _options?: Partial<RequestInstrumentationOptions>): void {
const { traceFetch, traceXHR, shouldCreateSpanForRequest, enableHTTPTimings, tracePropagationTargets } = {
traceFetch: defaultRequestInstrumentationOptions.traceFetch,
traceXHR: defaultRequestInstrumentationOptions.traceXHR,
Expand All@@ -115,8 +119,39 @@ export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumenta
const spans: Record<string, Span> = {};

if (traceFetch) {
// Keeping track of http requests, whose body payloads resolved later than the intial resolved request
// e.g. streaming using server sent events (SSE)
client.addEventProcessor(event => {
if (event.type === 'transaction' && event.spans) {
event.spans.forEach(span => {
if (span.op === 'http.client') {
const updatedTimestamp = spanIdToEndTimestamp.get(span.span_id);
if (updatedTimestamp) {
span.timestamp = updatedTimestamp / 1000;
spanIdToEndTimestamp.delete(span.span_id);
}
}
});
}
return event;
});

addFetchEndInstrumentationHandler(handlerData => {
if (handlerData.response) {
const span = responseToSpanId.get(handlerData.response);
if (span && handlerData.endTimestamp) {
spanIdToEndTimestamp.set(span, handlerData.endTimestamp);
}
}
});

addFetchInstrumentationHandler(handlerData => {
const createdSpan = instrumentFetchRequest(handlerData, shouldCreateSpan, shouldAttachHeadersWithTargets, spans);

if (handlerData.response && handlerData.fetchData.__span) {
responseToSpanId.set(handlerData.response, handlerData.fetchData.__span);
}

// We cannot use `window.location` in the generic fetch instrumentation,
// but we need it for reliable `server.address` attribute.
// so we extend this in here
Expand Down
18 changes: 15 additions & 3 deletions packages/browser/test/unit/tracing/request.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as browserUtils from '@sentry-internal/browser-utils';
import type { Client } from '@sentry/types';
import * as utils from '@sentry/utils';
import { WINDOW } from '../../../src/helpers';

Expand All@@ -10,16 +11,27 @@ beforeAll(() => {
global.Request = {};
});

class MockClient implements Partial<Client> {
public addEventProcessor: () => void;
constructor() {
// Mock addEventProcessor function
this.addEventProcessor = jest.fn();
}
}

describe('instrumentOutgoingRequests', () => {
let client: Client;

beforeEach(() => {
jest.clearAllMocks();
client = new MockClient() as unknown as Client;
});

it('instruments fetch and xhr requests', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests();
instrumentOutgoingRequests(client);

expect(addFetchSpy).toHaveBeenCalledWith(expect.any(Function));
expect(addXhrSpy).toHaveBeenCalledWith(expect.any(Function));
Expand All@@ -28,15 +40,15 @@ describe('instrumentOutgoingRequests', () => {
it('does not instrument fetch requests if traceFetch is false', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');

instrumentOutgoingRequests({ traceFetch: false });
instrumentOutgoingRequests(client, { traceFetch: false });

expect(addFetchSpy).not.toHaveBeenCalled();
});

it('does not instrument xhr requests if traceXHR is false', () => {
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests({ traceXHR: false });
instrumentOutgoingRequests(client, { traceXHR: false });

expect(addXhrSpy).not.toHaveBeenCalled();
});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,7 @@ describe('browserTracingIntegration', () => {
return createdRootSpan as Span;
});

const fakeClient = { getOptions: () => ({}), on: () => {} };
const fakeClient = { getOptions: () => ({}), on: () => {}, addEventProcessor: () => {} };

const mockedRoutingSpan = {
end: () => {},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration'),
gzip: true,
limit: '35 KB',
limit: '36 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay)',
Expand All@@ -29,7 +29,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration'),
gzip: true,
limit: '65 KB',
limit: '66 KB',
modifyWebpackConfig: function (config) {
const webpack = require('webpack');
config.plugins.push(
Expand DownExpand Up@@ -107,7 +107,7 @@ module.exports = [
import: createImport('init', 'ErrorBoundary', 'reactRouterV6BrowserTracingIntegration'),
ignore: ['react/jsx-runtime'],
gzip: true,
limit: '38 KB',
limit: '39 KB',
},
// Vue SDK (ESM)
{
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
"@sentry/react": "latest || *",
"@types/react": "18.0.0",
"@types/react-dom": "18.0.0",
"express": "4.19.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-router-dom": "^6.4.1",
Expand All@@ -14,7 +15,9 @@
},
"scripts": {
"build": "react-scripts build",
"start": "serve -s build",
"start": "run-p start:client start:server",
"start:client": "node server/app.js",
"start:server": "serve -s build",
"test": "playwright test",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand DownExpand Up@@ -43,7 +46,8 @@
"devDependencies": {
"@playwright/test": "^1.44.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"serve": "14.0.1"
"serve": "14.0.1",
"npm-run-all2": "^6.2.0"
},
"volta": {
"extends": "../../package.json"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
return new Promise(resolve => {
setTimeout(() => {
resolve();
}, time);
});
};

async function sseHandler(request, response, timeout = false) {
response.headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
'Access-Control-Allow-Origin': '*',
};

response.setHeader('Cache-Control', 'no-cache');
response.setHeader('Content-Type', 'text/event-stream');
response.setHeader('Access-Control-Allow-Origin', '*');
response.setHeader('Connection', 'keep-alive');

response.flushHeaders();

await wait(2000);

for (let index = 0; index < 10; index++) {
response.write(`data: ${new Date().toISOString()}\n\n`);
if (timeout) {
await wait(10000);
}
}

response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
console.log(`SSE service listening at http://localhost:${PORT}`);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
useNavigationType,
} from 'react-router-dom';
import Index from './pages/Index';
import SSE from './pages/SSE';
import User from './pages/User';

const replay = Sentry.replayIntegration();
Expand DownExpand Up@@ -48,6 +49,7 @@ root.render(
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/user/:id" element={<User />} />
<Route path="/sse" element={<SSE />} />
</SentryRoutes>
</BrowserRouter>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';

const fetchSSE = async ({ timeout }: { timeout: boolean }) => {
Sentry.startSpanManual({ name: 'sse stream using fetch' }, async span => {
const res = await Sentry.startSpan({ name: 'sse fetch call' }, async () => {
const endpoint = `http://localhost:8080/${timeout ? 'sse-timeout' : 'sse'}`;
return await fetch(endpoint);
});

const stream = res.body;
const reader = stream?.getReader();

const readChunk = async () => {
const readRes = await reader?.read();
if (readRes?.done) {
return;
}

new TextDecoder().decode(readRes?.value);

await readChunk();
};

try {
await readChunk();
} catch (error) {
console.error('Could not fetch sse', error);
}

span.end();
});
};

const SSE = () => {
return (
<>
<button id="fetch-button" onClick={() => fetchSSE({ timeout: false })}>
Fetch SSE
</button>
<button id="fetch-timeout-button" onClick={() => fetchSSE({ timeout: true })}>
Fetch timeout SSE
</button>
</>
);
};

export default SSE;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { SpanJSON } from '@sentry/types';

test('Waits for sse streaming when creating spans', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(span => span.description === 'GET http://localhost:8080/sse')[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 2s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(2);
});

test('Aborts when stream takes longer than 5s', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-timeout-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(
span => span.description === 'GET http://localhost:8080/sse-timeout',
)[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 10s but client should abort reading after 5s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(7);
});
2 changes: 1 addition & 1 deletion packages/browser/src/tracing/browserTracingIntegration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,7 +398,7 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
registerInpInteractionListener();
}

instrumentOutgoingRequests({
instrumentOutgoingRequests(client, {
traceFetch,
traceXHR,
tracePropagationTargets: client.getOptions().tracePropagationTargets,
Expand Down
37 changes: 36 additions & 1 deletion packages/browser/src/tracing/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ import {
import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/types';
import {
BAGGAGE_HEADER_NAME,
addFetchEndInstrumentationHandler,
addFetchInstrumentationHandler,
browserPerformanceTimeOrigin,
dynamicSamplingContextToSentryBaggageHeader,
Expand DownExpand Up@@ -93,14 +94,17 @@ export interface RequestInstrumentationOptions {
shouldCreateSpanForRequest?(this: void, url: string): boolean;
}

const responseToSpanId = new WeakMap<object, string>();
const spanIdToEndTimestamp = new Map<string, number>();

export const defaultRequestInstrumentationOptions: RequestInstrumentationOptions = {
traceFetch: true,
traceXHR: true,
enableHTTPTimings: true,
};

/** Registers span creators for xhr and fetch requests */
export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumentationOptions>): void {
export function instrumentOutgoingRequests(client: Client, _options?: Partial<RequestInstrumentationOptions>): void {
const { traceFetch, traceXHR, shouldCreateSpanForRequest, enableHTTPTimings, tracePropagationTargets } = {
traceFetch: defaultRequestInstrumentationOptions.traceFetch,
traceXHR: defaultRequestInstrumentationOptions.traceXHR,
Expand All@@ -115,8 +119,39 @@ export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumenta
const spans: Record<string, Span> = {};

if (traceFetch) {
// Keeping track of http requests, whose body payloads resolved later than the intial resolved request
// e.g. streaming using server sent events (SSE)
client.addEventProcessor(event => {
if (event.type === 'transaction' && event.spans) {
event.spans.forEach(span => {
if (span.op === 'http.client') {
const updatedTimestamp = spanIdToEndTimestamp.get(span.span_id);
if (updatedTimestamp) {
span.timestamp = updatedTimestamp / 1000;
spanIdToEndTimestamp.delete(span.span_id);
}
}
});
}
return event;
});

addFetchEndInstrumentationHandler(handlerData => {
if (handlerData.response) {
const span = responseToSpanId.get(handlerData.response);
if (span && handlerData.endTimestamp) {
spanIdToEndTimestamp.set(span, handlerData.endTimestamp);
}
}
});

addFetchInstrumentationHandler(handlerData => {
const createdSpan = instrumentFetchRequest(handlerData, shouldCreateSpan, shouldAttachHeadersWithTargets, spans);

if (handlerData.response && handlerData.fetchData.__span) {
responseToSpanId.set(handlerData.response, handlerData.fetchData.__span);
}

// We cannot use `window.location` in the generic fetch instrumentation,
// but we need it for reliable `server.address` attribute.
// so we extend this in here
Expand Down
18 changes: 15 additions & 3 deletions packages/browser/test/unit/tracing/request.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as browserUtils from '@sentry-internal/browser-utils';
import type { Client } from '@sentry/types';
import * as utils from '@sentry/utils';
import { WINDOW } from '../../../src/helpers';

Expand All@@ -10,16 +11,27 @@ beforeAll(() => {
global.Request = {};
});

class MockClient implements Partial<Client> {
public addEventProcessor: () => void;
constructor() {
// Mock addEventProcessor function
this.addEventProcessor = jest.fn();
}
}

describe('instrumentOutgoingRequests', () => {
let client: Client;

beforeEach(() => {
jest.clearAllMocks();
client = new MockClient() as unknown as Client;
});

it('instruments fetch and xhr requests', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests();
instrumentOutgoingRequests(client);

expect(addFetchSpy).toHaveBeenCalledWith(expect.any(Function));
expect(addXhrSpy).toHaveBeenCalledWith(expect.any(Function));
Expand All@@ -28,15 +40,15 @@ describe('instrumentOutgoingRequests', () => {
it('does not instrument fetch requests if traceFetch is false', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');

instrumentOutgoingRequests({ traceFetch: false });
instrumentOutgoingRequests(client, { traceFetch: false });

expect(addFetchSpy).not.toHaveBeenCalled();
});

it('does not instrument xhr requests if traceXHR is false', () => {
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests({ traceXHR: false });
instrumentOutgoingRequests(client, { traceXHR: false });

expect(addXhrSpy).not.toHaveBeenCalled();
});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,7 @@ describe('browserTracingIntegration', () => {
return createdRootSpan as Span;
});

const fakeClient = { getOptions: () => ({}), on: () => {} };
const fakeClient = { getOptions: () => ({}), on: () => {}, addEventProcessor: () => {} };

const mockedRoutingSpan = {
end: () => {},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration'),
gzip: true,
limit: '35 KB',
limit: '36 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay)',
Expand All@@ -29,7 +29,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration'),
gzip: true,
limit: '65 KB',
limit: '66 KB',
modifyWebpackConfig: function (config) {
const webpack = require('webpack');
config.plugins.push(
Expand DownExpand Up@@ -107,7 +107,7 @@ module.exports = [
import: createImport('init', 'ErrorBoundary', 'reactRouterV6BrowserTracingIntegration'),
ignore: ['react/jsx-runtime'],
gzip: true,
limit: '38 KB',
limit: '39 KB',
},
// Vue SDK (ESM)
{
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
"@sentry/react": "latest || *",
"@types/react": "18.0.0",
"@types/react-dom": "18.0.0",
"express": "4.19.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-router-dom": "^6.4.1",
Expand All@@ -14,7 +15,9 @@
},
"scripts": {
"build": "react-scripts build",
"start": "serve -s build",
"start": "run-p start:client start:server",
"start:client": "node server/app.js",
"start:server": "serve -s build",
"test": "playwright test",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand DownExpand Up@@ -43,7 +46,8 @@
"devDependencies": {
"@playwright/test": "^1.44.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"serve": "14.0.1"
"serve": "14.0.1",
"npm-run-all2": "^6.2.0"
},
"volta": {
"extends": "../../package.json"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
return new Promise(resolve => {
setTimeout(() => {
resolve();
}, time);
});
};

async function sseHandler(request, response, timeout = false) {
response.headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
'Access-Control-Allow-Origin': '*',
};

response.setHeader('Cache-Control', 'no-cache');
response.setHeader('Content-Type', 'text/event-stream');
response.setHeader('Access-Control-Allow-Origin', '*');
response.setHeader('Connection', 'keep-alive');

response.flushHeaders();

await wait(2000);

for (let index = 0; index < 10; index++) {
response.write(`data: ${new Date().toISOString()}\n\n`);
if (timeout) {
await wait(10000);
}
}

response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
console.log(`SSE service listening at http://localhost:${PORT}`);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
useNavigationType,
} from 'react-router-dom';
import Index from './pages/Index';
import SSE from './pages/SSE';
import User from './pages/User';

const replay = Sentry.replayIntegration();
Expand DownExpand Up@@ -48,6 +49,7 @@ root.render(
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/user/:id" element={<User />} />
<Route path="/sse" element={<SSE />} />
</SentryRoutes>
</BrowserRouter>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';

const fetchSSE = async ({ timeout }: { timeout: boolean }) => {
Sentry.startSpanManual({ name: 'sse stream using fetch' }, async span => {
const res = await Sentry.startSpan({ name: 'sse fetch call' }, async () => {
const endpoint = `http://localhost:8080/${timeout ? 'sse-timeout' : 'sse'}`;
return await fetch(endpoint);
});

const stream = res.body;
const reader = stream?.getReader();

const readChunk = async () => {
const readRes = await reader?.read();
if (readRes?.done) {
return;
}

new TextDecoder().decode(readRes?.value);

await readChunk();
};

try {
await readChunk();
} catch (error) {
console.error('Could not fetch sse', error);
}

span.end();
});
};

const SSE = () => {
return (
<>
<button id="fetch-button" onClick={() => fetchSSE({ timeout: false })}>
Fetch SSE
</button>
<button id="fetch-timeout-button" onClick={() => fetchSSE({ timeout: true })}>
Fetch timeout SSE
</button>
</>
);
};

export default SSE;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { SpanJSON } from '@sentry/types';

test('Waits for sse streaming when creating spans', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(span => span.description === 'GET http://localhost:8080/sse')[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 2s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(2);
});

test('Aborts when stream takes longer than 5s', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-timeout-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(
span => span.description === 'GET http://localhost:8080/sse-timeout',
)[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 10s but client should abort reading after 5s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(7);
});
2 changes: 1 addition & 1 deletion packages/browser/src/tracing/browserTracingIntegration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,7 +398,7 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
registerInpInteractionListener();
}

instrumentOutgoingRequests({
instrumentOutgoingRequests(client, {
traceFetch,
traceXHR,
tracePropagationTargets: client.getOptions().tracePropagationTargets,
Expand Down
37 changes: 36 additions & 1 deletion packages/browser/src/tracing/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ import {
import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/types';
import {
BAGGAGE_HEADER_NAME,
addFetchEndInstrumentationHandler,
addFetchInstrumentationHandler,
browserPerformanceTimeOrigin,
dynamicSamplingContextToSentryBaggageHeader,
Expand DownExpand Up@@ -93,14 +94,17 @@ export interface RequestInstrumentationOptions {
shouldCreateSpanForRequest?(this: void, url: string): boolean;
}

const responseToSpanId = new WeakMap<object, string>();
const spanIdToEndTimestamp = new Map<string, number>();

export const defaultRequestInstrumentationOptions: RequestInstrumentationOptions = {
traceFetch: true,
traceXHR: true,
enableHTTPTimings: true,
};

/** Registers span creators for xhr and fetch requests */
export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumentationOptions>): void {
export function instrumentOutgoingRequests(client: Client, _options?: Partial<RequestInstrumentationOptions>): void {
const { traceFetch, traceXHR, shouldCreateSpanForRequest, enableHTTPTimings, tracePropagationTargets } = {
traceFetch: defaultRequestInstrumentationOptions.traceFetch,
traceXHR: defaultRequestInstrumentationOptions.traceXHR,
Expand All@@ -115,8 +119,39 @@ export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumenta
const spans: Record<string, Span> = {};

if (traceFetch) {
// Keeping track of http requests, whose body payloads resolved later than the intial resolved request
// e.g. streaming using server sent events (SSE)
client.addEventProcessor(event => {
if (event.type === 'transaction' && event.spans) {
event.spans.forEach(span => {
if (span.op === 'http.client') {
const updatedTimestamp = spanIdToEndTimestamp.get(span.span_id);
if (updatedTimestamp) {
span.timestamp = updatedTimestamp / 1000;
spanIdToEndTimestamp.delete(span.span_id);
}
}
});
}
return event;
});

addFetchEndInstrumentationHandler(handlerData => {
if (handlerData.response) {
const span = responseToSpanId.get(handlerData.response);
if (span && handlerData.endTimestamp) {
spanIdToEndTimestamp.set(span, handlerData.endTimestamp);
}
}
});

addFetchInstrumentationHandler(handlerData => {
const createdSpan = instrumentFetchRequest(handlerData, shouldCreateSpan, shouldAttachHeadersWithTargets, spans);

if (handlerData.response && handlerData.fetchData.__span) {
responseToSpanId.set(handlerData.response, handlerData.fetchData.__span);
}

// We cannot use `window.location` in the generic fetch instrumentation,
// but we need it for reliable `server.address` attribute.
// so we extend this in here
Expand Down
18 changes: 15 additions & 3 deletions packages/browser/test/unit/tracing/request.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as browserUtils from '@sentry-internal/browser-utils';
import type { Client } from '@sentry/types';
import * as utils from '@sentry/utils';
import { WINDOW } from '../../../src/helpers';

Expand All@@ -10,16 +11,27 @@ beforeAll(() => {
global.Request = {};
});

class MockClient implements Partial<Client> {
public addEventProcessor: () => void;
constructor() {
// Mock addEventProcessor function
this.addEventProcessor = jest.fn();
}
}

describe('instrumentOutgoingRequests', () => {
let client: Client;

beforeEach(() => {
jest.clearAllMocks();
client = new MockClient() as unknown as Client;
});

it('instruments fetch and xhr requests', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests();
instrumentOutgoingRequests(client);

expect(addFetchSpy).toHaveBeenCalledWith(expect.any(Function));
expect(addXhrSpy).toHaveBeenCalledWith(expect.any(Function));
Expand All@@ -28,15 +40,15 @@ describe('instrumentOutgoingRequests', () => {
it('does not instrument fetch requests if traceFetch is false', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');

instrumentOutgoingRequests({ traceFetch: false });
instrumentOutgoingRequests(client, { traceFetch: false });

expect(addFetchSpy).not.toHaveBeenCalled();
});

it('does not instrument xhr requests if traceXHR is false', () => {
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests({ traceXHR: false });
instrumentOutgoingRequests(client, { traceXHR: false });

expect(addXhrSpy).not.toHaveBeenCalled();
});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,7 @@ describe('browserTracingIntegration', () => {
return createdRootSpan as Span;
});

const fakeClient = { getOptions: () => ({}), on: () => {} };
const fakeClient = { getOptions: () => ({}), on: () => {}, addEventProcessor: () => {} };

const mockedRoutingSpan = {
end: () => {},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration'),
gzip: true,
limit: '35 KB',
limit: '36 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay)',
Expand All@@ -29,7 +29,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration'),
gzip: true,
limit: '65 KB',
limit: '66 KB',
modifyWebpackConfig: function (config) {
const webpack = require('webpack');
config.plugins.push(
Expand DownExpand Up@@ -107,7 +107,7 @@ module.exports = [
import: createImport('init', 'ErrorBoundary', 'reactRouterV6BrowserTracingIntegration'),
ignore: ['react/jsx-runtime'],
gzip: true,
limit: '38 KB',
limit: '39 KB',
},
// Vue SDK (ESM)
{
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
"@sentry/react": "latest || *",
"@types/react": "18.0.0",
"@types/react-dom": "18.0.0",
"express": "4.19.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-router-dom": "^6.4.1",
Expand All@@ -14,7 +15,9 @@
},
"scripts": {
"build": "react-scripts build",
"start": "serve -s build",
"start": "run-p start:client start:server",
"start:client": "node server/app.js",
"start:server": "serve -s build",
"test": "playwright test",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand DownExpand Up@@ -43,7 +46,8 @@
"devDependencies": {
"@playwright/test": "^1.44.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"serve": "14.0.1"
"serve": "14.0.1",
"npm-run-all2": "^6.2.0"
},
"volta": {
"extends": "../../package.json"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
return new Promise(resolve => {
setTimeout(() => {
resolve();
}, time);
});
};

async function sseHandler(request, response, timeout = false) {
response.headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
'Access-Control-Allow-Origin': '*',
};

response.setHeader('Cache-Control', 'no-cache');
response.setHeader('Content-Type', 'text/event-stream');
response.setHeader('Access-Control-Allow-Origin', '*');
response.setHeader('Connection', 'keep-alive');

response.flushHeaders();

await wait(2000);

for (let index = 0; index < 10; index++) {
response.write(`data: ${new Date().toISOString()}\n\n`);
if (timeout) {
await wait(10000);
}
}

response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
console.log(`SSE service listening at http://localhost:${PORT}`);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
useNavigationType,
} from 'react-router-dom';
import Index from './pages/Index';
import SSE from './pages/SSE';
import User from './pages/User';

const replay = Sentry.replayIntegration();
Expand DownExpand Up@@ -48,6 +49,7 @@ root.render(
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/user/:id" element={<User />} />
<Route path="/sse" element={<SSE />} />
</SentryRoutes>
</BrowserRouter>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';

const fetchSSE = async ({ timeout }: { timeout: boolean }) => {
Sentry.startSpanManual({ name: 'sse stream using fetch' }, async span => {
const res = await Sentry.startSpan({ name: 'sse fetch call' }, async () => {
const endpoint = `http://localhost:8080/${timeout ? 'sse-timeout' : 'sse'}`;
return await fetch(endpoint);
});

const stream = res.body;
const reader = stream?.getReader();

const readChunk = async () => {
const readRes = await reader?.read();
if (readRes?.done) {
return;
}

new TextDecoder().decode(readRes?.value);

await readChunk();
};

try {
await readChunk();
} catch (error) {
console.error('Could not fetch sse', error);
}

span.end();
});
};

const SSE = () => {
return (
<>
<button id="fetch-button" onClick={() => fetchSSE({ timeout: false })}>
Fetch SSE
</button>
<button id="fetch-timeout-button" onClick={() => fetchSSE({ timeout: true })}>
Fetch timeout SSE
</button>
</>
);
};

export default SSE;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { SpanJSON } from '@sentry/types';

test('Waits for sse streaming when creating spans', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(span => span.description === 'GET http://localhost:8080/sse')[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 2s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(2);
});

test('Aborts when stream takes longer than 5s', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-timeout-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(
span => span.description === 'GET http://localhost:8080/sse-timeout',
)[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 10s but client should abort reading after 5s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(7);
});
2 changes: 1 addition & 1 deletion packages/browser/src/tracing/browserTracingIntegration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,7 +398,7 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
registerInpInteractionListener();
}

instrumentOutgoingRequests({
instrumentOutgoingRequests(client, {
traceFetch,
traceXHR,
tracePropagationTargets: client.getOptions().tracePropagationTargets,
Expand Down
37 changes: 36 additions & 1 deletion packages/browser/src/tracing/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ import {
import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/types';
import {
BAGGAGE_HEADER_NAME,
addFetchEndInstrumentationHandler,
addFetchInstrumentationHandler,
browserPerformanceTimeOrigin,
dynamicSamplingContextToSentryBaggageHeader,
Expand DownExpand Up@@ -93,14 +94,17 @@ export interface RequestInstrumentationOptions {
shouldCreateSpanForRequest?(this: void, url: string): boolean;
}

const responseToSpanId = new WeakMap<object, string>();
const spanIdToEndTimestamp = new Map<string, number>();

export const defaultRequestInstrumentationOptions: RequestInstrumentationOptions = {
traceFetch: true,
traceXHR: true,
enableHTTPTimings: true,
};

/** Registers span creators for xhr and fetch requests */
export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumentationOptions>): void {
export function instrumentOutgoingRequests(client: Client, _options?: Partial<RequestInstrumentationOptions>): void {
const { traceFetch, traceXHR, shouldCreateSpanForRequest, enableHTTPTimings, tracePropagationTargets } = {
traceFetch: defaultRequestInstrumentationOptions.traceFetch,
traceXHR: defaultRequestInstrumentationOptions.traceXHR,
Expand All@@ -115,8 +119,39 @@ export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumenta
const spans: Record<string, Span> = {};

if (traceFetch) {
// Keeping track of http requests, whose body payloads resolved later than the intial resolved request
// e.g. streaming using server sent events (SSE)
client.addEventProcessor(event => {
if (event.type === 'transaction' && event.spans) {
event.spans.forEach(span => {
if (span.op === 'http.client') {
const updatedTimestamp = spanIdToEndTimestamp.get(span.span_id);
if (updatedTimestamp) {
span.timestamp = updatedTimestamp / 1000;
spanIdToEndTimestamp.delete(span.span_id);
}
}
});
}
return event;
});

addFetchEndInstrumentationHandler(handlerData => {
if (handlerData.response) {
const span = responseToSpanId.get(handlerData.response);
if (span && handlerData.endTimestamp) {
spanIdToEndTimestamp.set(span, handlerData.endTimestamp);
}
}
});

addFetchInstrumentationHandler(handlerData => {
const createdSpan = instrumentFetchRequest(handlerData, shouldCreateSpan, shouldAttachHeadersWithTargets, spans);

if (handlerData.response && handlerData.fetchData.__span) {
responseToSpanId.set(handlerData.response, handlerData.fetchData.__span);
}

// We cannot use `window.location` in the generic fetch instrumentation,
// but we need it for reliable `server.address` attribute.
// so we extend this in here
Expand Down
18 changes: 15 additions & 3 deletions packages/browser/test/unit/tracing/request.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as browserUtils from '@sentry-internal/browser-utils';
import type { Client } from '@sentry/types';
import * as utils from '@sentry/utils';
import { WINDOW } from '../../../src/helpers';

Expand All@@ -10,16 +11,27 @@ beforeAll(() => {
global.Request = {};
});

class MockClient implements Partial<Client> {
public addEventProcessor: () => void;
constructor() {
// Mock addEventProcessor function
this.addEventProcessor = jest.fn();
}
}

describe('instrumentOutgoingRequests', () => {
let client: Client;

beforeEach(() => {
jest.clearAllMocks();
client = new MockClient() as unknown as Client;
});

it('instruments fetch and xhr requests', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests();
instrumentOutgoingRequests(client);

expect(addFetchSpy).toHaveBeenCalledWith(expect.any(Function));
expect(addXhrSpy).toHaveBeenCalledWith(expect.any(Function));
Expand All@@ -28,15 +40,15 @@ describe('instrumentOutgoingRequests', () => {
it('does not instrument fetch requests if traceFetch is false', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');

instrumentOutgoingRequests({ traceFetch: false });
instrumentOutgoingRequests(client, { traceFetch: false });

expect(addFetchSpy).not.toHaveBeenCalled();
});

it('does not instrument xhr requests if traceXHR is false', () => {
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests({ traceXHR: false });
instrumentOutgoingRequests(client, { traceXHR: false });

expect(addXhrSpy).not.toHaveBeenCalled();
});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,7 @@ describe('browserTracingIntegration', () => {
return createdRootSpan as Span;
});

const fakeClient = { getOptions: () => ({}), on: () => {} };
const fakeClient = { getOptions: () => ({}), on: () => {}, addEventProcessor: () => {} };

const mockedRoutingSpan = {
end: () => {},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration'),
gzip: true,
limit: '35 KB',
limit: '36 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay)',
Expand All@@ -29,7 +29,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration'),
gzip: true,
limit: '65 KB',
limit: '66 KB',
modifyWebpackConfig: function (config) {
const webpack = require('webpack');
config.plugins.push(
Expand DownExpand Up@@ -107,7 +107,7 @@ module.exports = [
import: createImport('init', 'ErrorBoundary', 'reactRouterV6BrowserTracingIntegration'),
ignore: ['react/jsx-runtime'],
gzip: true,
limit: '38 KB',
limit: '39 KB',
},
// Vue SDK (ESM)
{
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
"@sentry/react": "latest || *",
"@types/react": "18.0.0",
"@types/react-dom": "18.0.0",
"express": "4.19.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-router-dom": "^6.4.1",
Expand All@@ -14,7 +15,9 @@
},
"scripts": {
"build": "react-scripts build",
"start": "serve -s build",
"start": "run-p start:client start:server",
"start:client": "node server/app.js",
"start:server": "serve -s build",
"test": "playwright test",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand DownExpand Up@@ -43,7 +46,8 @@
"devDependencies": {
"@playwright/test": "^1.44.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"serve": "14.0.1"
"serve": "14.0.1",
"npm-run-all2": "^6.2.0"
},
"volta": {
"extends": "../../package.json"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
return new Promise(resolve => {
setTimeout(() => {
resolve();
}, time);
});
};

async function sseHandler(request, response, timeout = false) {
response.headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
'Access-Control-Allow-Origin': '*',
};

response.setHeader('Cache-Control', 'no-cache');
response.setHeader('Content-Type', 'text/event-stream');
response.setHeader('Access-Control-Allow-Origin', '*');
response.setHeader('Connection', 'keep-alive');

response.flushHeaders();

await wait(2000);

for (let index = 0; index < 10; index++) {
response.write(`data: ${new Date().toISOString()}\n\n`);
if (timeout) {
await wait(10000);
}
}

response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
console.log(`SSE service listening at http://localhost:${PORT}`);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
useNavigationType,
} from 'react-router-dom';
import Index from './pages/Index';
import SSE from './pages/SSE';
import User from './pages/User';

const replay = Sentry.replayIntegration();
Expand DownExpand Up@@ -48,6 +49,7 @@ root.render(
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/user/:id" element={<User />} />
<Route path="/sse" element={<SSE />} />
</SentryRoutes>
</BrowserRouter>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';

const fetchSSE = async ({ timeout }: { timeout: boolean }) => {
Sentry.startSpanManual({ name: 'sse stream using fetch' }, async span => {
const res = await Sentry.startSpan({ name: 'sse fetch call' }, async () => {
const endpoint = `http://localhost:8080/${timeout ? 'sse-timeout' : 'sse'}`;
return await fetch(endpoint);
});

const stream = res.body;
const reader = stream?.getReader();

const readChunk = async () => {
const readRes = await reader?.read();
if (readRes?.done) {
return;
}

new TextDecoder().decode(readRes?.value);

await readChunk();
};

try {
await readChunk();
} catch (error) {
console.error('Could not fetch sse', error);
}

span.end();
});
};

const SSE = () => {
return (
<>
<button id="fetch-button" onClick={() => fetchSSE({ timeout: false })}>
Fetch SSE
</button>
<button id="fetch-timeout-button" onClick={() => fetchSSE({ timeout: true })}>
Fetch timeout SSE
</button>
</>
);
};

export default SSE;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { SpanJSON } from '@sentry/types';

test('Waits for sse streaming when creating spans', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(span => span.description === 'GET http://localhost:8080/sse')[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 2s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(2);
});

test('Aborts when stream takes longer than 5s', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-timeout-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(
span => span.description === 'GET http://localhost:8080/sse-timeout',
)[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 10s but client should abort reading after 5s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(7);
});
2 changes: 1 addition & 1 deletion packages/browser/src/tracing/browserTracingIntegration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,7 +398,7 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
registerInpInteractionListener();
}

instrumentOutgoingRequests({
instrumentOutgoingRequests(client, {
traceFetch,
traceXHR,
tracePropagationTargets: client.getOptions().tracePropagationTargets,
Expand Down
37 changes: 36 additions & 1 deletion packages/browser/src/tracing/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ import {
import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/types';
import {
BAGGAGE_HEADER_NAME,
addFetchEndInstrumentationHandler,
addFetchInstrumentationHandler,
browserPerformanceTimeOrigin,
dynamicSamplingContextToSentryBaggageHeader,
Expand DownExpand Up@@ -93,14 +94,17 @@ export interface RequestInstrumentationOptions {
shouldCreateSpanForRequest?(this: void, url: string): boolean;
}

const responseToSpanId = new WeakMap<object, string>();
const spanIdToEndTimestamp = new Map<string, number>();

export const defaultRequestInstrumentationOptions: RequestInstrumentationOptions = {
traceFetch: true,
traceXHR: true,
enableHTTPTimings: true,
};

/** Registers span creators for xhr and fetch requests */
export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumentationOptions>): void {
export function instrumentOutgoingRequests(client: Client, _options?: Partial<RequestInstrumentationOptions>): void {
const { traceFetch, traceXHR, shouldCreateSpanForRequest, enableHTTPTimings, tracePropagationTargets } = {
traceFetch: defaultRequestInstrumentationOptions.traceFetch,
traceXHR: defaultRequestInstrumentationOptions.traceXHR,
Expand All@@ -115,8 +119,39 @@ export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumenta
const spans: Record<string, Span> = {};

if (traceFetch) {
// Keeping track of http requests, whose body payloads resolved later than the intial resolved request
// e.g. streaming using server sent events (SSE)
client.addEventProcessor(event => {
if (event.type === 'transaction' && event.spans) {
event.spans.forEach(span => {
if (span.op === 'http.client') {
const updatedTimestamp = spanIdToEndTimestamp.get(span.span_id);
if (updatedTimestamp) {
span.timestamp = updatedTimestamp / 1000;
spanIdToEndTimestamp.delete(span.span_id);
}
}
});
}
return event;
});

addFetchEndInstrumentationHandler(handlerData => {
if (handlerData.response) {
const span = responseToSpanId.get(handlerData.response);
if (span && handlerData.endTimestamp) {
spanIdToEndTimestamp.set(span, handlerData.endTimestamp);
}
}
});

addFetchInstrumentationHandler(handlerData => {
const createdSpan = instrumentFetchRequest(handlerData, shouldCreateSpan, shouldAttachHeadersWithTargets, spans);

if (handlerData.response && handlerData.fetchData.__span) {
responseToSpanId.set(handlerData.response, handlerData.fetchData.__span);
}

// We cannot use `window.location` in the generic fetch instrumentation,
// but we need it for reliable `server.address` attribute.
// so we extend this in here
Expand Down
18 changes: 15 additions & 3 deletions packages/browser/test/unit/tracing/request.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as browserUtils from '@sentry-internal/browser-utils';
import type { Client } from '@sentry/types';
import * as utils from '@sentry/utils';
import { WINDOW } from '../../../src/helpers';

Expand All@@ -10,16 +11,27 @@ beforeAll(() => {
global.Request = {};
});

class MockClient implements Partial<Client> {
public addEventProcessor: () => void;
constructor() {
// Mock addEventProcessor function
this.addEventProcessor = jest.fn();
}
}

describe('instrumentOutgoingRequests', () => {
let client: Client;

beforeEach(() => {
jest.clearAllMocks();
client = new MockClient() as unknown as Client;
});

it('instruments fetch and xhr requests', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests();
instrumentOutgoingRequests(client);

expect(addFetchSpy).toHaveBeenCalledWith(expect.any(Function));
expect(addXhrSpy).toHaveBeenCalledWith(expect.any(Function));
Expand All@@ -28,15 +40,15 @@ describe('instrumentOutgoingRequests', () => {
it('does not instrument fetch requests if traceFetch is false', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');

instrumentOutgoingRequests({ traceFetch: false });
instrumentOutgoingRequests(client, { traceFetch: false });

expect(addFetchSpy).not.toHaveBeenCalled();
});

it('does not instrument xhr requests if traceXHR is false', () => {
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests({ traceXHR: false });
instrumentOutgoingRequests(client, { traceXHR: false });

expect(addXhrSpy).not.toHaveBeenCalled();
});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,7 @@ describe('browserTracingIntegration', () => {
return createdRootSpan as Span;
});

const fakeClient = { getOptions: () => ({}), on: () => {} };
const fakeClient = { getOptions: () => ({}), on: () => {}, addEventProcessor: () => {} };

const mockedRoutingSpan = {
end: () => {},
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration'),
gzip: true,
limit: '35 KB',
limit: '36 KB',
},
{
name: '@sentry/browser (incl. Tracing, Replay)',
Expand All@@ -29,7 +29,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration'),
gzip: true,
limit: '65 KB',
limit: '66 KB',
modifyWebpackConfig: function (config) {
const webpack = require('webpack');
config.plugins.push(
Expand DownExpand Up@@ -107,7 +107,7 @@ module.exports = [
import: createImport('init', 'ErrorBoundary', 'reactRouterV6BrowserTracingIntegration'),
ignore: ['react/jsx-runtime'],
gzip: true,
limit: '38 KB',
limit: '39 KB',
},
// Vue SDK (ESM)
{
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
"@sentry/react": "latest || *",
"@types/react": "18.0.0",
"@types/react-dom": "18.0.0",
"express": "4.19.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-router-dom": "^6.4.1",
Expand All@@ -14,7 +15,9 @@
},
"scripts": {
"build": "react-scripts build",
"start": "serve -s build",
"start": "run-p start:client start:server",
"start:client": "node server/app.js",
"start:server": "serve -s build",
"test": "playwright test",
"clean": "npx rimraf node_modules pnpm-lock.yaml",
"test:build": "pnpm install && npx playwright install && pnpm build",
Expand DownExpand Up@@ -43,7 +46,8 @@
"devDependencies": {
"@playwright/test": "^1.44.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"serve": "14.0.1"
"serve": "14.0.1",
"npm-run-all2": "^6.2.0"
},
"volta": {
"extends": "../../package.json"
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
return new Promise(resolve => {
setTimeout(() => {
resolve();
}, time);
});
};

async function sseHandler(request, response, timeout = false) {
response.headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
'Access-Control-Allow-Origin': '*',
};

response.setHeader('Cache-Control', 'no-cache');
response.setHeader('Content-Type', 'text/event-stream');
response.setHeader('Access-Control-Allow-Origin', '*');
response.setHeader('Connection', 'keep-alive');

response.flushHeaders();

await wait(2000);

for (let index = 0; index < 10; index++) {
response.write(`data: ${new Date().toISOString()}\n\n`);
if (timeout) {
await wait(10000);
}
}

response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
console.log(`SSE service listening at http://localhost:${PORT}`);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import {
useNavigationType,
} from 'react-router-dom';
import Index from './pages/Index';
import SSE from './pages/SSE';
import User from './pages/User';

const replay = Sentry.replayIntegration();
Expand DownExpand Up@@ -48,6 +49,7 @@ root.render(
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/user/:id" element={<User />} />
<Route path="/sse" element={<SSE />} />
</SentryRoutes>
</BrowserRouter>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';

const fetchSSE = async ({ timeout }: { timeout: boolean }) => {
Sentry.startSpanManual({ name: 'sse stream using fetch' }, async span => {
const res = await Sentry.startSpan({ name: 'sse fetch call' }, async () => {
const endpoint = `http://localhost:8080/${timeout ? 'sse-timeout' : 'sse'}`;
return await fetch(endpoint);
});

const stream = res.body;
const reader = stream?.getReader();

const readChunk = async () => {
const readRes = await reader?.read();
if (readRes?.done) {
return;
}

new TextDecoder().decode(readRes?.value);

await readChunk();
};

try {
await readChunk();
} catch (error) {
console.error('Could not fetch sse', error);
}

span.end();
});
};

const SSE = () => {
return (
<>
<button id="fetch-button" onClick={() => fetchSSE({ timeout: false })}>
Fetch SSE
</button>
<button id="fetch-timeout-button" onClick={() => fetchSSE({ timeout: true })}>
Fetch timeout SSE
</button>
</>
);
};

export default SSE;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { SpanJSON } from '@sentry/types';

test('Waits for sse streaming when creating spans', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(span => span.description === 'GET http://localhost:8080/sse')[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 2s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(2);
});

test('Aborts when stream takes longer than 5s', async ({ page }) => {
await page.goto('/sse');

const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const fetchButton = page.locator('id=fetch-timeout-button');
await fetchButton.click();

const rootSpan = await transactionPromise;
const sseFetchCall = rootSpan.spans?.filter(span => span.description === 'sse fetch call')[0] as SpanJSON;
const httpGet = rootSpan.spans?.filter(
span => span.description === 'GET http://localhost:8080/sse-timeout',
)[0] as SpanJSON;

expect(sseFetchCall).toBeDefined();
expect(httpGet).toBeDefined();

expect(sseFetchCall?.timestamp).toBeDefined();
expect(sseFetchCall?.start_timestamp).toBeDefined();
expect(httpGet?.timestamp).toBeDefined();
expect(httpGet?.start_timestamp).toBeDefined();

// http headers get sent instantly from the server
const resolveDuration = Math.round((sseFetchCall.timestamp as number) - sseFetchCall.start_timestamp);

// body streams after 10s but client should abort reading after 5s
const resolveBodyDuration = Math.round((httpGet.timestamp as number) - httpGet.start_timestamp);

expect(resolveDuration).toBe(0);
expect(resolveBodyDuration).toBe(7);
});
2 changes: 1 addition & 1 deletion packages/browser/src/tracing/browserTracingIntegration.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -398,7 +398,7 @@ export const browserTracingIntegration = ((_options: Partial<BrowserTracingOptio
registerInpInteractionListener();
}

instrumentOutgoingRequests({
instrumentOutgoingRequests(client, {
traceFetch,
traceXHR,
tracePropagationTargets: client.getOptions().tracePropagationTargets,
Expand Down
37 changes: 36 additions & 1 deletion packages/browser/src/tracing/request.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,7 @@ import {
import type { Client, HandlerDataXhr, SentryWrappedXMLHttpRequest, Span } from '@sentry/types';
import {
BAGGAGE_HEADER_NAME,
addFetchEndInstrumentationHandler,
addFetchInstrumentationHandler,
browserPerformanceTimeOrigin,
dynamicSamplingContextToSentryBaggageHeader,
Expand DownExpand Up@@ -93,14 +94,17 @@ export interface RequestInstrumentationOptions {
shouldCreateSpanForRequest?(this: void, url: string): boolean;
}

const responseToSpanId = new WeakMap<object, string>();
const spanIdToEndTimestamp = new Map<string, number>();

export const defaultRequestInstrumentationOptions: RequestInstrumentationOptions = {
traceFetch: true,
traceXHR: true,
enableHTTPTimings: true,
};

/** Registers span creators for xhr and fetch requests */
export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumentationOptions>): void {
export function instrumentOutgoingRequests(client: Client, _options?: Partial<RequestInstrumentationOptions>): void {
const { traceFetch, traceXHR, shouldCreateSpanForRequest, enableHTTPTimings, tracePropagationTargets } = {
traceFetch: defaultRequestInstrumentationOptions.traceFetch,
traceXHR: defaultRequestInstrumentationOptions.traceXHR,
Expand All@@ -115,8 +119,39 @@ export function instrumentOutgoingRequests(_options?: Partial<RequestInstrumenta
const spans: Record<string, Span> = {};

if (traceFetch) {
// Keeping track of http requests, whose body payloads resolved later than the intial resolved request
// e.g. streaming using server sent events (SSE)
client.addEventProcessor(event => {
if (event.type === 'transaction' && event.spans) {
event.spans.forEach(span => {
if (span.op === 'http.client') {
const updatedTimestamp = spanIdToEndTimestamp.get(span.span_id);
if (updatedTimestamp) {
span.timestamp = updatedTimestamp / 1000;
spanIdToEndTimestamp.delete(span.span_id);
}
}
});
}
return event;
});

addFetchEndInstrumentationHandler(handlerData => {
if (handlerData.response) {
const span = responseToSpanId.get(handlerData.response);
if (span && handlerData.endTimestamp) {
spanIdToEndTimestamp.set(span, handlerData.endTimestamp);
}
}
});

addFetchInstrumentationHandler(handlerData => {
const createdSpan = instrumentFetchRequest(handlerData, shouldCreateSpan, shouldAttachHeadersWithTargets, spans);

if (handlerData.response && handlerData.fetchData.__span) {
responseToSpanId.set(handlerData.response, handlerData.fetchData.__span);
}

// We cannot use `window.location` in the generic fetch instrumentation,
// but we need it for reliable `server.address` attribute.
// so we extend this in here
Expand Down
18 changes: 15 additions & 3 deletions packages/browser/test/unit/tracing/request.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import * as browserUtils from '@sentry-internal/browser-utils';
import type { Client } from '@sentry/types';
import * as utils from '@sentry/utils';
import { WINDOW } from '../../../src/helpers';

Expand All@@ -10,16 +11,27 @@ beforeAll(() => {
global.Request = {};
});

class MockClient implements Partial<Client> {
public addEventProcessor: () => void;
constructor() {
// Mock addEventProcessor function
this.addEventProcessor = jest.fn();
}
}

describe('instrumentOutgoingRequests', () => {
let client: Client;

beforeEach(() => {
jest.clearAllMocks();
client = new MockClient() as unknown as Client;
});

it('instruments fetch and xhr requests', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests();
instrumentOutgoingRequests(client);

expect(addFetchSpy).toHaveBeenCalledWith(expect.any(Function));
expect(addXhrSpy).toHaveBeenCalledWith(expect.any(Function));
Expand All@@ -28,15 +40,15 @@ describe('instrumentOutgoingRequests', () => {
it('does not instrument fetch requests if traceFetch is false', () => {
const addFetchSpy = jest.spyOn(utils, 'addFetchInstrumentationHandler');

instrumentOutgoingRequests({ traceFetch: false });
instrumentOutgoingRequests(client, { traceFetch: false });

expect(addFetchSpy).not.toHaveBeenCalled();
});

it('does not instrument xhr requests if traceXHR is false', () => {
const addXhrSpy = jest.spyOn(browserUtils, 'addXhrInstrumentationHandler');

instrumentOutgoingRequests({ traceXHR: false });
instrumentOutgoingRequests(client, { traceXHR: false });

expect(addXhrSpy).not.toHaveBeenCalled();
});
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,7 @@ describe('browserTracingIntegration', () => {
return createdRootSpan as Span;
});

const fakeClient = { getOptions: () => ({}), on: () => {} };
const fakeClient = { getOptions: () => ({}), on: () => {}, addEventProcessor: () => {} };

const mockedRoutingSpan = {
end: () => {},
Expand Down
Loading