@newrelic/browser-agent 0.1.230 → 1.232.0

package/src/common/ids/unique-id.js

@@ -5,77 +5,100 @@
 
 import { globalScope } from '../util/global-scope'
 
+const uuidv4Template = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
+
+/**
+ * Creates a random single hexadecimal value from a provided random value
+ * table and corresponding index. If a random value table is not provided,
+ * Math.random will be used to generate the value.
+ *
+ * @param {Uint8Array} valueTable Random value table typically generated using
+ * the built-in crypto engine.
+ * @param {int} tableIndex The index of the value table to use for generating
+ * the hexadecimal value.
+ * @returns {int} single hexadecimal value in decimal format
+ */
+function getRandomValue (valueTable, tableIndex) {
+  if (valueTable) {
+    /**
+     * The value table could have any number value in the given index. Use
+     * bitwise AND to ensure the value we generate is a valid hex value.
+     * x & 15 will ensure the value converted to hex using `toString(16)`
+     * falls within the range of 0 and 15 inclusively.
+     */
+    return valueTable[tableIndex] & 15
+  } else {
+    return Math.random() * 16 | 0
+  }
+}
+
+/**
+ * Generates a RFC compliant UUIDv4 using native browser crypto engine. If the browser
+ * does not support the crypto engine, the function will fallback to insecure Math.random()
+ * @returns {string} uuid version 4 string
+ */
 export function generateUuid () {
-  var randomVals = null
-  var rvIndex = 0
-  var crypto = globalScope?.crypto || globalScope?.msCrypto
+  const crypto = globalScope?.crypto || globalScope?.msCrypto
+
+  let randomValueTable
+  let randomValueIndex = 0
   if (crypto && crypto.getRandomValues) {
     // eslint-disable-next-line
-    randomVals = crypto.getRandomValues(new Uint8Array(31))
-  }
-
-  function getRandomValue () {
-    if (randomVals) {
-      // same as % 16
-      return randomVals[rvIndex++] & 15
-    } else {
-      return Math.random() * 16 | 0
-    }
+    randomValueTable = crypto.getRandomValues(new Uint8Array(31))
   }
 
-  // v4 UUID
-  var template = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
-  var id = ''
-  var c
-  for (var i = 0; i < template.length; i++) {
-    c = template[i]
-    if (c === 'x') {
-      id += getRandomValue().toString(16)
-    } else if (c === 'y') {
+  return uuidv4Template.split('').map(templateInput => {
+    if (templateInput === 'x') {
+      return getRandomValue(randomValueTable, ++randomValueIndex).toString(16)
+    } else if (templateInput === 'y') {
       // this is the uuid variant per spec (8, 9, a, b)
       // % 4, then shift to get values 8-11
-      c = getRandomValue() & 0x3 | 0x8
-      id += c.toString(16)
+      return (getRandomValue() & 0x3 | 0x8).toString(16)
     } else {
-      id += c
+      return templateInput
     }
-  }
-
-  return id
-}
-
-// 16-character hex string (per DT spec)
-export function generateSpanId () {
-  return generateRandomHexString(16)
-}
-
-// 32-character hex string (per DT spec)
-export function generateTraceId () {
-  return generateRandomHexString(32)
+  }).join('')
 }
 
+/**
+ * Generates a string of the given length containing only hexadecimal
+ * value 0-9 and a-f.
+ * @param {int} length length of the string to generate
+ * @returns {string} generated hex string
+ */
 export function generateRandomHexString (length) {
-  var randomVals = null
-  var rvIndex = 0
-  var crypto = self.crypto || self.msCrypto
-  // eslint-disable-next-line
-  if (crypto && crypto.getRandomValues && Uint8Array) {
+  const crypto = globalScope?.crypto || globalScope?.msCrypto
+
+  let randomValueTable
+  let randomValueIndex = 0
+  if (crypto && crypto.getRandomValues) {
     // eslint-disable-next-line
-    randomVals = crypto.getRandomValues(new Uint8Array(31))
+    randomValueTable = crypto.getRandomValues(new Uint8Array(31))
   }
 
-  var chars = []
+  const chars = []
   for (var i = 0; i < length; i++) {
-    chars.push(getRandomValue().toString(16))
+    chars.push(getRandomValue(randomValueTable, ++randomValueIndex).toString(16))
   }
   return chars.join('')
+}
 
-  function getRandomValue () {
-    if (randomVals) {
-      // same as % 16
-      return randomVals[rvIndex++] & 15
-    } else {
-      return Math.random() * 16 | 0
-    }
-  }
+/**
+ * Generates a 16 character length hexadecimal string.
+ * per DT-spec.
+ * @see generateRandomHexString
+ * @returns {string} generated hex string
+ */
+export function generateSpanId () {
+  return generateRandomHexString(16)
+}
+
+/**
+ * Generates a 32 character length hexadecimal string.
+ * per DT-spec.
+ * @see generateRandomHexString
+ * @returns {string} generated hex string
+ */
+export function generateTraceId () {
+  return generateRandomHexString(32)
 }

package/src/common/ids/unique-id.test.js

@@ -0,0 +1,58 @@
+import crypto from 'crypto'
+import * as uniqueId from './unique-id'
+
+const getRandomValues = jest.fn(arr => crypto.randomBytes(arr.length))
+
+afterEach(() => {
+  delete global.crypto
+})
+
+describe('generateUuid', () => {
+  const uuidv4Regex = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/
+
+  test('should generate a uuidv4 that matches the expected format', () => {
+    const id = uniqueId.generateUuid()
+
+    expect(uuidv4Regex.test(id)).toEqual(true)
+  })
+
+  test('should support using native crypto library', () => {
+    global.crypto = { getRandomValues }
+
+    const id = uniqueId.generateUuid()
+
+    expect(uuidv4Regex.test(id)).toEqual(true)
+    expect(getRandomValues).toHaveBeenCalledTimes(1)
+  })
+})
+
+describe('generateRandomHexString', () => {
+  const hexRegex = /^[0-9a-f]{8}$/
+
+  test('should generate a valid hex string', () => {
+    const id = uniqueId.generateRandomHexString(8)
+
+    expect(hexRegex.test(id)).toEqual(true)
+  })
+
+  test('should support using native crypto library', () => {
+    global.crypto = { getRandomValues }
+
+    const id = uniqueId.generateRandomHexString(8)
+
+    expect(hexRegex.test(id)).toEqual(true)
+    expect(getRandomValues).toHaveBeenCalledTimes(1)
+  })
+})
+
+test('generateSpanId should generate a 16 character hex string', () => {
+  const id = uniqueId.generateSpanId()
+
+  expect(/^[0-9a-f]{16}$/.test(id)).toEqual(true)
+})
+
+test('generateTraceId should generate a 32 character hex string', () => {
+  const id = uniqueId.generateTraceId()
+
+  expect(/^[0-9a-f]{32}$/.test(id)).toEqual(true)
+})

package/src/common/session/constants.js

@@ -0,0 +1,3 @@
+export const PREFIX = 'NRBA'
+export const DEFAULT_EXPIRES_MS = 14400000
+export const DEFAULT_INACTIVE_MS = 1800000

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

@@ -0,0 +1,271 @@
+import { generateRandomHexString } from '../ids/unique-id'
+import { warn } from '../util/console'
+import { stringify } from '../util/stringify'
+import { ee } from '../event-emitter/contextual-ee'
+import { Timer } from '../timer/timer'
+import { isBrowserScope } from '../util/global-scope'
+import { DEFAULT_EXPIRES_MS, DEFAULT_INACTIVE_MS, PREFIX } from './constants'
+import { LocalMemory } from '../storage/local-memory'
+import { InteractionTimer } from '../timer/interaction-timer'
+import { wrapEvents } from '../wrap'
+import { Configurable } from '../config/state/configurable'
+import { handle } from '../event-emitter/handle'
+import { SUPPORTABILITY_METRIC_CHANNEL } from '../../features/metrics/constants'
+import { FEATURE_NAMES } from '../../loaders/features/features'
+
+const model = {
+  value: '',
+  inactiveAt: 0,
+  expiresAt: 0,
+  updatedAt: Date.now(),
+  sessionReplayActive: false,
+  sessionTraceActive: false,
+  custom: {}
+}
+
+export class SessionEntity {
+  /**
+   * Create a self-managing Session Entity. This entity is scoped to the agent identifier which triggered it, allowing for multiple simultaneous session objects to exist.
+   * There is one "namespace" an agent can store data in LS -- NRBA_{key}. If there are two agents on one page, and they both use the same key, they could overwrite each other since they would both use the same namespace in LS by default.
+   * The value can be overridden in the constructor, but will default to a unique 16 character hex string
+   * expiresMs and inactiveMs are used to "expire" the session, but can be overridden in the constructor. Pass 0 to disable expiration timers.
+   */
+  constructor (opts) {
+    this.setup(opts)
+  }
+
+  setup ({ agentIdentifier, key, value = generateRandomHexString(16), expiresMs = DEFAULT_EXPIRES_MS, inactiveMs = DEFAULT_INACTIVE_MS, storageAPI = new LocalMemory() }) {
+    if (!agentIdentifier || !key) throw new Error('Missing Required Fields')
+    if (!isBrowserScope) this.storage = new LocalMemory()
+    else this.storage = storageAPI
+
+    this.sync(model)
+
+    this.agentIdentifier = agentIdentifier
+
+    // key is intended to act as the k=v pair
+    this.key = key
+    // value is intended to act as the primary value of the k=v pair
+    this.value = value
+
+    this.expiresMs = expiresMs
+    this.inactiveMs = inactiveMs
+
+    this.ee = ee.get(agentIdentifier)
+
+    wrapEvents(this.ee)
+
+    // the first time the session entity class is instantiated, we check the storage API for an existing
+    // object. If it exists, the values inside the object are used to inform the timers that run locally.
+    // if the initial read is empty, it allows us to set a "fresh" "new" session immediately.
+    // the local timers are used after the session is running to "expire" the session, allowing for pausing timers etc.
+    // the timestamps stored in the storage API can be checked at initial run, and when the page is restored, otherwise we lean
+    // on the local timers to expire the session
+    const initialRead = this.read()
+
+    // the set-up of the timer used to expire the session "naturally" at a certain time
+    // this gets ignored if the value is falsy, allowing for session entities that do not expire
+    if (expiresMs) {
+      this.expiresAt = initialRead?.expiresAt || this.getFutureTimestamp(expiresMs)
+      this.expiresTimer = new Timer({
+        // When the inactive timer ends, collect a SM and reset the session
+        onEnd: () => {
+          this.collectSM('expired', this)
+          this.collectSM('duration', this)
+          this.reset()
+        }
+      }, this.expiresAt - Date.now())
+    } else {
+      this.expiresAt = Infinity
+    }
+
+    // the set-up of the timer used to expire the session due to "inactivity" at a certain time
+    // this gets ignored if the value is falsy, allowing for session entities that do not expire
+    // this gets "refreshed" when "activity" is observed
+    if (inactiveMs) {
+      this.inactiveAt = initialRead?.inactiveAt || this.getFutureTimestamp(inactiveMs)
+      this.inactiveTimer = new InteractionTimer({
+        // When the inactive timer ends, collect a SM and reset the session
+        onEnd: () => {
+          this.collectSM('inactive', this)
+          this.collectSM('duration', this)
+          this.reset()
+        },
+        // When the inactive timer refreshes, it will update the storage values with an update timestamp
+        onRefresh: this.refresh.bind(this),
+        // When the inactive timer pauses, update the storage values with an update timestamp
+        onPause: () => this.write(new Configurable(this.read(), model)),
+        ee: this.ee,
+        refreshEvents: ['click', 'keydown', 'scroll']
+      }, this.inactiveAt - Date.now())
+    } else {
+      this.inactiveAt = Infinity
+    }
+
+    // The fact that the session is "new" or pre-existing is used in some places in the agent.  Session Replay and Trace
+    // can use this info to inform whether to trust a new sampling decision vs continue a previous tracking effort.
+    this.isNew = !Object.keys(initialRead).length
+    // if its a "new" session, we write to storage API with the default values.  These values may change over the lifespan of the agent run.
+    // we can use configurable here to help us know and manage what values are being used. -- see "model" above
+    if (this.isNew) this.write(new Configurable(this, model), true)
+    else this.sync(initialRead)
+
+    this.initialized = true
+  }
+
+  // This is the actual key appended to the storage API
+  get lookupKey () {
+    return `${PREFIX}_${this.key}`
+  }
+
+  sync (data) {
+    Object.assign(this, data)
+  }
+
+  /**
+   * Fetch the stored values from the storage API tied to this entity
+   * @returns {Object}
+   */
+  read () {
+    try {
+      const val = this.storage.get(this.lookupKey)
+      if (!val) return {}
+      // TODO - decompression would need to happen here if we decide to do it
+      const obj = typeof val === 'string' ? JSON.parse(val) : val
+      if (this.isInvalid(obj)) return {}
+      // if the session expires, collect a SM count before resetting
+      if (this.isExpired(obj.expiresAt)) {
+        this.collectSM('expired', this)
+        this.collectSM('duration', obj, true)
+        return this.reset()
+      }
+      // if "inactive" timer is expired at "read" time -- esp. initial read -- reset
+      // collect a SM count before resetting
+      if (this.isExpired(obj.inactiveAt)) {
+        this.collectSM('inactive', this)
+        this.collectSM('duration', obj, true)
+        return this.reset()
+      }
+
+      return obj
+    } catch (e) {
+      warn('Failed to read from storage API', e)
+      // storage is inaccessible
+      return {}
+    }
+  }
+
+  /**
+   * Store data to the storage API tied to this entity
+   * To preseve existing attributes, the output of ...session.read()
+   * should be appended to the data argument
+   * @param {Object} data
+   * @returns {Object}
+   */
+  write (data) {
+    try {
+      if (!data || typeof data !== 'object') return
+      // everytime we update, we can update a timestamp for sanity
+      data.updatedAt = Date.now()
+      this.sync(data)
+      // TODO - compression would need happen here if we decide to do it
+      this.storage.set(this.lookupKey, stringify(data))
+      return data
+    } catch (e) {
+      // storage is inaccessible
+      warn('Failed to write to the storage API', e)
+      return null
+    }
+  }
+
+  reset () {
+    // this method should set off a chain of actions across the features by emitting 'new-session'
+    // * send off pending payloads
+    // * stop recording (stn and sr)...
+    // * delete the session and start over
+    try {
+      if (this.initialized) this.ee.emit('session-reset')
+
+      this.storage.remove(this.lookupKey)
+      this.inactiveTimer?.abort?.()
+      this.expiresTimer?.clear?.()
+      delete this.custom
+      delete this.value
+
+      this.setup({
+        agentIdentifier: this.agentIdentifier,
+        key: this.key,
+        storageAPI: this.storage,
+        expiresMs: this.expiresMs,
+        inactiveMs: this.inactiveMs
+      })
+      return this.read()
+    } catch (e) {
+      return {}
+    }
+  }
+
+  /**
+   * Refresh the inactivity timer data
+   */
+  refresh () {
+    // read here & invalidate
+    const existingData = this.read()
+    this.inactiveAt = this.getFutureTimestamp(this.inactiveMs)
+    this.write({ ...existingData, inactiveAt: this.inactiveAt })
+  }
+
+  /**
+   * @param {number} timestamp
+   * @returns {boolean}
+   */
+  isExpired (timestamp) {
+    return Date.now() > timestamp
+  }
+
+  /**
+   * @param {Object} data
+   * @returns {boolean}
+   */
+  isInvalid (data) {
+    const requiredKeys = ['value', 'expiresAt', 'inactiveAt']
+    return !requiredKeys.every(x => Object.keys(data).includes(x))
+  }
+
+  collectSM (type, data, useUpdatedAt) {
+    let value, tag
+    if (type === 'duration') {
+      const startingTimestamp = data.expiresAt - data.expiresMs
+      const endingTimestamp = useUpdatedAt ? data.updatedAt : Date.now()
+      value = endingTimestamp - startingTimestamp
+      tag = 'Session/Duration/Ms'
+    }
+    if (type === 'expired') tag = 'Session/Expired/Seen'
+    if (type === 'inactive') tag = 'Session/Inactive/Seen'
+
+    if (tag) handle(SUPPORTABILITY_METRIC_CHANNEL, [tag, value], undefined, FEATURE_NAMES.metrics, this.ee)
+  }
+
+  /**
+   * @param {number} futureMs - The number of ms to use to generate a future timestamp
+   * @returns {number}
+   */
+  getFutureTimestamp (futureMs) {
+    return Date.now() + futureMs
+  }
+
+  syncCustomAttribute (key, value) {
+    if (!isBrowserScope) return
+    if (value === null) {
+      const curr = this.read()
+      if (curr.custom) {
+        delete curr.custom[key]
+        this.write({ ...curr })
+      }
+    } else {
+      const curr = this.read()
+      this.custom = { ...(curr?.custom || {}), [key]: value }
+      this.write({ ...curr, custom: this.custom })
+    }
+  }
+}