@newrelic/browser-agent 1.233.0 → 1.233.1

package/dist/cjs/cdn/experimental.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _agent = require("../loaders/agent");
+var _instrument = require("../features/page_view_event/instrument");
+var _instrument2 = require("../features/page_view_timing/instrument");
+var _instrument3 = require("../features/metrics/instrument");
+var _instrument4 = require("../features/jserrors/instrument");
+var _instrument5 = require("../features/ajax/instrument");
+var _instrument6 = require("../features/session_trace/instrument");
+var _instrument7 = require("../features/session_replay/instrument");
+var _instrument8 = require("../features/spa/instrument");
+var _instrument9 = require("../features/page_action/instrument");
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * @file Creates an "EXPERIMENTAL" agent loader bundle composed of the core agent and all available feature modules, including experimental features.
+ *
+ * NOTE: This loader is ONLY used for internal testing. The code contained within is likely under development and dormant. It will not download to instrumented pages or record any data.
+ * It is not production ready, and is not intended to be imported or implemented in any build of the browser agent
+ */
+
+new _agent.Agent({
+  features: [_instrument5.Instrument, _instrument.Instrument, _instrument2.Instrument, _instrument6.Instrument, _instrument7.Instrument, _instrument3.Instrument, _instrument9.Instrument, _instrument4.Instrument, _instrument8.Instrument],
+  loaderType: 'experimental'
+});

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

@@ -68,7 +68,7 @@ const model = () => {
     },
     session_replay: {
       // feature settings
-      enabled: true,
+      enabled: false,
       harvestTimeSeconds: 60,
       sampleRate: 0.1,
       errorSampleRate: 0.1,

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

@@ -12,7 +12,7 @@ exports.VERSION = exports.DIST_METHOD = exports.BUILD_ENV = void 0;
 /**
  * Exposes the version of the agent
  */
-const VERSION = "1.233.0";
+const VERSION = "1.233.1";
 
 /**
  * Exposes the build type of the agent

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

@@ -12,7 +12,7 @@ exports.VERSION = exports.DIST_METHOD = exports.BUILD_ENV = void 0;
 /**
  * Exposes the version of the agent
  */
-const VERSION = "1.233.0";
+const VERSION = "1.233.1";
 
 /**
  * Exposes the build type of the agent

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

@@ -18,6 +18,17 @@ var _config = require("../config/config");
  * Periodically invokes harvest calls and handles retries
  */
 class HarvestScheduler extends _sharedContext.SharedContext {
+  /**
+     * Create a HarvestScheduler
+     * @param {string} endpoint - The base BAM endpoint name -- ex. 'events'
+     * @param {object} opts - The options used to configure the HarvestScheduler
+     * @param {Function} opts.onFinished - The callback to be fired when a harvest has finished
+     * @param {Function} opts.getPayload - A callback which can be triggered to return a payload for harvesting
+     * @param {number} opts.retryDelay - The number of seconds to wait before retrying after a network failure
+     * @param {boolean} opts.raw - Use a prefabricated payload shape as the harvest payload without the need for formatting
+     * @param {string} opts.customUrl - A custom url that falls outside of the shape of the standard BAM harvester url pattern.  Will use directly instead of concatenating various pieces
+     * @param {*} parent - The parent object, whose state can be passed into SharedContext
+     */
   constructor(endpoint, opts, parent) {
     super(parent); // gets any allowed properties from the parent and stores them in `sharedContext`
     this.endpoint = endpoint;
@@ -79,7 +90,12 @@ class HarvestScheduler extends _sharedContext.SharedContext {
       var payload = this.opts.getPayload({
         retry: retry
       });
-      if (!payload) return;
+      if (!payload) {
+        if (this.started) {
+          this.scheduleHarvest();
+        }
+        return;
+      }
       payload = Object.prototype.toString.call(payload) === '[object Array]' ? payload : [payload];
       harvests.push(...payload);
     }
@@ -101,9 +117,8 @@ class HarvestScheduler extends _sharedContext.SharedContext {
         opts,
         submitMethod,
         cbFinished: onHarvestFinished,
-        includeBaseParams: this.opts.includeBaseParams,
         customUrl: this.opts.customUrl,
-        gzip: this.opts.gzip
+        raw: this.opts.raw
       });
     });
     if (this.started) {

package/dist/cjs/common/harvest/harvest-scheduler.test.js

@@ -0,0 +1,39 @@
+"use strict";
+
+var _init = require("../config/state/init");
+var _harvestScheduler = require("./harvest-scheduler");
+describe('runHarvest', () => {
+  it('should re-schedule harvest even if there is no accumulated data', () => {
+    (0, _init.setConfiguration)('asdf', {});
+    const scheduler = new _harvestScheduler.HarvestScheduler('events', {
+      getPayload: jest.fn()
+    }, {
+      agentIdentifier: 'asdf',
+      ee: {
+        on: jest.fn()
+      }
+    });
+    scheduler.started = true;
+    jest.spyOn(scheduler, 'scheduleHarvest');
+    scheduler.runHarvest();
+    expect(scheduler.opts.getPayload()).toBeFalsy();
+    expect(scheduler.scheduleHarvest).toHaveBeenCalledTimes(1);
+  });
+  it('should also re-schedule harvest if there is accumulated data', () => {
+    (0, _init.setConfiguration)('asdf', {});
+    const scheduler = new _harvestScheduler.HarvestScheduler('events', {
+      getPayload: jest.fn().mockImplementation(() => 'payload')
+    }, {
+      agentIdentifier: 'asdf',
+      ee: {
+        on: jest.fn()
+      }
+    });
+    scheduler.started = true;
+    scheduler.harvest._send = () => {};
+    jest.spyOn(scheduler, 'scheduleHarvest');
+    scheduler.runHarvest();
+    expect(scheduler.opts.getPayload()).toBeTruthy();
+    expect(scheduler.scheduleHarvest).toHaveBeenCalledTimes(1);
+  });
+});

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

@@ -125,7 +125,7 @@ class Harvest extends _sharedContext.SharedContext {
       submitMethod,
       cbFinished,
       customUrl,
-      gzip,
+      raw,
       includeBaseParams = true
     } = _ref;
     var info = (0, _config.getInfo)(this.sharedContext.agentIdentifier);
@@ -140,16 +140,18 @@ class Harvest extends _sharedContext.SharedContext {
       }
       return false;
     }
-    var url = customUrl || this.getScheme() + '://' + info.errorBeacon + '/' + endpoint + '/1/' + info.licenseKey + '?';
-    var baseParams = includeBaseParams ? this.baseQueryString() : '';
-    var params = payload.qs ? (0, _encode.obj)(payload.qs, agentRuntime.maxBytes) : '';
+    let url = '';
+    if (customUrl) url = customUrl;else if (raw) url = "".concat(this.getScheme(), "://").concat(info.errorBeacon, "/").concat(endpoint);else url = "".concat(this.getScheme(), "://").concat(info.errorBeacon, "/").concat(endpoint, "/1/").concat(info.licenseKey);
+    var baseParams = !raw && includeBaseParams ? this.baseQueryString() : '';
+    var payloadParams = payload.qs ? (0, _encode.obj)(payload.qs, agentRuntime.maxBytes) : '';
     if (!submitMethod) {
       submitMethod = getSubmitMethod(endpoint, opts);
     }
     var method = submitMethod.method;
     var useBody = submitMethod.useBody;
     var body;
-    var fullUrl = url + baseParams + params;
+    var fullUrl = "".concat(url, "?").concat(baseParams).concat(payloadParams);
+    const gzip = payload?.qs?.content_encoding === 'gzip';
     if (!gzip) {
       if (useBody && endpoint === 'events') {
         body = payload.body.e;
@@ -165,25 +167,10 @@ class Harvest extends _sharedContext.SharedContext {
     // 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'
-      });
-    }
+    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),

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

@@ -95,11 +95,7 @@ class Aggregate extends _aggregateBase.AggregateBase {
       onFinished: this.onHarvestFinished.bind(this),
       retryDelay: this.harvestTimeSeconds,
       getPayload: this.prepareHarvest.bind(this),
-      // TODO -- this stuff needs a better way to be handled
-      includeBaseParams: false,
-      customUrl: 'https://vortex-alb.stg-single-tooth.cell.us.nr-data.net/blob',
-      raw: true,
-      gzip: true
+      raw: true
     }, this);
 
     // Wait for an error to be reported.  This currently is wrapped around the "Error" feature.  This is a feature-feature dependency.
@@ -159,7 +155,7 @@ class Aggregate extends _aggregateBase.AggregateBase {
       if (fullSample) this.mode = MODE.FULL; // full mode has precedence over error mode
       else if (errorSample) this.mode = MODE.ERROR;
       // If neither are selected, then don't record (early return)
-      return;
+      else return;
     }
 
     // FULL mode records AND reports from the beginning, while ERROR mode only records (but does not report).
@@ -169,6 +165,11 @@ class Aggregate extends _aggregateBase.AggregateBase {
       // We only report (harvest) in FULL mode
       this.scheduler.startTimer(this.harvestTimeSeconds);
     }
+
+    // If an error was noticed before the mode could be set (like in the early lifecycle of the page), immediately set to FULL mode
+    if (this.mode === MODE.ERROR && this.errorNoticed) {
+      this.mode = MODE.FULL;
+    }
     // We record in FULL or ERROR mode
 
     recorder = (await Promise.resolve().then(() => _interopRequireWildcard(require( /* webpackChunkName: "recorder" */'rrweb')))).record;
@@ -201,7 +202,9 @@ class Aggregate extends _aggregateBase.AggregateBase {
     const info = (0, _config.getInfo)(this.agentIdentifier);
     return {
       qs: {
-        protocol_version: '0'
+        protocol_version: '0',
+        content_encoding: 'gzip',
+        browser_monitoring_key: info.licenseKey
       },
       body: {
         type: 'SessionReplay',

package/dist/esm/cdn/experimental.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * @file Creates an "EXPERIMENTAL" agent loader bundle composed of the core agent and all available feature modules, including experimental features.
+ *
+ * NOTE: This loader is ONLY used for internal testing. The code contained within is likely under development and dormant. It will not download to instrumented pages or record any data.
+ * It is not production ready, and is not intended to be imported or implemented in any build of the browser agent
+ */
+import { Agent } from '../loaders/agent';
+import { Instrument as InstrumentPageViewEvent } from '../features/page_view_event/instrument';
+import { Instrument as InstrumentPageViewTiming } from '../features/page_view_timing/instrument';
+import { Instrument as InstrumentMetrics } from '../features/metrics/instrument';
+import { Instrument as InstrumentErrors } from '../features/jserrors/instrument';
+import { Instrument as InstrumentXhr } from '../features/ajax/instrument';
+import { Instrument as InstrumentSessionTrace } from '../features/session_trace/instrument';
+import { Instrument as InstrumentSessionReplay } from '../features/session_replay/instrument';
+import { Instrument as InstrumentSpa } from '../features/spa/instrument';
+import { Instrument as InstrumentPageAction } from '../features/page_action/instrument';
+new Agent({
+  features: [InstrumentXhr, InstrumentPageViewEvent, InstrumentPageViewTiming, InstrumentSessionTrace, InstrumentSessionReplay, InstrumentMetrics, InstrumentPageAction, InstrumentErrors, InstrumentSpa],
+  loaderType: 'experimental'
+});

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

@@ -60,7 +60,7 @@ const model = () => {
     },
     session_replay: {
       // feature settings
-      enabled: true,
+      enabled: false,
       harvestTimeSeconds: 60,
       sampleRate: 0.1,
       errorSampleRate: 0.1,

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

@@ -6,7 +6,7 @@
 /**
  * Exposes the version of the agent
  */
-export const VERSION = "1.233.0";
+export const VERSION = "1.233.1";
 
 /**
  * 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.233.0";
+export const VERSION = "1.233.1";
 
 /**
  * Exposes the build type of the agent

package/dist/esm/common/harvest/harvest-scheduler.js

@@ -13,6 +13,17 @@ import { getConfigurationValue } from '../config/config';
  * Periodically invokes harvest calls and handles retries
  */
 export class HarvestScheduler extends SharedContext {
+  /**
+     * Create a HarvestScheduler
+     * @param {string} endpoint - The base BAM endpoint name -- ex. 'events'
+     * @param {object} opts - The options used to configure the HarvestScheduler
+     * @param {Function} opts.onFinished - The callback to be fired when a harvest has finished
+     * @param {Function} opts.getPayload - A callback which can be triggered to return a payload for harvesting
+     * @param {number} opts.retryDelay - The number of seconds to wait before retrying after a network failure
+     * @param {boolean} opts.raw - Use a prefabricated payload shape as the harvest payload without the need for formatting
+     * @param {string} opts.customUrl - A custom url that falls outside of the shape of the standard BAM harvester url pattern.  Will use directly instead of concatenating various pieces
+     * @param {*} parent - The parent object, whose state can be passed into SharedContext
+     */
   constructor(endpoint, opts, parent) {
     super(parent); // gets any allowed properties from the parent and stores them in `sharedContext`
     this.endpoint = endpoint;
@@ -74,7 +85,12 @@ export class HarvestScheduler extends SharedContext {
       var payload = this.opts.getPayload({
         retry: retry
       });
-      if (!payload) return;
+      if (!payload) {
+        if (this.started) {
+          this.scheduleHarvest();
+        }
+        return;
+      }
       payload = Object.prototype.toString.call(payload) === '[object Array]' ? payload : [payload];
       harvests.push(...payload);
     }
@@ -96,9 +112,8 @@ export class HarvestScheduler extends SharedContext {
         opts,
         submitMethod,
         cbFinished: onHarvestFinished,
-        includeBaseParams: this.opts.includeBaseParams,
         customUrl: this.opts.customUrl,
-        gzip: this.opts.gzip
+        raw: this.opts.raw
       });
     });
     if (this.started) {

package/dist/esm/common/harvest/harvest-scheduler.test.js

@@ -0,0 +1,37 @@
+import { setConfiguration } from '../config/state/init';
+import { HarvestScheduler } from './harvest-scheduler';
+describe('runHarvest', () => {
+  it('should re-schedule harvest even if there is no accumulated data', () => {
+    setConfiguration('asdf', {});
+    const scheduler = new HarvestScheduler('events', {
+      getPayload: jest.fn()
+    }, {
+      agentIdentifier: 'asdf',
+      ee: {
+        on: jest.fn()
+      }
+    });
+    scheduler.started = true;
+    jest.spyOn(scheduler, 'scheduleHarvest');
+    scheduler.runHarvest();
+    expect(scheduler.opts.getPayload()).toBeFalsy();
+    expect(scheduler.scheduleHarvest).toHaveBeenCalledTimes(1);
+  });
+  it('should also re-schedule harvest if there is accumulated data', () => {
+    setConfiguration('asdf', {});
+    const scheduler = new HarvestScheduler('events', {
+      getPayload: jest.fn().mockImplementation(() => 'payload')
+    }, {
+      agentIdentifier: 'asdf',
+      ee: {
+        on: jest.fn()
+      }
+    });
+    scheduler.started = true;
+    scheduler.harvest._send = () => {};
+    jest.spyOn(scheduler, 'scheduleHarvest');
+    scheduler.runHarvest();
+    expect(scheduler.opts.getPayload()).toBeTruthy();
+    expect(scheduler.scheduleHarvest).toHaveBeenCalledTimes(1);
+  });
+});

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

@@ -119,7 +119,7 @@ export class Harvest extends SharedContext {
       submitMethod,
       cbFinished,
       customUrl,
-      gzip,
+      raw,
       includeBaseParams = true
     } = _ref;
     var info = getInfo(this.sharedContext.agentIdentifier);
@@ -134,16 +134,18 @@ export class Harvest extends SharedContext {
       }
       return false;
     }
-    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) : '';
+    let url = '';
+    if (customUrl) url = customUrl;else if (raw) url = "".concat(this.getScheme(), "://").concat(info.errorBeacon, "/").concat(endpoint);else url = "".concat(this.getScheme(), "://").concat(info.errorBeacon, "/").concat(endpoint, "/1/").concat(info.licenseKey);
+    var baseParams = !raw && includeBaseParams ? this.baseQueryString() : '';
+    var payloadParams = payload.qs ? encodeObj(payload.qs, agentRuntime.maxBytes) : '';
     if (!submitMethod) {
       submitMethod = getSubmitMethod(endpoint, opts);
     }
     var method = submitMethod.method;
     var useBody = submitMethod.useBody;
     var body;
-    var fullUrl = url + baseParams + params;
+    var fullUrl = "".concat(url, "?").concat(baseParams).concat(payloadParams);
+    const gzip = payload?.qs?.content_encoding === 'gzip';
     if (!gzip) {
       if (useBody && endpoint === 'events') {
         body = payload.body.e;
@@ -159,25 +161,10 @@ export class Harvest extends SharedContext {
     // 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'
-      });
-    }
+    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),

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

@@ -90,11 +90,7 @@ export class Aggregate extends AggregateBase {
       onFinished: this.onHarvestFinished.bind(this),
       retryDelay: this.harvestTimeSeconds,
       getPayload: this.prepareHarvest.bind(this),
-      // TODO -- this stuff needs a better way to be handled
-      includeBaseParams: false,
-      customUrl: 'https://vortex-alb.stg-single-tooth.cell.us.nr-data.net/blob',
-      raw: true,
-      gzip: true
+      raw: true
     }, this);
 
     // Wait for an error to be reported.  This currently is wrapped around the "Error" feature.  This is a feature-feature dependency.
@@ -154,7 +150,7 @@ export class Aggregate extends AggregateBase {
       if (fullSample) this.mode = MODE.FULL; // full mode has precedence over error mode
       else if (errorSample) this.mode = MODE.ERROR;
       // If neither are selected, then don't record (early return)
-      return;
+      else return;
     }
 
     // FULL mode records AND reports from the beginning, while ERROR mode only records (but does not report).
@@ -164,6 +160,11 @@ export class Aggregate extends AggregateBase {
       // We only report (harvest) in FULL mode
       this.scheduler.startTimer(this.harvestTimeSeconds);
     }
+
+    // If an error was noticed before the mode could be set (like in the early lifecycle of the page), immediately set to FULL mode
+    if (this.mode === MODE.ERROR && this.errorNoticed) {
+      this.mode = MODE.FULL;
+    }
     // We record in FULL or ERROR mode
 
     recorder = (await import( /* webpackChunkName: "recorder" */'rrweb')).record;
@@ -196,7 +197,9 @@ export class Aggregate extends AggregateBase {
     const info = getInfo(this.agentIdentifier);
     return {
       qs: {
-        protocol_version: '0'
+        protocol_version: '0',
+        content_encoding: 'gzip',
+        browser_monitoring_key: info.licenseKey
       },
       body: {
         type: 'SessionReplay',

package/dist/types/cdn/experimental.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=experimental.d.ts.map

package/dist/types/cdn/experimental.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"experimental.d.ts","sourceRoot":"","sources":["../../../src/cdn/experimental.js"],"names":[],"mappings":""}

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

@@ -2,9 +2,32 @@
  * Periodically invokes harvest calls and handles retries
  */
 export class HarvestScheduler extends SharedContext {
-    constructor(endpoint: any, opts: any, parent: any);
-    endpoint: any;
-    opts: any;
+    /**
+       * Create a HarvestScheduler
+       * @param {string} endpoint - The base BAM endpoint name -- ex. 'events'
+       * @param {object} opts - The options used to configure the HarvestScheduler
+       * @param {Function} opts.onFinished - The callback to be fired when a harvest has finished
+       * @param {Function} opts.getPayload - A callback which can be triggered to return a payload for harvesting
+       * @param {number} opts.retryDelay - The number of seconds to wait before retrying after a network failure
+       * @param {boolean} opts.raw - Use a prefabricated payload shape as the harvest payload without the need for formatting
+       * @param {string} opts.customUrl - A custom url that falls outside of the shape of the standard BAM harvester url pattern.  Will use directly instead of concatenating various pieces
+       * @param {*} parent - The parent object, whose state can be passed into SharedContext
+       */
+    constructor(endpoint: string, opts: {
+        onFinished: Function;
+        getPayload: Function;
+        retryDelay: number;
+        raw: boolean;
+        customUrl: string;
+    }, parent: any);
+    endpoint: string;
+    opts: {
+        onFinished: Function;
+        getPayload: Function;
+        retryDelay: number;
+        raw: boolean;
+        customUrl: string;
+    };
     started: boolean;
     timeoutHandle: NodeJS.Timeout | null;
     aborted: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"harvest-scheduler.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/harvest-scheduler.js"],"names":[],"mappings":"AAWA;;GAEG;AACH;IACE,mDAeC;IAbC,cAAwB;IACxB,UAAsB;IACtB,iBAAoB;IACpB,qCAAyB;IACzB,iBAAoB;IAEpB,iBAA8C;IAShD,eAKC;IAED,mDAIC;IAHC,cAAwB;IAK1B,uCAMC;IAED,6CAWC;IAED,yCAsDC;IAED,gDAiBC;CACF;8BAtI6B,2BAA2B;wBAChB,WAAW"}
+{"version":3,"file":"harvest-scheduler.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/harvest-scheduler.js"],"names":[],"mappings":"AAWA;;GAEG;AACH;IACE;;;;;;;;;;SAUK;IACL,sBATa,MAAM;QAES,UAAU;QACV,UAAU;QACZ,UAAU,EAAvB,MAAM;QACQ,GAAG,EAAjB,OAAO;QACM,SAAS,EAAtB,MAAM;oBAkBlB;IAbC,iBAAwB;IACxB;;;oBARW,MAAM;aACN,OAAO;mBACP,MAAM;MAMK;IACtB,iBAAoB;IACpB,qCAAyB;IACzB,iBAAoB;IAEpB,iBAA8C;IAShD,eAKC;IAED,mDAIC;IAHC,cAAwB;IAK1B,uCAMC;IAED,6CAWC;IAED,yCA0DC;IAED,gDAiBC;CACF;8BArJ6B,2BAA2B;wBAChB,WAAW"}

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

@@ -37,14 +37,14 @@ export class Harvest extends SharedContext {
      * @param {NetworkSendSpec} spec Specification for sending data
      */
     obfuscateAndSend(spec: NetworkSendSpec): any;
-    _send({ endpoint, payload, opts, submitMethod, cbFinished, customUrl, gzip, includeBaseParams }: {
+    _send({ endpoint, payload, opts, submitMethod, cbFinished, customUrl, raw, includeBaseParams }: {
         endpoint: any;
         payload?: {} | undefined;
         opts?: {} | undefined;
         submitMethod: any;
         cbFinished: any;
         customUrl: any;
-        gzip: any;
+        raw: any;
         includeBaseParams?: boolean | undefined;
     }): any;
     baseQueryString(): string;

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

@@ -1 +1 @@
-{"version":3,"file":"harvest.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/harvest.js"],"names":[],"mappings":"AAoOA;;;;;;;;;;;;;;;;;EAsBC;AAnND;IAII,0BAA2H;IAC3H,uBAAoD;IACpD,kCAAsH;IAEtH,YAAiB;IAGnB;;;;OAIG;IACH,YAFW,eAAe,OAYzB;IAED;;;OAGG;IACH,WAFW,eAAe,OAazB;IAED;;;OAGG;IACH,uBAFW,eAAe,OAMzB;IAED;;;;;;;;;YAkFC;IAGD,0BAmBC;IAED;;;MAYC;IAED,mCAGC;IAED,uBAIC;CACF;8BA3MY,MAAM;8BALW,2BAA2B;2BAF9B,mBAAmB"}
+{"version":3,"file":"harvest.d.ts","sourceRoot":"","sources":["../../../../src/common/harvest/harvest.js"],"names":[],"mappings":"AAmOA;;;;;;;;;;;;;;;;;EAsBC;AAlND;IAII,0BAA2H;IAC3H,uBAAoD;IACpD,kCAAsH;IAEtH,YAAiB;IAGnB;;;;OAIG;IACH,YAFW,eAAe,OAYzB;IAED;;;OAGG;IACH,WAFW,eAAe,OAazB;IAED;;;OAGG;IACH,uBAFW,eAAe,OAMzB;IAED;;;;;;;;;YAiFC;IAGD,0BAmBC;IAED;;;MAYC;IAED,mCAGC;IAED,uBAIC;CACF;8BA1MY,MAAM;8BALW,2BAA2B;2BAF9B,mBAAmB"}

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

@@ -37,6 +37,8 @@ export class Aggregate extends AggregateBase {
     prepareHarvest(options: any): {
         qs: {
             protocol_version: string;
+            content_encoding: string;
+            browser_monitoring_key: any;
         };
         body: {
             type: string;
@@ -56,6 +58,8 @@ export class Aggregate extends AggregateBase {
     getHarvestContents(): {
         qs: {
             protocol_version: string;
+            content_encoding: string;
+            browser_monitoring_key: any;
         };
         body: {
             type: string;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/session_replay/aggregate/index.js"],"names":[],"mappings":"AAsBA,4CAA4C;AAiB5C;IACE,2BAAiC;IACjC,mDAuFC;IApFC,iHAAiH;IACjH,cAAgB;IAChB,8GAA8G;IAC9G,wBAAgH;IAChH,iFAAiF;IACjF,qBAAwB;IACxB,uDAAuD;IACvD,sBAAyB;IACzB,6GAA6G;IAC7G,aAAoB;IAIpB,gGAAgG;IAChG,sBAAyB;IACzB;;;MAGE;IACF,qBAAwB;IACxB,+HAA+H;IAC/H,kBAAqB;IAErB,qGAAqG;IACrG,+BAA+B;IAE/B,uIAAuI;IACvI,0BAAyE;IAiBzE,4BASQ;IAiCV;;;;;;OAMG;IACH,kCALW,OAAO,eACP,OAAO,cACP,OAAO,GACL,IAAI,CAyChB;IAED;;;;;;;;;;;;;;;;;;oBAaC;IAED;;;;;;;;;;;;;;;;;;MAoBC;IAED,qCAOC;IAED,kFAAkF;IAClF,oBAMC;IAED,qDAAqD;IACrD,uBAoBC;IAED,yHAAyH;IACzH,yCA0BC;IAED,0HAA0H;IAC1H,yBAIC;IAED,gCAAgC;IAChC,0CAGC;IAED,yDAAyD;IACzD,cAKC;IAED;;;SAGK;IACL,uCAEC;CACF;8BAtS6B,4BAA4B;iCALzB,2CAA2C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/session_replay/aggregate/index.js"],"names":[],"mappings":"AAsBA,4CAA4C;AAiB5C;IACE,2BAAiC;IACjC,mDAmFC;IAhFC,iHAAiH;IACjH,cAAgB;IAChB,8GAA8G;IAC9G,wBAAgH;IAChH,iFAAiF;IACjF,qBAAwB;IACxB,uDAAuD;IACvD,sBAAyB;IACzB,6GAA6G;IAC7G,aAAoB;IAIpB,gGAAgG;IAChG,sBAAyB;IACzB;;;MAGE;IACF,qBAAwB;IACxB,+HAA+H;IAC/H,kBAAqB;IAErB,qGAAqG;IACrG,+BAA+B;IAE/B,uIAAuI;IACvI,0BAAyE;IAiBzE,4BAKQ;IAiCV;;;;;;OAMG;IACH,kCALW,OAAO,eACP,OAAO,cACP,OAAO,GACL,IAAI,CA8ChB;IAED;;;;;;;;;;;;;;;;;;;;oBAaC;IAED;;;;;;;;;;;;;;;;;;;;MAwBC;IAED,qCAOC;IAED,kFAAkF;IAClF,oBAMC;IAED,qDAAqD;IACrD,uBAoBC;IAED,yHAAyH;IACzH,yCA0BC;IAED,0HAA0H;IAC1H,yBAIC;IAED,gCAAgC;IAChC,0CAGC;IAED,yDAAyD;IACzD,cAKC;IAED;;;SAGK;IACL,uCAEC;CACF;8BA3S6B,4BAA4B;iCALzB,2CAA2C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newrelic/browser-agent",
-  "version": "1.233.0",
+  "version": "1.233.1",
   "private": false,
   "author": "New Relic Browser Agent Team <browser-agent@newrelic.com>",
   "description": "Tests for the New Relic JavaScript agent",
@@ -126,7 +126,8 @@
     "npm:build:esm": "npx babel --env-name npm-esm --out-dir dist/esm --out-file-extension .js ./src",
     "npm:build:cjs": "npx babel --env-name npm-cjs --out-dir dist/cjs --out-file-extension .js ./src",
     "npm:build:types": "npx tsc -b",
-    "npm:pack": "mkdir -p temp && export PKG_NAME=$(npm pack --pack-destination temp) && echo ./temp/$PKG_NAME"
+    "npm:pack": "mkdir -p temp && export PKG_NAME=$(npm pack --pack-destination temp) && echo ./temp/$PKG_NAME",
+    "watch:browser-tests": "jung -r ./src -F '.*\\.test\\.js' --run -- npm run build:browser-tests"
   },
   "config": {
     "unsafe-perm": true

package/src/cdn/experimental.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * @file Creates an "EXPERIMENTAL" agent loader bundle composed of the core agent and all available feature modules, including experimental features.
+ *
+ * NOTE: This loader is ONLY used for internal testing. The code contained within is likely under development and dormant. It will not download to instrumented pages or record any data.
+ * It is not production ready, and is not intended to be imported or implemented in any build of the browser agent
+ */
+import { Agent } from '../loaders/agent'
+
+import { Instrument as InstrumentPageViewEvent } from '../features/page_view_event/instrument'
+import { Instrument as InstrumentPageViewTiming } from '../features/page_view_timing/instrument'
+import { Instrument as InstrumentMetrics } from '../features/metrics/instrument'
+import { Instrument as InstrumentErrors } from '../features/jserrors/instrument'
+import { Instrument as InstrumentXhr } from '../features/ajax/instrument'
+import { Instrument as InstrumentSessionTrace } from '../features/session_trace/instrument'
+import { Instrument as InstrumentSessionReplay } from '../features/session_replay/instrument'
+import { Instrument as InstrumentSpa } from '../features/spa/instrument'
+import { Instrument as InstrumentPageAction } from '../features/page_action/instrument'
+
+new Agent({
+  features: [
+    InstrumentXhr,
+    InstrumentPageViewEvent,
+    InstrumentPageViewTiming,
+    InstrumentSessionTrace,
+    InstrumentSessionReplay,
+    InstrumentMetrics,
+    InstrumentPageAction,
+    InstrumentErrors,
+    InstrumentSpa
+  ],
+  loaderType: 'experimental'
+})

package/src/common/config/state/init.js

@@ -34,7 +34,7 @@ const model = () => {
     session_trace: { enabled: true, harvestTimeSeconds: 10 },
     session_replay: {
       // feature settings
-      enabled: true,
+      enabled: false,
       harvestTimeSeconds: 60,
       sampleRate: 0.1,
       errorSampleRate: 0.1,

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

@@ -13,6 +13,17 @@ import { getConfigurationValue } from '../config/config'
  * Periodically invokes harvest calls and handles retries
  */
 export class HarvestScheduler extends SharedContext {
+  /**
+     * Create a HarvestScheduler
+     * @param {string} endpoint - The base BAM endpoint name -- ex. 'events'
+     * @param {object} opts - The options used to configure the HarvestScheduler
+     * @param {Function} opts.onFinished - The callback to be fired when a harvest has finished
+     * @param {Function} opts.getPayload - A callback which can be triggered to return a payload for harvesting
+     * @param {number} opts.retryDelay - The number of seconds to wait before retrying after a network failure
+     * @param {boolean} opts.raw - Use a prefabricated payload shape as the harvest payload without the need for formatting
+     * @param {string} opts.customUrl - A custom url that falls outside of the shape of the standard BAM harvester url pattern.  Will use directly instead of concatenating various pieces
+     * @param {*} parent - The parent object, whose state can be passed into SharedContext
+     */
   constructor (endpoint, opts, parent) {
     super(parent) // gets any allowed properties from the parent and stores them in `sharedContext`
     this.endpoint = endpoint
@@ -78,7 +89,12 @@ export class HarvestScheduler extends SharedContext {
       const retry = submitMethod.method === submitData.xhr
       var payload = this.opts.getPayload({ retry: retry })
 
-      if (!payload) return
+      if (!payload) {
+        if (this.started) {
+          this.scheduleHarvest()
+        }
+        return
+      }
 
       payload = Object.prototype.toString.call(payload) === '[object Array]' ? payload : [payload]
       harvests.push(...payload)
@@ -103,9 +119,8 @@ export class HarvestScheduler extends SharedContext {
         opts,
         submitMethod,
         cbFinished: onHarvestFinished,
-        includeBaseParams: this.opts.includeBaseParams,
         customUrl: this.opts.customUrl,
-        gzip: this.opts.gzip
+        raw: this.opts.raw
       })
     })
 

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

@@ -0,0 +1,25 @@
+import { setConfiguration } from '../config/state/init'
+import { HarvestScheduler } from './harvest-scheduler'
+
+describe('runHarvest', () => {
+  it('should re-schedule harvest even if there is no accumulated data', () => {
+    setConfiguration('asdf', {})
+    const scheduler = new HarvestScheduler('events', { getPayload: jest.fn() }, { agentIdentifier: 'asdf', ee: { on: jest.fn() } })
+    scheduler.started = true
+    jest.spyOn(scheduler, 'scheduleHarvest')
+    scheduler.runHarvest()
+    expect(scheduler.opts.getPayload()).toBeFalsy()
+    expect(scheduler.scheduleHarvest).toHaveBeenCalledTimes(1)
+  })
+
+  it('should also re-schedule harvest if there is accumulated data', () => {
+    setConfiguration('asdf', {})
+    const scheduler = new HarvestScheduler('events', { getPayload: jest.fn().mockImplementation(() => 'payload') }, { agentIdentifier: 'asdf', ee: { on: jest.fn() } })
+    scheduler.started = true
+    scheduler.harvest._send = () => {}
+    jest.spyOn(scheduler, 'scheduleHarvest')
+    scheduler.runHarvest()
+    expect(scheduler.opts.getPayload()).toBeTruthy()
+    expect(scheduler.scheduleHarvest).toHaveBeenCalledTimes(1)
+  })
+})

package/src/common/harvest/harvest.js

@@ -92,7 +92,7 @@ export class Harvest extends SharedContext {
     return this._send({ ...spec, payload })
   }
 
-  _send ({ endpoint, payload = {}, opts = {}, submitMethod, cbFinished, customUrl, gzip, includeBaseParams = true }) {
+  _send ({ endpoint, payload = {}, opts = {}, submitMethod, cbFinished, customUrl, raw, includeBaseParams = true }) {
     var info = getInfo(this.sharedContext.agentIdentifier)
     if (!info.errorBeacon) return false
 
@@ -105,10 +105,13 @@ export class Harvest extends SharedContext {
       return false
     }
 
-    var url = customUrl || this.getScheme() + '://' + info.errorBeacon + '/' + endpoint + '/1/' + info.licenseKey + '?'
+    let url = ''
+    if (customUrl) url = customUrl
+    else if (raw) url = `${this.getScheme()}://${info.errorBeacon}/${endpoint}`
+    else url = `${this.getScheme()}://${info.errorBeacon}/${endpoint}/1/${info.licenseKey}`
 
-    var baseParams = includeBaseParams ? this.baseQueryString() : ''
-    var params = payload.qs ? encodeObj(payload.qs, agentRuntime.maxBytes) : ''
+    var baseParams = !raw && includeBaseParams ? this.baseQueryString() : ''
+    var payloadParams = payload.qs ? encodeObj(payload.qs, agentRuntime.maxBytes) : ''
     if (!submitMethod) {
       submitMethod = getSubmitMethod(endpoint, opts)
     }
@@ -116,7 +119,9 @@ export class Harvest extends SharedContext {
     var useBody = submitMethod.useBody
 
     var body
-    var fullUrl = url + baseParams + params
+    var fullUrl = `${url}?${baseParams}${payloadParams}`
+
+    const gzip = payload?.qs?.content_encoding === 'gzip'
 
     if (!gzip) {
       if (useBody && endpoint === 'events') {
@@ -135,13 +140,7 @@ export class Harvest extends SharedContext {
 
     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' })
-    }
+    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),

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

@@ -90,11 +90,7 @@ export class Aggregate extends AggregateBase {
       onFinished: this.onHarvestFinished.bind(this),
       retryDelay: this.harvestTimeSeconds,
       getPayload: this.prepareHarvest.bind(this),
-      // TODO -- this stuff needs a better way to be handled
-      includeBaseParams: false,
-      customUrl: 'https://vortex-alb.stg-single-tooth.cell.us.nr-data.net/blob',
-      raw: true,
-      gzip: true
+      raw: true
     }, this)
 
     // Wait for an error to be reported.  This currently is wrapped around the "Error" feature.  This is a feature-feature dependency.
@@ -153,7 +149,7 @@ export class Aggregate extends AggregateBase {
       if (fullSample) this.mode = MODE.FULL // full mode has precedence over error mode
       else if (errorSample) this.mode = MODE.ERROR
       // If neither are selected, then don't record (early return)
-      return
+      else return
     }
 
     // FULL mode records AND reports from the beginning, while ERROR mode only records (but does not report).
@@ -163,6 +159,11 @@ export class Aggregate extends AggregateBase {
       // We only report (harvest) in FULL mode
       this.scheduler.startTimer(this.harvestTimeSeconds)
     }
+
+    // If an error was noticed before the mode could be set (like in the early lifecycle of the page), immediately set to FULL mode
+    if (this.mode === MODE.ERROR && this.errorNoticed) {
+      this.mode = MODE.FULL
+    }
     // We record in FULL or ERROR mode
 
     recorder = (await import(/* webpackChunkName: "recorder" */'rrweb')).record
@@ -195,7 +196,11 @@ export class Aggregate extends AggregateBase {
     const agentRuntime = getRuntime(this.agentIdentifier)
     const info = getInfo(this.agentIdentifier)
     return {
-      qs: { protocol_version: '0' },
+      qs: {
+        protocol_version: '0',
+        content_encoding: 'gzip',
+        browser_monitoring_key: info.licenseKey
+      },
       body: {
         type: 'SessionReplay',
         appId: Number(info.applicationID),