fix: Add X-NewRelic-ID header only if defined (#531)

newrelic · May 17, 2023 · 36ceedf · 36ceedf
1 parent 806bcc4
commit 36ceedf
Show file tree

Hide file tree

Showing 5 changed files with 87 additions and 18 deletions.
diff --git a/src/features/ajax/instrument/index.js b/src/features/ajax/instrument/index.js
@@ -99,7 +99,7 @@ function subscribeToEvents (agentIdentifier, ee, handler, dt) {
 
   function onOpenXhrEnd (args, xhr) {
     var loader_config = getLoaderConfig(agentIdentifier)
-    if ('xpid' in loader_config && this.sameOrigin) {
+    if (loader_config.xpid && this.sameOrigin) {
       xhr.setRequestHeader('X-NewRelic-ID', loader_config.xpid)
     }
 

diff --git a/tests/assets/cat-cors.html b/tests/assets/cat-cors.html
@@ -6,18 +6,19 @@
 <html>
   <head>
     <meta charset="utf-8">
-    <title>Example Page</title>
+    <title>CAT header on CORS XHR</title>
     {init}
-    {config}
-    {loader}
     <script type="text/javascript">
       if (!NREUM.loader_config) NREUM.loader_config = {}
       NREUM.loader_config.xpid = '12#34'
-
+    </script>
+    {config}
+    {loader}
+    <script type="text/javascript">
       var xhr = new XMLHttpRequest()
-      var testId = window.location.search.match(/testId=([^&]*)/)[1]
+      var testIdMatches = window.location.search.match(/testId=([^&]*)/)
+      var testId = testIdMatches ? testIdMatches[1] : ''
       var url = 'http://' + NREUM.info.beacon + '/cat-cors/' + testId
-
       xhr.open('GET', url)
       xhr.send()
     </script>

diff --git a/tests/assets/cat-same-origin.html b/tests/assets/cat-same-origin.html
@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<!--
+  Copyright 2020 New Relic Corporation.
+  PDX-License-Identifier: Apache-2.0
+-->
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>CAT header on same-origin XHR</title>
+    {init}
+    <script type="text/javascript">
+      if (!NREUM.loader_config) NREUM.loader_config = {}
+      try {
+        NREUM.loader_config.xpid = window.location.search.match(/xpid=([^&]*)/)[1]
+      } catch (e) {
+        NREUM.loader_config.xpid = '12#36'
+      }
+    </script>
+    {config}
+    {loader}
+    <script type="text/javascript">
+      var xhr = new XMLHttpRequest()
+      var testIdMatches = window.location.search.match(/testId=([^&]*)/)
+      var testId = testIdMatches ? testIdMatches[1] : ''
+      var url = '/same-origin/' + testId
+      xhr.open('GET', url)
+      xhr.send()
+    </script>
+  </head>
+  <body>
+  </body>
+</html>
diff --git a/tests/functional/xhr/cat-cors.test.js b/tests/functional/xhr/cat-cors.test.js
@@ -6,7 +6,7 @@
 const testDriver = require('../../../tools/jil/index')
 const { fail } = require('./helpers')
 
-testDriver.test('does not set CAT headers on outbound XHRs to different origin', function (t, browser, router) {
+testDriver.test('does not set CAT header on cross-origin XHRs', function (t, browser, router) {
   t.plan(1)
 
   const ajaxPromise = router.expect('bamServer', {
@@ -23,3 +23,39 @@ testDriver.test('does not set CAT headers on outbound XHRs to different origin',
     })
     .catch(fail(t, 'unexpected error'))
 })
+
+testDriver.test('sets CAT header on same origin XHRs if xpid is defined', function (t, browser, router) {
+  t.plan(1)
+
+  const ajaxPromise = router.expect('assetServer', {
+    test: function (request) {
+      const url = new URL(request.url, 'resolve://')
+      return url.pathname === `/same-origin/${router.testId}`
+    }
+  })
+  let loadPromise = browser.get(router.assetURL('cat-same-origin.html', { testId: router.testId }))
+
+  Promise.all([ajaxPromise, loadPromise])
+    .then(([{ request }]) => {
+      t.ok(request.headers['x-newrelic-id'], 'same-origin XHR should have CAT header if xpid is specified')
+    })
+    .catch(fail(t, 'unexpected error'))
+})
+
+testDriver.test('does not set CAT header on same origin XHRs if xpid is undefined', function (t, browser, router) {
+  t.plan(1)
+
+  const ajaxPromise = router.expect('assetServer', {
+    test: function (request) {
+      const url = new URL(request.url, 'resolve://')
+      return url.pathname === `/same-origin/${router.testId}`
+    }
+  })
+  let loadPromise = browser.get(router.assetURL('cat-same-origin.html', { testId: router.testId, xpid: '' }))
+
+  Promise.all([ajaxPromise, loadPromise])
+    .then(([{ request }]) => {
+      t.notok(request.headers['x-newrelic-id'], 'same-origin XHR should not have CAT header if xpid is undefined')
+    })
+    .catch(fail(t, 'unexpected error'))
+})
diff --git a/tools/browsers-lists/browsers-supported.json b/tools/browsers-lists/browsers-supported.json
@@ -2,17 +2,17 @@
   "chrome": [
     {
       "browserName": "chrome",
-      "platformName": "Windows 10",
-      "platform": "Windows 10",
-      "version": "103",
-      "browserVersion": "103"
+      "platformName": "Windows 11",
+      "platform": "Windows 11",
+      "version": "104",
+      "browserVersion": "104"
     },
     {
       "browserName": "chrome",
       "platformName": "Windows 10",
       "platform": "Windows 10",
-      "version": "106",
-      "browserVersion": "106"
+      "version": "107",
+      "browserVersion": "107"
     },
     {
       "browserName": "chrome",
@@ -34,15 +34,15 @@
       "browserName": "MicrosoftEdge",
       "platformName": "Windows 10",
       "platform": "Windows 10",
-      "version": "103",
-      "browserVersion": "103"
+      "version": "104",
+      "browserVersion": "104"
     },
     {
       "browserName": "MicrosoftEdge",
       "platformName": "Windows 11",
       "platform": "Windows 11",
-      "version": "106",
-      "browserVersion": "106"
+      "version": "107",
+      "browserVersion": "107"
     },
     {
       "browserName": "MicrosoftEdge",