@newrelic/browser-agent 1.232.1 → 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/cdn/polyfills.js

@@ -2,8 +2,10 @@
 
 require("core-js/stable/promise");
 require("core-js/stable/array/includes");
-require("core-js/stable/array/from");
 require("core-js/stable/array/find");
+require("core-js/stable/array/flat");
+require("core-js/stable/array/flat-map");
+require("core-js/stable/array/from");
 require("core-js/stable/array/some");
 require("core-js/stable/object/assign");
 require("core-js/stable/object/entries");
@@ -11,4 +13,5 @@ require("core-js/stable/object/values");
 require("core-js/stable/map");
 require("core-js/stable/reflect");
 require("core-js/stable/set");
-require("core-js/stable/weak-set");
+require("core-js/stable/weak-set");
+require("core-js/stable/object/get-own-property-descriptors");

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

@@ -3,36 +3,25 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.Configurable = void 0;
-var _featureDependencies = require("../../../loaders/features/featureDependencies");
+exports.getModeledObject = getModeledObject;
 var _console = require("../../util/console");
-class Configurable {
-  constructor(obj, model) {
-    Object.assign(this, setValues(obj, model));
-  }
-}
-exports.Configurable = Configurable;
-function setValues(obj, model) {
-  const state = {};
+function getModeledObject(obj, model) {
   try {
-    if (!obj || typeof obj !== 'object') return (0, _console.warn)('New setting a Configurable requires an object as input');
+    if (!obj || typeof obj !== 'object') return (0, _console.warn)('Setting a Configurable requires an object as input');
     if (!model || typeof model !== 'object') return (0, _console.warn)('Setting a Configurable requires a model to set its initial properties');
-    Object.assign(state, model);
-    Object.entries(obj).forEach(_ref => {
-      let [key, value] = _ref;
-      if (!Object.keys(model).includes(key)) return;
-      const frozenAttrs = (0, _featureDependencies.getFrozenAttributes)(key);
-      if (frozenAttrs.length && value && typeof value === 'object') {
-        frozenAttrs.forEach(attr => {
-          if (attr in value) {
-            (0, _console.warn)("\"".concat(attr, "\" is a protected attribute and can not be changed in feature ").concat(key, ".  It will have no effect."));
-            delete value[attr];
-          }
-        });
+    // allow getters and setters to pass from model to target
+    const output = Object.create(Object.getPrototypeOf(model), Object.getOwnPropertyDescriptors(model));
+    const target = Object.keys(output).length === 0 ? obj : output;
+    for (let key in target) {
+      if (obj[key] !== undefined) {
+        try {
+          if (typeof obj[key] === 'object' && typeof model[key] === 'object') output[key] = getModeledObject(obj[key], model[key]);else output[key] = obj[key];
+        } catch (e) {
+          (0, _console.warn)('An error occurred while setting a property of a Configurable', e);
+        }
       }
-      state[key] = value;
-    });
-    return state;
+    }
+    return output;
   } catch (err) {
     (0, _console.warn)('An error occured while setting a Configurable', err);
   }

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

@@ -45,6 +45,6 @@ function getInfo(id) {
 }
 function setInfo(id, obj) {
   if (!id) throw new Error('All info objects require an agent identifier!');
-  _cache[id] = new _configurable.Configurable(obj, model);
+  _cache[id] = (0, _configurable.getModeledObject)(obj, model);
   (0, _nreum.gosNREUMInitializedAgents)(id, _cache[id], 'info');
 }

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

@@ -7,63 +7,108 @@ exports.getConfiguration = getConfiguration;
 exports.getConfigurationValue = getConfigurationValue;
 exports.setConfiguration = setConfiguration;
 var _constants = require("../../session/constants");
-var _globalScope = require("../../util/global-scope");
 var _nreum = require("../../window/nreum");
 var _configurable = require("./configurable");
-const model = {
-  allow_bfcache: true,
-  // *cli - temporary feature flag for BFCache work
-  privacy: {
-    cookies_enabled: true
-  },
-  // *cli - per discussion, default should be true
-  ajax: {
-    deny_list: undefined,
-    enabled: true,
-    harvestTimeSeconds: 10
-  },
-  distributed_tracing: {
-    enabled: undefined,
-    exclude_newrelic_header: undefined,
-    cors_use_newrelic_header: undefined,
-    cors_use_tracecontext_headers: undefined,
-    allowed_origins: undefined
-  },
-  session: {
-    domain: undefined,
-    // used by first party cookies to set the top-level domain
-    expiresMs: _constants.DEFAULT_EXPIRES_MS,
-    inactiveMs: _constants.DEFAULT_INACTIVE_MS
-  },
-  ssl: undefined,
-  obfuscate: undefined,
-  jserrors: {
-    enabled: true,
-    harvestTimeSeconds: 10
-  },
-  metrics: {
-    enabled: true
-  },
-  page_action: {
-    enabled: true,
-    harvestTimeSeconds: 30
-  },
-  page_view_event: {
-    enabled: true
-  },
-  page_view_timing: {
-    enabled: true,
-    harvestTimeSeconds: 30,
-    long_task: false
-  },
-  session_trace: {
-    enabled: true,
-    harvestTimeSeconds: 10
-  },
-  spa: {
-    enabled: true,
-    harvestTimeSeconds: 10
-  }
+const model = () => {
+  const hiddenState = {
+    blockSelector: '[data-nr-block]',
+    maskInputOptions: {
+      password: true
+    }
+  };
+  return {
+    allow_bfcache: true,
+    // *cli - temporary feature flag for BFCache work
+    privacy: {
+      cookies_enabled: true
+    },
+    // *cli - per discussion, default should be true
+    ajax: {
+      deny_list: undefined,
+      enabled: true,
+      harvestTimeSeconds: 10
+    },
+    distributed_tracing: {
+      enabled: undefined,
+      exclude_newrelic_header: undefined,
+      cors_use_newrelic_header: undefined,
+      cors_use_tracecontext_headers: undefined,
+      allowed_origins: undefined
+    },
+    session: {
+      domain: undefined,
+      // used by first party cookies to set the top-level domain
+      expiresMs: _constants.DEFAULT_EXPIRES_MS,
+      inactiveMs: _constants.DEFAULT_INACTIVE_MS
+    },
+    ssl: undefined,
+    obfuscate: undefined,
+    jserrors: {
+      enabled: true,
+      harvestTimeSeconds: 10
+    },
+    metrics: {
+      enabled: true
+    },
+    page_action: {
+      enabled: true,
+      harvestTimeSeconds: 30
+    },
+    page_view_event: {
+      enabled: true
+    },
+    page_view_timing: {
+      enabled: true,
+      harvestTimeSeconds: 30,
+      long_task: false
+    },
+    session_trace: {
+      enabled: true,
+      harvestTimeSeconds: 10
+    },
+    session_replay: {
+      // feature settings
+      enabled: false,
+      harvestTimeSeconds: 60,
+      sampleRate: 0.1,
+      errorSampleRate: 0.1,
+      // recording config settings
+      maskTextSelector: '*',
+      maskAllInputs: true,
+      // these properties only have getters because they are enforcable constants and should error if someone tries to override them
+      get blockClass() {
+        return 'nr-block';
+      },
+      get ignoreClass() {
+        return 'nr-ignore';
+      },
+      get maskTextClass() {
+        return 'nr-mask';
+      },
+      // props with a getter and setter are used to extend enforcable constants with customer input
+      // we must preserve data-nr-block no matter what else the customer sets
+      get blockSelector() {
+        return hiddenState.blockSelector;
+      },
+      set blockSelector(val) {
+        hiddenState.blockSelector += ",".concat(val);
+      },
+      // password: must always be present and true no matter what customer sets
+      get maskInputOptions() {
+        return hiddenState.maskInputOptions;
+      },
+      set maskInputOptions(val) {
+        hiddenState.maskInputOptions = {
+          ...val,
+          password: true
+        };
+      }
+    },
+    spa: {
+      enabled: true,
+      harvestTimeSeconds: 10
+    }
+  };
 };
 const _cache = {};
 function getConfiguration(id) {
@@ -73,7 +118,7 @@ function getConfiguration(id) {
 }
 function setConfiguration(id, obj) {
   if (!id) throw new Error('All configuration objects require an agent identifier!');
-  _cache[id] = new _configurable.Configurable(obj, model);
+  _cache[id] = (0, _configurable.getModeledObject)(obj, model());
   (0, _nreum.gosNREUMInitializedAgents)(id, _cache[id], 'config');
 }
 function getConfigurationValue(id, path) {

package/dist/cjs/common/config/state/loader-config.js

@@ -23,6 +23,6 @@ function getLoaderConfig(id) {
 }
 function setLoaderConfig(id, obj) {
   if (!id) throw new Error('All loader-config objects require an agent identifier!');
-  _cache[id] = new _configurable.Configurable(obj, model);
+  _cache[id] = (0, _configurable.getModeledObject)(obj, model);
   (0, _nreum.gosNREUMInitializedAgents)(id, _cache[id], 'loader_config');
 }

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

@@ -5,13 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getRuntime = getRuntime;
 exports.setRuntime = setRuntime;
-var userAgent = _interopRequireWildcard(require("../../util/user-agent"));
 var _configurable = require("./configurable");
 var _nreum = require("../../window/nreum");
 var _globalScope = require("../../util/global-scope");
 var _env = require("../../constants/env.npm");
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 const model = {
   buildEnv: _env.BUILD_ENV,
   bytesSent: {},
@@ -33,7 +30,6 @@ const model = {
   releaseIds: {},
   session: undefined,
   xhrWrappable: typeof _globalScope.globalScope.XMLHttpRequest?.prototype?.addEventListener === 'function',
-  userAgent,
   version: _env.VERSION
 };
 const _cache = {};
@@ -44,6 +40,6 @@ function getRuntime(id) {
 }
 function setRuntime(id, obj) {
   if (!id) throw new Error('All runtime objects require an agent identifier!');
-  _cache[id] = new _configurable.Configurable(obj, model);
+  _cache[id] = (0, _configurable.getModeledObject)(obj, model);
   (0, _nreum.gosNREUMInitializedAgents)(id, _cache[id], 'runtime');
 }

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

package/dist/cjs/common/drain/drain.js

@@ -66,7 +66,7 @@ function drain() {
 
   // Only when the event-groups for all features are ready to drain (staged) do we execute the drain. This has the effect
   // that the last feature to call drain triggers drain for all features.
-  const items = Array.from(registry[agentIdentifier]);
+  const items = [...registry[agentIdentifier]];
   if (items.every(_ref => {
     let [key, values] = _ref;
     return values.staged;

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;
@@ -69,23 +80,47 @@ class HarvestScheduler extends _sharedContext.SharedContext {
   runHarvest(opts) {
     if (this.aborted) return;
     var scheduler = this;
+    let harvests = [];
+    let submitMethod;
     if (this.opts.getPayload) {
-      // Ajax & PVT
-      var submitMethod = (0, _harvest.getSubmitMethod)(this.endpoint, opts);
+      // Ajax & PVT & SR
+      submitMethod = (0, _harvest.getSubmitMethod)(this.endpoint, opts);
       if (!submitMethod) return false;
-      var retry = submitMethod.method === _submitData.submitData.xhr;
+      const retry = submitMethod.method === _submitData.submitData.xhr;
       var payload = this.opts.getPayload({
         retry: retry
       });
-      if (payload) {
-        payload = Object.prototype.toString.call(payload) === '[object Array]' ? payload : [payload];
-        for (var i = 0; i < payload.length; i++) {
-          this.harvest.send(this.endpoint, payload[i], opts, submitMethod, onHarvestFinished);
+      if (!payload) {
+        if (this.started) {
+          this.scheduleHarvest();
         }
+        return;
       }
+      payload = Object.prototype.toString.call(payload) === '[object Array]' ? payload : [payload];
+      harvests.push(...payload);
+    }
+
+    /** sendX is used for features that do not supply a preformatted payload via "getPayload" */
+    let send = args => this.harvest.sendX(args);
+    if (harvests.length) {
+      /** _send is the underlying method for sending in the harvest, if sending raw we can bypass the other helpers completely which format the payloads */
+      if (this.opts.raw) send = args => this.harvest._send(args);
+      /** send is used to formated the payloads from "getPayload" and obfuscate before sending */else send = args => this.harvest.send(args);
     } else {
-      this.harvest.sendX(this.endpoint, opts, onHarvestFinished);
+      // force it to run at least once in sendX mode
+      harvests.push(undefined);
     }
+    harvests.forEach(payload => {
+      send({
+        endpoint: this.endpoint,
+        payload,
+        opts,
+        submitMethod,
+        cbFinished: onHarvestFinished,
+        customUrl: this.opts.customUrl,
+        raw: this.opts.raw
+      });
+    });
     if (this.started) {
       this.scheduleHarvest();
     }

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);
+  });
+});