@newrelic/browser-agent 1.256.1 → 1.258.0

package/dist/types/loaders/api/apiAsync.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apiAsync.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/apiAsync.js"],"names":[],"mappings":"AAQA,mDA8CC"}
+{"version":3,"file":"apiAsync.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/apiAsync.js"],"names":[],"mappings":"AASA,mDA8CC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newrelic/browser-agent",
-  "version": "1.256.1",
+  "version": "1.258.0",
   "private": false,
   "author": "New Relic Browser Agent Team <browser-agent@newrelic.com>",
   "description": "New Relic Browser Agent",

package/src/common/config/state/configurable.js

@@ -11,14 +11,15 @@ export function getModeledObject (obj, model) {
     )
     const target = Object.keys(output).length === 0 ? obj : output
     for (let key in target) {
-      if (obj[key] !== undefined) {
-        try {
-          if (Array.isArray(obj[key]) && Array.isArray(model[key])) output[key] = Array.from(new Set([...obj[key], ...model[key]]))
-          else if (typeof obj[key] === 'object' && typeof model[key] === 'object') output[key] = getModeledObject(obj[key], model[key])
-          else output[key] = obj[key]
-        } catch (e) {
-          warn('An error occurred while setting a property of a Configurable', e)
-        }
+      if (obj[key] === undefined) continue
+      try {
+        if (obj[key] === null) { output[key] = null; continue }
+
+        if (Array.isArray(obj[key]) && Array.isArray(model[key])) output[key] = Array.from(new Set([...obj[key], ...model[key]]))
+        else if (typeof obj[key] === 'object' && typeof model[key] === 'object') output[key] = getModeledObject(obj[key], model[key])
+        else output[key] = obj[key]
+      } catch (e) {
+        warn('An error occurred while setting a property of a Configurable', e)
       }
     }
     return output

package/src/common/config/state/init.js

@@ -46,7 +46,6 @@ const model = () => {
       allowed_origins: undefined
     },
     session: {
-      domain: undefined, // used by first party cookies to set the top-level domain
       expiresMs: DEFAULT_EXPIRES_MS,
       inactiveMs: DEFAULT_INACTIVE_MS
     },

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

@@ -1,19 +1,21 @@
 import { getModeledObject } from './configurable'
 import { getNREUMInitializedAgent } from '../../window/nreum'
-import { globalScope } from '../../constants/runtime'
+import { globalScope, originTime } from '../../constants/runtime'
 import { BUILD_ENV, DIST_METHOD, VERSION } from '../../constants/env'
 
-const model = {
+const readonly = {
   buildEnv: BUILD_ENV,
+  distMethod: DIST_METHOD,
+  version: VERSION,
+  originTime
+}
+
+const model = {
   customTransaction: undefined,
   disabled: false,
-  distMethod: DIST_METHOD,
   isolatedBacklog: false,
   loaderType: undefined,
   maxBytes: 30000,
-  // The "timeOrigin" property is the new standard timestamp property shared across main frame and workers, but is not supported in some early Safari browsers (safari<15) + IE
-  // ingest expects an integer value, and timeOrigin can return a float.
-  offset: Math.floor(globalScope?.performance?.timeOrigin || globalScope?.performance?.timing?.navigationStart || Date.now()),
   onerror: undefined,
   origin: '' + globalScope.location,
   ptid: undefined,
@@ -21,8 +23,6 @@ const model = {
   /** Agent-specific metadata found in the RUM call response. ex. entityGuid */
   appMetadata: {},
   session: undefined,
-  xhrWrappable: typeof globalScope.XMLHttpRequest?.prototype?.addEventListener === 'function',
-  version: VERSION,
   denyList: undefined,
   harvestCount: 0,
   timeKeeper: undefined
@@ -38,7 +38,10 @@ export function getRuntime (id) {
 
 export function setRuntime (id, obj) {
   if (!id) throw new Error('All runtime objects require an agent identifier!')
-  _cache[id] = getModeledObject(obj, model)
+  _cache[id] = {
+    ...getModeledObject(obj, model),
+    ...readonly
+  }
   const agentInst = getNREUMInitializedAgent(id)
   if (agentInst) agentInst.runtime = _cache[id]
 }

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

@@ -6,3 +6,5 @@ export const isiOS = false
 export const iOSBelow16 = false
 export const ffVersion = 0
 export const supportsSendBeacon = true
+
+export const originTime = Date.now()

package/src/common/constants/runtime.js

@@ -74,4 +74,9 @@ export const isIE = Boolean(isBrowserScope && window.document.documentMode) // d
 
 export const supportsSendBeacon = !!globalScope.navigator?.sendBeacon
 
-export const offset = Math.floor(Date.now() - performance.now())
+/**
+ * Represents the absolute timestamp in milliseconds that the page was loaded
+ * according to the browser's local clock.
+ * @type {number}
+ */
+export const originTime = Math.floor(Date.now() - performance.now())

package/src/common/drain/__mocks__/drain.js

@@ -0,0 +1,2 @@
+export const drain = jest.fn()
+export const registerDrain = jest.fn()

package/src/common/harvest/harvest.js

@@ -103,7 +103,7 @@ export class Harvest extends SharedContext {
     if (customUrl) url = customUrl
     if (raw) url = `${protocol}://${perceviedBeacon}/${endpoint}`
 
-    const baseParams = !raw && includeBaseParams ? this.baseQueryString(qs) : ''
+    const baseParams = !raw && includeBaseParams ? this.baseQueryString(qs, endpoint) : ''
     let payloadParams = encodeObj(qs, agentRuntime.maxBytes)
     if (!submitMethod) {
       submitMethod = submitData.getSubmitMethod({ isFinalHarvest: opts.unload })
@@ -167,14 +167,15 @@ export class Harvest extends SharedContext {
   }
 
   // The stuff that gets sent every time.
-  baseQueryString (qs) {
+  baseQueryString (qs, endpoint) {
     const runtime = getRuntime(this.sharedContext.agentIdentifier)
     const info = getInfo(this.sharedContext.agentIdentifier)
 
     const location = cleanURL(getLocation())
     const ref = this.obfuscator.shouldObfuscate() ? this.obfuscator.obfuscateString(location) : location
+    const hr = runtime?.session?.state.sessionReplayMode === 1 && endpoint !== 'jserrors'
 
-    return ([
+    const qps = [
       'a=' + info.applicationID,
       encodeParam('sa', (info.sa ? '' + info.sa : '')),
       encodeParam('v', VERSION),
@@ -184,9 +185,10 @@ export class Harvest extends SharedContext {
       '&ck=0', // ck param DEPRECATED - still expected by backend
       '&s=' + (runtime.session?.state.value || '0'), // the 0 id encaps all untrackable and default traffic
       encodeParam('ref', ref),
-      encodeParam('ptid', (runtime.ptid ? '' + runtime.ptid : '')),
-      encodeParam('hr', (runtime?.session?.state.sessionReplayMode === 1 ? '1' : '0'), qs) // hasReplay
-    ].join(''))
+      encodeParam('ptid', (runtime.ptid ? '' + runtime.ptid : ''))
+    ]
+    if (hr) qps.push(encodeParam('hr', '1', qs))
+    return qps.join('')
   }
 
   /**

package/src/common/session/constants.js

@@ -4,6 +4,7 @@ export const DEFAULT_EXPIRES_MS = 14400000
 export const DEFAULT_INACTIVE_MS = 1800000
 
 export const SESSION_EVENTS = {
+  STARTED: 'session-started',
   PAUSE: 'session-pause',
   RESET: 'session-reset',
   RESUME: 'session-resume',

package/src/common/session/session-entity.js

@@ -24,6 +24,7 @@ const model = {
   sessionReplaySentFirstChunk: false,
   sessionTraceMode: MODE.OFF,
   traceHarvestStarted: false,
+  serverTimeDiff: null, // set by TimeKeeper; "undefined" value will not be stringified and stored but "null" will
   custom: {}
 }
 
@@ -135,6 +136,7 @@ export class SessionEntity {
     else this.sync(initialRead)
 
     this.initialized = true
+    this.ee.emit(SESSION_EVENTS.STARTED, [this.isNew])
   }
 
   // This is the actual key appended to the storage API

package/src/common/timing/time-keeper.js

@@ -1,3 +1,8 @@
+import { originTime } from '../constants/runtime'
+import { ee as baseEE } from '../event-emitter/contextual-ee'
+import { getRuntime } from '../config/config'
+import { SESSION_EVENT_TYPES, SESSION_EVENTS } from '../session/constants'
+
 /**
  * Class used to adjust the timestamp of harvested data to New Relic server time. This
  * is done by tracking the performance timings of the RUM call and applying a calculation
@@ -5,10 +10,10 @@
  */
 export class TimeKeeper {
   /**
-   * Represents the browser origin time.
-   * @type {number}
+   * Pointer to the current agent session if it exists.
+   * @type {import('../session/session-entity').SessionEntity}
    */
-  #originTime
+  #session
 
   /**
    * Represents the browser origin time corrected to NR server time.
@@ -30,18 +35,25 @@ export class TimeKeeper {
    */
   #ready = false
 
-  constructor () {
-    this.#originTime = Date.now() - performance.now()
+  constructor (agentIdentifier) {
+    this.#session = getRuntime(agentIdentifier)?.session
+
+    if (this.#session) {
+      const ee = baseEE.get(agentIdentifier)
+      ee.on(SESSION_EVENTS.UPDATE, this.#processSessionUpdate.bind(this))
+      ee.on(SESSION_EVENTS.STARTED, () => {
+        if (this.#ready) {
+          this.#session.write({ serverTimeDiff: this.#localTimeDiff })
+        }
+      })
+      this.#processSessionUpdate(null, this.#session.read())
+    }
   }
 
   get ready () {
     return this.#ready
   }
 
-  get originTime () {
-    return this.#originTime
-  }
-
   get correctedOriginTime () {
     return this.#correctedOriginTime
   }
@@ -53,6 +65,8 @@ export class TimeKeeper {
    * @param endTime {number} The end time of the RUM request
    */
   processRumRequest (rumRequest, startTime, endTime) {
+    if (this.#ready) return // Server time calculated from session entity
+
     const responseDateHeader = rumRequest.getResponseHeader('Date')
     if (!responseDateHeader) {
       throw new Error('Missing date header on rum response.')
@@ -63,12 +77,13 @@ export class TimeKeeper {
 
     // Corrected page origin time
     this.#correctedOriginTime = Math.floor(Date.parse(responseDateHeader) - serverOffset)
-    this.#localTimeDiff = this.#originTime - this.#correctedOriginTime
+    this.#localTimeDiff = originTime - this.#correctedOriginTime
 
     if (Number.isNaN(this.#correctedOriginTime)) {
       throw new Error('Date header invalid format.')
     }
 
+    if (this.#session) this.#session.write({ serverTimeDiff: this.#localTimeDiff })
     this.#ready = true
   }
 
@@ -90,4 +105,23 @@ export class TimeKeeper {
   correctAbsoluteTimestamp (timestamp) {
     return Math.floor(timestamp - this.#localTimeDiff)
   }
+
+  /**
+   * Processes a session entity update payload to extract the server time calculated.
+   * @param {import('../session/constants').SESSION_EVENT_TYPES | null} type
+   * @param {Object} data
+   */
+  #processSessionUpdate (type, data) {
+    if (typeof data?.serverTimeDiff !== 'number') return
+
+    if (
+      (!type && !this.#ready) || // This captures the initial read from the session entity when the timekeeper first initializes
+      type === SESSION_EVENT_TYPES.CROSS_TAB // This captures any cross-tab write of the session entity
+    ) {
+      // This captures the initial read from the session entity when the timekeeper first initializes
+      this.#localTimeDiff = data.serverTimeDiff
+      this.#correctedOriginTime = originTime - this.#localTimeDiff
+      this.#ready = true
+    }
+  }
 }

package/src/common/vitals/time-to-first-byte.js

@@ -1,4 +1,4 @@
-import { globalScope, isBrowserScope, isiOS, offset } from '../constants/runtime'
+import { globalScope, isBrowserScope, isiOS, originTime } from '../constants/runtime'
 import { VITAL_NAMES } from './constants'
 import { VitalMetric } from './vital-metric'
 import { onTTFB } from 'web-vitals/attribution'
@@ -14,7 +14,7 @@ if (isBrowserScope && typeof PerformanceNavigationTiming !== 'undefined' && !isi
   if (!timeToFirstByte.isValid) {
     const entry = {}
     // convert real timestamps to relative timestamps to match web-vitals behavior
-    for (let key in globalScope?.performance?.timing || {}) entry[key] = Math.max(globalScope?.performance?.timing[key] - offset, 0)
+    for (let key in globalScope?.performance?.timing || {}) entry[key] = Math.max(globalScope?.performance?.timing[key] - originTime, 0)
 
     // ttfb is equiv to document's responseStart property in timing API --> https://developer.mozilla.org/en-US/docs/Web/API/PerformanceTiming/responseStart
     timeToFirstByte.update({ value: entry.responseStart, attrs: { navigationEntry: entry } })

package/src/common/vitals/vital-metric.js

@@ -9,7 +9,7 @@ export class VitalMetric {
   }
 
   update ({ value, attrs = {} }) {
-    if (value < 0) return
+    if (value === undefined || value === null || value < 0) return
     const state = {
       value: this.roundingMethod(value),
       name: this.name,

package/src/common/window/__mocks__/load.js

@@ -0,0 +1,3 @@
+export const checkState = jest.fn()
+export const onWindowLoad = jest.fn()
+export const onDOMContentLoaded = jest.fn()

package/src/features/ajax/aggregate/chunk.js

@@ -0,0 +1,51 @@
+import { nullable, numeric, getAddStringContext, addCustomAttributes } from '../../../common/serialize/bel-serializer'
+import { getInfo } from '../../../common/config/config'
+
+export default class Chunk {
+  constructor (events, aggregateInstance) {
+    this.addString = getAddStringContext(aggregateInstance.agentIdentifier) // pass agentIdentifier here
+    this.events = events
+    this.payload = 'bel.7;'
+
+    for (let i = 0; i < events.length; i++) {
+      const event = events[i]
+      const fields = [
+        numeric(event.startTime),
+        numeric(event.endTime - event.startTime),
+        numeric(0), // callbackEnd
+        numeric(0), // no callbackDuration for non-SPA events
+        this.addString(event.method),
+        numeric(event.status),
+        this.addString(event.domain),
+        this.addString(event.path),
+        numeric(event.requestSize),
+        numeric(event.responseSize),
+        event.type === 'fetch' ? 1 : '',
+        this.addString(0), // nodeId
+        nullable(event.spanId, this.addString, true) + // guid
+        nullable(event.traceId, this.addString, true) + // traceId
+        nullable(event.spanTimestamp, numeric, false) // timestamp
+      ]
+
+      let insert = '2,'
+
+      // Since configuration objects (like info) are created new each time they are set, we have to grab the current pointer to the attr object here.
+      const jsAttributes = getInfo(aggregateInstance.agentIdentifier).jsAttributes
+
+      // add custom attributes
+      // gql decorators are added as custom attributes to alleviate need for new BEL schema
+      const attrParts = addCustomAttributes({ ...(jsAttributes || {}), ...(event.gql || {}) }, this.addString)
+      fields.unshift(numeric(attrParts.length))
+
+      insert += fields.join(',')
+      if (attrParts && attrParts.length > 0) {
+        insert += ';' + attrParts.join(';')
+      }
+      if ((i + 1) < events.length) insert += ';'
+
+      this.payload += insert
+    }
+
+    this.tooBig = this.payload.length * 2 > aggregateInstance.MAX_PAYLOAD_SIZE
+  }
+}