feat: Origin of agent webpack chunks now changeable

babel.config.js

@@ -94,7 +94,8 @@ module.exports = function (api, ...args) {
         [
           './tools/babel/plugins/transform-import',
           {
-            '(constants/)env$': '$1env.npm'
+            '(constants/)env$': '$1env.npm',
+            '(configure/)public-path$': '$1public-path.npm'
           }
         ]
       ]
@@ -112,7 +113,8 @@ module.exports = function (api, ...args) {
         [
           './tools/babel/plugins/transform-import',
           {
-            '(constants/)env$': '$1env.npm'
+            '(constants/)env$': '$1env.npm',
+            '(configure/)public-path$': '$1public-path.npm'
           }
         ]
       ]

src/common/config/state/info.js

@@ -6,7 +6,6 @@ const model = {
   beacon: nrDefaults.beacon,
   errorBeacon: nrDefaults.errorBeacon,
   // others must be populated by user
-  assetsPath: undefined,
   licenseKey: undefined,
   applicationID: undefined,
   sa: undefined,

src/common/config/state/init.js

@@ -9,6 +9,7 @@ const model = () => {
   }
   return {
     allow_bfcache: true, // *cli - temporary feature flag for BFCache work
+    assetsPath: undefined,
     privacy: { cookies_enabled: true }, // *cli - per discussion, default should be true
     ajax: { deny_list: undefined, block_internal: true, enabled: true, harvestTimeSeconds: 10 },
     distributed_tracing: {

src/common/url/check-url.js

@@ -1,12 +1,27 @@
-export function isValidAssetUrl (string) {
-  /* Note: This API is not available in IE11 and throws in Safari v14- when base is undefined.
-    Hence, this will always return false for those environments.
+/**
+ * Checks input string to see if it's acceptable as agent's public path for loading source code.
+ * @param {string} string - supposed url string
+ * @returns Absolute url if 'string' is accepted. Empty string if it's denied.
+ */
+export function validateAssetUrl (string) {
+  if (!string || typeof string !== 'string') return ''
+
+  if (string.indexOf(':/') !== -1) {
+    if (!string.startsWith('http')) return '' // non http schemes, such as ftp, are not allowed to be an asset source
+  } else { // there's no scheme on this supposed URL, so we'll assume https -- the api will require a scheme.
+    if (string.startsWith('/')) return '' // no relative paths...
+    string = 'https://' + string
+  }
+  /* Note: URL API is not available in IE11 and throws in Safari v14- when base is undefined.
+    Hence, this will always return empty string for those environments.
   */
+  let properUrl
   try {
-    let url = new URL(string)
+    properUrl = new URL(string)
+    properUrl.protocol = 'https:' // enforce HTTPS over HTTP
   } catch (_) {
-    return false
+    return ''
   }
-  if (!string.endsWith('/')) return false // webpack concats base verbatim so this is a stringent req
-  return true
+  // We want a url with scheme, domain, and port minus username|password => origin; webpack concats this verbatim, so an ending slash is required
+  return properUrl.origin + '/'
 }

src/common/url/check-url.test.js

@@ -1,16 +1,15 @@
-import { isValidAssetUrl } from './check-url'
+import { validateAssetUrl } from './check-url'
 
-test('isValidAssetUrl works correctly', () => {
-  expect(isValidAssetUrl(undefined)).toEqual(false)
-  expect(isValidAssetUrl(123)).toEqual(false)
-  expect(isValidAssetUrl('')).toEqual(false)
-  expect(isValidAssetUrl('blah')).toEqual(false)
-  expect(isValidAssetUrl('/someRelativePath')).toEqual(false)
-  expect(isValidAssetUrl('www.missingscheme.com')).toEqual(false)
-  expect(isValidAssetUrl('http://noendingslash.net')).toEqual(false)
+test('validateAssetUrl works correctly', () => {
+  expect(validateAssetUrl(undefined)).toEqual('')
+  expect(validateAssetUrl(123)).toEqual('')
+  expect(validateAssetUrl('')).toEqual('')
+  expect(validateAssetUrl('/someRelativePath')).toEqual('')
+  expect(validateAssetUrl('data://anotherscheme.com/')).toEqual('')
 
-  expect(isValidAssetUrl('http://absolutepath.net/')).toEqual(true)
-  expect(isValidAssetUrl('https://www.absolutepath.org/')).toEqual(true)
-  expect(isValidAssetUrl('data://anotherscheme.com/')).toEqual(true)
-  expect(isValidAssetUrl('https://js-agent.nr.com/somepath/')).toEqual(true)
+  expect(validateAssetUrl('www.missingscheme.com/')).toEqual('https://www.missingscheme.com/')
+  expect(validateAssetUrl('http:/enforcescheme.net/')).toEqual('https://enforcescheme.net/')
+  expect(validateAssetUrl('enforceendslash.net:1234')).toEqual('https://enforceendslash.net:1234/')
+  expect(validateAssetUrl('https://www.absolutepath.org/somepath')).toEqual('https://www.absolutepath.org/')
+  expect(validateAssetUrl('js-agent.nr.com:9876/foo/bar?query=search')).toEqual('https://js-agent.nr.com:9876/')
 })

src/loaders/configure/configure.js

@@ -3,7 +3,7 @@ import { addToNREUM, gosCDN, gosNREUMInitializedAgents } from '../../common/wind
 import { getConfiguration, setConfiguration, setInfo, setLoaderConfig, setRuntime } from '../../common/config/config'
 import { activatedFeatures } from '../../common/util/feature-flags'
 import { isWorkerScope } from '../../common/constants/runtime'
-import { isValidAssetUrl } from '../../common/url/check-url'
+import { validateAssetUrl } from '../../common/url/check-url'
 import { redefinePublicPath } from './public-path'
 import { warn } from '../../common/util/console'
 
@@ -18,6 +18,11 @@ export function configure (agentIdentifier, opts = {}, loaderType, forceDrain) {
     loader_config = nr.loader_config
   }
 
+  if (init.assetsPath) {
+    const retVal = validateAssetUrl(init.assetsPath)
+    if (retVal !== '') redefinePublicPath(retVal)
+    else warn('New public path must be a valid URL. Chunk origin remains unchanged.')
+  }
   setConfiguration(agentIdentifier, init || {})
   // eslint-disable-next-line camelcase
   setLoaderConfig(agentIdentifier, loader_config || {})
@@ -26,10 +31,6 @@ export function configure (agentIdentifier, opts = {}, loaderType, forceDrain) {
   if (isWorkerScope) { // add a default attr to all worker payloads
     info.jsAttributes.isWorker = true
   }
-  if (info.assetsPath) {
-    if (isValidAssetUrl(info.assetsPath)) redefinePublicPath(info.assetsPath)
-    else warn('New assets path must be a valid URL. Chunk origin remains unchanged.')
-  }
   setInfo(agentIdentifier, info)
 
   const updatedInit = getConfiguration(agentIdentifier)

src/loaders/configure/public-path.js

@@ -1,9 +1,9 @@
 // Set the default CDN or remote for fetching the assets; NPM shouldn't change this var.
 if (typeof WEBP_CONST_PUBLIC_PATH !== 'undefined') {
-  __webpack_public_path__ = WEBP_CONST_PUBLIC_PATH
+  __webpack_public_path__ = WEBP_CONST_PUBLIC_PATH // eslint-disable-line
 }
 
 export const redefinePublicPath = (url) => {
   // There's no URL validation here, so caller should check arg if need be.
-  __webpack_public_path__ = url
+  __webpack_public_path__ = url // eslint-disable-line
 }

src/loaders/configure/public-path.npm.js

@@ -0,0 +1,4 @@
+
+export const redefinePublicPath = () => {
+  // We don't support setting public path in webpack via NPM build.
+}

tests/specs/proxy.e2e.js

@@ -7,7 +7,7 @@ describe('Using proxy servers -', () => {
     /** This is where we expect the agent to fetch its chunk. '/build/' is necessary within the URL because the way our asset server
      * handles each test requests -- see /testing-server/plugins/test-handle/index.js. */
     const assetServerChangedUrl = `http://${host}:${port}/build/fakepath/`
-    let url = await browser.testHandle.assetURL('instrumented.html', { config: { assetsPath: assetServerChangedUrl } })
+    let url = await browser.testHandle.assetURL('instrumented.html', { init: { assetsPath: assetServerChangedUrl } })
 
     // Expecting a GET to http://bam-test-1.nr-local.net:<asset port>/build/fakepath/nr-spa.min.js for chunk and response of 404 (no cross-origin)
     let expectRequest = browser.testHandle.expect('assetServer', {

tools/webpack/env.mjs

@@ -72,12 +72,6 @@ export default async (env) => {
   env.PUBLIC_PATH = PUBLIC_PATH
   env.VERSION = VERSION
 
-  // -- These are likely not being used(?)
-  // process.env.PATH_VERSION = PATH_VERSION
-  // process.env.SUBVERSION = SUBVERSION
-  // process.env.PUBLIC_PATH = PUBLIC_PATH
-  // process.env.VERSION = VERSION
-
   // These values are used in babel to replace ENV variables in src/common/constants/env.cdn.js
   process.env.BUILD_VERSION = VERSION
   process.env.BUILD_ENV = SUBVERSION