@newrelic/browser-agent 1.232.0 → 1.233.0

package/src/common/harvest/harvest-scheduler.js

@@ -68,22 +68,47 @@ export class HarvestScheduler extends SharedContext {
     if (this.aborted) return
     var scheduler = this
 
-    if (this.opts.getPayload) { // Ajax & PVT
-      var submitMethod = getSubmitMethod(this.endpoint, opts)
+    let harvests = []
+    let submitMethod
+
+    if (this.opts.getPayload) { // Ajax & PVT & SR
+      submitMethod = getSubmitMethod(this.endpoint, opts)
       if (!submitMethod) return false
 
-      var retry = submitMethod.method === submitData.xhr
+      const retry = submitMethod.method === submitData.xhr
       var payload = this.opts.getPayload({ retry: retry })
-      if (payload) {
-        payload = Object.prototype.toString.call(payload) === '[object Array]' ? payload : [payload]
-        for (var i = 0; i < payload.length; i++) {
-          this.harvest.send(this.endpoint, payload[i], opts, submitMethod, onHarvestFinished)
-        }
-      }
+
+      if (!payload) return
+
+      payload = Object.prototype.toString.call(payload) === '[object Array]' ? payload : [payload]
+      harvests.push(...payload)
+    }
+
+    /** sendX is used for features that do not supply a preformatted payload via "getPayload" */
+    let send = args => this.harvest.sendX(args)
+    if (harvests.length) {
+      /** _send is the underlying method for sending in the harvest, if sending raw we can bypass the other helpers completely which format the payloads */
+      if (this.opts.raw) send = args => this.harvest._send(args)
+      /** send is used to formated the payloads from "getPayload" and obfuscate before sending */
+      else send = args => this.harvest.send(args)
     } else {
-      this.harvest.sendX(this.endpoint, opts, onHarvestFinished)
+      // force it to run at least once in sendX mode
+      harvests.push(undefined)
     }
 
+    harvests.forEach(payload => {
+      send({
+        endpoint: this.endpoint,
+        payload,
+        opts,
+        submitMethod,
+        cbFinished: onHarvestFinished,
+        includeBaseParams: this.opts.includeBaseParams,
+        customUrl: this.opts.customUrl,
+        gzip: this.opts.gzip
+      })
+    })
+
     if (this.started) {
       this.scheduleHarvest()
     }

package/src/common/harvest/harvest.js

@@ -8,7 +8,7 @@ import { obj as encodeObj, param as encodeParam } from '../url/encode'
 import { stringify } from '../util/stringify'
 import { submitData } from '../util/submit-data'
 import { getLocation } from '../url/location'
-import { getInfo, getConfigurationValue, getRuntime, getConfiguration } from '../config/config'
+import { getInfo, getConfigurationValue, getRuntime } from '../config/config'
 import { cleanURL } from '../url/clean-url'
 import { now } from '../timing/now'
 import { eventListenerOpts } from '../event-listener/event-listener-opts'
@@ -18,6 +18,23 @@ import { SharedContext } from '../context/shared-context'
 import { VERSION } from '../constants/env'
 import { isBrowserScope, isWorkerScope } from '../util/global-scope'
 
+/**
+ * @typedef {object} NetworkSendSpec
+ * @param {string} endpoint The endpoint to use (jserrors, events, resources etc.)
+ * @param {object} payload Object representing payload.
+ * @param {object} payload.qs Map of values that should be sent as part of the request query string.
+ * @param {string} payload.body String that should be sent as the body of the request.
+ * @param {string} payload.body.e Special case of body used for browser interactions.
+ * @param {object} opts Additional options for sending data
+ * @param {boolean} opts.needResponse Specify whether the caller expects a response data.
+ * @param {boolean} opts.unload Specify whether the call is a final harvest during page unload.
+ * @param {boolean} opts.sendEmptyBody Specify whether the call should be made even if the body is empty. Useful for rum calls.
+ * @param {function} submitMethod The submit method to use {@link ../util/submit-data}
+ * @param {string} customUrl Override the beacon url the data is sent to; must include protocol if defined
+ * @param {boolean} gzip Enabled gzip compression on the body of the request before it is sent
+ * @param {boolean} includeBaseParams Enables the use of base query parameters in the beacon url {@see Harvest.baseQueryString}
+ */
+
 const haveSendBeacon = !!navigator.sendBeacon // only the web window obj has sendBeacon at this time, so 'false' for other envs
 
 export class Harvest extends SharedContext {
@@ -34,55 +51,48 @@ export class Harvest extends SharedContext {
   /**
    * Initiate a harvest from multiple sources. An event that corresponds to the endpoint
    * name is emitted, which gives any listeners the opportunity to provide payload data.
-   *
-   * @param {string} endpoint - The endpoint of the harvest (jserrors, events, resources etc.)
-   *
-   * @param {object} opts
-   * @param {bool} opts.needResponse - Specify whether the caller expects a response data.
-   * @param {bool} opts.unload - Specify whether the call is a final harvest during page unload.
+   * @param {NetworkSendSpec} spec Specification for sending data
    */
-  sendX (endpoint, opts, cbFinished) {
+  sendX (spec) {
+    const { endpoint, opts } = spec
     var submitMethod = getSubmitMethod(endpoint, opts)
     if (!submitMethod) return false
     var options = {
       retry: submitMethod.method === submitData.xhr
     }
-    return this.obfuscator.shouldObfuscate() ? this.obfuscateAndSend(endpoint, this.createPayload(endpoint, options), opts, submitMethod, cbFinished) : this._send(endpoint, this.createPayload(endpoint, options), opts, submitMethod, cbFinished)
+    const payload = this.createPayload(endpoint, options)
+    var caller = this.obfuscator.shouldObfuscate() ? this.obfuscateAndSend.bind(this) : this._send.bind(this)
+    return caller({ ...spec, payload, submitMethod })
   }
 
   /**
- * Initiate a harvest call.
- *
- * @param {string} endpoint - The endpoint of the harvest (jserrors, events, resources etc.)
- * @param {object} nr - The loader singleton.
- *
- * @param {object} singlePayload - Object representing payload.
- * @param {object} singlePayload.qs - Map of values that should be sent as part of the request query string.
- * @param {string} singlePayload.body - String that should be sent as the body of the request.
- * @param {string} singlePayload.body.e - Special case of body used for browser interactions.
- *
- * @param {object} opts
- * @param {bool} opts.needResponse - Specify whether the caller expects a response data.
- * @param {bool} opts.unload - Specify whether the call is a final harvest during page unload.
- */
-  send (endpoint, singlePayload, opts, submitMethod, cbFinished) {
+   * Initiate a harvest call.
+   * @param {NetworkSendSpec} spec Specification for sending data
+   */
+  send (spec) {
+    const { payload = {} } = spec
     var makeBody = createAccumulator()
     var makeQueryString = createAccumulator()
-    if (singlePayload.body) mapOwn(singlePayload.body, makeBody)
-    if (singlePayload.qs) mapOwn(singlePayload.qs, makeQueryString)
+    if (payload.body) mapOwn(payload.body, makeBody)
+    if (payload.qs) mapOwn(payload.qs, makeQueryString)
 
-    var payload = { body: makeBody(), qs: makeQueryString() }
-    var caller = this.obfuscator.shouldObfuscate() ? (...args) => this.obfuscateAndSend(...args) : (...args) => this._send(...args)
+    var newPayload = { body: makeBody(), qs: makeQueryString() }
+    var caller = this.obfuscator.shouldObfuscate() ? this.obfuscateAndSend.bind(this) : this._send.bind(this)
 
-    return caller(endpoint, payload, opts, submitMethod, cbFinished)
+    return caller({ ...spec, payload: newPayload })
   }
 
-  obfuscateAndSend (endpoint, payload, opts, submitMethod, cbFinished) {
+  /**
+   * Apply obfuscation rules to the payload and then initial the harvest network call.
+   * @param {NetworkSendSpec} spec Specification for sending data
+   */
+  obfuscateAndSend (spec) {
+    const { payload = {} } = spec
     applyFnToProps(payload, (...args) => this.obfuscator.obfuscateString(...args), 'string', ['e'])
-    return this._send(endpoint, payload, opts, submitMethod, cbFinished)
+    return this._send({ ...spec, payload })
   }
 
-  _send (endpoint, payload, opts, submitMethod, cbFinished) {
+  _send ({ endpoint, payload = {}, opts = {}, submitMethod, cbFinished, customUrl, gzip, includeBaseParams = true }) {
     var info = getInfo(this.sharedContext.agentIdentifier)
     if (!info.errorBeacon) return false
 
@@ -95,11 +105,10 @@ export class Harvest extends SharedContext {
       return false
     }
 
-    if (!opts) opts = {}
-
-    var url = this.getScheme() + '://' + info.errorBeacon + '/' + endpoint + '/1/' + info.licenseKey + this.baseQueryString()
-    if (payload.qs) url += encodeObj(payload.qs, agentRuntime.maxBytes)
+    var url = customUrl || this.getScheme() + '://' + info.errorBeacon + '/' + endpoint + '/1/' + info.licenseKey + '?'
 
+    var baseParams = includeBaseParams ? this.baseQueryString() : ''
+    var params = payload.qs ? encodeObj(payload.qs, agentRuntime.maxBytes) : ''
     if (!submitMethod) {
       submitMethod = getSubmitMethod(endpoint, opts)
     }
@@ -107,29 +116,43 @@ export class Harvest extends SharedContext {
     var useBody = submitMethod.useBody
 
     var body
-    var fullUrl = url
-    if (useBody && endpoint === 'events') {
-      body = payload.body.e
-    } else if (useBody) {
-      body = stringify(payload.body)
-    } else {
-      fullUrl = url + encodeObj(payload.body, agentRuntime.maxBytes)
-    }
+    var fullUrl = url + baseParams + params
+
+    if (!gzip) {
+      if (useBody && endpoint === 'events') {
+        body = payload.body.e
+      } else if (useBody) {
+        body = stringify(payload.body)
+      } else {
+        fullUrl = fullUrl + encodeObj(payload.body, agentRuntime.maxBytes)
+      }
+    } else body = payload.body
 
     // Get bytes harvested per endpoint as a supportability metric. See metrics aggregator (on unload).
     agentRuntime.bytesSent[endpoint] = (agentRuntime.bytesSent[endpoint] || 0) + body?.length || 0
     // Get query bytes harvested per endpoint as a supportability metric. See metrics aggregator (on unload).
     agentRuntime.queryBytesSent[endpoint] = (agentRuntime.queryBytesSent[endpoint] || 0) + fullUrl.split('?').slice(-1)[0]?.length || 0
 
+    const headers = []
+
+    if (gzip) {
+      headers.push({ key: 'content-type', value: 'application/json' })
+      headers.push({ key: 'X-Browser-Monitoring-Key', value: info.licenseKey })
+      headers.push({ key: 'Content-Encoding', value: 'gzip' })
+    } else {
+      headers.push({ key: 'content-type', value: 'text/plain' })
+    }
+
     /* Since workers don't support sendBeacon right now, or Image(), they can only use XHR method.
         Because they still do permit synch XHR, the idea is that at final harvest time (worker is closing),
         we just make a BLOCKING request--trivial impact--with the remaining data as a temp fill-in for sendBeacon. */
-    var result = method(fullUrl, body, opts.unload && isWorkerScope)
+
+    var result = method({ url: fullUrl, body, sync: opts.unload && isWorkerScope, headers })
 
     if (cbFinished && method === submitData.xhr) {
       var xhr = result
       xhr.addEventListener('load', function () {
-        var result = { sent: true }
+        var result = { sent: true, status: this.status }
         if (this.status === 429) {
           result.retry = true
           result.delay = this.tooManyRequestsDelay
@@ -147,7 +170,7 @@ export class Harvest extends SharedContext {
     // if beacon request failed, retry with an alternative method -- will not happen for workers
     if (!result && method === submitData.beacon) {
       method = submitData.img
-      result = method(url + encodeObj(payload.body, agentRuntime.maxBytes))
+      result = method({ url: fullUrl + encodeObj(payload.body, agentRuntime.maxBytes) })
     }
 
     return result
@@ -162,14 +185,14 @@ export class Harvest extends SharedContext {
     var ref = this.obfuscator.shouldObfuscate() ? this.obfuscator.obfuscateString(location) : location
 
     return ([
-      '?a=' + info.applicationID,
+      'a=' + info.applicationID,
       encodeParam('sa', (info.sa ? '' + info.sa : '')),
       encodeParam('v', VERSION),
       transactionNameParam(info),
       encodeParam('ct', runtime.customTransaction),
       '&rst=' + now(),
       '&ck=0', // ck param DEPRECATED - still expected by backend
-      '&s=' + (runtime.session?.value || '0'), // the 0 id encaps all untrackable and default traffic
+      '&s=' + (runtime.session?.state.value || '0'), // the 0 id encaps all untrackable and default traffic
       encodeParam('ref', ref),
       encodeParam('ptid', (runtime.ptid ? '' + runtime.ptid : ''))
     ].join(''))
@@ -241,7 +264,7 @@ function createAccumulator () {
   var accumulator = {}
   var hasData = false
   return function (key, val) {
-    if (val && val.length) {
+    if (val !== null && val !== undefined && val.length) {
       accumulator[key] = val
       hasData = true
     }

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

@@ -8,21 +8,29 @@ 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 { getModeledObject } 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'
 
+// this is what can be stored in local storage (not enforced but probably should be)
+// these values should sync between local storage and the parent class props
 const model = {
   value: '',
   inactiveAt: 0,
   expiresAt: 0,
   updatedAt: Date.now(),
-  sessionReplayActive: false,
+  sessionReplay: 0,
   sessionTraceActive: false,
   custom: {}
 }
 
+export const SESSION_EVENTS = {
+  PAUSE: 'session-pause',
+  RESET: 'session-reset',
+  RESUME: 'session-resume'
+}
+
 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.
@@ -39,14 +47,15 @@ export class SessionEntity {
     if (!isBrowserScope) this.storage = new LocalMemory()
     else this.storage = storageAPI
 
+    this.state = {}
+
     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.state.value = value
 
     this.expiresMs = expiresMs
     this.inactiveMs = inactiveMs
@@ -66,7 +75,7 @@ export class SessionEntity {
     // 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.state.expiresAt = initialRead?.expiresAt || this.getFutureTimestamp(expiresMs)
       this.expiresTimer = new Timer({
         // When the inactive timer ends, collect a SM and reset the session
         onEnd: () => {
@@ -74,16 +83,16 @@ export class SessionEntity {
           this.collectSM('duration', this)
           this.reset()
         }
-      }, this.expiresAt - Date.now())
+      }, this.state.expiresAt - Date.now())
     } else {
-      this.expiresAt = Infinity
+      this.state.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.state.inactiveAt = initialRead?.inactiveAt || this.getFutureTimestamp(inactiveMs)
       this.inactiveTimer = new InteractionTimer({
         // When the inactive timer ends, collect a SM and reset the session
         onEnd: () => {
@@ -93,21 +102,25 @@ export class SessionEntity {
         },
         // When the inactive timer refreshes, it will update the storage values with an update timestamp
         onRefresh: this.refresh.bind(this),
+        onResume: () => { this.ee.emit(SESSION_EVENTS.RESUME) },
         // When the inactive timer pauses, update the storage values with an update timestamp
-        onPause: () => this.write(new Configurable(this.read(), model)),
+        onPause: () => {
+          if (this.initialized) this.ee.emit(SESSION_EVENTS.PAUSE)
+          this.write(getModeledObject(this.state, model))
+        },
         ee: this.ee,
         refreshEvents: ['click', 'keydown', 'scroll']
-      }, this.inactiveAt - Date.now())
+      }, this.state.inactiveAt - Date.now())
     } else {
-      this.inactiveAt = Infinity
+      this.state.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 (this.isNew === undefined) 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)
+    // we can use a modeled object here to help us know and manage what values are being used. -- see "model" above
+    if (this.isNew) this.write(getModeledObject(this.state, model), true)
     else this.sync(initialRead)
 
     this.initialized = true
@@ -119,7 +132,7 @@ export class SessionEntity {
   }
 
   sync (data) {
-    Object.assign(this, data)
+    Object.assign(this.state, data)
   }
 
   /**
@@ -167,7 +180,8 @@ export class SessionEntity {
       if (!data || typeof data !== 'object') return
       // everytime we update, we can update a timestamp for sanity
       data.updatedAt = Date.now()
-      this.sync(data)
+      this.sync(data) // update the parent class "state" properties with the local storage values
+      //
       // TODO - compression would need happen here if we decide to do it
       this.storage.set(this.lookupKey, stringify(data))
       return data
@@ -184,13 +198,11 @@ export class SessionEntity {
     // * stop recording (stn and sr)...
     // * delete the session and start over
     try {
-      if (this.initialized) this.ee.emit('session-reset')
-
+      if (this.initialized) this.ee.emit(SESSION_EVENTS.RESET)
       this.storage.remove(this.lookupKey)
       this.inactiveTimer?.abort?.()
       this.expiresTimer?.clear?.()
-      delete this.custom
-      delete this.value
+      delete this.isNew
 
       this.setup({
         agentIdentifier: this.agentIdentifier,
@@ -211,8 +223,7 @@ export class SessionEntity {
   refresh () {
     // read here & invalidate
     const existingData = this.read()
-    this.inactiveAt = this.getFutureTimestamp(this.inactiveMs)
-    this.write({ ...existingData, inactiveAt: this.inactiveAt })
+    this.write({ ...existingData, inactiveAt: this.getFutureTimestamp(this.inactiveMs) })
   }
 
   /**
@@ -228,7 +239,7 @@ export class SessionEntity {
    * @returns {boolean}
    */
   isInvalid (data) {
-    const requiredKeys = ['value', 'expiresAt', 'inactiveAt']
+    const requiredKeys = Object.keys(model)
     return !requiredKeys.every(x => Object.keys(data).includes(x))
   }