@newrelic/browser-agent 1.278.0 → 1.278.2

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.278.2](https://github.com/newrelic/newrelic-browser-agent/compare/v1.278.1...v1.278.2) (2025-01-09)
+
+
+### Bug Fixes
+
+* Allow the page view feature to have access to an event buffer ([#1315](https://github.com/newrelic/newrelic-browser-agent/issues/1315)) ([64babe1](https://github.com/newrelic/newrelic-browser-agent/commit/64babe18a5c4190f6d7bdc775fe5f55db095c892))
+
+## [1.278.1](https://github.com/newrelic/newrelic-browser-agent/compare/v1.278.0...v1.278.1) (2025-01-08)
+
+
+### Bug Fixes
+
+* Make Metrics harvest only on EoL for new Harvester ([#1311](https://github.com/newrelic/newrelic-browser-agent/issues/1311)) ([5cecedc](https://github.com/newrelic/newrelic-browser-agent/commit/5cecedcad6af7a14ec0e6777eba059ff1a5c008d))
+
 ## [1.278.0](https://github.com/newrelic/newrelic-browser-agent/compare/v1.277.0...v1.278.0) (2025-01-07)
 
 

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.278.0";
+const VERSION = exports.VERSION = "1.278.2";
 
 /**
  * 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.278.0";
+const VERSION = exports.VERSION = "1.278.2";
 
 /**
  * Exposes the build type of the agent

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

@@ -64,7 +64,7 @@ class Harvester {
     let ranSend = false;
     if (!localOpts.directSend) {
       // primarily used by rum call to bypass makeHarvestPayload by providing payload directly
-      dataToSendArr = aggregateInst.makeHarvestPayload(shouldRetryOnFail); // be sure the 'this' of makeHarvestPayload is the aggregate w/ access to its harvestOpts
+      dataToSendArr = aggregateInst.makeHarvestPayload(shouldRetryOnFail, localOpts); // be sure the 'this' of makeHarvestPayload is the aggregate w/ access to its harvestOpts
       if (!dataToSendArr) return false; // can be undefined if storage is empty or preharvest checks failed
     } else dataToSendArr = [localOpts.directSend];
     dataToSendArr.forEach(({

package/dist/cjs/features/metrics/aggregate/index.js

@@ -38,9 +38,9 @@ class Aggregate extends _aggregateBase.AggregateBase {
     this.singleChecks(); // checks that are run only one time, at script load
     this.eachSessionChecks(); // the start of every time user engages with page
   }
-  preHarvestChecks() {
-    return this.drained;
-  } // only allow any metrics to be sent if we know for sure it has gotten the go-ahead RUM flag
+  preHarvestChecks(opts) {
+    return this.drained && opts.isFinalHarvest;
+  } // only allow any metrics to be sent after we get the right RUM flag and only on EoL
 
   storeSupportabilityMetrics(name, value) {
     if (this.blocked) return;

package/dist/cjs/features/page_view_event/aggregate/index.js

@@ -125,8 +125,6 @@ class Aggregate extends _aggregateBase.AggregateBase {
     xhr
   }) {
     const rumEndTime = (0, _now.now)();
-    this.blocked = true; // this prevents harvester from polling this feature's event buffer (DNE) on interval; in other words, harvests will skip PVE
-
     if (status >= 400 || status === 0) {
       (0, _console.warn)(18, status);
       // Adding retry logic for the rum call will be a separate change; this.blocked will need to be changed since that prevents another triggerHarvestFor()

package/dist/cjs/features/utils/aggregate-base.js

@@ -23,8 +23,7 @@ class AggregateBase extends _featureBase.FeatureBase {
 
     // This switch needs to be after doOnceForAllAggregate which may new sharedAggregator and reset mainAppKey.
     switch (this.featureName) {
-      // PVE has no need for eventBuffer, and SessionTrace + Replay have their own storage mechanisms.
-      case _features.FEATURE_NAMES.pageViewEvent:
+      // SessionTrace + Replay have their own storage mechanisms.
       case _features.FEATURE_NAMES.sessionTrace:
       case _features.FEATURE_NAMES.sessionReplay:
         break;
@@ -33,6 +32,9 @@ class AggregateBase extends _featureBase.FeatureBase {
       case _features.FEATURE_NAMES.metrics:
         this.events = agentRef.sharedAggregator;
         break;
+      /** All other features get EventBuffer in the ESM by default. Note: PVE is included here, but event buffer will always be empty so future harvests will still not happen by interval or EOL.
+      This was necessary to prevent race cond. issues where the event buffer was checked before the feature could "block" itself.
+      Its easier to just keep an empty event buffer in place. */
       default:
         this.events = new _eventStoreManager.EventStoreManager(agentRef.mainAppKey, 1);
         break;
@@ -75,17 +77,17 @@ class AggregateBase extends _featureBase.FeatureBase {
   /**
    * Return harvest payload. A "serializer" function can be defined on a derived class to format the payload.
    * @param {Boolean} shouldRetryOnFail - harvester flag to backup payload for retry later if harvest request fails; this should be moved to harvester logic
-   * @param {object|undefined} target - the target app passed onto the event store manager to determine which app's data to return; if none provided, all apps data will be returned
+   * @param {object|undefined} opts.target - the target app passed onto the event store manager to determine which app's data to return; if none provided, all apps data will be returned
    * @returns {Array} Final payload tagged with their targeting browser app. The value of `payload` can be undefined if there are no pending events for an app. This should be a minimum length of 1.
    */
-  makeHarvestPayload(shouldRetryOnFail = false, target) {
-    if (this.events.isEmpty(this.harvestOpts, target)) return;
+  makeHarvestPayload(shouldRetryOnFail = false, opts = {}) {
+    if (this.events.isEmpty(this.harvestOpts, opts.target)) return;
     // Other conditions and things to do when preparing harvest that is required.
-    if (this.preHarvestChecks && !this.preHarvestChecks()) return;
-    if (shouldRetryOnFail) this.events.save(this.harvestOpts, target);
-    const returnedDataArr = this.events.get(this.harvestOpts, target);
+    if (this.preHarvestChecks && !this.preHarvestChecks(opts)) return;
+    if (shouldRetryOnFail) this.events.save(this.harvestOpts, opts.target);
+    const returnedDataArr = this.events.get(this.harvestOpts, opts.target);
     if (!returnedDataArr.length) throw new Error('Unexpected problem encountered. There should be at least one app for harvest!');
-    this.events.clear(this.harvestOpts, target);
+    this.events.clear(this.harvestOpts, opts.target);
     return returnedDataArr.map(({
       targetApp,
       data

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

@@ -6,7 +6,7 @@
 /**
  * Exposes the version of the agent
  */
-export const VERSION = "1.278.0";
+export const VERSION = "1.278.2";
 
 /**
  * Exposes the build type of the agent

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

@@ -6,7 +6,7 @@
 /**
  * Exposes the version of the agent
  */
-export const VERSION = "1.278.0";
+export const VERSION = "1.278.2";
 
 /**
  * Exposes the build type of the agent

package/dist/esm/common/harvest/harvester.js

@@ -58,7 +58,7 @@ export class Harvester {
     let ranSend = false;
     if (!localOpts.directSend) {
       // primarily used by rum call to bypass makeHarvestPayload by providing payload directly
-      dataToSendArr = aggregateInst.makeHarvestPayload(shouldRetryOnFail); // be sure the 'this' of makeHarvestPayload is the aggregate w/ access to its harvestOpts
+      dataToSendArr = aggregateInst.makeHarvestPayload(shouldRetryOnFail, localOpts); // be sure the 'this' of makeHarvestPayload is the aggregate w/ access to its harvestOpts
       if (!dataToSendArr) return false; // can be undefined if storage is empty or preharvest checks failed
     } else dataToSendArr = [localOpts.directSend];
     dataToSendArr.forEach(({

package/dist/esm/features/metrics/aggregate/index.js

@@ -32,9 +32,9 @@ export class Aggregate extends AggregateBase {
     this.singleChecks(); // checks that are run only one time, at script load
     this.eachSessionChecks(); // the start of every time user engages with page
   }
-  preHarvestChecks() {
-    return this.drained;
-  } // only allow any metrics to be sent if we know for sure it has gotten the go-ahead RUM flag
+  preHarvestChecks(opts) {
+    return this.drained && opts.isFinalHarvest;
+  } // only allow any metrics to be sent after we get the right RUM flag and only on EoL
 
   storeSupportabilityMetrics(name, value) {
     if (this.blocked) return;

package/dist/esm/features/page_view_event/aggregate/index.js

@@ -117,8 +117,6 @@ export class Aggregate extends AggregateBase {
     xhr
   }) {
     const rumEndTime = now();
-    this.blocked = true; // this prevents harvester from polling this feature's event buffer (DNE) on interval; in other words, harvests will skip PVE
-
     if (status >= 400 || status === 0) {
       warn(18, status);
       // Adding retry logic for the rum call will be a separate change; this.blocked will need to be changed since that prevents another triggerHarvestFor()

package/dist/esm/features/utils/aggregate-base.js

@@ -17,8 +17,7 @@ export class AggregateBase extends FeatureBase {
 
     // This switch needs to be after doOnceForAllAggregate which may new sharedAggregator and reset mainAppKey.
     switch (this.featureName) {
-      // PVE has no need for eventBuffer, and SessionTrace + Replay have their own storage mechanisms.
-      case FEATURE_NAMES.pageViewEvent:
+      // SessionTrace + Replay have their own storage mechanisms.
       case FEATURE_NAMES.sessionTrace:
       case FEATURE_NAMES.sessionReplay:
         break;
@@ -27,6 +26,9 @@ export class AggregateBase extends FeatureBase {
       case FEATURE_NAMES.metrics:
         this.events = agentRef.sharedAggregator;
         break;
+      /** All other features get EventBuffer in the ESM by default. Note: PVE is included here, but event buffer will always be empty so future harvests will still not happen by interval or EOL.
+      This was necessary to prevent race cond. issues where the event buffer was checked before the feature could "block" itself.
+      Its easier to just keep an empty event buffer in place. */
       default:
         this.events = new EventStoreManager(agentRef.mainAppKey, 1);
         break;
@@ -69,17 +71,17 @@ export class AggregateBase extends FeatureBase {
   /**
    * Return harvest payload. A "serializer" function can be defined on a derived class to format the payload.
    * @param {Boolean} shouldRetryOnFail - harvester flag to backup payload for retry later if harvest request fails; this should be moved to harvester logic
-   * @param {object|undefined} target - the target app passed onto the event store manager to determine which app's data to return; if none provided, all apps data will be returned
+   * @param {object|undefined} opts.target - the target app passed onto the event store manager to determine which app's data to return; if none provided, all apps data will be returned
    * @returns {Array} Final payload tagged with their targeting browser app. The value of `payload` can be undefined if there are no pending events for an app. This should be a minimum length of 1.
    */
-  makeHarvestPayload(shouldRetryOnFail = false, target) {
-    if (this.events.isEmpty(this.harvestOpts, target)) return;
+  makeHarvestPayload(shouldRetryOnFail = false, opts = {}) {
+    if (this.events.isEmpty(this.harvestOpts, opts.target)) return;
     // Other conditions and things to do when preparing harvest that is required.
-    if (this.preHarvestChecks && !this.preHarvestChecks()) return;
-    if (shouldRetryOnFail) this.events.save(this.harvestOpts, target);
-    const returnedDataArr = this.events.get(this.harvestOpts, target);
+    if (this.preHarvestChecks && !this.preHarvestChecks(opts)) return;
+    if (shouldRetryOnFail) this.events.save(this.harvestOpts, opts.target);
+    const returnedDataArr = this.events.get(this.harvestOpts, opts.target);
     if (!returnedDataArr.length) throw new Error('Unexpected problem encountered. There should be at least one app for harvest!');
-    this.events.clear(this.harvestOpts, target);
+    this.events.clear(this.harvestOpts, opts.target);
     return returnedDataArr.map(({
       targetApp,
       data

package/dist/types/features/metrics/aggregate/index.d.ts

@@ -1,7 +1,7 @@
 export class Aggregate extends AggregateBase {
     static featureName: string;
     constructor(agentRef: any);
-    preHarvestChecks(): boolean | undefined;
+    preHarvestChecks(opts: any): any;
     storeSupportabilityMetrics(name: any, value: any): void;
     storeEventMetrics(name: any, metrics: any): void;
     singleChecks(): void;

package/dist/types/features/metrics/aggregate/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/metrics/aggregate/index.js"],"names":[],"mappings":"AAYA;IACE,2BAAiC;IACjC,2BAoBC;IAED,wCAA2C;IAE3C,wDAKC;IAED,iDAKC;IAED,qBAqEC;IAED,0BAOC;CACF;8BA5H6B,4BAA4B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/metrics/aggregate/index.js"],"names":[],"mappings":"AAYA;IACE,2BAAiC;IACjC,2BAoBC;IAED,iCAAsE;IAEtE,wDAKC;IAED,iDAKC;IAED,qBAqEC;IAED,0BAOC;CACF;8BA5H6B,4BAA4B"}

package/dist/types/features/page_view_event/aggregate/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/page_view_event/aggregate/index.js"],"names":[],"mappings":"AAgBA;IACE,2BAA2C;IAC3C,2BA0BC;IAvBC,wBAAwB;IACxB,8BAA8B;IAC9B,8BAA8B;IAuBhC,gBAmEC;IATC,iCAAyB;IAW3B;;;;aAwBC;CACF;8BApI6B,4BAA4B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/page_view_event/aggregate/index.js"],"names":[],"mappings":"AAgBA;IACE,2BAA2C;IAC3C,2BA0BC;IAvBC,wBAAwB;IACxB,8BAA8B;IAC9B,8BAA8B;IAuBhC,gBAmEC;IATC,iCAAyB;IAW3B;;;;aAuBC;CACF;8BAnI6B,4BAA4B"}

package/dist/types/features/utils/aggregate-base.d.ts

@@ -13,10 +13,10 @@ export class AggregateBase extends FeatureBase {
     /**
      * Return harvest payload. A "serializer" function can be defined on a derived class to format the payload.
      * @param {Boolean} shouldRetryOnFail - harvester flag to backup payload for retry later if harvest request fails; this should be moved to harvester logic
-     * @param {object|undefined} target - the target app passed onto the event store manager to determine which app's data to return; if none provided, all apps data will be returned
+     * @param {object|undefined} opts.target - the target app passed onto the event store manager to determine which app's data to return; if none provided, all apps data will be returned
      * @returns {Array} Final payload tagged with their targeting browser app. The value of `payload` can be undefined if there are no pending events for an app. This should be a minimum length of 1.
      */
-    makeHarvestPayload(shouldRetryOnFail: boolean | undefined, target: object | undefined): any[];
+    makeHarvestPayload(shouldRetryOnFail?: boolean, opts?: {}): any[];
     /**
      * Cleanup task after a harvest.
      * @param {object} result - the cbResult object from the harvester's send method

package/dist/types/features/utils/aggregate-base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aggregate-base.d.ts","sourceRoot":"","sources":["../../../../src/features/utils/aggregate-base.js"],"names":[],"mappings":"AAWA;IAGI,cAAwB;IAcpB,YAAuC;IAM3C,gBAAqB;IAGvB;;;;OAIG;IACH,yBAHW,MAAM,EAAE,gBAwBlB;IAED,cAGC;IADC,6BAAmB;IAGrB;;;;;OAKG;IACH,mEAHW,MAAM,GAAC,SAAS,SAwB1B;IAED;;;OAGG;IACH,4BAFW,MAAM,QAMhB;IAED;;;OAGG;IACH,6CAsBC;IAED;;;OAGG;IACH,2CASC;IAPC,gBAA6C;CAQhD;4BAvJ2B,gBAAgB"}
+{"version":3,"file":"aggregate-base.d.ts","sourceRoot":"","sources":["../../../../src/features/utils/aggregate-base.js"],"names":[],"mappings":"AAWA;IAGI,cAAwB;IAapB,YAAuC;IAS3C,gBAAqB;IAGvB;;;;OAIG;IACH,yBAHW,MAAM,EAAE,gBAwBlB;IAED,cAGC;IADC,6BAAmB;IAGrB;;;;;OAKG;IACH,kEAqBC;IAED;;;OAGG;IACH,4BAFW,MAAM,QAMhB;IAED;;;OAGG;IACH,6CAsBC;IAED;;;OAGG;IACH,2CASC;IAPC,gBAA6C;CAQhD;4BAzJ2B,gBAAgB"}

package/package.json

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

package/src/common/harvest/harvester.js

@@ -57,7 +57,7 @@ export class Harvester {
     const shouldRetryOnFail = !localOpts.isFinalHarvest && submitMethod === xhrMethod // always retry all features harvests except for final
     let dataToSendArr; let ranSend = false
     if (!localOpts.directSend) { // primarily used by rum call to bypass makeHarvestPayload by providing payload directly
-      dataToSendArr = aggregateInst.makeHarvestPayload(shouldRetryOnFail) // be sure the 'this' of makeHarvestPayload is the aggregate w/ access to its harvestOpts
+      dataToSendArr = aggregateInst.makeHarvestPayload(shouldRetryOnFail, localOpts) // be sure the 'this' of makeHarvestPayload is the aggregate w/ access to its harvestOpts
       if (!dataToSendArr) return false // can be undefined if storage is empty or preharvest checks failed
     } else dataToSendArr = [localOpts.directSend]
 

package/src/features/metrics/aggregate/index.js

@@ -34,7 +34,7 @@ export class Aggregate extends AggregateBase {
     this.eachSessionChecks() // the start of every time user engages with page
   }
 
-  preHarvestChecks () { return this.drained } // only allow any metrics to be sent if we know for sure it has gotten the go-ahead RUM flag
+  preHarvestChecks (opts) { return this.drained && opts.isFinalHarvest } // only allow any metrics to be sent after we get the right RUM flag and only on EoL
 
   storeSupportabilityMetrics (name, value) {
     if (this.blocked) return

package/src/features/page_view_event/aggregate/index.js

@@ -115,7 +115,6 @@ export class Aggregate extends AggregateBase {
 
   postHarvestCleanup ({ status, responseText, xhr }) {
     const rumEndTime = now()
-    this.blocked = true // this prevents harvester from polling this feature's event buffer (DNE) on interval; in other words, harvests will skip PVE
 
     if (status >= 400 || status === 0) {
       warn(18, status)

package/src/features/utils/aggregate-base.js

@@ -18,8 +18,7 @@ export class AggregateBase extends FeatureBase {
 
     // This switch needs to be after doOnceForAllAggregate which may new sharedAggregator and reset mainAppKey.
     switch (this.featureName) {
-      // PVE has no need for eventBuffer, and SessionTrace + Replay have their own storage mechanisms.
-      case FEATURE_NAMES.pageViewEvent:
+      // SessionTrace + Replay have their own storage mechanisms.
       case FEATURE_NAMES.sessionTrace:
       case FEATURE_NAMES.sessionReplay:
         break
@@ -28,6 +27,9 @@ export class AggregateBase extends FeatureBase {
       case FEATURE_NAMES.metrics:
         this.events = agentRef.sharedAggregator
         break
+      /** All other features get EventBuffer in the ESM by default. Note: PVE is included here, but event buffer will always be empty so future harvests will still not happen by interval or EOL.
+      This was necessary to prevent race cond. issues where the event buffer was checked before the feature could "block" itself.
+      Its easier to just keep an empty event buffer in place. */
       default:
         this.events = new EventStoreManager(agentRef.mainAppKey, 1)
         break
@@ -71,18 +73,18 @@ export class AggregateBase extends FeatureBase {
   /**
    * Return harvest payload. A "serializer" function can be defined on a derived class to format the payload.
    * @param {Boolean} shouldRetryOnFail - harvester flag to backup payload for retry later if harvest request fails; this should be moved to harvester logic
-   * @param {object|undefined} target - the target app passed onto the event store manager to determine which app's data to return; if none provided, all apps data will be returned
+   * @param {object|undefined} opts.target - the target app passed onto the event store manager to determine which app's data to return; if none provided, all apps data will be returned
    * @returns {Array} Final payload tagged with their targeting browser app. The value of `payload` can be undefined if there are no pending events for an app. This should be a minimum length of 1.
    */
-  makeHarvestPayload (shouldRetryOnFail = false, target) {
-    if (this.events.isEmpty(this.harvestOpts, target)) return
+  makeHarvestPayload (shouldRetryOnFail = false, opts = {}) {
+    if (this.events.isEmpty(this.harvestOpts, opts.target)) return
     // Other conditions and things to do when preparing harvest that is required.
-    if (this.preHarvestChecks && !this.preHarvestChecks()) return
+    if (this.preHarvestChecks && !this.preHarvestChecks(opts)) return
 
-    if (shouldRetryOnFail) this.events.save(this.harvestOpts, target)
-    const returnedDataArr = this.events.get(this.harvestOpts, target)
+    if (shouldRetryOnFail) this.events.save(this.harvestOpts, opts.target)
+    const returnedDataArr = this.events.get(this.harvestOpts, opts.target)
     if (!returnedDataArr.length) throw new Error('Unexpected problem encountered. There should be at least one app for harvest!')
-    this.events.clear(this.harvestOpts, target)
+    this.events.clear(this.harvestOpts, opts.target)
 
     return returnedDataArr.map(({ targetApp, data }) => {
       // A serializer or formatter assists in creating the payload `body` from stored events on harvest when defined by derived feature class.