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
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
fetch('http://sentry-test.io/foo?token=sensitive-token-value&page=1').then(() => {
Sentry.captureException('test error');
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';

sentryTest('filters sensitive query params in the fetch breadcrumb URL', async ({ getLocalTestUrl, page }) => {
const url = await getLocalTestUrl({ testDir: __dirname });

await page.route('**/foo?*', route => route.fulfill({ status: 200, body: '{}' }));

const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

expect(eventData.breadcrumbs).toEqual([
{
timestamp: expect.any(Number),
category: 'fetch',
type: 'http',
data: {
method: 'GET',
status_code: 200,
url: 'http://sentry-test.io/foo?token=[Filtered]&page=1',
},
},
]);
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
history.pushState({}, '', '/foo?jwt=sensitive-jwt-value&a=1');
history.pushState({}, '', '/bar');

Sentry.captureException('test exception');
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/browser';
import { sentryTest } from '../../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';

sentryTest('filters sensitive query params in navigation breadcrumbs', async ({ getLocalTestUrl, page }) => {
const url = await getLocalTestUrl({ testDir: __dirname });

const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

expect(eventData.breadcrumbs).toEqual([
{
category: 'navigation',
data: {
from: '/index.html',
to: '/foo?jwt=[Filtered]&a=1',
},
timestamp: expect.any(Number),
},
{
category: 'navigation',
data: {
from: '/foo?jwt=[Filtered]&a=1',
to: '/bar',
},
timestamp: expect.any(Number),
},
]);
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
const xhr = new XMLHttpRequest();

xhr.open('GET', 'http://sentry-test.io/foo?token=sensitive-token-value&page=1');
xhr.send();

xhr.addEventListener('readystatechange', function () {
if (xhr.readyState === 4) {
Sentry.captureException('test error');
}
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { expect } from '@playwright/test';
import type { Event } from '@sentry/core';
import { sentryTest } from '../../../../../utils/fixtures';
import { getFirstSentryEnvelopeRequest } from '../../../../../utils/helpers';

sentryTest('filters sensitive query params in the XHR breadcrumb URL', async ({ getLocalTestUrl, page }) => {
const url = await getLocalTestUrl({ testDir: __dirname });

await page.route('**/foo?*', route => route.fulfill({ status: 200, body: '{}' }));

const eventData = await getFirstSentryEnvelopeRequest<Event>(page, url);

expect(eventData.breadcrumbs).toEqual([
{
timestamp: expect.any(Number),
category: 'xhr',
type: 'http',
data: {
method: 'GET',
status_code: 200,
url: 'http://sentry-test.io/foo?token=[Filtered]&page=1',
},
},
]);
});
4 changes: 2 additions & 2 deletions packages/browser-utils/src/performance/elementTiming.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { IntegrationFn } from '@sentry/core';
import { browserPerformanceTimeOrigin, defineIntegration, metrics } from '@sentry/core';
import { browserPerformanceTimeOrigin, defineIntegration, filterCollectedUrl, metrics } from '@sentry/core';
import { addPerformanceInstrumentationHandler } from '../instrumentation/performanceObserver';
import { getBrowserPerformanceAPI } from './utils';

Expand Down Expand Up @@ -58,7 +58,7 @@ const _elementTimingIntegration = (() => {
}

if (elementEntry.url) {
metricAttributes['ui.element.url'] = elementEntry.url;
metricAttributes['ui.element.url'] = filterCollectedUrl(elementEntry.url);
}

if (elementEntry.naturalWidth) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ describe('elementTimingIntegration', () => {
identifier: 'hero-image',
id: 'img1',
element: { tagName: 'IMG' },
url: 'https://example.com/hero.jpg',
url: 'https://example.com/hero.jpg?token=abc&w=1920',
naturalWidth: 1920,
naturalHeight: 1080,
} as unknown as PerformanceEntry,
Expand All @@ -112,7 +112,7 @@ describe('elementTimingIntegration', () => {
'ui.element.paint_type': 'image-paint',
'ui.element.id': 'img1',
'ui.element.type': 'img',
'ui.element.url': 'https://example.com/hero.jpg',
'ui.element.url': 'https://example.com/hero.jpg?token=[Filtered]&w=1920',
'ui.element.width': 1920,
'ui.element.height': 1080,
};
Expand Down
10 changes: 6 additions & 4 deletions packages/browser/src/integrations/breadcrumbs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
addFetchInstrumentationHandler,
debug,
defineIntegration,
filterCollectedUrl,
getBreadcrumbLogLevelFromHttpStatusCode,
getClient,
getEventDescription,
Expand Down Expand Up @@ -192,7 +193,7 @@ function _getXhrBreadcrumbHandler(client: Client): (handlerData: HandlerDataXhr)

const data: XhrBreadcrumbData = {
method,
url,
url: filterCollectedUrl(url),
status_code,
};

Expand Down Expand Up @@ -247,7 +248,7 @@ function _getFetchBreadcrumbHandler(client: Client): (handlerData: HandlerDataFe

const breadcrumb = {
category: 'fetch',
data: handlerData.fetchData,
data: { ...handlerData.fetchData, url: filterCollectedUrl(handlerData.fetchData.url) },
level: 'error',
type: 'http',
} satisfies Breadcrumb;
Expand All @@ -259,6 +260,7 @@ function _getFetchBreadcrumbHandler(client: Client): (handlerData: HandlerDataFe
const response = handlerData.response as Response | undefined;
const data: FetchBreadcrumbData = {
...handlerData.fetchData,
url: filterCollectedUrl(handlerData.fetchData.url),
status_code: response?.status,
};

Expand Down Expand Up @@ -315,8 +317,8 @@ function _getHistoryBreadcrumbHandler(client: Client): (handlerData: HandlerData
addBreadcrumb({
category: 'navigation',
data: {
from,
to,
from: filterCollectedUrl(from),
to: filterCollectedUrl(to),

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

filterCollectedUrl omits in-scope client

Low Severity

This is more an "is this necessary" check than a functional break: filterCollectedUrl is called without the in-scope client, so it falls back to getClient(). The review guidelines ask to pass the client when one is available so dataCollection.urlQueryParams comes from the owning client, not the current scope. Flagged because that rule is in the review rules file.

Additional Locations (1)
Fix in Cursor Fix in Web

Triggered by project rule: PR Review Guidelines for Cursor Bot

Reviewed by Cursor Bugbot for commit 1aa2891. Configure here.

},
});
};
Expand Down
Loading