@newrelic/browser-agent 1.241.0 → 1.243.0

package/src/common/config/state/runtime.test.js

@@ -1,21 +0,0 @@
-let getRuntime, setRuntime
-beforeEach(async () => {
-  jest.resetModules()
-  ;({ getRuntime, setRuntime } = await import('./runtime.js'))
-})
-
-test('set/getRuntime should throw on an invalid agent id', () => {
-  // currently only checks if it's a truthy value
-  expect(() => setRuntime(undefined, {})).toThrow('require an agent id')
-  expect(() => getRuntime(undefined)).toThrow('require an agent id')
-  expect(() => setRuntime('', {})).toThrow('require an agent id')
-  expect(() => getRuntime('')).toThrow('require an agent id')
-})
-
-test('set/getRuntime works correctly', () => {
-  expect(() => setRuntime(123, { session: 1 })).not.toThrow() // notice setRuntime accepts numbers
-  let cachedObj = getRuntime('123')
-  expect(Object.keys(cachedObj).length).toBeGreaterThan(1)
-  expect(cachedObj.session).toEqual(1)
-  expect(cachedObj.maxBytes).toEqual(30000) // this should mirror default in runtime.js
-})

package/src/common/constants/env.cdn.test.js

@@ -1,7 +0,0 @@
-import * as env from './env.cdn'
-
-test('should default environment variables to CDN values', async () => {
-  expect(env.VERSION).toMatch(/\d{1,3}\.\d{1,3}\.\d{1,3}/)
-  expect(env.BUILD_ENV).toEqual('CDN')
-  expect(env.DIST_METHOD).toEqual('CDN')
-})

package/src/common/constants/env.npm.test.js

@@ -1,7 +0,0 @@
-import * as env from './env.npm'
-
-test('should default environment variables to NPM values', () => {
-  expect(env.VERSION).toMatch(/\d{1,3}\.\d{1,3}\.\d{1,3}/)
-  expect(env.BUILD_ENV).toEqual('NPM')
-  expect(env.DIST_METHOD).toEqual('NPM')
-})

package/src/common/constants/env.test.js

@@ -1,7 +0,0 @@
-import * as env from './env'
-
-test('should default environment variables to NPM values', () => {
-  expect(env.VERSION).toMatch(/\d{1,3}\.\d{1,3}\.\d{1,3}/)
-  expect(env.BUILD_ENV).toEqual('NPM')
-  expect(env.DIST_METHOD).toEqual('NPM')
-})

package/src/common/constants/runtime.test.js

@@ -1,176 +0,0 @@
-/**
- * The runtime module exports variables whose values are set at the time of import and
- * can depend on the environment the agent is running within. To make testing this module
- * easier, use async import to import the module and only use the node jest environment so
- * we can more easily define environment variables.
- * @jest-environment node
- */
-
-import { faker } from '@faker-js/faker'
-
-beforeEach(() => {
-  // We assume every runtime has a global navigator variable
-  global.navigator = {
-    userAgent: faker.lorem.sentence()
-  }
-})
-
-afterEach(() => {
-  delete global.navigator
-  jest.resetModules()
-})
-
-test('should indicate agent is running in a browser scope', async () => {
-  const mockedWindow = global.window = {
-    [faker.datatype.uuid()]: faker.lorem.sentence,
-    document: {
-      [faker.datatype.uuid()]: faker.lorem.sentence
-    }
-  }
-
-  const runtime = await import('./runtime')
-
-  delete global.window
-
-  expect(runtime.isBrowserScope).toEqual(true)
-  expect(runtime.isWorkerScope).toEqual(false)
-  expect(runtime.globalScope).toEqual(mockedWindow)
-})
-
-test('should indicate agent is running in a worker scope using global self variable', async () => {
-  global.WorkerGlobalScope = class WorkerGlobalScope {}
-  global.WorkerNavigator = class WorkerNavigator {}
-  const mockedGlobalSelf = global.self = new global.WorkerGlobalScope()
-  mockedGlobalSelf.navigator = new global.WorkerNavigator()
-
-  const runtime = await import('./runtime')
-
-  delete global.WorkerGlobalScope
-  delete global.WorkerNavigator
-  delete global.self
-
-  expect(runtime.isBrowserScope).toEqual(false)
-  expect(runtime.isWorkerScope).toEqual(true)
-  expect(runtime.globalScope).toEqual(mockedGlobalSelf)
-})
-
-test('should indicate agent is running in a worker scope using global self variable', async () => {
-  global.WorkerGlobalScope = class WorkerGlobalScope {}
-  global.WorkerNavigator = class WorkerNavigator {}
-  const cachedGlobalThis = global.globalThis
-  const mockedGlobalThis = global.globalThis = new WorkerGlobalScope()
-  Object.defineProperties(global.globalThis, Object.getOwnPropertyDescriptors(cachedGlobalThis))
-  global.globalThis.navigator = new WorkerNavigator()
-
-  const runtime = await import('./runtime')
-
-  delete global.WorkerGlobalScope
-  delete global.WorkerNavigator
-  global.globalThis = cachedGlobalThis
-
-  expect(runtime.isBrowserScope).toEqual(false)
-  expect(runtime.isWorkerScope).toEqual(true)
-  expect(runtime.globalScope).toEqual(mockedGlobalThis)
-})
-
-test('should store the initial page location', async () => {
-  const initialLocation = faker.internet.url()
-  const mockedWindow = global.window = {
-    [faker.datatype.uuid()]: faker.lorem.sentence,
-    document: {
-      [faker.datatype.uuid()]: faker.lorem.sentence
-    },
-    location: {
-      href: initialLocation,
-      toString () {
-        return this.href
-      }
-    }
-  }
-
-  const runtime = await import('./runtime')
-  mockedWindow.location.href = faker.internet.url()
-
-  delete global.window
-
-  expect(runtime.initialLocation).toEqual(initialLocation)
-  expect(runtime.initialLocation).not.toEqual(mockedWindow.location.href)
-})
-
-test.each([
-  { userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 16_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1', expected: true },
-  { userAgent: 'Mozilla/5.0 (iPad; CPU OS 16_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1', expected: true },
-  { userAgent: 'Mozilla/5.0 (iPod touch; CPU iPhone OS 16_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1', expected: true },
-  { userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 13_4) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Safari/605.1.15', expected: false },
-  { userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0', expected: false },
-  { userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 13.4; rv:109.0) Gecko/20100101 Firefox/114.0', expected: false }
-])('should set isiOS to $expected for $userAgent', async ({ userAgent, expected }) => {
-  global.navigator.userAgent = userAgent
-  global.window = { navigator: global.navigator, document: true }
-
-  const runtime = await import('./runtime')
-
-  expect(runtime.isiOS).toEqual(expected)
-  delete global.window
-})
-
-test.each([
-  { userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 16_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1', expected: false },
-  { userAgent: 'Mozilla/5.0 (iPad; CPU OS 16_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1', expected: false },
-  { userAgent: 'Mozilla/5.0 (iPod touch; CPU iPhone OS 16_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1', expected: false },
-  { userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Mobile/15E148 Safari/604.1', expected: true },
-  { userAgent: 'Mozilla/5.0 (iPad; CPU OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Mobile/15E148 Safari/604.1', expected: true },
-  { userAgent: 'Mozilla/5.0 (iPod touch; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Mobile/15E148 Safari/604.1', expected: true },
-  { userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 13_4) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Safari/605.1.15', expected: false },
-  { userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0', expected: false },
-  { userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 13.4; rv:109.0) Gecko/20100101 Firefox/114.0', expected: false }
-])('should set iOSBelow16 to $expected for $userAgent', async ({ userAgent, expected }) => {
-  if (!expected) {
-    global.SharedWorker = class SharedWorker {}
-  }
-  global.navigator.userAgent = userAgent
-  global.window = { navigator: global.navigator, document: true }
-
-  const runtime = await import('./runtime')
-
-  delete global.SharedWorker
-
-  expect(runtime.iOSBelow16).toEqual(expected)
-  delete global.window
-})
-
-test.each([
-  { userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 16_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1', expected: 0 },
-  { userAgent: 'Mozilla/5.0 (iPad; CPU OS 16_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1', expected: 0 },
-  { userAgent: 'Mozilla/5.0 (iPod touch; CPU iPhone OS 16_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Mobile/15E148 Safari/604.1', expected: 0 },
-  { userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 13_4) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5 Safari/605.1.15', expected: 0 },
-  { userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/114.0', expected: 114 },
-  { userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 13.4; rv:109.0) Gecko/20100101 Firefox/114.0', expected: 114 }
-])('should set ffVersion to $expected for $userAgent', async ({ userAgent, expected }) => {
-  global.navigator.userAgent = userAgent
-  global.window = { navigator: global.navigator, document: true }
-
-  const runtime = await import('./runtime')
-
-  expect(runtime.ffVersion).toEqual(expected)
-  delete global.window
-})
-
-test('should set supportsSendBeacon to false', async () => {
-  // Ensure we don't have a sendBeacon function
-  delete global.navigator.sendBeacon
-
-  const runtime = await import('./runtime')
-
-  expect(runtime.supportsSendBeacon).toEqual(false)
-})
-
-test('should set supportsSendBeacon to true', async () => {
-  global.navigator.sendBeacon = jest.fn()
-  global.window = { navigator: global.navigator, document: true }
-
-  const runtime = await import('./runtime')
-
-  expect(runtime.supportsSendBeacon).toEqual(true)
-  delete global.window
-})

package/src/common/deny-list/deny-list.test.js

@@ -1,104 +0,0 @@
-jest.enableAutomock()
-jest.unmock('./deny-list')
-
-let denyListModule
-
-beforeEach(async () => {
-  denyListModule = await import('./deny-list')
-})
-
-afterEach(() => {
-  jest.resetModules()
-})
-
-test('domain-only blocks all subdomains and all paths', () => {
-  denyListModule.setDenyList(['foo.com'])
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/a' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/a/b' })).toBeFalsy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'www.foo.com', pathname: '/' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'a.b.foo.com', pathname: '/' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'a.b.foo.com', pathname: '/c/d' })).toBeFalsy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'oo.com', pathname: '/' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bar.com', pathname: '/' })).toBeTruthy()
-})
-
-test('subdomain blocks further subdomains, but not parent domain', () => {
-  denyListModule.setDenyList(['bar.foo.com'])
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bar.foo.com', pathname: '/' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bar.foo.com', pathname: '/a' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bar.foo.com', pathname: '/a/b' })).toBeFalsy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'a.bar.foo.com', pathname: '/' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'a.bar.foo.com', pathname: '/a' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'a.bar.foo.com', pathname: '/a/b' })).toBeFalsy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/a' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/a/b' })).toBeTruthy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'oo.com', pathname: '/' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bar.com', pathname: '/' })).toBeTruthy()
-})
-
-test('* blocks all domains', () => {
-  denyListModule.setDenyList(['*'])
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'www.foo.com', pathname: '/' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bar.com', pathname: '/' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'www.bar.com', pathname: '/' })).toBeFalsy()
-})
-
-test('respects path', () => {
-  denyListModule.setDenyList(['bam.nr-data.net/somepath'])
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.net', pathname: '/somepath' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.net', port: '7890', protocol: 'https', host: 'bam.nr-data.net:7890', pathname: '/somepath' })).toBeFalsy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.com', pathname: '' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.com', pathname: '/someotherpath' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.com', pathname: '/some/otherpath' })).toBeTruthy()
-})
-
-test('ignores port', () => {
-  denyListModule.setDenyList(['bam.nr-data.net:1234'])
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.net', pathname: '', port: '4321' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.net', port: '7890', protocol: 'http', host: 'bam.nr-data.net:7890', pathname: '/somepath' })).toBeFalsy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.com', pathname: '' })).toBeTruthy()
-})
-
-test('ignores protocol', () => {
-  denyListModule.setDenyList(['http://bam.nr-data.net'])
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.net', pathname: '', protocol: 'https' })).toBeFalsy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.net', port: '7890', protocol: 'https', host: 'bam.nr-data.net:7890', pathname: '/somepath' })).toBeFalsy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bam.nr-data.com', pathname: '', protocol: 'http' })).toBeTruthy()
-})
-
-test.each([
-  null,
-  undefined,
-  '!@$%^*',
-  'https://example.com/http://foo.bar/'
-])('ignores invalid deny list value %s', (denyListValue) => {
-  denyListModule.setDenyList([denyListValue])
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/a' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'foo.com', pathname: '/a/b' })).toBeTruthy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'www.foo.com', pathname: '/' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'a.b.foo.com', pathname: '/' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'a.b.foo.com', pathname: '/c/d' })).toBeTruthy()
-
-  expect(denyListModule.shouldCollectEvent({ hostname: 'oo.com', pathname: '/' })).toBeTruthy()
-  expect(denyListModule.shouldCollectEvent({ hostname: 'bar.com', pathname: '/' })).toBeTruthy()
-})

package/src/common/drain/drain.test.js

@@ -1,74 +0,0 @@
-let registerDrain, drain, ee
-beforeEach(async () => {
-  jest.resetModules()
-  ;({ registerDrain, drain } = await import('./drain'))
-  ;({ ee } = await import('../event-emitter/contextual-ee'))
-})
-
-test('can register a feat and drain it', () => {
-  registerDrain('abcd', 'page_view_event')
-
-  let emitSpy = jest.spyOn(ee.get('abcd'), 'emit')
-  drain('abcd', 'page_view_event')
-  expect(emitSpy).toHaveBeenCalledWith('drain-page_view_event', expect.anything())
-})
-
-test('other unregistered drains do not affect feat reg & drain', () => {
-  registerDrain('abcd', 'page_view_event')
-
-  let emitSpy = jest.spyOn(ee.get('abcd'), 'emit')
-  drain('abcd', 'timon')
-  expect(emitSpy).toHaveBeenCalledWith('drain-timon', expect.anything())
-  expect(emitSpy).not.toHaveBeenCalledWith('drain-page_view_event', expect.anything())
-
-  drain('abcd', 'page_view_event')
-  expect(emitSpy).toHaveBeenCalledWith('drain-page_view_event', expect.anything())
-})
-
-describe('drain', () => {
-  test('does not execute until all registered groups calls it and in order', () => {
-    registerDrain('abcd', 'page_view_timing')
-    registerDrain('abcd', 'page_view_event')
-
-    let emitSpy = jest.spyOn(ee.get('abcd'), 'emit')
-    drain('abcd', 'page_view_event')
-    expect(emitSpy).not.toHaveBeenCalled()
-
-    drain('abcd', 'page_view_timing')
-    // The priority order of features is also checked here, even though the latter was registered first.
-    expect(emitSpy).toHaveBeenNthCalledWith(1, 'drain-page_view_event', expect.anything())
-    expect(emitSpy).toHaveBeenNthCalledWith(2, 'drain-page_view_timing', expect.anything())
-  })
-
-  test('does not require registration for non-feat groups', () => {
-    let emitSpy = jest.spyOn(ee.get('abcd'), 'emit')
-    drain('abcd', 'pumbaa')
-    expect(emitSpy).toHaveBeenCalledWith('drain-pumbaa', expect.anything())
-  })
-
-  test('defaults to "feature" group when not provided one', () => {
-    let emitSpy = jest.spyOn(ee.get('abcd'), 'emit')
-    drain('abcd')
-    expect(emitSpy).toHaveBeenCalledWith('drain-feature', expect.anything())
-  })
-
-  test('works on the global ee when agent id not provided', () => {
-    let emitSpy = jest.spyOn(ee, 'emit')
-    drain()
-    expect(emitSpy).toHaveBeenCalledWith('drain-feature', expect.anything())
-  })
-})
-
-test('non-feat groups can register and drain too alongside features', () => {
-  registerDrain('abcd', 'page_view_event')
-  registerDrain('abcd', 'simba')
-
-  console.log(JSON.stringify(ee.get('abcd')))
-  let emitSpy = jest.spyOn(ee.get('abcd'), 'emit')
-  drain('abcd', 'simba')
-  expect(emitSpy).not.toHaveBeenCalled()
-
-  drain('abcd', 'page_view_event')
-  expect(emitSpy).toHaveBeenNthCalledWith(1, 'drain-simba', expect.anything()) // non-feat have prio of 0
-  expect(emitSpy).toHaveBeenNthCalledWith(2, 'drain-page_view_event', expect.anything())
-})