@newrelic/browser-agent 1.302.0-rc.6 → 1.302.0-rc.7

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

@@ -17,7 +17,7 @@ exports.VERSION = exports.RRWEB_VERSION = exports.RRWEB_PACKAGE_NAME = exports.D
 /**
  * Exposes the version of the agent
  */
-const VERSION = exports.VERSION = "1.302.0-rc.6";
+const VERSION = exports.VERSION = "1.302.0-rc.7";
 
 /**
  * Exposes the build type of the agent

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

@@ -17,7 +17,7 @@ exports.VERSION = exports.RRWEB_VERSION = exports.RRWEB_PACKAGE_NAME = exports.D
 /**
  * Exposes the version of the agent
  */
-const VERSION = exports.VERSION = "1.302.0-rc.6";
+const VERSION = exports.VERSION = "1.302.0-rc.7";
 
 /**
  * Exposes the build type of the agent

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

@@ -25,8 +25,10 @@ var _globalEvent = require("../dispatch/global-event");
  * SPDX-License-Identifier: Apache-2.0
  */
 
-const RETRY_FAILED = 'Harvester/Retry/Failed/';
-const RETRY_SUCCEEDED = 'Harvester/Retry/Succeeded/';
+const RETRY = 'Harvester/Retry/';
+const RETRY_ATTEMPTED = RETRY + 'Attempted/';
+const RETRY_FAILED = RETRY + 'Failed/';
+const RETRY_SUCCEEDED = RETRY + 'Succeeded/';
 class Harvester {
   #started = false;
   initializedAggregates = [];
@@ -70,8 +72,7 @@ class Harvester {
     const submitMethod = (0, _submitData.getSubmitMethod)(localOpts);
     if (!submitMethod) return output;
     const shouldRetryOnFail = !localOpts.isFinalHarvest && submitMethod === _submitData.xhr; // always retry all features harvests except for final
-    output.payload = !localOpts.directSend ? aggregateInst.makeHarvestPayload(shouldRetryOnFail, localOpts) : localOpts.directSend?.payload; // features like PVE can define the payload directly, bypassing the makeHarvestPayload logic
-
+    output.payload = aggregateInst.makeHarvestPayload(shouldRetryOnFail, localOpts);
     if (!output.payload) return output;
     send(this.agentRef, {
       endpoint: _features.FEATURE_TO_ENDPOINT[aggregateInst.featureName],
@@ -93,7 +94,9 @@ class Harvester {
     function cbFinished(result) {
       if (aggregateInst.harvestOpts.prevAttemptCode) {
         // this means we just retried a harvest that last failed
-        (0, _handle.handle)(_constants.SUPPORTABILITY_METRIC_CHANNEL, [(result.retry ? RETRY_FAILED : RETRY_SUCCEEDED) + aggregateInst.harvestOpts.prevAttemptCode], undefined, _features.FEATURE_NAMES.metrics, aggregateInst.ee);
+        const reportSM = message => (0, _handle.handle)(_constants.SUPPORTABILITY_METRIC_CHANNEL, [message], undefined, _features.FEATURE_NAMES.metrics, aggregateInst.ee);
+        reportSM(RETRY_ATTEMPTED + aggregateInst.featureName);
+        reportSM((result.retry ? RETRY_FAILED : RETRY_SUCCEEDED) + aggregateInst.harvestOpts.prevAttemptCode);
         delete aggregateInst.harvestOpts.prevAttemptCode; // always reset last observation so we don't falsely report again next harvest
         // In case this re-attempt failed again, that'll be handled (re-marked again) next.
       }
@@ -183,9 +186,9 @@ function send(agentRef, {
           status: this.status,
           retry: shouldRetry(this.status),
           fullUrl,
-          xhr: this
+          xhr: this,
+          responseText: this.responseText
         };
-        if (localOpts.needResponse) cbResult.responseText = this.responseText;
         cbFinished(cbResult);
 
         /** temporary audit of consistency of harvest metadata flags */
@@ -199,9 +202,9 @@ function send(agentRef, {
           status,
           retry: shouldRetry(status),
           fullUrl,
-          fetchResponse: response
+          fetchResponse: response,
+          responseText: await response.text()
         };
-        if (localOpts.needResponse) cbResult.responseText = await response.text();
         cbFinished(cbResult);
         /** temporary audit of consistency of harvest metadata flags */
         if (!shouldRetry(status)) trackHarvestMetadata();

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

@@ -30,7 +30,6 @@ exports.unused = void 0;
  * @property {HarvestEndpointIdentifier} endpoint The endpoint to use (jserrors, events, resources etc.)
  * @property {HarvestPayload} payload Object representing payload.
  * @property {object} localOpts Additional options for sending data
- * @property {boolean} localOpts.needResponse Specify whether the caller expects a response data.
  * @property {boolean} localOpts.isFinalHarvest Specify whether the call is a final harvest during page unload.
  * @property {boolean} localOpts.sendEmptyBody Specify whether the call should be made even if the body is empty. Useful for rum calls.
  * @property {boolean} localOpts.forceNoRetry Don't save the buffered data in the case of a need to retry the transmission.

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

@@ -35,7 +35,7 @@ class Aggregate extends _aggregateBase.AggregateBase {
     this.timeToFirstByte = 0;
     this.firstByteToWindowLoad = 0; // our "frontend" duration
     this.firstByteToDomContent = 0; // our "dom processing" duration
-
+    this.retries = 0;
     if (!(0, _info.isValid)(agentRef.info)) {
       this.ee.abort();
       return (0, _console.warn)(43);
@@ -63,12 +63,8 @@ class Aggregate extends _aggregateBase.AggregateBase {
    *
    * @param {Function} cb A function to run once the RUM call has finished - Defaults to activateFeatures
    * @param {*} customAttributes custom attributes to attach to the RUM call - Defaults to info.js
-   * @param {*} target The target to harvest to
    */
-  sendRum(customAttributes = this.agentRef.info.jsAttributes, target = {
-    licenseKey: this.agentRef.info.licenseKey,
-    applicationID: this.agentRef.info.applicationID
-  }) {
+  sendRum(customAttributes = this.agentRef.info.jsAttributes) {
     const info = this.agentRef.info;
     const measures = {};
     if (info.queueTime) measures.qt = info.queueTime;
@@ -119,27 +115,30 @@ class Aggregate extends _aggregateBase.AggregateBase {
     }
     queryParameters.fp = _firstPaint.firstPaint.current.value;
     queryParameters.fcp = _firstContentfulPaint.firstContentfulPaint.current.value;
-    const timeKeeper = this.agentRef.runtime.timeKeeper;
-    if (timeKeeper?.ready) {
-      queryParameters.timestamp = Math.floor(timeKeeper.correctRelativeTimestamp((0, _now.now)()));
-    }
-    this.rumStartTime = (0, _now.now)();
+    this.queryStringsBuilder = () => {
+      // this will be called by AggregateBase.makeHarvestPayload every time harvest is triggered to be qs
+      this.rumStartTime = (0, _now.now)(); // this should be reset at the beginning of each RUM call for proper timeKeeper calculation in coordination with postHarvestCleanup
+      const timeKeeper = this.agentRef.runtime.timeKeeper;
+      if (timeKeeper?.ready) {
+        queryParameters.timestamp = Math.floor(timeKeeper.correctRelativeTimestamp(this.rumStartTime));
+      }
+      return queryParameters;
+    };
+    this.events.add(body);
     this.agentRef.runtime.harvester.triggerHarvestFor(this, {
-      directSend: {
-        target,
-        payload: {
-          qs: queryParameters,
-          body
-        }
-      },
-      needResponse: true,
       sendEmptyBody: true
     });
   }
+  serializer(eventBuffer) {
+    // this is necessary because PVE sends a single item rather than an array; in the case of undefined, this prevents sending [null] as body
+    return eventBuffer[0];
+  }
   postHarvestCleanup({
+    sent,
     status,
     responseText,
-    xhr
+    xhr,
+    retry
   }) {
     const rumEndTime = (0, _now.now)();
     let app, flags;
@@ -152,8 +151,20 @@ class Aggregate extends _aggregateBase.AggregateBase {
       // wont set entity stuff here, if main agent will later abort, if registered agent, nothing will happen
       (0, _console.warn)(53, error);
     }
+    super.postHarvestCleanup({
+      sent,
+      retry
+    }); // this will set isRetrying & re-buffer the body if request is to be retried
+    if (this.isRetrying && this.retries++ < 1) {
+      // Only retry once
+      setTimeout(() => this.agentRef.runtime.harvester.triggerHarvestFor(this, {
+        sendEmptyBody: true
+      }), 5000); // Retry sending the RUM event after 5 seconds
+      return;
+    }
     if (status >= 400 || status === 0) {
       (0, _console.warn)(18, status);
+      this.blocked = true;
 
       // Get estimated payload size of our backlog
       const textEncoder = new TextEncoder();
@@ -217,6 +228,7 @@ class Aggregate extends _aggregateBase.AggregateBase {
       }
     } catch (error) {
       this.ee.abort();
+      this.blocked = true;
       (0, _console.warn)(17, error);
       return;
     }

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

@@ -11,7 +11,7 @@
 /**
  * Exposes the version of the agent
  */
-export const VERSION = "1.302.0-rc.6";
+export const VERSION = "1.302.0-rc.7";
 
 /**
  * Exposes the build type of the agent

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

@@ -11,7 +11,7 @@
 /**
  * Exposes the version of the agent
  */
-export const VERSION = "1.302.0-rc.6";
+export const VERSION = "1.302.0-rc.7";
 
 /**
  * Exposes the build type of the agent

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

@@ -17,8 +17,10 @@ import { stringify } from '../util/stringify';
 import { getSubmitMethod, xhr as xhrMethod, xhrFetch as fetchMethod } from '../util/submit-data';
 import { activatedFeatures } from '../util/feature-flags';
 import { dispatchGlobalEvent } from '../dispatch/global-event';
-const RETRY_FAILED = 'Harvester/Retry/Failed/';
-const RETRY_SUCCEEDED = 'Harvester/Retry/Succeeded/';
+const RETRY = 'Harvester/Retry/';
+const RETRY_ATTEMPTED = RETRY + 'Attempted/';
+const RETRY_FAILED = RETRY + 'Failed/';
+const RETRY_SUCCEEDED = RETRY + 'Succeeded/';
 export class Harvester {
   #started = false;
   initializedAggregates = [];
@@ -62,8 +64,7 @@ export class Harvester {
     const submitMethod = getSubmitMethod(localOpts);
     if (!submitMethod) return output;
     const shouldRetryOnFail = !localOpts.isFinalHarvest && submitMethod === xhrMethod; // always retry all features harvests except for final
-    output.payload = !localOpts.directSend ? aggregateInst.makeHarvestPayload(shouldRetryOnFail, localOpts) : localOpts.directSend?.payload; // features like PVE can define the payload directly, bypassing the makeHarvestPayload logic
-
+    output.payload = aggregateInst.makeHarvestPayload(shouldRetryOnFail, localOpts);
     if (!output.payload) return output;
     send(this.agentRef, {
       endpoint: FEATURE_TO_ENDPOINT[aggregateInst.featureName],
@@ -85,7 +86,9 @@ export class Harvester {
     function cbFinished(result) {
       if (aggregateInst.harvestOpts.prevAttemptCode) {
         // this means we just retried a harvest that last failed
-        handle(SUPPORTABILITY_METRIC_CHANNEL, [(result.retry ? RETRY_FAILED : RETRY_SUCCEEDED) + aggregateInst.harvestOpts.prevAttemptCode], undefined, FEATURE_NAMES.metrics, aggregateInst.ee);
+        const reportSM = message => handle(SUPPORTABILITY_METRIC_CHANNEL, [message], undefined, FEATURE_NAMES.metrics, aggregateInst.ee);
+        reportSM(RETRY_ATTEMPTED + aggregateInst.featureName);
+        reportSM((result.retry ? RETRY_FAILED : RETRY_SUCCEEDED) + aggregateInst.harvestOpts.prevAttemptCode);
         delete aggregateInst.harvestOpts.prevAttemptCode; // always reset last observation so we don't falsely report again next harvest
         // In case this re-attempt failed again, that'll be handled (re-marked again) next.
       }
@@ -175,9 +178,9 @@ export function send(agentRef, {
           status: this.status,
           retry: shouldRetry(this.status),
           fullUrl,
-          xhr: this
+          xhr: this,
+          responseText: this.responseText
         };
-        if (localOpts.needResponse) cbResult.responseText = this.responseText;
         cbFinished(cbResult);
 
         /** temporary audit of consistency of harvest metadata flags */
@@ -191,9 +194,9 @@ export function send(agentRef, {
           status,
           retry: shouldRetry(status),
           fullUrl,
-          fetchResponse: response
+          fetchResponse: response,
+          responseText: await response.text()
         };
-        if (localOpts.needResponse) cbResult.responseText = await response.text();
         cbFinished(cbResult);
         /** temporary audit of consistency of harvest metadata flags */
         if (!shouldRetry(status)) trackHarvestMetadata();

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

@@ -24,7 +24,6 @@
  * @property {HarvestEndpointIdentifier} endpoint The endpoint to use (jserrors, events, resources etc.)
  * @property {HarvestPayload} payload Object representing payload.
  * @property {object} localOpts Additional options for sending data
- * @property {boolean} localOpts.needResponse Specify whether the caller expects a response data.
  * @property {boolean} localOpts.isFinalHarvest Specify whether the call is a final harvest during page unload.
  * @property {boolean} localOpts.sendEmptyBody Specify whether the call should be made even if the body is empty. Useful for rum calls.
  * @property {boolean} localOpts.forceNoRetry Don't save the buffered data in the case of a need to retry the transmission.

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

@@ -27,7 +27,7 @@ export class Aggregate extends AggregateBase {
     this.timeToFirstByte = 0;
     this.firstByteToWindowLoad = 0; // our "frontend" duration
     this.firstByteToDomContent = 0; // our "dom processing" duration
-
+    this.retries = 0;
     if (!isValid(agentRef.info)) {
       this.ee.abort();
       return warn(43);
@@ -55,12 +55,8 @@ export class Aggregate extends AggregateBase {
    *
    * @param {Function} cb A function to run once the RUM call has finished - Defaults to activateFeatures
    * @param {*} customAttributes custom attributes to attach to the RUM call - Defaults to info.js
-   * @param {*} target The target to harvest to
    */
-  sendRum(customAttributes = this.agentRef.info.jsAttributes, target = {
-    licenseKey: this.agentRef.info.licenseKey,
-    applicationID: this.agentRef.info.applicationID
-  }) {
+  sendRum(customAttributes = this.agentRef.info.jsAttributes) {
     const info = this.agentRef.info;
     const measures = {};
     if (info.queueTime) measures.qt = info.queueTime;
@@ -111,27 +107,30 @@ export class Aggregate extends AggregateBase {
     }
     queryParameters.fp = firstPaint.current.value;
     queryParameters.fcp = firstContentfulPaint.current.value;
-    const timeKeeper = this.agentRef.runtime.timeKeeper;
-    if (timeKeeper?.ready) {
-      queryParameters.timestamp = Math.floor(timeKeeper.correctRelativeTimestamp(now()));
-    }
-    this.rumStartTime = now();
+    this.queryStringsBuilder = () => {
+      // this will be called by AggregateBase.makeHarvestPayload every time harvest is triggered to be qs
+      this.rumStartTime = now(); // this should be reset at the beginning of each RUM call for proper timeKeeper calculation in coordination with postHarvestCleanup
+      const timeKeeper = this.agentRef.runtime.timeKeeper;
+      if (timeKeeper?.ready) {
+        queryParameters.timestamp = Math.floor(timeKeeper.correctRelativeTimestamp(this.rumStartTime));
+      }
+      return queryParameters;
+    };
+    this.events.add(body);
     this.agentRef.runtime.harvester.triggerHarvestFor(this, {
-      directSend: {
-        target,
-        payload: {
-          qs: queryParameters,
-          body
-        }
-      },
-      needResponse: true,
       sendEmptyBody: true
     });
   }
+  serializer(eventBuffer) {
+    // this is necessary because PVE sends a single item rather than an array; in the case of undefined, this prevents sending [null] as body
+    return eventBuffer[0];
+  }
   postHarvestCleanup({
+    sent,
     status,
     responseText,
-    xhr
+    xhr,
+    retry
   }) {
     const rumEndTime = now();
     let app, flags;
@@ -144,8 +143,20 @@ export class Aggregate extends AggregateBase {
       // wont set entity stuff here, if main agent will later abort, if registered agent, nothing will happen
       warn(53, error);
     }
+    super.postHarvestCleanup({
+      sent,
+      retry
+    }); // this will set isRetrying & re-buffer the body if request is to be retried
+    if (this.isRetrying && this.retries++ < 1) {
+      // Only retry once
+      setTimeout(() => this.agentRef.runtime.harvester.triggerHarvestFor(this, {
+        sendEmptyBody: true
+      }), 5000); // Retry sending the RUM event after 5 seconds
+      return;
+    }
     if (status >= 400 || status === 0) {
       warn(18, status);
+      this.blocked = true;
 
       // Get estimated payload size of our backlog
       const textEncoder = new TextEncoder();
@@ -209,6 +220,7 @@ export class Aggregate extends AggregateBase {
       }
     } catch (error) {
       this.ee.abort();
+      this.blocked = true;
       warn(17, error);
       return;
     }

package/dist/types/common/harvest/harvester.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"harvester.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/harvester.js"],"names":[],"mappings":"AAyGA;;;;IAII;AACJ;;;;;;;;;IAFc,OAAO,CAyHpB;AA9MD;IAIE,2BAUC;IAZD,6BAA0B;IAGxB,cAAwB;IAW1B,wCASC;IAED;;;;;OAKG;IACH,iCAJW,MAAM,cACN,MAAM,GACJ,OAAO,CA2CnB;;CACF;8BAGY,OAAO,YAAY,EAAE,eAAe"}
+{"version":3,"file":"harvester.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/harvester.js"],"names":[],"mappings":"AA6GA;;;;IAII;AACJ;;;;;;;;;IAFc,OAAO,CAuHpB;AA9MD;IAIE,2BAUC;IAZD,6BAA0B;IAGxB,cAAwB;IAW1B,wCASC;IAED;;;;;OAKG;IACH,iCAJW,MAAM,cACN,MAAM,GACJ,OAAO,CA6CnB;;CACF;8BAGY,OAAO,YAAY,EAAE,eAAe"}

package/dist/types/common/harvest/types.d.ts

@@ -20,7 +20,6 @@
  * @property {HarvestEndpointIdentifier} endpoint The endpoint to use (jserrors, events, resources etc.)
  * @property {HarvestPayload} payload Object representing payload.
  * @property {object} localOpts Additional options for sending data
- * @property {boolean} localOpts.needResponse Specify whether the caller expects a response data.
  * @property {boolean} localOpts.isFinalHarvest Specify whether the call is a final harvest during page unload.
  * @property {boolean} localOpts.sendEmptyBody Specify whether the call should be made even if the body is empty. Useful for rum calls.
  * @property {boolean} localOpts.forceNoRetry Don't save the buffered data in the case of a need to retry the transmission.
@@ -51,7 +50,6 @@ export type NetworkSendSpec = {
      * Additional options for sending data
      */
     localOpts: {
-        needResponse: boolean;
         isFinalHarvest: boolean;
         sendEmptyBody: boolean;
         forceNoRetry: boolean;

package/dist/types/common/harvest/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/types.js"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;;;;GAUG;AAEH,wBAAwB;wCArBX,KAAK,GAAC,UAAU,GAAC,QAAQ,GAAC,KAAK,GAAC,WAAW,GAAC,MAAM;;;;;QAKjD,MAAM;;;;UACN,MAAM;;;;;;cAKN,yBAAyB;;;;aACzB,cAAc;;;;eAEzB;QAA8B,YAAY,EAA/B,OAAO;QACY,cAAc,EAAjC,OAAO;QACY,aAAa,EAAhC,OAAO;QACY,YAAY,EAA/B,OAAO;KAClB;;;;kBAAW,OAAO,wBAAwB,EAAE,cAAc"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/types.js"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;;;GASG;AAEH,wBAAwB;wCApBX,KAAK,GAAC,UAAU,GAAC,QAAQ,GAAC,KAAK,GAAC,WAAW,GAAC,MAAM;;;;;QAKjD,MAAM;;;;UACN,MAAM;;;;;;cAKN,yBAAyB;;;;aACzB,cAAc;;;;eAEzB;QAA8B,cAAc,EAAjC,OAAO;QACY,aAAa,EAAhC,OAAO;QACY,YAAY,EAA/B,OAAO;KAClB;;;;kBAAW,OAAO,wBAAwB,EAAE,cAAc"}

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

@@ -4,18 +4,36 @@ export class Aggregate extends AggregateBase {
     timeToFirstByte: number;
     firstByteToWindowLoad: number;
     firstByteToDomContent: number;
+    retries: number;
     /**
      *
      * @param {Function} cb A function to run once the RUM call has finished - Defaults to activateFeatures
      * @param {*} customAttributes custom attributes to attach to the RUM call - Defaults to info.js
-     * @param {*} target The target to harvest to
      */
-    sendRum(customAttributes?: any, target?: any): void;
+    sendRum(customAttributes?: any): void;
+    queryStringsBuilder: (() => {
+        xx: any;
+        ua: any;
+        at: any;
+        qt: any;
+        ap: any;
+        be: number;
+        fe: number;
+        dc: number;
+        tt: any;
+        us: any;
+        ac: any;
+        pr: any;
+        af: string;
+    }) | undefined;
     rumStartTime: number | undefined;
-    postHarvestCleanup({ status, responseText, xhr }: {
+    serializer(eventBuffer: any): any;
+    postHarvestCleanup({ sent, status, responseText, xhr, retry }: {
+        sent: any;
         status: any;
         responseText: any;
         xhr: any;
+        retry: any;
     }): void;
 }
 import { AggregateBase } from '../../utils/aggregate-base';

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":"AAuBA;IACE,2BAA2C;IAC3C,2BA0BC;IAvBC,wBAAwB;IACxB,8BAA8B;IAC9B,8BAA8B;IAuBhC;;;;;OAKG;IACH,2BAHW,GAAC,WACD,GAAC,QAsEX;IAVC,iCAAyB;IAY3B;;;;aAwFC;CACF;8BA9M6B,4BAA4B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/page_view_event/aggregate/index.js"],"names":[],"mappings":"AAuBA;IACE,2BAA2C;IAC3C,2BA2BC;IAxBC,wBAAwB;IACxB,8BAA8B;IAC9B,8BAA8B;IAC9B,gBAAgB;IAuBlB;;;;OAIG;IACH,2BAFW,GAAC,QAoEX;IAbC;;;;;;;;;;;;;;mBAOC;IANC,iCAAyB;IAc7B,kCAEC;IAED;;;;;;aAiGC;CACF;8BAzN6B,4BAA4B"}

package/package.json

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

package/src/common/harvest/harvester.js

@@ -18,8 +18,10 @@ import { getSubmitMethod, xhr as xhrMethod, xhrFetch as fetchMethod } from '../u
 import { activatedFeatures } from '../util/feature-flags'
 import { dispatchGlobalEvent } from '../dispatch/global-event'
 
-const RETRY_FAILED = 'Harvester/Retry/Failed/'
-const RETRY_SUCCEEDED = 'Harvester/Retry/Succeeded/'
+const RETRY = 'Harvester/Retry/'
+const RETRY_ATTEMPTED = RETRY + 'Attempted/'
+const RETRY_FAILED = RETRY + 'Failed/'
+const RETRY_SUCCEEDED = RETRY + 'Succeeded/'
 
 export class Harvester {
   #started = false
@@ -62,7 +64,7 @@ export class Harvester {
     if (!submitMethod) return output
 
     const shouldRetryOnFail = !localOpts.isFinalHarvest && submitMethod === xhrMethod // always retry all features harvests except for final
-    output.payload = !localOpts.directSend ? aggregateInst.makeHarvestPayload(shouldRetryOnFail, localOpts) : localOpts.directSend?.payload // features like PVE can define the payload directly, bypassing the makeHarvestPayload logic
+    output.payload = aggregateInst.makeHarvestPayload(shouldRetryOnFail, localOpts)
 
     if (!output.payload) return output
 
@@ -86,7 +88,9 @@ export class Harvester {
      */
     function cbFinished (result) {
       if (aggregateInst.harvestOpts.prevAttemptCode) { // this means we just retried a harvest that last failed
-        handle(SUPPORTABILITY_METRIC_CHANNEL, [(result.retry ? RETRY_FAILED : RETRY_SUCCEEDED) + aggregateInst.harvestOpts.prevAttemptCode], undefined, FEATURE_NAMES.metrics, aggregateInst.ee)
+        const reportSM = (message) => handle(SUPPORTABILITY_METRIC_CHANNEL, [message], undefined, FEATURE_NAMES.metrics, aggregateInst.ee)
+        reportSM(RETRY_ATTEMPTED + aggregateInst.featureName)
+        reportSM((result.retry ? RETRY_FAILED : RETRY_SUCCEEDED) + aggregateInst.harvestOpts.prevAttemptCode)
         delete aggregateInst.harvestOpts.prevAttemptCode // always reset last observation so we don't falsely report again next harvest
         // In case this re-attempt failed again, that'll be handled (re-marked again) next.
       }
@@ -155,8 +159,7 @@ export function send (agentRef, { endpoint, payload, localOpts = {}, submitMetho
       result.addEventListener('loadend', function () {
         // `this` here in block refers to the XHR object in this scope, do not change the anon function to an arrow function
         // status 0 refers to a local error, such as CORS or network failure, or a blocked request by the browser (e.g. adblocker)
-        const cbResult = { sent: this.status !== 0, status: this.status, retry: shouldRetry(this.status), fullUrl, xhr: this }
-        if (localOpts.needResponse) cbResult.responseText = this.responseText
+        const cbResult = { sent: this.status !== 0, status: this.status, retry: shouldRetry(this.status), fullUrl, xhr: this, responseText: this.responseText }
         cbFinished(cbResult)
 
         /** temporary audit of consistency of harvest metadata flags */
@@ -165,8 +168,7 @@ export function send (agentRef, { endpoint, payload, localOpts = {}, submitMetho
     } else if (submitMethod === fetchMethod) {
       result.then(async function (response) {
         const status = response.status
-        const cbResult = { sent: true, status, retry: shouldRetry(status), fullUrl, fetchResponse: response }
-        if (localOpts.needResponse) cbResult.responseText = await response.text()
+        const cbResult = { sent: true, status, retry: shouldRetry(status), fullUrl, fetchResponse: response, responseText: await response.text() }
         cbFinished(cbResult)
         /** temporary audit of consistency of harvest metadata flags */
         if (!shouldRetry(status)) trackHarvestMetadata()

package/src/common/harvest/types.js

@@ -24,7 +24,6 @@
  * @property {HarvestEndpointIdentifier} endpoint The endpoint to use (jserrors, events, resources etc.)
  * @property {HarvestPayload} payload Object representing payload.
  * @property {object} localOpts Additional options for sending data
- * @property {boolean} localOpts.needResponse Specify whether the caller expects a response data.
  * @property {boolean} localOpts.isFinalHarvest Specify whether the call is a final harvest during page unload.
  * @property {boolean} localOpts.sendEmptyBody Specify whether the call should be made even if the body is empty. Useful for rum calls.
  * @property {boolean} localOpts.forceNoRetry Don't save the buffered data in the case of a need to retry the transmission.

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

@@ -29,6 +29,7 @@ export class Aggregate extends AggregateBase {
     this.timeToFirstByte = 0
     this.firstByteToWindowLoad = 0 // our "frontend" duration
     this.firstByteToDomContent = 0 // our "dom processing" duration
+    this.retries = 0
 
     if (!isValid(agentRef.info)) {
       this.ee.abort()
@@ -55,9 +56,8 @@ export class Aggregate extends AggregateBase {
    *
    * @param {Function} cb A function to run once the RUM call has finished - Defaults to activateFeatures
    * @param {*} customAttributes custom attributes to attach to the RUM call - Defaults to info.js
-   * @param {*} target The target to harvest to
    */
-  sendRum (customAttributes = this.agentRef.info.jsAttributes, target = { licenseKey: this.agentRef.info.licenseKey, applicationID: this.agentRef.info.applicationID }) {
+  sendRum (customAttributes = this.agentRef.info.jsAttributes) {
     const info = this.agentRef.info
     const measures = {}
 
@@ -110,24 +110,26 @@ export class Aggregate extends AggregateBase {
     queryParameters.fp = firstPaint.current.value
     queryParameters.fcp = firstContentfulPaint.current.value
 
-    const timeKeeper = this.agentRef.runtime.timeKeeper
-    if (timeKeeper?.ready) {
-      queryParameters.timestamp = Math.floor(timeKeeper.correctRelativeTimestamp(now()))
+    this.queryStringsBuilder = () => { // this will be called by AggregateBase.makeHarvestPayload every time harvest is triggered to be qs
+      this.rumStartTime = now() // this should be reset at the beginning of each RUM call for proper timeKeeper calculation in coordination with postHarvestCleanup
+      const timeKeeper = this.agentRef.runtime.timeKeeper
+      if (timeKeeper?.ready) {
+        queryParameters.timestamp = Math.floor(timeKeeper.correctRelativeTimestamp(this.rumStartTime))
+      }
+      return queryParameters
     }
-
-    this.rumStartTime = now()
+    this.events.add(body)
 
     this.agentRef.runtime.harvester.triggerHarvestFor(this, {
-      directSend: {
-        target,
-        payload: { qs: queryParameters, body }
-      },
-      needResponse: true,
       sendEmptyBody: true
     })
   }
 
-  postHarvestCleanup ({ status, responseText, xhr }) {
+  serializer (eventBuffer) { // this is necessary because PVE sends a single item rather than an array; in the case of undefined, this prevents sending [null] as body
+    return eventBuffer[0]
+  }
+
+  postHarvestCleanup ({ sent, status, responseText, xhr, retry }) {
     const rumEndTime = now()
     let app, flags
     try {
@@ -137,8 +139,16 @@ export class Aggregate extends AggregateBase {
       warn(53, error)
     }
 
+    super.postHarvestCleanup({ sent, retry }) // this will set isRetrying & re-buffer the body if request is to be retried
+    if (this.isRetrying && this.retries++ < 1) { // Only retry once
+      setTimeout(() => this.agentRef.runtime.harvester.triggerHarvestFor(this, {
+        sendEmptyBody: true
+      }), 5000) // Retry sending the RUM event after 5 seconds
+      return
+    }
     if (status >= 400 || status === 0) {
       warn(18, status)
+      this.blocked = true
 
       // Get estimated payload size of our backlog
       const textEncoder = new TextEncoder()
@@ -205,6 +215,7 @@ export class Aggregate extends AggregateBase {
       }
     } catch (error) {
       this.ee.abort()
+      this.blocked = true
       warn(17, error)
       return
     }