Merge pull request #164 from newrelic/handle-data-urls

Add handling for data URLs

feature/xhr/instrument/index.js

@@ -19,6 +19,7 @@ var ffVersion = require('../../../loader/firefox-version')
 var dataSize = require('ds')
 var responseSizeFromXhr = require('./response-size')
 var eventListenerOpts = require('event-listener-opts')
+var recordSupportability = require('metrics').recordSupportability
 
 var origRequest = NREUM.o.REQ
 var origXHR = window.XMLHttpRequest
@@ -264,6 +265,9 @@ ee.on('fetch-start', function (fetchArguments, dtPayload) {
   }
   addUrl(this, url)
 
+  // Do not generate telemetry for Data URL requests because they don't behave like other network requests
+  if (this.params.protocol === 'data') return
+
   var method = ('' + ((target && target instanceof origRequest && target.method) ||
     opts.method || 'GET')).toUpperCase()
   this.params.method = method
@@ -278,6 +282,13 @@ ee.on('fetch-done', function (err, res) {
   if (!this.params) {
     this.params = {}
   }
+
+  // Do not generate telemetry for Data URL requests because they don't behave like other network requests
+  if (this.params.protocol === 'data') {
+    recordSupportability('Ajax/DataUrl/Excluded')
+    return
+  }
+
   this.params.status = res ? res.status : 0
 
   // convert rxSize to a number
@@ -307,6 +318,12 @@ function end (xhr) {
     xhr.removeEventListener(handlers[i], this.listener, false)
   }
 
+  // Do not generate telemetry for Data URL requests because they don't behave like other network requests
+  if (params.protocol && params.protocol === 'data') {
+    recordSupportability('Ajax/DataUrl/Excluded')
+    return
+  }
+
   if (params.aborted) return
   metrics.duration = loader.now() - this.startTime
   if (!this.loadCaptureCalled && xhr.readyState === 4) {

feature/xhr/instrument/parse-url.js

@@ -10,6 +10,13 @@ module.exports = function parseUrl (url) {
     return stringsToParsedUrls[url]
   }
 
+  // Return if URL is a data URL, parseUrl assumes urls are http/https
+  if ((url || '').indexOf('data:') === 0) {
+    return {
+      protocol: 'data'
+    }
+  }
+
   var urlEl = document.createElement('a')
   var location = window.location
   var ret = {}

tests/browser/xhr/data-url.browser.js

@@ -0,0 +1,88 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+var test = require('../../../tools/jil/browser-test')
+var ee = require('ee')
+var handleEE = ee.get('handle')
+
+var hasXhr = window.XMLHttpRequest && XMLHttpRequest.prototype && XMLHttpRequest.prototype.addEventListener
+
+require('../../../feature/xhr/instrument')
+
+test('XHR request for Data URL does not generate telemetry', function(t) {
+  if (!hasXhr) {
+    t.skip('XHR is not supported in this browser')
+    t.end()
+    return
+  }
+
+  ee.addEventListener('send-xhr-start', validate)
+  handleEE.addEventListener('xhr', failCase)
+
+  try {
+    var xhr = new XMLHttpRequest()
+    xhr.open('GET', 'data:,dataUrl')
+    xhr.send()
+  } catch (e) {
+    ee.removeEventListener('send-xhr-start', validate)
+    handleEE.removeEventListener('xhr', failCase)
+
+    t.skip('XHR with data URL not supported in this browser')
+    t.end()
+    return
+  }
+
+  t.plan(2)
+
+  function validate (args, xhr) {
+    t.equals(this.params.protocol, 'data', 'XHR Data URL request recorded')
+    setTimeout(() => {
+      ee.removeEventListener('send-xhr-start', validate)
+      handleEE.removeEventListener('xhr', failCase)
+
+      t.pass('XHR Data URL request did not generate telemetry')
+      t.end()
+    }, 100)
+  }
+
+  function failCase (params, metrics, start) {
+    ee.removeEventListener('send-xhr-start', validate)
+    handleEE.removeEventListener('xhr', failCase)
+
+    t.fail('XHR Data URL request should not generate telemetry')
+  }
+})
+
+test('Data URL Fetch requests do not generate telemetry', function(t) {
+  if (!window.fetch) {
+    t.pass('fetch is not supported in this browser')
+    t.end()
+    return
+  }
+
+  handleEE.addEventListener('xhr', failCase)
+
+  ee.addEventListener('fetch-done', validate)
+
+  fetch('data:,dataUrl')
+
+  function validate () {
+    t.equals(this.params.protocol, 'data', 'Fetch data URL request recorded')
+
+    setTimeout(() => {
+      handleEE.removeEventListener('xhr', failCase)
+      ee.removeEventListener('fetch-done', validate)
+
+      t.pass('Fetch data URL request did not generate telemetry')
+      t.end()
+    }, 100)
+  }
+
+  function failCase(params, metrics, start) {
+    t.fail('Data URL Fetch requests should not generate telemetry')
+    handleEE.removeEventListener('xhr', failCase)
+    ee.removeEventListener('fetch-done', validate)
+  }
+})

tests/browser/xhr/parse-url.browser.js

@@ -79,6 +79,12 @@ function xhr_tests () {
           port: location.port,
           sameOrigin: true
         }
+      },
+      {
+        url: 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==',
+        results: {
+          protocol: 'data'
+        }
       }
     ]