Track patched XHR requests for network breadcrumbs #2055
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal
Fixes two issues with the current xhr monkey patch for network breadcrumbs:
XMLHttpRequest.send
was overridden on the instance in order to record the duration of the request. However this causes a potential incompatibility issue with other libraries that may be monkey patching XHR and callingthis.send
- as observed with msw, where both libraries call into each other causing an infinite loop.open
is called more than once) event listeners from previous uses were not removed, resulting in duplicate breadcrumbs being logged.Design
send
is now overridden on the prototype rather than the instance, and WeakMaps are used to store metadata and event listeners associated with tracked XHR instances.The
open
override now just adds the request instance to a weak map along with it's method and url. Whensend
is called, the request metadata and any existing event listeners are retrieved - if there are previous event listeners for the request these are removed before new ones are added.XHR is not monkey-patched (and XHR breadcrumbs are disabled) if WeakMap is not available - this affects IE<=10.
Testing
Updated unit tests and relied on existing e2e tests.