Skip to content

fix: Make sure that body is not exposed in the breadcrumb by default #2911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 16, 2020
Merged

fix: Make sure that body is not exposed in the breadcrumb by default #2911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 8 additions & 15 deletions packages/browser/src/integrations/breadcrumbs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,6 @@ import {
safeJoin,
} from '@sentry/utils';

/**
* @hidden
*/
export interface SentryWrappedXMLHttpRequest extends XMLHttpRequest {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
[key: string]: any;
__sentry_xhr__?: {
method?: string;
url?: string;
status_code?: number;
};
}

/** JSDoc */
interface BreadcrumbsOptions {
console: boolean;
Expand Down Expand Up @@ -212,15 +199,21 @@ export class Breadcrumbs implements Integration {
return;
}

const { method, url, status_code, body } = handlerData.xhr.__sentry_xhr__ || {};

getCurrentHub().addBreadcrumb(
{
category: 'xhr',
data: handlerData.xhr.__sentry_xhr__,
data: {
method,
url,
status_code,
},
type: 'http',
},
{
xhr: handlerData.xhr,
...(handlerData.xhr.__sentry_xhr__.body && { input: handlerData.xhr.__sentry_xhr__.body }),
input: body,
},
);

Expand Down
2 changes: 2 additions & 0 deletions packages/browser/test/integration/suites/breadcrumbs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ describe("breadcrumbs", function() {
assert.equal(summary.breadcrumbs[0].type, "http");
assert.equal(summary.breadcrumbs[0].category, "xhr");
assert.equal(summary.breadcrumbs[0].data.method, "GET");
assert.isUndefined(summary.breadcrumbs[0].data.input);
// To make sure that we are not providing this key for non-post requests
assert.equal(summary.breadcrumbHints[0].input, undefined);
});
Expand Down Expand Up @@ -109,6 +110,7 @@ describe("breadcrumbs", function() {
assert.equal(summary.breadcrumbs[0].type, "http");
assert.equal(summary.breadcrumbs[0].category, "xhr");
assert.equal(summary.breadcrumbs[0].data.method, "POST");
assert.isUndefined(summary.breadcrumbs[0].data.input);
assert.equal(summary.breadcrumbHints[0].input, '{"foo":"bar"}');
});
}
Expand Down