Skip to content

fix(tracing): ignore the xhr/fetch response if its request is not being tracked #4428

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 5 commits into from
Jan 24, 2022
Merged

fix(tracing): ignore the xhr/fetch response if its request is not being tracked #4428

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e0137ef
fix(tracing): ignore the xhr response if its request is not being tra…
datbth Jan 20, 2022
c2e870c
chore(tracing): fix test
datbth Jan 21, 2022
d788c70
chore(tracing): refactor
datbth Jan 21, 2022
3993dd3
fix(tracing): ignore the fetch response if its request is not being t…
datbth Jan 21, 2022
ccecb71
chore(tracing): fix test
datbth Jan 23, 2022
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
18 changes: 12 additions & 6 deletions packages/tracing/src/browser/request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,11 @@ export function fetchCallback(
return;
}

if (handlerData.endTimestamp && handlerData.fetchData.__span) {
const span = spans[handlerData.fetchData.__span];
if (handlerData.endTimestamp) {
const spanId = handlerData.fetchData.__span;
if (!spanId) return;

const span = spans[spanId];
if (span) {
if (handlerData.response) {
// TODO (kmclb) remove this once types PR goes through
Expand All @@ -154,7 +157,7 @@ export function fetchCallback(
span.finish();

// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spans[handlerData.fetchData.__span];
delete spans[spanId];
}
return;
}
Expand Down Expand Up @@ -216,14 +219,17 @@ export function xhrCallback(
const xhr = handlerData.xhr.__sentry_xhr__;

// check first if the request has finished and is tracked by an existing span which should now end
if (handlerData.endTimestamp && handlerData.xhr.__sentry_xhr_span_id__) {
const span = spans[handlerData.xhr.__sentry_xhr_span_id__];
if (handlerData.endTimestamp) {
Copy link
Member

Choose a reason for hiding this comment

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

we probably want this logic to be like:

if (handlerData.endTimestamp) {
  const spanId = handlerData.xhr.__sentry_xhr_span_id__;
  if (spanId) {
    const span = spans[spanId];
    if (span) {
      span.setHttpStatus(xhr.status_code);
      span.finish();

      // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
      delete spans[spanId];
    }
  }
  return;
}

This is also more bundle size efficient

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hi, thanks for looking into this.

I have refactored into using the spanId variable as suggested.
But I'm using eager-return style because it modifies less codes and I also believe multiple nesting levels is less readable. Not sure if it's significant to the bundle size?

Copy link
Member

Choose a reason for hiding this comment

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

Well it's two return keywords rather than one (both of which can't be minified), but yeah the impact is probably minimal. We can leave it like this!

const spanId = handlerData.xhr.__sentry_xhr_span_id__;
if (!spanId) return;

const span = spans[spanId];
if (span) {
span.setHttpStatus(xhr.status_code);
span.finish();

// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
delete spans[handlerData.xhr.__sentry_xhr_span_id__];
delete spans[spanId];
}
return;
}
Expand Down
45 changes: 42 additions & 3 deletions packages/tracing/test/browser/request.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,12 @@ describe('callbacks', () => {
let transaction: Transaction;
const alwaysCreateSpan = () => true;
const neverCreateSpan = () => false;
const startTimestamp = 1356996072000;
const endTimestamp = 1356996072000;
const fetchHandlerData: FetchData = {
args: ['http://dogs.are.great/', {}],
fetchData: { url: 'http://dogs.are.great/', method: 'GET' },
startTimestamp: 1356996072000,
startTimestamp,
};
const xhrHandlerData: XHRData = {
xhr: {
Expand All @@ -66,9 +68,8 @@ describe('callbacks', () => {
// setRequestHeader: XMLHttpRequest.prototype.setRequestHeader,
setRequestHeader,
},
startTimestamp: 1353501072000,
startTimestamp,
};
const endTimestamp = 1356996072000;

beforeAll(() => {
hub = new Hub(new BrowserClient({ tracesSampleRate: 1 }));
Expand Down Expand Up @@ -173,6 +174,23 @@ describe('callbacks', () => {
expect(newSpan!.status).toBe(spanStatusfromHttpCode(404));
});

it('ignores response with no associated span', () => {
// the request might be missed somehow. E.g. if it was sent before tracing gets enabled.

const postRequestFetchHandlerData = {
...fetchHandlerData,
endTimestamp,
response: { status: 404 } as Response,
};

// in that case, the response coming back will be ignored
fetchCallback(postRequestFetchHandlerData, alwaysCreateSpan, {});

const newSpan = transaction.spanRecorder?.spans[1];

expect(newSpan).toBeUndefined();
});

it('adds sentry-trace header to fetch requests', () => {
// TODO
});
Expand Down Expand Up @@ -263,5 +281,26 @@ describe('callbacks', () => {

expect(newSpan!.status).toBe(spanStatusfromHttpCode(404));
});

it('ignores response with no associated span', () => {
// the request might be missed somehow. E.g. if it was sent before tracing gets enabled.

const postRequestXHRHandlerData = {
...{
xhr: {
__sentry_xhr__: xhrHandlerData.xhr.__sentry_xhr__,
},
},
startTimestamp,
endTimestamp,
};

// in that case, the response coming back will be ignored
xhrCallback(postRequestXHRHandlerData, alwaysCreateSpan, {});

const newSpan = transaction.spanRecorder?.spans[1];

expect(newSpan).toBeUndefined();
});
});
});
2 changes: 2 additions & 0 deletions packages/tracing/test/hub.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,7 @@ describe('Hub', () => {

const request = new XMLHttpRequest();
request.open('GET', '/chase-partners');
request.send();

// mock a response having been received successfully (we have to do it in this roundabout way because readyState
// is readonly and changing it doesn't trigger a readystatechange event)
Expand Down Expand Up @@ -418,6 +419,7 @@ describe('Hub', () => {

const request = new XMLHttpRequest();
request.open('GET', '/chase-partners');
request.send();
Copy link
Member

Choose a reason for hiding this comment

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

This errors because we are now actually making the request, to a resource that doesn't exist.

As a quick thing to unblock we can just request http://example.com - but we should probably use SinonFakeServer like we do to test the xhr transport in

sentry-javascript/packages/browser/test/unit/transports/xhr.test.ts

Lines 18 to 24 in caba96e

let server: SinonFakeServer;
let transport: Transports.BaseTransport;
describe('XHRTransport', () => {
beforeEach(() => {
server = fakeServer.create();
server.respondImmediately = true;

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh somehow the tests did not fail on my machine. They do fail when I disable the Internet. I'm working on this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I could not get the tests to work properly with fake servers. But since these tests do not really care about the responses, I have fixed them by waiting for the requests to complete regardless of the result


// mock a response having been received successfully (we have to do it in this roundabout way because readyState
// is readonly and changing it doesn't trigger a readystatechange event)
Expand Down