@newrelic/browser-agent 1.233.1 → 1.235.0

package/README.md

@@ -6,7 +6,7 @@ The New Relic browser agent instruments your web application or site and provide
 
 - The instructions on this page pertain to installing the browser agent as an NPM package.
 
-- The browser agent is also generally available as a copy-paste JavaScript snippet and via auto-injection by backend apps. See *[Install the browser agent](https://docs.newrelic.com/docs/browser/browser-monitoring/installation/install-browser-monitoring-agent/)* for info on these alternatives.
+- The browser agent is also generally available as a copy-paste JavaScript snippet and via auto-injection by backend apps. See *[Install the browser agent](https://docs.newrelic.com/docs/browser/browser-monitoring/installation/install-browser-monitoring-agent/)* for info on these alternatives. Releases are deployed to customers gradually, so the version available via these other methods often lags the current release of this package.
 
 - For questions and feedback on this package, please visit the [Explorer's Hub](https://forum.newrelic.com/s/), New Relic's community support forum.
 

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

package/dist/cjs/common/constants/shared-channel.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sharedChannel = void 0;
+/**
+ * @file Keeps an object alive that is passed to all feature aggregate modules.
+ * The purpose is to have a way for communication and signals to relay across features at runtime.
+ * This object can hold any arbitrary values and should be treated as on-the-fly dynamic.
+ */
+
+let onReplayReady;
+const sessionReplayInitialized = new Promise(resolve => onReplayReady = resolve);
+const sharedChannel = Object.freeze({
+  onReplayReady,
+  sessionReplayInitialized
+});
+exports.sharedChannel = sharedChannel;

package/dist/cjs/common/event-emitter/contextual-ee.test.js

@@ -93,7 +93,7 @@ describe('event-emitter context', () => {
   });
 });
 describe('event-emitter buffer', () => {
-  it('it should create a new buffer for the given group', async () => {
+  test('it should create a new buffer for the given group', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));
@@ -105,7 +105,7 @@ describe('event-emitter buffer', () => {
     }));
     expect(ee.isBuffering(eventType)).toEqual(true);
   });
-  it('it should default group to "feature"', async () => {
+  test('it should default group to "feature"', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));
@@ -116,7 +116,7 @@ describe('event-emitter buffer', () => {
     }));
     expect(ee.isBuffering(eventType)).toEqual(true);
   });
-  it('it should not create buffer if event-emitter is aborted', async () => {
+  test('it should not create buffer if event-emitter is aborted', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));
@@ -156,7 +156,7 @@ describe('event-emitter abort', () => {
   });
 });
 describe('event-emitter emit', () => {
-  it('should execute the listener', async () => {
+  test('should execute the listener', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));
@@ -167,7 +167,7 @@ describe('event-emitter emit', () => {
     ee.emit(eventType, eventArgs);
     expect(mockListener).toHaveBeenCalledWith(eventArgs[0], eventArgs[1], eventArgs[2]);
   });
-  it('should not execute the listener after removal', async () => {
+  test('should not execute the listener after removal', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));
@@ -180,7 +180,7 @@ describe('event-emitter emit', () => {
     ee.emit(eventType, eventArgs);
     expect(mockListener).toHaveBeenCalledTimes(1);
   });
-  it('should return early if global event-emitter is aborted', async () => {
+  test('should return early if global event-emitter is aborted', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));
@@ -195,7 +195,7 @@ describe('event-emitter emit', () => {
     ee.emit(eventType, eventArgs);
     expect(mockListener).toHaveBeenCalledTimes(0);
   });
-  it('should still emit if global event-emitter is aborted but force flag is true', async () => {
+  test('should still emit if global event-emitter is aborted but force flag is true', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));
@@ -211,7 +211,7 @@ describe('event-emitter emit', () => {
     scopeEE.emit(eventType, eventArgs, {}, true);
     expect(mockScopeListener).toHaveBeenCalledTimes(1);
   });
-  it('should bubble the event if bubble flag is true', async () => {
+  test('should bubble the event if bubble flag is true', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));
@@ -226,7 +226,7 @@ describe('event-emitter emit', () => {
     expect(mockScopeListener).toHaveBeenCalledTimes(1);
     expect(mockListener).toHaveBeenCalledTimes(1);
   });
-  it('should not bubble the event if bubble flag is false', async () => {
+  test('should not bubble the event if bubble flag is false', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));
@@ -241,7 +241,7 @@ describe('event-emitter emit', () => {
     expect(mockScopeListener).toHaveBeenCalledTimes(1);
     expect(mockListener).not.toHaveBeenCalled();
   });
-  it('should buffer the event on the scoped event-emitter', async () => {
+  test('should buffer the event on the scoped event-emitter', async () => {
     const {
       ee
     } = await Promise.resolve().then(() => _interopRequireWildcard(require('./contextual-ee')));

package/dist/cjs/common/harvest/{harvest-scheduler.test.js → harvest-scheduler.component-test.js}

@@ -3,7 +3,7 @@
 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', () => {
+  test('should re-schedule harvest even if there is no accumulated data', () => {
     (0, _init.setConfiguration)('asdf', {});
     const scheduler = new _harvestScheduler.HarvestScheduler('events', {
       getPayload: jest.fn()
@@ -19,7 +19,7 @@ describe('runHarvest', () => {
     expect(scheduler.opts.getPayload()).toBeFalsy();
     expect(scheduler.scheduleHarvest).toHaveBeenCalledTimes(1);
   });
-  it('should also re-schedule harvest if there is accumulated data', () => {
+  test('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')

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

@@ -9,6 +9,7 @@ var _sharedContext = require("../context/shared-context");
 var _harvest = require("./harvest");
 var _eol = require("../unload/eol");
 var _config = require("../config/config");
+var _sessionEntity = require("../session/session-entity");
 /*
  * Copyright 2020 New Relic Corporation. All rights reserved.
  * SPDX-License-Identifier: Apache-2.0
@@ -42,9 +43,18 @@ class HarvestScheduler extends _sharedContext.SharedContext {
     // unload if EOL mechanism fires
     (0, _eol.subscribeToEOL)(this.unload.bind(this), (0, _config.getConfigurationValue)(this.sharedContext.agentIdentifier, 'allow_bfcache')); // TO DO: remove feature flag after rls stable
 
-    // unload if session resets
-    this.sharedContext?.ee.on('session-reset', this.unload.bind(this));
+    /* Flush all buffered data if session resets and give up retries. This should be synchronous to ensure that the correct `session` value is sent.
+      Since session-reset generates a new session ID and the ID is grabbed at send-time, any delays or retries would cause the payload to be sent under
+      the wrong session ID. */
+    this.sharedContext?.ee.on(_sessionEntity.SESSION_EVENTS.RESET, () => this.runHarvest({
+      forceNoRetry: true
+    }));
   }
+
+  /**
+   * This function is only meant for the last outgoing harvest cycle of a page. It trickles down to using sendBeacon, which should not be used
+   * to send payloads while the page is still active, due to limitations on how much data can be buffered in the API at any one time.
+   */
   unload() {
     if (this.aborted) return;
     // If opts.onUnload is defined, these are special actions to execute before attempting to send the final payload.
@@ -116,7 +126,7 @@ class HarvestScheduler extends _sharedContext.SharedContext {
         payload,
         opts,
         submitMethod,
-        cbFinished: onHarvestFinished,
+        cbFinished: cbRanAfterSend,
         customUrl: this.opts.customUrl,
         raw: this.opts.raw
       });
@@ -125,8 +135,14 @@ class HarvestScheduler extends _sharedContext.SharedContext {
       this.scheduleHarvest();
     }
     return;
-    function onHarvestFinished(result) {
-      if (result.blocked) scheduler.onHarvestBlocked(opts, result);else scheduler.onHarvestFinished(opts, result);
+
+    /**
+     * This is executed immediately after harvest sends the data via XHR, or if there's nothing to send. Note that this excludes on unloading / sendBeacon.
+     * @param {Object} result
+     */
+    function cbRanAfterSend(result) {
+      if (opts?.forceNoRetry) result.retry = false; // discard unsent data rather than re-queuing for next harvest attempt
+      scheduler.onHarvestFinished(opts, result);
     }
   }
   onHarvestFinished(opts, result) {

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

@@ -0,0 +1,224 @@
+"use strict";
+
+var _submitData = require("../util/submit-data");
+var _harvest = require("./harvest");
+jest.mock('../context/shared-context', () => ({
+  __esModule: true,
+  SharedContext: function () {
+    this.sharedContext = {
+      agentIdentifier: 'abcd'
+    };
+  }
+}));
+jest.mock('../config/config', () => ({
+  __esModule: true,
+  getConfigurationValue: jest.fn(),
+  getInfo: jest.fn().mockReturnValue({
+    errorBeacon: 'example.com',
+    licenseKey: 'abcd'
+  }),
+  getRuntime: jest.fn().mockReturnValue({
+    bytesSent: {},
+    queryBytesSent: {}
+  })
+}));
+jest.mock('../util/submit-data', () => ({
+  __esModule: true,
+  submitData: {
+    xhr: jest.fn(() => ({
+      addEventListener: jest.fn()
+    })),
+    beacon: jest.fn(),
+    img: jest.fn()
+  }
+}));
+describe('sendX', () => {
+  test.each([null, undefined, false])('should not send request when body is empty and sendEmptyBody is %s', sendEmptyBody => {
+    const sendCallback = jest.fn();
+    const harvester = new _harvest.Harvest();
+    harvester.on('jserrors', () => ({
+      body: {},
+      qs: {}
+    }));
+    harvester.sendX({
+      endpoint: 'jserrors',
+      cbFinished: sendCallback
+    });
+    expect(sendCallback).toHaveBeenCalledWith({
+      sent: false
+    });
+    expect(_submitData.submitData.xhr).not.toHaveBeenCalled();
+    expect(_submitData.submitData.img).not.toHaveBeenCalled();
+    expect(_submitData.submitData.beacon).not.toHaveBeenCalled();
+  });
+  test('should send request when body is empty and sendEmptyBody is true', () => {
+    const harvester = new _harvest.Harvest();
+    harvester.on('jserrors', () => ({
+      body: {},
+      qs: {}
+    }));
+    harvester.sendX({
+      endpoint: 'jserrors',
+      opts: {
+        sendEmptyBody: true
+      },
+      cbFinished: jest.fn()
+    });
+    expect(_submitData.submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining('https://example.com/jserrors/1/abcd?'),
+      body: undefined
+    }));
+    expect(_submitData.submitData.img).not.toHaveBeenCalled();
+    expect(_submitData.submitData.beacon).not.toHaveBeenCalled();
+  });
+  test.each([null, undefined, []])('should remove %s values from the body and query string when sending', emptyValue => {
+    const harvester = new _harvest.Harvest();
+    harvester.on('jserrors', () => ({
+      body: {
+        bar: 'foo',
+        empty: emptyValue
+      },
+      qs: {
+        foo: 'bar',
+        empty: emptyValue
+      }
+    }));
+    harvester.sendX({
+      endpoint: 'jserrors',
+      cbFinished: jest.fn()
+    });
+    expect(_submitData.submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining('&foo=bar'),
+      body: JSON.stringify({
+        bar: 'foo'
+      })
+    }));
+    expect(_submitData.submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.not.stringContaining('&empty'),
+      body: expect.not.stringContaining('empty')
+    }));
+    expect(_submitData.submitData.img).not.toHaveBeenCalled();
+    expect(_submitData.submitData.beacon).not.toHaveBeenCalled();
+  });
+  test.each([1, false, true])('should not remove value %s (when it doesn\'t have a length) from the body and query string when sending', nonStringValue => {
+    const harvester = new _harvest.Harvest();
+    harvester.on('jserrors', () => ({
+      body: {
+        bar: 'foo',
+        nonString: nonStringValue
+      },
+      qs: {
+        foo: 'bar',
+        nonString: nonStringValue
+      }
+    }));
+    harvester.sendX({
+      endpoint: 'jserrors',
+      cbFinished: jest.fn()
+    });
+    expect(_submitData.submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining("&nonString=".concat(nonStringValue)),
+      body: JSON.stringify({
+        bar: 'foo',
+        nonString: nonStringValue
+      })
+    }));
+    expect(_submitData.submitData.img).not.toHaveBeenCalled();
+    expect(_submitData.submitData.beacon).not.toHaveBeenCalled();
+  });
+});
+describe('send', () => {
+  test.each([null, undefined, false])('should not send request when body is empty and sendEmptyBody is %s', sendEmptyBody => {
+    const sendCallback = jest.fn();
+    const harvester = new _harvest.Harvest();
+    harvester.send({
+      endpoint: 'rum',
+      payload: {
+        qs: {},
+        body: {}
+      },
+      opts: {
+        sendEmptyBody
+      },
+      cbFinished: sendCallback
+    });
+    expect(sendCallback).toHaveBeenCalledWith({
+      sent: false
+    });
+    expect(_submitData.submitData.xhr).not.toHaveBeenCalled();
+    expect(_submitData.submitData.img).not.toHaveBeenCalled();
+    expect(_submitData.submitData.beacon).not.toHaveBeenCalled();
+  });
+  test('should send request when body is empty and sendEmptyBody is true', () => {
+    const harvester = new _harvest.Harvest();
+    harvester.send({
+      endpoint: 'rum',
+      payload: {
+        qs: {},
+        body: {}
+      },
+      opts: {
+        sendEmptyBody: true
+      }
+    });
+    expect(_submitData.submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining('https://example.com/1/abcd?'),
+      body: undefined
+    }));
+    expect(_submitData.submitData.img).not.toHaveBeenCalled();
+    expect(_submitData.submitData.beacon).not.toHaveBeenCalled();
+  });
+  test.each([null, undefined, []])('should remove %s values from the body and query string when sending', emptyValue => {
+    const harvester = new _harvest.Harvest();
+    harvester.send({
+      endpoint: 'rum',
+      payload: {
+        qs: {
+          foo: 'bar',
+          empty: emptyValue
+        },
+        body: {
+          bar: 'foo',
+          empty: emptyValue
+        }
+      }
+    });
+    expect(_submitData.submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining('&foo=bar'),
+      body: JSON.stringify({
+        bar: 'foo'
+      })
+    }));
+    expect(_submitData.submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.not.stringContaining('&empty'),
+      body: expect.not.stringContaining('empty')
+    }));
+    expect(_submitData.submitData.img).not.toHaveBeenCalled();
+    expect(_submitData.submitData.beacon).not.toHaveBeenCalled();
+  });
+  test.each([1, false, true])('should not remove value %s (when it doesn\'t have a length) from the body and query string when sending', nonStringValue => {
+    const harvester = new _harvest.Harvest();
+    harvester.send({
+      endpoint: 'rum',
+      payload: {
+        qs: {
+          foo: 'bar',
+          nonString: nonStringValue
+        },
+        body: {
+          bar: 'foo',
+          nonString: nonStringValue
+        }
+      }
+    });
+    expect(_submitData.submitData.xhr).toHaveBeenCalledWith(expect.objectContaining({
+      url: expect.stringContaining("&nonString=".concat(nonStringValue)),
+      body: JSON.stringify({
+        bar: 'foo',
+        nonString: nonStringValue
+      })
+    }));
+    expect(_submitData.submitData.img).not.toHaveBeenCalled();
+    expect(_submitData.submitData.beacon).not.toHaveBeenCalled();
+  });
+});

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

@@ -131,7 +131,7 @@ class Harvest extends _sharedContext.SharedContext {
     var info = (0, _config.getInfo)(this.sharedContext.agentIdentifier);
     if (!info.errorBeacon) return false;
     var agentRuntime = (0, _config.getRuntime)(this.sharedContext.agentIdentifier);
-    if (!payload.body) {
+    if (!payload.body && !opts?.sendEmptyBody) {
       // no payload body? nothing to send, just run onfinish stuff and return
       if (cbFinished) {
         cbFinished({
@@ -141,7 +141,7 @@ class Harvest extends _sharedContext.SharedContext {
       return false;
     }
     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);
+    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 !== 'rum' ? "/".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) {
@@ -250,18 +250,11 @@ class Harvest extends _sharedContext.SharedContext {
   }
 }
 exports.Harvest = Harvest;
-function or(a, b) {
-  return a || b;
-}
 function getSubmitMethod(endpoint, opts) {
   opts = opts || {};
   var method;
   var useBody;
-  if (opts.needResponse) {
-    // currently: only STN needs a response
-    useBody = true;
-    method = _submitData.submitData.xhr;
-  } else if (opts.unload && _globalScope.isBrowserScope) {
+  if (opts.unload && _globalScope.isBrowserScope) {
     // all the features' final harvest; neither methods work outside window context
     useBody = haveSendBeacon;
     method = haveSendBeacon ? _submitData.submitData.beacon : _submitData.submitData.img; // really only IE doesn't have Beacon API for web browsers
@@ -291,7 +284,7 @@ function createAccumulator() {
   var accumulator = {};
   var hasData = false;
   return function (key, val) {
-    if (val !== null && val !== undefined && val.length) {
+    if (val !== null && val !== undefined && val.toString()?.length) {
       accumulator[key] = val;
       hasData = true;
     }