BOOMR.plugins. AutoXHR

BOOMR.init({
    instrument_xhr: true
});

xhr = new XMLHttpRequest();
xhr.open("GET", "/api/foo");
xhr.send(null);

BOOMR.init({
    AutoXHR: {
        alwaysSendXhr: true
    }
});

BOOMR.init({
    AutoXHR: {
        alwaysSendXhr: [
            "http://domain.com/url/to/match",
            /regexmatch/,
        ]
   }
});

// or

BOOMR.init({
    AutoXHR: {
        alwaysSendXhr: function(url) {
            return url.indexOf("domain.com") !== -1;
        }
   }
});

BOOMR = window.BOOMR || {};

BOOMR.xhr_excludes = {
  "www.mydomain.com":  true,
  "a.anotherdomain.net": true,
  "/api/v1/foobar":  true,
  "https://mydomain.com/dashboard/": true
};

BOOMR.init({
  AutoXHR: {
    excludeFilters: [
      function(anchor) {
        return anchor.href.match(/non-trackable/);
      }
    ]
  }
});

BOOMR.init({
  AutoXHR: {
    domExcludeFilters: [
      function(elem) {
        return elem.id === "ignore";
      }
    ]
  }
});

Methods

---

addDomExcludeFilter(cb, ctx [, name])

Add a DOM filter function to the list of functions to run to validate if an DOM element should be instrumented.

Parameters:

Name	Type	Argument	Description
cb	BOOMR.plugins.AutoXHR.htmlElementCallback		Callback to run to validate filtering of an XHR Request
ctx	Object		Context to run {@param cb} in
name	string	<optional>	Optional name for the filter, called out when running exclude filters for debugging purposes

Example

BOOMR.plugins.AutoXHR.addDomExcludeFilter(function(elem) {
  return elem.id === "ignore";
}, null, "exampleFilter");

---

addExcludeFilter(cb, ctx [, name])

Add a XHR filter function to the list of functions to run to validate if an XHR should be instrumented.

Parameters:

Name	Type	Argument	Description
cb	BOOMR.plugins.AutoXHR.htmlElementCallback		Callback to run to validate filtering of an XHR Request
ctx	Object		Context to run {@param cb} in
name	string	<optional>	Optional name for the filter, called out when running exclude filters for debugging purposes

Example

BOOMR.plugins.AutoXHR.addExcludeFilter(function(anchor) {
  var m = anchor.href.match(/some-page\.html/g);

  // If matching flag to not instrument
  if (m && m.length > 0) {
    return true;
  }
  return false;
}, null, "exampleFilter");

---

enableAutoXhr()

Enables AutoXHR if not already enabled.

---

getMutationHandler()

Gets the MutationHandler

Returns:

Type: MutationHandler

Handler

---

getPathName(anchor)

Tries to resolve href links from relative URLs.

This implementation takes into account a bug in the way IE handles relative paths on anchors and resolves this by assigning a.href to itself which triggers the URL resolution in IE and will fix missing leading slashes if necessary.

Parameters:

Name	Type	Description
anchor	string	The anchor object to resolve

Returns:

Type: string

The unrelativized URL href

---

init(config)

Initializes the plugin.

Parameters:

Name	Type	Description
config	object	Configuration Properties Name Type Argument Default Description instrument_xhr boolean <optional> Whether or not to instrument XHR AutoXHR.spaBackEndResources Array.<string> <optional> Default resources to count as Back-End during a SPA nav AutoXHR.monitorFetch boolean <optional> Whether or not to instrument fetch() AutoXHR.fetchBodyUsedWait number <optional> If the fetch response's bodyUsed flag is false, we'll wait this amount of ms before checking RT for an entry. Setting to 0 will disable this feature AutoXHR.alwaysSendXhr boolean | Array.<string> | Array.<RegExp> | Array.<function()> <optional> Whether or not to send XHR beacons for every XHR. captureXhrRequestResponse boolean <optional> Whether or not to capture an XHR's request and response bodies on for the xhr_load event. AutoXHR.spaIdleTimeout number <optional> 1000 Timeout for Single Page Applications after the final resource fetch has completed before calling the SPA navigation complete. Default is 1000ms. AutoXHR.xhrIdleTimeout number <optional> 50 Timeout for XHRs after final resource fetch has completed before calling the XHR complete. Default is 50ms. AutoXHR.xhrRequireChanges boolean <optional> true Whether or not a XHR beacon will only be triggered if there were DOM changes. AutoXHR.spaStartFromClick boolean <optional> false In Single Page Apps, start tracking the SPA Soft Navigation from any preceeding clicks. If false, will start from the most recent pushState.

Returns:

BOOMR.plugins.AutoXHR The AutoXHR plugin for chaining

---

is_complete()

This plugin is always complete (ready to send a beacon)

Returns:

Type: boolean

true

---

loadFinished(resource)

Mark this as the time load ended via resources loadEventEnd property, if this resource has been added to the MutationHandler already notify that the resource has finished. Otherwise add this call to the lise of Events that occured.

Parameters:

Name	Type	Description
resource	object	Resource

---

shouldExcludeXhr(anchor)

Based on the contents of BOOMR.xhr_excludes check if the URL that we instrumented as XHR request matches any of the URLs we are supposed to not send a beacon about.

Parameters:

Name	Type	Description
anchor	HTMLAnchorElement	HTML anchor element with URL of the element checked against BOOMR.xhr_excludes

Returns:

Type: boolean

true if intended to be excluded, false if it is not in the list of excludables

Type Definitions

---

htmlElementCallback(elem)

A callback with a HTML element.

Parameters:

Name	Type	Description
elem	HTMLAnchorElement	HTML element