Skip to content

Change XHR instrumentation ordering #2643

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 8, 2020
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
- [react] feat: Add @sentry/react package (#2631)
- [browser] Change XHR instrumentation order to handle `onreadystatechange` breadcrumbs correctly (#2643)

## 5.16.1

Expand Down
53 changes: 31 additions & 22 deletions packages/utils/src/instrument.ts
Original file line number Diff line number Diff line change
Expand Up @@ -218,35 +218,19 @@ function instrumentXHR(): void {

fill(xhrproto, 'open', function(originalOpen: () => void): () => void {
return function(this: SentryWrappedXMLHttpRequest, ...args: any[]): void {
const xhr = this; // tslint:disable-line:no-this-assignment
const url = args[1];
this.__sentry_xhr__ = {
xhr.__sentry_xhr__ = {
method: isString(args[0]) ? args[0].toUpperCase() : args[0],
url: args[1],
};

// if Sentry key appears in URL, don't capture it as a request
if (isString(url) && this.__sentry_xhr__.method === 'POST' && url.match(/sentry_key/)) {
this.__sentry_own_request__ = true;
if (isString(url) && xhr.__sentry_xhr__.method === 'POST' && url.match(/sentry_key/)) {
xhr.__sentry_own_request__ = true;
}

return originalOpen.apply(this, args);
};
});

fill(xhrproto, 'send', function(originalSend: () => void): () => void {
return function(this: SentryWrappedXMLHttpRequest, ...args: any[]): void {
const xhr = this; // tslint:disable-line:no-this-assignment
const commonHandlerData = {
args,
startTimestamp: Date.now(),
xhr,
};

triggerHandlers('xhr', {
...commonHandlerData,
});

xhr.addEventListener('readystatechange', function(): void {
const onreadystatechangeHandler = function(): void {
if (xhr.readyState === 4) {
try {
// touching statusCode in some platforms throws
Expand All @@ -258,10 +242,35 @@ function instrumentXHR(): void {
/* do nothing */
}
triggerHandlers('xhr', {
...commonHandlerData,
args,
endTimestamp: Date.now(),
startTimestamp: Date.now(),
xhr,
});
}
};

if ('onreadystatechange' in xhr && typeof xhr.onreadystatechange === 'function') {
fill(xhr, 'onreadystatechange', function(original: WrappedFunction): Function {
return function(...readyStateArgs: any[]): void {
onreadystatechangeHandler();
return original.apply(xhr, readyStateArgs);
};
});
} else {
xhr.addEventListener('readystatechange', onreadystatechangeHandler);
}

return originalOpen.apply(xhr, args);
};
});

fill(xhrproto, 'send', function(originalSend: () => void): () => void {
return function(this: SentryWrappedXMLHttpRequest, ...args: any[]): void {
triggerHandlers('xhr', {
args,
startTimestamp: Date.now(),
xhr: this,
});

return originalSend.apply(this, args);
Expand Down