@newrelic/browser-agent 1.256.1 → 1.258.0

package/CHANGELOG.md

@@ -3,6 +3,38 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.258.0](https://github.com/newrelic/newrelic-browser-agent/compare/v1.257.0...v1.258.0) (2024-04-29)
+
+
+### Features
+
+* Add harvestId to Session Replay payloads ([#1002](https://github.com/newrelic/newrelic-browser-agent/issues/1002)) ([aea9ac4](https://github.com/newrelic/newrelic-browser-agent/commit/aea9ac4dc791c58badc6d2efe7bdbb3c0f51a8bb))
+* JSErrors timestamped per harvest ([#997](https://github.com/newrelic/newrelic-browser-agent/issues/997)) ([97ae128](https://github.com/newrelic/newrelic-browser-agent/commit/97ae128934df7a74701eef001e49b0065ffe8216))
+* Maintain calculated NR server time for session ([#980](https://github.com/newrelic/newrelic-browser-agent/issues/980)) ([c487e04](https://github.com/newrelic/newrelic-browser-agent/commit/c487e04f46a606545c8172b6ed1c022b4dc1cac1))
+* Restructure AJAX Aggregate ([#1003](https://github.com/newrelic/newrelic-browser-agent/issues/1003)) ([1c3a6b9](https://github.com/newrelic/newrelic-browser-agent/commit/1c3a6b963c1eb7e0792225c3a4c15b6fd8d64505))
+
+
+### Bug Fixes
+
+* Clean up xhrWrappable ([#1000](https://github.com/newrelic/newrelic-browser-agent/issues/1000)) ([5e28fb7](https://github.com/newrelic/newrelic-browser-agent/commit/5e28fb722aa2bf08acc89066d5814e5bef862741))
+* Prevent null CLS ([#993](https://github.com/newrelic/newrelic-browser-agent/issues/993)) ([a518039](https://github.com/newrelic/newrelic-browser-agent/commit/a518039aa61862553d546cf0e675b733a9f9bed7))
+
+## [1.257.0](https://github.com/newrelic/newrelic-browser-agent/compare/v1.256.1...v1.257.0) (2024-04-18)
+
+
+### Features
+
+* Decorate errors with hasReplay individually ([#983](https://github.com/newrelic/newrelic-browser-agent/issues/983)) ([b6a7a3e](https://github.com/newrelic/newrelic-browser-agent/commit/b6a7a3ebcf2a69b9cbe9888208bb62330918cdf7))
+* Session Replay preload optimizations ([#982](https://github.com/newrelic/newrelic-browser-agent/issues/982)) ([fa20693](https://github.com/newrelic/newrelic-browser-agent/commit/fa20693d746bed2fa0b8ff972e4b9bee4bbe6956))
+
+
+### Bug Fixes
+
+* Agent class type declarations ([#987](https://github.com/newrelic/newrelic-browser-agent/issues/987)) ([b682c88](https://github.com/newrelic/newrelic-browser-agent/commit/b682c880bfb149b61f6c00bf821459ea55a37ae8))
+* JSEerrors harvest hasReplay decoration ([#986](https://github.com/newrelic/newrelic-browser-agent/issues/986)) ([6dd09c5](https://github.com/newrelic/newrelic-browser-agent/commit/6dd09c505af87b3a1b08330362eca46951ea22ed))
+* Session replay preload without autoStart ([#985](https://github.com/newrelic/newrelic-browser-agent/issues/985)) ([f50351a](https://github.com/newrelic/newrelic-browser-agent/commit/f50351acb08b65b03e7f4b5530a001a80fc04ece))
+* Soft navigations memory leak on harvest ([#979](https://github.com/newrelic/newrelic-browser-agent/issues/979)) ([53bb120](https://github.com/newrelic/newrelic-browser-agent/commit/53bb1209cb66fe1a52385b2863e35a93fb29afae))
+
 ## [1.256.1](https://github.com/newrelic/newrelic-browser-agent/compare/v1.256.0...v1.256.1) (2024-04-15)
 
 

package/dist/cjs/common/config/state/configurable.js

@@ -13,12 +13,15 @@ function getModeledObject(obj, model) {
     const output = Object.create(Object.getPrototypeOf(model), Object.getOwnPropertyDescriptors(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) {
-          (0, _console.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) {
+        (0, _console.warn)('An error occurred while setting a property of a Configurable', e);
       }
     }
     return output;

package/dist/cjs/common/config/state/init.js

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

package/dist/cjs/common/config/state/runtime.js

@@ -9,17 +9,18 @@ var _configurable = require("./configurable");
 var _nreum = require("../../window/nreum");
 var _runtime = require("../../constants/runtime");
 var _env = require("../../constants/env.npm");
-const model = {
+const readonly = {
   buildEnv: _env.BUILD_ENV,
+  distMethod: _env.DIST_METHOD,
+  version: _env.VERSION,
+  originTime: _runtime.originTime
+};
+const model = {
   customTransaction: undefined,
   disabled: false,
-  distMethod: _env.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(_runtime.globalScope?.performance?.timeOrigin || _runtime.globalScope?.performance?.timing?.navigationStart || Date.now()),
   onerror: undefined,
   origin: '' + _runtime.globalScope.location,
   ptid: undefined,
@@ -27,8 +28,6 @@ const model = {
   /** Agent-specific metadata found in the RUM call response. ex. entityGuid */
   appMetadata: {},
   session: undefined,
-  xhrWrappable: typeof _runtime.globalScope.XMLHttpRequest?.prototype?.addEventListener === 'function',
-  version: _env.VERSION,
   denyList: undefined,
   harvestCount: 0,
   timeKeeper: undefined
@@ -41,7 +40,10 @@ function getRuntime(id) {
 }
 function setRuntime(id, obj) {
   if (!id) throw new Error('All runtime objects require an agent identifier!');
-  _cache[id] = (0, _configurable.getModeledObject)(obj, model);
+  _cache[id] = {
+    ...(0, _configurable.getModeledObject)(obj, model),
+    ...readonly
+  };
   const agentInst = (0, _nreum.getNREUMInitializedAgent)(id);
   if (agentInst) agentInst.runtime = _cache[id];
 }

package/dist/cjs/common/constants/env.cdn.js

@@ -12,7 +12,7 @@ exports.VERSION = exports.RRWEB_VERSION = exports.DIST_METHOD = exports.BUILD_EN
 /**
  * Exposes the version of the agent
  */
-const VERSION = exports.VERSION = "1.256.1";
+const VERSION = exports.VERSION = "1.258.0";
 
 /**
  * Exposes the build type of the agent

package/dist/cjs/common/constants/env.npm.js

@@ -12,7 +12,7 @@ exports.VERSION = exports.RRWEB_VERSION = exports.DIST_METHOD = exports.BUILD_EN
 /**
  * Exposes the version of the agent
  */
-const VERSION = exports.VERSION = "1.256.1";
+const VERSION = exports.VERSION = "1.258.0";
 
 /**
  * Exposes the build type of the agent

package/dist/cjs/common/constants/runtime.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.supportsSendBeacon = exports.offset = exports.loadedAsDeferredBrowserScript = exports.isiOS = exports.isWorkerScope = exports.isIE = exports.isBrowserScope = exports.initiallyHidden = exports.initialLocation = exports.iOSBelow16 = exports.globalScope = exports.ffVersion = void 0;
+exports.supportsSendBeacon = exports.originTime = exports.loadedAsDeferredBrowserScript = exports.isiOS = exports.isWorkerScope = exports.isIE = exports.isBrowserScope = exports.initiallyHidden = exports.initialLocation = exports.iOSBelow16 = exports.globalScope = exports.ffVersion = void 0;
 /**
  * @file Contains constants about the environment the agent is running
  * within. These values are derived at the time the agent is first loaded.
@@ -44,4 +44,10 @@ const ffVersion = exports.ffVersion = (() => {
 const isIE = exports.isIE = Boolean(isBrowserScope && window.document.documentMode); // deprecated property that only works in IE
 
 const supportsSendBeacon = exports.supportsSendBeacon = !!globalScope.navigator?.sendBeacon;
-const offset = exports.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}
+ */
+const originTime = exports.originTime = Math.floor(Date.now() - performance.now());

package/dist/cjs/common/harvest/harvest.js

@@ -137,7 +137,7 @@ class Harvest extends _sharedContext.SharedContext {
     let url = "".concat(protocol, "://").concat(perceviedBeacon).concat(endpointURLPart, "/1/").concat(info.licenseKey);
     if (customUrl) url = customUrl;
     if (raw) url = "".concat(protocol, "://").concat(perceviedBeacon, "/").concat(endpoint);
-    const baseParams = !raw && includeBaseParams ? this.baseQueryString(qs) : '';
+    const baseParams = !raw && includeBaseParams ? this.baseQueryString(qs, endpoint) : '';
     let payloadParams = (0, _encode.obj)(qs, agentRuntime.maxBytes);
     if (!submitMethod) {
       submitMethod = submitData.getSubmitMethod({
@@ -207,17 +207,19 @@ class Harvest extends _sharedContext.SharedContext {
   }
 
   // The stuff that gets sent every time.
-  baseQueryString(qs) {
+  baseQueryString(qs, endpoint) {
     const runtime = (0, _config.getRuntime)(this.sharedContext.agentIdentifier);
     const info = (0, _config.getInfo)(this.sharedContext.agentIdentifier);
     const location = (0, _cleanUrl.cleanURL)((0, _location.getLocation)());
     const ref = this.obfuscator.shouldObfuscate() ? this.obfuscator.obfuscateString(location) : location;
-    return ['a=' + info.applicationID, (0, _encode.param)('sa', info.sa ? '' + info.sa : ''), (0, _encode.param)('v', _env.VERSION), transactionNameParam(info), (0, _encode.param)('ct', runtime.customTransaction), '&rst=' + (0, _now.now)(), '&ck=0',
+    const hr = runtime?.session?.state.sessionReplayMode === 1 && endpoint !== 'jserrors';
+    const qps = ['a=' + info.applicationID, (0, _encode.param)('sa', info.sa ? '' + info.sa : ''), (0, _encode.param)('v', _env.VERSION), transactionNameParam(info), (0, _encode.param)('ct', runtime.customTransaction), '&rst=' + (0, _now.now)(), '&ck=0',
     // ck param DEPRECATED - still expected by backend
     '&s=' + (runtime.session?.state.value || '0'),
     // the 0 id encaps all untrackable and default traffic
-    (0, _encode.param)('ref', ref), (0, _encode.param)('ptid', runtime.ptid ? '' + runtime.ptid : ''), (0, _encode.param)('hr', runtime?.session?.state.sessionReplayMode === 1 ? '1' : '0', qs) // hasReplay
-    ].join('');
+    (0, _encode.param)('ref', ref), (0, _encode.param)('ptid', runtime.ptid ? '' + runtime.ptid : '')];
+    if (hr) qps.push((0, _encode.param)('hr', '1', qs));
+    return qps.join('');
   }
 
   /**

package/dist/cjs/common/session/constants.js

@@ -9,6 +9,7 @@ const DEFAULT_KEY = exports.DEFAULT_KEY = 'SESSION';
 const DEFAULT_EXPIRES_MS = exports.DEFAULT_EXPIRES_MS = 14400000;
 const DEFAULT_INACTIVE_MS = exports.DEFAULT_INACTIVE_MS = 1800000;
 const SESSION_EVENTS = exports.SESSION_EVENTS = {
+  STARTED: 'session-started',
   PAUSE: 'session-pause',
   RESET: 'session-reset',
   RESUME: 'session-resume',

package/dist/cjs/common/session/session-entity.js

@@ -29,6 +29,8 @@ const model = {
   sessionReplaySentFirstChunk: false,
   sessionTraceMode: _constants.MODE.OFF,
   traceHarvestStarted: false,
+  serverTimeDiff: null,
+  // set by TimeKeeper; "undefined" value will not be stringified and stored but "null" will
   custom: {}
 };
 class SessionEntity {
@@ -143,6 +145,7 @@ class SessionEntity {
     // 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((0, _configurable.getModeledObject)(this.state, model), true);else this.sync(initialRead);
     this.initialized = true;
+    this.ee.emit(_constants.SESSION_EVENTS.STARTED, [this.isNew]);
   }
 
   // This is the actual key appended to the storage API

package/dist/cjs/common/timing/time-keeper.js

@@ -4,6 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.TimeKeeper = void 0;
+var _runtime = require("../constants/runtime");
+var _contextualEe = require("../event-emitter/contextual-ee");
+var _config = require("../config/config");
+var _constants = require("../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
@@ -11,10 +15,10 @@ exports.TimeKeeper = void 0;
  */
 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.
@@ -35,15 +39,24 @@ class TimeKeeper {
    * @type {number}
    */
   #ready = false;
-  constructor() {
-    this.#originTime = Date.now() - performance.now();
+  constructor(agentIdentifier) {
+    this.#session = (0, _config.getRuntime)(agentIdentifier)?.session;
+    if (this.#session) {
+      const ee = _contextualEe.ee.get(agentIdentifier);
+      ee.on(_constants.SESSION_EVENTS.UPDATE, this.#processSessionUpdate.bind(this));
+      ee.on(_constants.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;
   }
@@ -55,6 +68,8 @@ 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.');
@@ -64,10 +79,13 @@ class TimeKeeper {
 
     // Corrected page origin time
     this.#correctedOriginTime = Math.floor(Date.parse(responseDateHeader) - serverOffset);
-    this.#localTimeDiff = this.#originTime - this.#correctedOriginTime;
+    this.#localTimeDiff = _runtime.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;
   }
 
@@ -89,5 +107,23 @@ 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 === _constants.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 = _runtime.originTime - this.#localTimeDiff;
+      this.#ready = true;
+    }
+  }
 }
 exports.TimeKeeper = TimeKeeper;

package/dist/cjs/common/vitals/time-to-first-byte.js

@@ -27,7 +27,7 @@ if (_runtime.isBrowserScope && typeof PerformanceNavigationTiming !== 'undefined
   if (!timeToFirstByte.isValid) {
     const entry = {};
     // convert real timestamps to relative timestamps to match web-vitals behavior
-    for (let key in _runtime.globalScope?.performance?.timing || {}) entry[key] = Math.max(_runtime.globalScope?.performance?.timing[key] - _runtime.offset, 0);
+    for (let key in _runtime.globalScope?.performance?.timing || {}) entry[key] = Math.max(_runtime.globalScope?.performance?.timing[key] - _runtime.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({

package/dist/cjs/common/vitals/vital-metric.js

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

package/dist/cjs/features/ajax/aggregate/chunk.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _belSerializer = require("../../../common/serialize/bel-serializer");
+var _config = require("../../../common/config/config");
+class Chunk {
+  constructor(events, aggregateInstance) {
+    this.addString = (0, _belSerializer.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 = [(0, _belSerializer.numeric)(event.startTime), (0, _belSerializer.numeric)(event.endTime - event.startTime), (0, _belSerializer.numeric)(0),
+      // callbackEnd
+      (0, _belSerializer.numeric)(0),
+      // no callbackDuration for non-SPA events
+      this.addString(event.method), (0, _belSerializer.numeric)(event.status), this.addString(event.domain), this.addString(event.path), (0, _belSerializer.numeric)(event.requestSize), (0, _belSerializer.numeric)(event.responseSize), event.type === 'fetch' ? 1 : '', this.addString(0),
+      // nodeId
+      (0, _belSerializer.nullable)(event.spanId, this.addString, true) +
+      // guid
+      (0, _belSerializer.nullable)(event.traceId, this.addString, true) +
+      // traceId
+      (0, _belSerializer.nullable)(event.spanTimestamp, _belSerializer.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 = (0, _config.getInfo)(aggregateInstance.agentIdentifier).jsAttributes;
+
+      // add custom attributes
+      // gql decorators are added as custom attributes to alleviate need for new BEL schema
+      const attrParts = (0, _belSerializer.addCustomAttributes)({
+        ...(jsAttributes || {}),
+        ...(event.gql || {})
+      }, this.addString);
+      fields.unshift((0, _belSerializer.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;
+  }
+}
+exports.default = Chunk;