XMLHttpRequest #595
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -35,18 +35,18 @@ import { EventNames } from './enums/EventNames'; | |||||
| import { Format } from './enums/Format'; | ||||||
| import { | ||||||
| OpenFunction, | ||||||
| PropagateTraceHeaderCorsUrls, | ||||||
| SendBody, | ||||||
| SendFunction, | ||||||
| XhrMem, | ||||||
| } from './types'; | ||||||
|
|
||||||
| /** | ||||||
| * XMLHttpRequest config | ||||||
| */ | ||||||
| export interface XMLHttpRequestPluginConfig extends types.PluginConfig { | ||||||
| // urls which should include trace headers when origin doesn't match | ||||||
| propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls; | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
|
|
@@ -61,16 +61,7 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| protected _config!: XMLHttpRequestPluginConfig; | ||||||
|
|
||||||
| private _tasksCount = 0; | ||||||
| private _xhrMem = new WeakMap<XMLHttpRequest, XhrMem>(); | ||||||
| private _usedResources: { [key: string]: PerformanceResourceTiming[] } = {}; | ||||||
obecny marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
obecny marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| constructor(config: XMLHttpRequestPluginConfig = {}) { | ||||||
|
|
@@ -85,7 +76,8 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| * @private | ||||||
| */ | ||||||
| private _addHeaders(xhr: XMLHttpRequest, span: types.Span) { | ||||||
| let propagateTraceHeaderUrls = | ||||||
| this._config.propagateTraceHeaderCorsUrls || []; | ||||||
| if ( | ||||||
| typeof propagateTraceHeaderUrls === 'string' || | ||||||
|
Contributor
There was a problem hiding this comment. Could we have this logic handled by the utility function for matching strings? |
||||||
| propagateTraceHeaderUrls instanceof RegExp | ||||||
|
|
@@ -155,29 +147,35 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| /** | ||||||
| * will collect information about all resources created | ||||||
| * between "send" and "end" | ||||||
| * @param xhr | ||||||
| * @param spanName | ||||||
| * @private | ||||||
| */ | ||||||
| private _addPossibleCorsPreflightResourceObserver( | ||||||
| xhr: XMLHttpRequest, | ||||||
| spanName: string | ||||||
| ) { | ||||||
| const xhrMem = this._xhrMem.get(xhr); | ||||||
| if (!xhrMem) { | ||||||
| return; | ||||||
| } | ||||||
| xhrMem.resourcesCreatedInTheMiddle = { | ||||||
| observer: new PerformanceObserver(list => { | ||||||
| const entries = list.getEntries() as PerformanceResourceTiming[]; | ||||||
| entries.forEach(entry => { | ||||||
| if ( | ||||||
| entry.initiatorType === 'xmlhttprequest' && | ||||||
| entry.name === spanName | ||||||
| ) { | ||||||
| if (xhrMem.resourcesCreatedInTheMiddle) { | ||||||
| xhrMem.resourcesCreatedInTheMiddle.entries.push(entry); | ||||||
| } | ||||||
| } | ||||||
| }); | ||||||
| }), | ||||||
| entries: [], | ||||||
| }; | ||||||
| xhrMem.resourcesCreatedInTheMiddle.observer.observe({ | ||||||
| entryTypes: ['resource'], | ||||||
| }); | ||||||
| } | ||||||
|
|
@@ -189,9 +187,7 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| private _clearResources() { | ||||||
| if (this._tasksCount === 0) { | ||||||
| ((otperformance as unknown) as Performance).clearResourceTimings(); | ||||||
| this._xhrMem = new WeakMap<XMLHttpRequest, XhrMem>(); | ||||||
obecny marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| this._usedResources = {}; | ||||||
| } | ||||||
| } | ||||||
|
|
@@ -235,12 +231,10 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| * @param xhr | ||||||
| * @private | ||||||
| */ | ||||||
| private _cleanPreviousSpanInformation(xhr: XMLHttpRequest) { | ||||||
| const xhrMem = this._xhrMem.get(xhr); | ||||||
| if (xhrMem) { | ||||||
| const callbackToRemoveEvents = xhrMem.callbackToRemoveEvents; | ||||||
| if (callbackToRemoveEvents) { | ||||||
| callbackToRemoveEvents(); | ||||||
| } | ||||||
|
|
@@ -255,7 +249,7 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| * @private | ||||||
| */ | ||||||
| private _createSpan( | ||||||
| xhr: XMLHttpRequest, | ||||||
| url: string, | ||||||
| method: string | ||||||
| ): tracing.Span | undefined { | ||||||
|
|
@@ -275,11 +269,11 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
|
|
||||||
| currentSpan.addEvent(EventNames.METHOD_OPEN); | ||||||
|
|
||||||
| this._xhrMem.set(xhr, { | ||||||
| span: currentSpan, | ||||||
| }); | ||||||
|
|
||||||
| this._cleanPreviousSpanInformation(xhr); | ||||||
|
|
||||||
| return currentSpan; | ||||||
| } | ||||||
|
|
@@ -314,7 +308,7 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| user?: string | null, | ||||||
| pass?: string | null | ||||||
| ): void { | ||||||
| plugin._createSpan(this as XMLHttpRequest, url, method); | ||||||
|
|
||||||
| return original.call(this, method, url, true, user, pass); | ||||||
|
||||||
| }; | ||||||
|
|
@@ -328,24 +322,23 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| protected _patchSend() { | ||||||
| const plugin = this; | ||||||
|
|
||||||
| function endSpan(xhr: XMLHttpRequest, eventName: string) { | ||||||
| const xhrMem = plugin._xhrMem.get(xhr); | ||||||
| if (!xhrMem) { | ||||||
| return; | ||||||
| } | ||||||
| const callbackToRemoveEvents = xhrMem.callbackToRemoveEvents; | ||||||
|
|
||||||
| let resourcesCreatedInTheMiddle = xhrMem.resourcesCreatedInTheMiddle; | ||||||
| let entries; | ||||||
| if (resourcesCreatedInTheMiddle) { | ||||||
| entries = resourcesCreatedInTheMiddle.entries.slice(); | ||||||
| } | ||||||
| if (typeof callbackToRemoveEvents === 'function') { | ||||||
| callbackToRemoveEvents(); | ||||||
| } | ||||||
| const currentSpan = xhrMem.span; | ||||||
| if (currentSpan) { | ||||||
| plugin._findResourceAndAddNetworkEvents(currentSpan, entries); | ||||||
| currentSpan.addEvent(eventName); | ||||||
|
|
||||||
|
|
@@ -378,38 +371,41 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| plugin._clearResources(); | ||||||
| } | ||||||
|
|
||||||
| function onError(this: XMLHttpRequest) { | ||||||
| endSpan(this, EventNames.EVENT_ERROR); | ||||||
| } | ||||||
|
|
||||||
| function onTimeout(this: XMLHttpRequest) { | ||||||
| endSpan(this, EventNames.EVENT_TIMEOUT); | ||||||
| } | ||||||
|
|
||||||
| function onLoad(this: XMLHttpRequest) { | ||||||
| if (this.status < 299) { | ||||||
| endSpan(this, EventNames.EVENT_LOAD); | ||||||
| } else { | ||||||
| endSpan(this, EventNames.EVENT_ERROR); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| function unregister(xhr: XMLHttpRequest) { | ||||||
| xhr.removeEventListener('load', onLoad); | ||||||
| xhr.removeEventListener('error', onError); | ||||||
| xhr.removeEventListener('timeout', onTimeout); | ||||||
| const xhrMem = plugin._xhrMem.get(xhr); | ||||||
| if (xhrMem) { | ||||||
| delete xhrMem.callbackToRemoveEvents; | ||||||
obecny marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| } | ||||||
| } | ||||||
|
|
||||||
| return (original: SendFunction): SendFunction => { | ||||||
obecny marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| return function patchSend(this: XMLHttpRequest, body?: SendBody): void { | ||||||
| const xhrMem = plugin._xhrMem.get(this); | ||||||
| if (!xhrMem) { | ||||||
| return; | ||||||
dyladan marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| } | ||||||
| const currentSpan: types.Span = xhrMem.span; | ||||||
|
|
||||||
| if (currentSpan) { | ||||||
| plugin._tasksCount++; | ||||||
| currentSpan.addEvent(EventNames.METHOD_SEND); | ||||||
| const spanName = (currentSpan as tracing.Span).name; | ||||||
|
|
@@ -418,14 +414,15 @@ export class XMLHttpRequestPlugin extends BasePlugin<XMLHttpRequest> { | |||||
| this.addEventListener('error', onError); | ||||||
| this.addEventListener('timeout', onTimeout); | ||||||
|
|
||||||
| xhrMem.callbackToRemoveEvents = () => { | ||||||
| unregister(this); | ||||||
| if (xhrMem.resourcesCreatedInTheMiddle) { | ||||||
| xhrMem.resourcesCreatedInTheMiddle.observer.disconnect(); | ||||||
| delete xhrMem.resourcesCreatedInTheMiddle; | ||||||
| } | ||||||
| }; | ||||||
| plugin._addHeaders(this, currentSpan); | ||||||
| plugin._addPossibleCorsPreflightResourceObserver(this, spanName); | ||||||
| } | ||||||
| return original.call(this, body); | ||||||
|
||||||
| return original.call(this, body); | |
| return original.apply(this, arguments); |
Member
Author
There was a problem hiding this comment.
- call is faster
- we already know there is just one para, we know it's type so we can use it and typescript will also validate the type of this is correcty
- You don't have
argumentsword in typescript , so you would still declare array of aguments and define type for it, which would be quite weird anyway
Member
Author
There was a problem hiding this comment.
and the same here, thx
@draffensperger @mayurkale22 ^^
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Uh oh!
There was an error while loading. Please reload this page.