feat: Handle duplicate agent APIs (#1418)

Author: ellisong

src/loaders/api/api.js

@@ -32,13 +32,13 @@ export function setTopLevelCallers () {
   function caller (fnName, ...args) {
     let returnVals = []
     Object.values(nr.initializedAgents).forEach(val => {
-      if (!val || !val.api) {
+      if (!val || !val.api || !val.runtime) {
         warn(38, fnName)
-      } else if (val.exposed && val.api[fnName]) {
+      } else if (val.exposed && val.api[fnName] && val.runtime.loaderType !== 'micro-agent') {
         returnVals.push(val.api[fnName](...args))
       }
     })
-    return returnVals.length > 1 ? returnVals : returnVals[0]
+    return returnVals[0]
   }
 }
 

tests/specs/npm/micro-agent.e2e.js

@@ -91,4 +91,21 @@ describe('micro-agent', () => {
       return true
     }
   })
+
+  it('returns null on top-level spa api interaction call', async () => {
+    await browser.url(await browser.testHandle.assetURL('test-builds/browser-agent-wrapper/micro-agent.html'))
+
+    const ixn = await browser.execute(function () {
+      var opts = {
+        info: NREUM.info,
+        init: NREUM.init
+      }
+      window.agent1 = new MicroAgent({ ...opts, info: { ...opts.info, applicationID: 1 } })
+
+      // top-level interaction call should return null since there is no non-micro agent to respond to the api call
+      return window.newrelic.interaction()
+    })
+
+    expect(ixn).toBeNull()
+  })
 })

tests/specs/npm/multi-agent.e2e.js

@@ -0,0 +1,21 @@
+/* globals MicroAgent */
+
+describe('multi-agent', () => {
+  it('has a single interaction response on top-level spa api interaction call', async () => {
+    await browser.url(await browser.testHandle.assetURL('test-builds/browser-agent-wrapper/multi-agent.html'))
+
+    const ixn = await browser.execute(function () {
+      var opts = {
+        info: NREUM.info,
+        init: NREUM.init
+      }
+      window.agent1 = new MicroAgent({ ...opts, info: { ...opts.info, applicationID: 1 } })
+
+      // micro-agents are forbidden to respond to a top-level api call, so only the non-micro agent's interaction should exist
+      return window.newrelic.interaction()
+    })
+
+    // a single interaction should have api methods defined on them
+    expect(ixn.get).toBeDefined()
+  })
+})

tests/unit/loaders/api/api.test.js

@@ -32,7 +32,7 @@ describe('setTopLevelCallers', () => {
     expect(typeof nreum.wrapLogger).toEqual('function')
   })
 
-  test('should forward calls to initialized and exposed agents', () => {
+  test('should forward calls to the first initialized and exposed agent that is not a micro-agent', () => {
     setTopLevelCallers()
 
     const nreum = gosCDN()
@@ -41,18 +41,27 @@ describe('setTopLevelCallers', () => {
         exposed: true,
         api: {
           setErrorHandler: jest.fn()
+        },
+        runtime: {
+          loaderType: 'micro-agent'
         }
       },
       [faker.string.uuid()]: {
         exposed: true,
         api: {
           setErrorHandler: jest.fn()
+        },
+        runtime: {
+          loaderType: 'browser-agent'
         }
       },
       [faker.string.uuid()]: {
         exposed: false,
         api: {
           setErrorHandler: jest.fn()
+        },
+        runtime: {
+          loaderType: 'browser-agent'
         }
       }
     }
@@ -61,7 +70,7 @@ describe('setTopLevelCallers', () => {
     nreum.setErrorHandler(errorHandler)
 
     Object.values(nreum.initializedAgents).forEach(agent => {
-      if (agent.exposed) {
+      if (agent.exposed && agent.runtime.loaderType === 'browser-agent') {
         expect(agent.api.setErrorHandler).toHaveBeenCalledTimes(1)
         expect(agent.api.setErrorHandler).toHaveBeenCalledWith(errorHandler)
       } else {
@@ -70,31 +79,7 @@ describe('setTopLevelCallers', () => {
     })
   })
 
-  test('should return a single value when only one exposed agent returns a value', () => {
-    setTopLevelCallers()
-
-    const nreum = gosCDN()
-    const expected = faker.string.uuid()
-    nreum.initializedAgents = {
-      [faker.string.uuid()]: {
-        exposed: true,
-        api: {
-          interaction: jest.fn().mockReturnValue(expected)
-        }
-      },
-      [faker.string.uuid()]: {
-        exposed: false,
-        api: {
-          interaction: jest.fn().mockReturnValue(expected)
-        }
-      }
-    }
-
-    const result = nreum.interaction()
-    expect(result).toEqual(expected)
-  })
-
-  test('should return an array of values for each exposed agent that returns a value', () => {
+  test('should return a single value for the first exposed browser-agent in the nreum initialized agents array', () => {
     setTopLevelCallers()
 
     const nreum = gosCDN()
@@ -104,23 +89,32 @@ describe('setTopLevelCallers', () => {
         exposed: true,
         api: {
           interaction: jest.fn().mockReturnValue(expected)
+        },
+        runtime: {
+          loaderType: 'browser-agent'
         }
       },
       [faker.string.uuid()]: {
         exposed: true,
         api: {
           interaction: jest.fn().mockReturnValue(expected)
+        },
+        runtime: {
+          loaderType: 'browser-agent'
         }
       },
       [faker.string.uuid()]: {
         exposed: false,
         api: {
           interaction: jest.fn().mockReturnValue(expected)
+        },
+        runtime: {
+          loaderType: 'browser-agent'
         }
       }
     }
 
     const result = nreum.interaction()
-    expect(result).toEqual([expected, expected])
+    expect(result).toEqual(expected)
   })
 })

tools/test-builds/browser-agent-wrapper/webpack.config.js

@@ -13,6 +13,18 @@ const htmlTemplate = (script) => `<html>
     <h1>This is a generic page that is instrumented by the NPM agent</h1>
   </body>
 </html>`
+const multiAgentHtmlTemplate = () => `<html>
+  <head>
+    <title>RUM Unit Test</title>
+    {init}
+    {config}
+    <script src="browser-agent.js"></script>
+    <script src="micro-agent.js"></script>
+  </head>
+  <body>
+    <h1>This is a generic page that is instrumented by the NPM agent. It has a main agent and a micro agent running together.</h1>
+  </body>
+</html>`
 const workerHtmlTemplate = `<html>
   <head>
     <title>RUM Unit Test</title>
@@ -115,6 +127,12 @@ const config = [
         minify: false,
         inject: false,
         templateContent: htmlTemplate('micro-agent')
+      }),
+      new HtmlWebpackPlugin({
+        filename: 'multi-agent.html',
+        minify: false,
+        inject: false,
+        templateContent: multiAgentHtmlTemplate()
       })
     ]
   },