@newrelic/browser-agent 1.276.0 → 1.277.0

package/dist/esm/features/soft_navigations/aggregate/interaction.js

@@ -4,7 +4,7 @@ import { generateUuid } from '../../../common/ids/unique-id';
 import { addCustomAttributes, getAddStringContext, nullable, numeric } from '../../../common/serialize/bel-serializer';
 import { now } from '../../../common/timing/now';
 import { cleanURL } from '../../../common/url/clean-url';
-import { NODE_TYPE, INTERACTION_STATUS, INTERACTION_TYPE, API_TRIGGER_NAME } from '../constants';
+import { NODE_TYPE, INTERACTION_STATUS, INTERACTION_TYPE, API_TRIGGER_NAME, IPL_TRIGGER_NAME } from '../constants';
 import { BelNode } from './bel-node';
 
 /**
@@ -13,8 +13,6 @@ import { BelNode } from './bel-node';
 export class Interaction extends BelNode {
   id = generateUuid(); // unique id that is serialized and used to link interactions with errors
   initialPageURL = initialLocation;
-  oldURL = '' + globalScope?.location;
-  newURL = '' + globalScope?.location;
   customName;
   customAttributes = {};
   customDataByApi = {};
@@ -29,7 +27,7 @@ export class Interaction extends BelNode {
   keepOpenUntilEndApi = false;
   onDone = [];
   cancellationTimer;
-  constructor(agentIdentifier, uiEvent, uiEventTimestamp, currentRouteKnown) {
+  constructor(agentIdentifier, uiEvent, uiEventTimestamp, currentRouteKnown, currentUrl) {
     super(agentIdentifier);
     this.belType = NODE_TYPE.INTERACTION;
     this.trigger = uiEvent;
@@ -38,6 +36,7 @@ export class Interaction extends BelNode {
     this.eventSubscription = new Map([['finished', []], ['cancelled', []]]);
     this.forceSave = this.forceIgnore = false;
     if (this.trigger === API_TRIGGER_NAME) this.createdByApi = true;
+    this.newURL = this.oldURL = currentUrl || globalScope?.location.href;
   }
   updateDom(timestamp) {
     this.domTimestamp = timestamp || now(); // default timestamp should be precise for accurate isActiveDuring calculations
@@ -57,6 +56,8 @@ export class Interaction extends BelNode {
   done(customEndTime) {
     // User could've mark this interaction--regardless UI or api started--as "don't close until .end() is called on it". Only .end provides a timestamp; the default flows do not.
     if (this.keepOpenUntilEndApi && customEndTime === undefined) return false;
+    // If interaction is already closed, this is a no-op. However, returning true lets startUIInteraction know that it CAN start a new interaction, as this one is done.
+    if (this.status !== INTERACTION_STATUS.IP) return true;
     this.onDone.forEach(apiProvidedCb => apiProvidedCb(this.customDataByApi)); // this interaction's .save or .ignore can still be set by these user provided callbacks for example
 
     if (this.forceIgnore) this.#cancel(); // .ignore() always has precedence over save actions
@@ -66,7 +67,6 @@ export class Interaction extends BelNode {
     return true;
   }
   #finish(customEndTime = 0) {
-    if (this.status !== INTERACTION_STATUS.IP) return; // disallow this call if the ixn is already done aka not in-progress
     clearTimeout(this.cancellationTimer);
     this.end = Math.max(this.domTimestamp, this.historyTimestamp, customEndTime);
     this.customAttributes = {
@@ -80,7 +80,6 @@ export class Interaction extends BelNode {
     callbacks.forEach(fn => fn());
   }
   #cancel() {
-    if (this.status !== INTERACTION_STATUS.IP) return; // disallow this call if the ixn is already done aka not in-progress
     clearTimeout(this.cancellationTimer);
     this.status = INTERACTION_STATUS.CAN;
 
@@ -97,7 +96,7 @@ export class Interaction extends BelNode {
    */
   isActiveDuring(timestamp) {
     if (this.status === INTERACTION_STATUS.IP) return this.start <= timestamp;
-    return this.status === INTERACTION_STATUS.FIN && this.start <= timestamp && this.end >= timestamp;
+    return this.status === INTERACTION_STATUS.FIN && this.start <= timestamp && this.end > timestamp;
   }
 
   // Following are virtual properties overridden by a subclass:
@@ -105,16 +104,17 @@ export class Interaction extends BelNode {
   get firstContentfulPaint() {}
   get navTiming() {}
   serialize(firstStartTimeOfPayload) {
+    const isFirstIxnOfPayload = firstStartTimeOfPayload === undefined;
     const addString = getAddStringContext(this.agentIdentifier);
     const nodeList = [];
     let ixnType;
-    if (this.trigger === 'initialPageLoad') ixnType = INTERACTION_TYPE.INITIAL_PAGE_LOAD;else if (this.newURL !== this.oldURL) ixnType = INTERACTION_TYPE.ROUTE_CHANGE;else ixnType = INTERACTION_TYPE.UNSPECIFIED;
+    if (this.trigger === IPL_TRIGGER_NAME) ixnType = INTERACTION_TYPE.INITIAL_PAGE_LOAD;else if (this.newURL !== this.oldURL) ixnType = INTERACTION_TYPE.ROUTE_CHANGE;else ixnType = INTERACTION_TYPE.UNSPECIFIED;
 
     // IMPORTANT: The order in which addString is called matters and correlates to the order in which string shows up in the harvest payload. Do not re-order the following code.
     const fields = [numeric(this.belType), 0,
     // this will be overwritten below with number of attached nodes
-    numeric(this.start - firstStartTimeOfPayload),
-    // relative to first node
+    numeric(this.start - (isFirstIxnOfPayload ? 0 : firstStartTimeOfPayload)),
+    // the very 1st ixn does not require offset so it should fallback to a 0 while rest is offset by the very 1st ixn's start
     numeric(this.end - this.start),
     // end -- relative to start
     numeric(this.callbackEnd),
@@ -125,9 +125,9 @@ export class Interaction extends BelNode {
     const allAttachedNodes = addCustomAttributes(this.customAttributes || {}, addString); // start with all custom attributes
     if (getInfo(this.agentIdentifier).atts) allAttachedNodes.push('a,' + addString(getInfo(this.agentIdentifier).atts)); // add apm provided attributes
     /* Querypack encoder+decoder quirkiness:
-       - If first ixn node of payload is being processed, we use this node's start to offset. (firstStartTime should be 0--or undefined.)
-       - Else for subsequent ixn nodes, we use the first ixn node's start to offset. */
-    this.children.forEach(node => allAttachedNodes.push(node.serialize(firstStartTimeOfPayload || this.start))); // recursively add the serialized string of every child of this (ixn) bel node
+       - If first ixn node of payload is being processed, its children's start time must be offset by this node's start. (firstStartTime should be undefined.)
+       - Else for subsequent ixns in the same payload, we go back to using that first ixn node's start to offset their children's start. */
+    this.children.forEach(node => allAttachedNodes.push(node.serialize(isFirstIxnOfPayload ? this.start : firstStartTimeOfPayload))); // recursively add the serialized string of every child of this (ixn) bel node
 
     fields[1] = numeric(allAttachedNodes.length);
     nodeList.push(fields);

package/dist/esm/features/soft_navigations/constants.js

@@ -3,9 +3,12 @@ export const INTERACTION_TRIGGERS = ['click',
 // e.g. user clicks link or the page back/forward buttons
 'keydown',
 // e.g. user presses left and right arrow key to switch between displayed photo gallery
-'submit' // e.g. user clicks submit butotn or presses enter while editing a form field
+'submit',
+// e.g. user clicks submit butotn or presses enter while editing a form field
+'popstate' // history api is used to navigate back and forward
 ];
 export const API_TRIGGER_NAME = 'api';
+export const IPL_TRIGGER_NAME = 'initialPageLoad';
 export const FEATURE_NAME = FEATURE_NAMES.softNav;
 export const INTERACTION_TYPE = {
   INITIAL_PAGE_LOAD: '',

package/dist/esm/loaders/api/api-methods.js

@@ -1,3 +1,3 @@
 import { SR_EVENT_EMITTER_TYPES } from '../../features/session_replay/constants';
-export const apiMethods = ['setErrorHandler', 'finished', 'addToTrace', 'addRelease', 'addPageAction', 'setCurrentRouteName', 'setPageViewName', 'setCustomAttribute', 'interaction', 'noticeError', 'setUserId', 'setApplicationVersion', 'start', SR_EVENT_EMITTER_TYPES.RECORD, SR_EVENT_EMITTER_TYPES.PAUSE, 'log', 'wrapLogger'];
+export const apiMethods = ['setErrorHandler', 'finished', 'addToTrace', 'addRelease', 'recordCustomEvent', 'addPageAction', 'setCurrentRouteName', 'setPageViewName', 'setCustomAttribute', 'interaction', 'noticeError', 'setUserId', 'setApplicationVersion', 'start', SR_EVENT_EMITTER_TYPES.RECORD, SR_EVENT_EMITTER_TYPES.PAUSE, 'log', 'wrapLogger'];
 export const asyncApiMethods = ['setErrorHandler', 'finished', 'addToTrace', 'addRelease'];

package/dist/esm/loaders/api/api.js

@@ -72,6 +72,7 @@ export function setAPI(agentIdentifier, forceDrain, runSoftNavOverSpa = false) {
     apiInterface[fnName] = apiCall(prefix, fnName, true, 'api');
   });
   apiInterface.addPageAction = apiCall(prefix, 'addPageAction', true, FEATURE_NAMES.genericEvents);
+  apiInterface.recordCustomEvent = apiCall(prefix, 'recordCustomEvent', true, FEATURE_NAMES.genericEvents);
   apiInterface.setPageViewName = function (name, host) {
     if (typeof name !== 'string') return;
     if (name.charAt(0) !== '/') name = '/' + name;
@@ -190,7 +191,7 @@ export function setAPI(agentIdentifier, forceDrain, runSoftNavOverSpa = false) {
   function apiCall(prefix, name, notSpa, bufferGroup) {
     return function () {
       handle(SUPPORTABILITY_METRIC_CHANNEL, ['API/' + name + '/called'], undefined, FEATURE_NAMES.metrics, instanceEE);
-      if (bufferGroup) handle(prefix + name, [now(), ...arguments], notSpa ? null : this, bufferGroup, instanceEE); // no bufferGroup means only the SM is emitted
+      if (bufferGroup) handle(prefix + name, [notSpa ? now() : performance.now(), ...arguments], notSpa ? null : this, bufferGroup, instanceEE); // no bufferGroup means only the SM is emitted
       return notSpa ? undefined : this; // returns the InteractionHandle which allows these methods to be chained
     };
   }

package/dist/esm/loaders/micro-agent-base.js

@@ -27,6 +27,16 @@ export class MicroAgentBase {
     return this.#callMethod('addPageAction', name, attributes);
   }
 
+  /**
+   * Records a custom event with a specified eventType and attributes.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
+   * @param {string} eventType The eventType to store the event as.
+   * @param {object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+   */
+  recordCustomEvent(eventType, attributes) {
+    return this.#callMethod('recordCustomEvent', eventType, attributes);
+  }
+
   /**
    * Groups page views to help URL structure or to capture the URL's routing information.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setpageviewname/}

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

@@ -24,6 +24,7 @@ export class Aggregate extends AggregateBase {
         ua: any;
         at: any;
     };
+    toEpoch(timestamp: any): number;
     trackSupportabilityMetrics(): void;
 }
 import { AggregateBase } from '../../utils/aggregate-base';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/generic_events/aggregate/index.js"],"names":[],"mappings":"AAoBA;IACE,2BAAiC;IACjC,2BAsKC;IAnKC,yBAA4B;IAC5B,wBAAyE;IAEzE,gCAAkG;IA8B9F,4CAAuD;IAyHzD,mCAGQ;IASZ;;;;;;;;;;;OAWG;IACH,eAHW,MAAM,YAAC,QA0CjB;IAED,qCAEC;IAED;;;MAEC;IAED,mCASC;CACF;8BA7P6B,4BAA4B;sCAOpB,wCAAwC;iCAX7C,2CAA2C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/generic_events/aggregate/index.js"],"names":[],"mappings":"AAoBA;IACE,2BAAiC;IACjC,2BA+KC;IA5KC,yBAA4B;IAC5B,wBAAyE;IAEzE,gCAAkG;IAuC9F,4CAAuD;IAyHzD,mCAGQ;IASZ;;;;;;;;;;;OAWG;IACH,eAHW,MAAM,YAAC,QA0CjB;IAED,qCAEC;IAED;;;MAEC;IAED,gCAEC;IAED,mCASC;CACF;8BA1Q6B,4BAA4B;sCAOpB,wCAAwC;iCAX7C,2CAA2C"}

package/dist/types/features/generic_events/constants.d.ts

@@ -5,6 +5,7 @@ export const OBSERVED_EVENTS: string[];
 export const OBSERVED_WINDOW_EVENTS: string[];
 export const RAGE_CLICK_THRESHOLD_EVENTS: 4;
 export const RAGE_CLICK_THRESHOLD_MS: 1000;
+export const RESERVED_EVENT_TYPES: string[];
 export namespace FEATURE_FLAGS {
     let MARKS: string;
     let MEASURES: string;

package/dist/types/features/generic_events/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/features/generic_events/constants.js"],"names":[],"mappings":"AAEA,kCAAuD;AACvD,uCAAuC;AACvC,uCAAuC;AAEvC,uCAA6F;AAC7F,8CAAuD;AAEvD,4CAA4C;AAC5C,2CAA2C"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/features/generic_events/constants.js"],"names":[],"mappings":"AAEA,kCAAuD;AACvD,uCAAuC;AACvC,uCAAuC;AAEvC,uCAA6F;AAC7F,8CAAuD;AAEvD,4CAA4C;AAC5C,2CAA2C;AAE3C,4CAAsF"}

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

@@ -8,6 +8,7 @@ export class Aggregate extends AggregateBase {
     initialPageLoadInteraction: InitialPageLoadInteraction;
     latestRouteSetByApi: any;
     interactionInProgress: Interaction | null;
+    latestHistoryUrl: any;
     serializer(eventBuffer: any): string;
     startUIInteraction(eventName: any, startedAt: any, sourceElem: any): void;
     setClosureHandlers(): void;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/soft_navigations/aggregate/index.js"],"names":[],"mappings":"AAaA;IACE,2BAAiC;IACjC;;OAkDC;IA9CC,2BAAwC;IACxC,iBAA8B;IAE9B,uDAA0F;IAW1F,yBAA+B;IAC/B,0CAAiC;IAiCnC,qCAUC;IAED,0EAeC;IAED,2BAiBC;IAED;;;;;;;OAOG;IACH,6BAHW,mBAAmB,OAqB7B;;CA2FF;8BAjO6B,4BAA4B;2CAGf,iCAAiC;4BAChD,eAAe"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/soft_navigations/aggregate/index.js"],"names":[],"mappings":"AAaA;IACE,2BAAiC;IACjC;;OAyDC;IArDC,2BAAwC;IACxC,iBAA8B;IAE9B,uDAA0F;IAa1F,yBAA+B;IAC/B,0CAAiC;IACjC,sBAA4B;IAqC9B,qCAUC;IAED,0EAiBC;IAED,2BAiBC;IAED;;;;;;;OAOG;IACH,6BAHW,mBAAmB,OAqB7B;;CA6FF;8BA5O6B,4BAA4B;2CAGf,iCAAiC;4BAChD,eAAe"}

package/dist/types/features/soft_navigations/aggregate/initial-page-load-interaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"initial-page-load-interaction.d.ts","sourceRoot":"","sources":["../../../../../src/features/soft_navigations/aggregate/initial-page-load-interaction.js"],"names":[],"mappings":"AAOA;IACE,kCAKC;IAED,sBAAqD;IACrD,gCAAyE;IAEzE;;;OAGG;IACH,oCA6BC;CACF;4BAnD2B,eAAe"}
+{"version":3,"file":"initial-page-load-interaction.d.ts","sourceRoot":"","sources":["../../../../../src/features/soft_navigations/aggregate/initial-page-load-interaction.js"],"names":[],"mappings":"AAQA;IACE,kCAKC;IAED,sBAAqD;IACrD,gCAAyE;IAEzE;;;OAGG;IACH,oCA6BC;CACF;4BApD2B,eAAe"}

package/dist/types/features/soft_navigations/aggregate/interaction.d.ts

@@ -2,11 +2,9 @@
  * link https://github.com/newrelic/nr-querypack/blob/main/schemas/bel/7.qpschema
  **/
 export class Interaction extends BelNode {
-    constructor(agentIdentifier: any, uiEvent: any, uiEventTimestamp: any, currentRouteKnown: any);
+    constructor(agentIdentifier: any, uiEvent: any, uiEventTimestamp: any, currentRouteKnown: any, currentUrl: any);
     id: string;
     initialPageURL: string;
-    oldURL: string;
-    newURL: string;
     customName: any;
     customAttributes: {};
     customDataByApi: {};
@@ -27,6 +25,8 @@ export class Interaction extends BelNode {
     eventSubscription: Map<string, never[]>;
     forceSave: boolean;
     forceIgnore: boolean;
+    newURL: any;
+    oldURL: any;
     updateDom(timestamp: any): void;
     updateHistory(timestamp: any, newUrl: any): void;
     seenHistoryAndDomChange(): boolean;

package/dist/types/features/soft_navigations/aggregate/interaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interaction.d.ts","sourceRoot":"","sources":["../../../../../src/features/soft_navigations/aggregate/interaction.js"],"names":[],"mappings":"AASA;;IAEI;AACJ;IAoBE,+FAYC;IA/BD,WAAmB;IACnB,uBAAgC;IAChC,eAAmC;IACnC,eAAmC;IACnC,gBAAU;IACV,qBAAqB;IACrB,oBAAoB;IACpB,eAAS;IACT,aAAO;IACP,cAAQ;IACR,+EAA+E;IAC/E,eAA8B;IAC9B,qBAAgB;IAChB,yBAAoB;IACpB,sBAAoB;IACpB,6BAA2B;IAC3B,cAAW;IACX,uBAAiB;IAIf,gBAAoC;IACpC,aAAsB;IAEtB,cAAiC;IACjC,wCAGE;IACF,mBAAyC;IAAxB,qBAAwB;IAI3C,gCAEC;IAED,iDAGC;IAED,mCAEC;IAED,8BAIC;IAED,kCAUC;IAwBD;;;;;OAKG;IACH,0BAHW,mBAAmB,WAM7B;IAGD,uBAAoB;IACpB,iCAA8B;IAC9B,sBAAmB;IAEnB,gDA2CC;;CACF;wBAxJuB,YAAY"}
+{"version":3,"file":"interaction.d.ts","sourceRoot":"","sources":["../../../../../src/features/soft_navigations/aggregate/interaction.js"],"names":[],"mappings":"AASA;;IAEI;AACJ;IAkBE,gHAaC;IA9BD,WAAmB;IACnB,uBAAgC;IAChC,gBAAU;IACV,qBAAqB;IACrB,oBAAoB;IACpB,eAAS;IACT,aAAO;IACP,cAAQ;IACR,+EAA+E;IAC/E,eAA8B;IAC9B,qBAAgB;IAChB,yBAAoB;IACpB,sBAAoB;IACpB,6BAA2B;IAC3B,cAAW;IACX,uBAAiB;IAIf,gBAAoC;IACpC,aAAsB;IAEtB,cAAiC;IACjC,wCAGE;IACF,mBAAyC;IAAxB,qBAAwB;IAEzC,YAAsE;IAAxD,YAAwD;IAGxE,gCAEC;IAED,iDAGC;IAED,mCAEC;IAED,8BAIC;IAED,kCAaC;IAsBD;;;;;OAKG;IACH,0BAHW,mBAAmB,WAM7B;IAGD,uBAAoB;IACpB,iCAA8B;IAC9B,sBAAmB;IAEnB,gDA4CC;;CACF;wBAzJuB,YAAY"}

package/dist/types/features/soft_navigations/constants.d.ts

@@ -1,5 +1,6 @@
 export const INTERACTION_TRIGGERS: string[];
 export const API_TRIGGER_NAME: "api";
+export const IPL_TRIGGER_NAME: "initialPageLoad";
 export const FEATURE_NAME: string;
 export namespace INTERACTION_TYPE {
     let INITIAL_PAGE_LOAD: string;

package/dist/types/features/soft_navigations/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/features/soft_navigations/constants.js"],"names":[],"mappings":"AAEA,4CAIC;AACD,qCAAqC;AAErC,kCAAiD"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/features/soft_navigations/constants.js"],"names":[],"mappings":"AAEA,4CAKC;AACD,qCAAqC;AACrC,iDAAiD;AAEjD,kCAAiD"}

package/dist/types/loaders/api/api.d.ts

@@ -9,6 +9,7 @@ export function setAPI(agentIdentifier: any, forceDrain: any, runSoftNavOverSpa?
         level?: string | undefined;
     }): void;
     addPageAction: (...args: any[]) => any;
+    recordCustomEvent: (...args: any[]) => any;
     setPageViewName(name: any, host: any): any;
     setCustomAttribute(name: any, value: any, persistAttribute?: boolean): any;
     /**

package/dist/types/loaders/api/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/api.js"],"names":[],"mappings":"AAuBA,2CAiBC;AAID;;;;;;;;;;;;IAiEE;;;;OAIG;qBAFQ,MAAM;IAWjB;;;;OAIG;iCAFQ,MAAM,GAAC,IAAI;;;;;EAiGvB"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/api.js"],"names":[],"mappings":"AAuBA,2CAiBC;AAID;;;;;;;;;;;;;IAmEE;;;;OAIG;qBAFQ,MAAM;IAWjB;;;;OAIG;iCAFQ,MAAM,GAAC,IAAI;;;;;EAiGvB"}

package/dist/types/loaders/micro-agent-base.d.ts

@@ -8,6 +8,13 @@ export class MicroAgentBase {
      * @param {object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}. The key is reported as its own PageAction attribute with the specified values.
      */
     addPageAction(name: string, attributes?: object | undefined): any;
+    /**
+     * Records a custom event with a specified eventType and attributes.
+     * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/recordCustomEvent/}
+     * @param {string} eventType The eventType to store the event as.
+     * @param {object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}.
+     */
+    recordCustomEvent(eventType: string, attributes?: object | undefined): any;
     /**
      * Groups page views to help URL structure or to capture the URL's routing information.
      * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setpageviewname/}

package/dist/types/loaders/micro-agent-base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"micro-agent-base.d.ts","sourceRoot":"","sources":["../../../src/loaders/micro-agent-base.js"],"names":[],"mappings":"AAGA;IAGE,sCAEC;IAJD,wBAAe;IAkBf;;;;;OAKG;IACH,oBAHW,MAAM,wCAKhB;IAED;;;;;OAKG;IACH,sBAHW,MAAM,kCAKhB;IAED;;;;;;OAMG;IACH,yBAJW,MAAM,SACN,MAAM,GAAC,MAAM,GAAC,OAAO,GAAC,IAAI,sCAKpC;IAED;;;;;OAKG;IACH,mBAHW,KAAK,GAAC,MAAM,8CAKtB;IAED;;;;OAIG;IACH,iBAFW,MAAM,GAAC,IAAI,OAIrB;IAED;;;;;;;OAOG;IACH,6BAJW,MAAM,GAAC,IAAI,OAMrB;IAED;;;;OAIG;IACH,0BAFW,CAAC,KAAK,EAAE,KAAK,GAAC,MAAM,KAAK,OAAO,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,OAI9D;IAED;;;;;OAKG;IACH,iBAHW,MAAM,MACN,MAAM,OAIhB;IAED;;;;;MAKE;IACF,aAHW,MAAM;2BACc,MAAM;gBAAU,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,MAAM,GAAC,MAAM;wBAInF;;CACF"}
+{"version":3,"file":"micro-agent-base.d.ts","sourceRoot":"","sources":["../../../src/loaders/micro-agent-base.js"],"names":[],"mappings":"AAGA;IAGE,sCAEC;IAJD,wBAAe;IAkBf;;;;;OAKG;IACH,oBAHW,MAAM,wCAKhB;IAED;;;;;OAKG;IACH,6BAHW,MAAM,wCAKhB;IAED;;;;;OAKG;IACH,sBAHW,MAAM,kCAKhB;IAED;;;;;;OAMG;IACH,yBAJW,MAAM,SACN,MAAM,GAAC,MAAM,GAAC,OAAO,GAAC,IAAI,sCAKpC;IAED;;;;;OAKG;IACH,mBAHW,KAAK,GAAC,MAAM,8CAKtB;IAED;;;;OAIG;IACH,iBAFW,MAAM,GAAC,IAAI,OAIrB;IAED;;;;;;;OAOG;IACH,6BAJW,MAAM,GAAC,IAAI,OAMrB;IAED;;;;OAIG;IACH,0BAFW,CAAC,KAAK,EAAE,KAAK,GAAC,MAAM,KAAK,OAAO,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,OAI9D;IAED;;;;;OAKG;IACH,iBAHW,MAAM,MACN,MAAM,OAIhB;IAED;;;;;MAKE;IACF,aAHW,MAAM;2BACc,MAAM;gBAAU,OAAO,GAAC,OAAO,GAAC,OAAO,GAAC,MAAM,GAAC,MAAM;wBAInF;;CACF"}

package/package.json

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

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

@@ -5,7 +5,7 @@
 import { stringify } from '../../../common/util/stringify'
 import { HarvestScheduler } from '../../../common/harvest/harvest-scheduler'
 import { cleanURL } from '../../../common/url/clean-url'
-import { FEATURE_NAME } from '../constants'
+import { FEATURE_NAME, RESERVED_EVENT_TYPES } from '../constants'
 import { globalScope, initialLocation, isBrowserScope } from '../../../common/constants/runtime'
 import { AggregateBase } from '../../utils/aggregate-base'
 import { warn } from '../../../common/util/console'
@@ -37,12 +37,21 @@ export class Aggregate extends AggregateBase {
 
       this.trackSupportabilityMetrics()
 
+      registerHandler('api-recordCustomEvent', (timestamp, eventType, attributes) => {
+        if (RESERVED_EVENT_TYPES.includes(eventType)) return warn(46)
+        this.addEvent({
+          eventType,
+          timestamp: this.toEpoch(timestamp),
+          ...attributes
+        })
+      }, this.featureName, this.ee)
+
       if (agentRef.init.page_action.enabled) {
         registerHandler('api-addPageAction', (timestamp, name, attributes) => {
           this.addEvent({
             ...attributes,
             eventType: 'PageAction',
-            timestamp: Math.floor(this.agentRef.runtime.timeKeeper.correctRelativeTimestamp(timestamp)),
+            timestamp: this.toEpoch(timestamp),
             timeSinceLoad: timestamp / 1000,
             actionName: name,
             referrerUrl: this.referrerUrl,
@@ -66,7 +75,7 @@ export class Aggregate extends AggregateBase {
               const { target, timeStamp, type } = aggregatedUserAction.event
               this.addEvent({
                 eventType: 'UserAction',
-                timestamp: Math.floor(this.agentRef.runtime.timeKeeper.correctRelativeTimestamp(timeStamp)),
+                timestamp: this.toEpoch(timeStamp),
                 action: type,
                 actionCount: aggregatedUserAction.count,
                 actionDuration: aggregatedUserAction.relativeMs[aggregatedUserAction.relativeMs.length - 1],
@@ -118,7 +127,7 @@ export class Aggregate extends AggregateBase {
                     handle(SUPPORTABILITY_METRIC_CHANNEL, ['Generic/Performance/' + type + '/Seen'])
                     this.addEvent({
                       eventType: 'BrowserPerformance',
-                      timestamp: Math.floor(agentRef.runtime.timeKeeper.correctRelativeTimestamp(entry.startTime)),
+                      timestamp: this.toEpoch(entry.startTime),
                       entryName: cleanURL(entry.name),
                       entryDuration: entry.duration,
                       entryType: type,
@@ -250,6 +259,10 @@ export class Aggregate extends AggregateBase {
     return { ua: this.agentRef.info.userAttributes, at: this.agentRef.info.atts }
   }
 
+  toEpoch (timestamp) {
+    return Math.floor(this.agentRef.runtime.timeKeeper.correctRelativeTimestamp(timestamp))
+  }
+
   trackSupportabilityMetrics () {
     /** track usage SMs to improve these experimental features */
     const configPerfTag = 'Config/Performance/'

package/src/features/generic_events/constants.js

@@ -10,6 +10,8 @@ export const OBSERVED_WINDOW_EVENTS = ['focus', 'blur']
 export const RAGE_CLICK_THRESHOLD_EVENTS = 4
 export const RAGE_CLICK_THRESHOLD_MS = 1000
 
+export const RESERVED_EVENT_TYPES = ['PageAction', 'UserAction', 'BrowserPerformance']
+
 export const FEATURE_FLAGS = {
   MARKS: 'experimental.marks',
   MEASURES: 'experimental.measures',

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

@@ -6,7 +6,7 @@ import { timeToFirstByte } from '../../../common/vitals/time-to-first-byte'
 import { FEATURE_NAMES, FEATURE_TO_ENDPOINT } from '../../../loaders/features/features'
 import { SUPPORTABILITY_METRIC_CHANNEL } from '../../metrics/constants'
 import { AggregateBase } from '../../utils/aggregate-base'
-import { API_TRIGGER_NAME, FEATURE_NAME, INTERACTION_STATUS } from '../constants'
+import { API_TRIGGER_NAME, FEATURE_NAME, INTERACTION_STATUS, INTERACTION_TRIGGERS, IPL_TRIGGER_NAME } from '../constants'
 import { AjaxNode } from './ajax-node'
 import { InitialPageLoadInteraction } from './initial-page-load-interaction'
 import { Interaction } from './interaction'
@@ -21,18 +21,21 @@ export class Aggregate extends AggregateBase {
     this.domObserver = domObserver
 
     this.initialPageLoadInteraction = new InitialPageLoadInteraction(agentRef.agentIdentifier)
+    this.initialPageLoadInteraction.onDone.push(() => { // this ensures the .end() method also works with iPL
+      this.initialPageLoadInteraction.forceSave = true // unless forcibly ignored, iPL always finish by default
+      this.interactionsToHarvest.add(this.initialPageLoadInteraction)
+      this.initialPageLoadInteraction = null
+    })
     timeToFirstByte.subscribe(({ attrs }) => {
       const loadEventTime = attrs.navigationEntry.loadEventEnd
-      this.initialPageLoadInteraction.forceSave = true
       this.initialPageLoadInteraction.done(loadEventTime)
-      this.interactionsToHarvest.add(this.initialPageLoadInteraction)
-      this.initialPageLoadInteraction = null
       // Report metric on the initial page load time
       handle(SUPPORTABILITY_METRIC_CHANNEL, ['SoftNav/Interaction/InitialPageLoad/Duration/Ms', Math.round(loadEventTime)], undefined, FEATURE_NAMES.metrics, this.ee)
     })
 
     this.latestRouteSetByApi = null
     this.interactionInProgress = null // aside from the "page load" interaction, there can only ever be 1 ongoing at a time
+    this.latestHistoryUrl = null
 
     this.blocked = false
     this.waitForFlags(['spa']).then(([spaOn]) => {
@@ -53,7 +56,11 @@ export class Aggregate extends AggregateBase {
 
     // By default, a complete UI driven interaction requires event -> URL change -> DOM mod in that exact order.
     registerHandler('newUIEvent', (event) => this.startUIInteraction(event.type, Math.floor(event.timeStamp), event.target), this.featureName, this.ee)
-    registerHandler('newURL', (timestamp, url) => this.interactionInProgress?.updateHistory(timestamp, url), this.featureName, this.ee)
+    registerHandler('newURL', (timestamp, url) => {
+      // In the case of 'popstate' trigger, by the time the event fires, the URL has already changed, so we need to store what-will-be the *previous* URL for oldURL of next popstate ixn.
+      this.latestHistoryUrl = url
+      this.interactionInProgress?.updateHistory(timestamp, url)
+    }, this.featureName, this.ee)
     registerHandler('newDom', timestamp => {
       this.interactionInProgress?.updateDom(timestamp)
       if (this.interactionInProgress?.seenHistoryAndDomChange()) this.interactionInProgress.done()
@@ -68,21 +75,23 @@ export class Aggregate extends AggregateBase {
   serializer (eventBuffer) {
     // The payload depacker takes the first ixn of a payload (if there are multiple ixns) and positively offset the subsequent ixns timestamps by that amount.
     // In order to accurately portray the real start & end times of the 2nd & onward ixns, we hence need to negatively offset their start timestamps with that of the 1st ixn.
-    let firstIxnStartTime = 0 // the very 1st ixn does not require any offsetting
+    let firstIxnStartTime
     const serializedIxnList = []
     for (const interaction of eventBuffer) {
       serializedIxnList.push(interaction.serialize(firstIxnStartTime))
-      if (!firstIxnStartTime) firstIxnStartTime = Math.floor(interaction.start)
+      if (firstIxnStartTime === undefined) firstIxnStartTime = Math.floor(interaction.start) // careful not to match or overwrite on 0 value!
     }
     return `bel.7;${serializedIxnList.join(';')}`
   }
 
   startUIInteraction (eventName, startedAt, sourceElem) { // this is throttled by instrumentation so that it isn't excessively called
     if (this.interactionInProgress?.createdByApi) return // api-started interactions cannot be disrupted aka cancelled by UI events (and the vice versa applies as well)
-    if (this.interactionInProgress?.done() === false) return
+    if (this.interactionInProgress?.done() === false) return // current in-progress is blocked from closing, e.g. by 'waitForEnd' api option
+
+    const oldURL = eventName === INTERACTION_TRIGGERS[3] ? this.latestHistoryUrl : undefined // see related comment in 'newURL' handler above, 'popstate'
+    this.interactionInProgress = new Interaction(this.agentIdentifier, eventName, startedAt, this.latestRouteSetByApi, oldURL)
 
-    this.interactionInProgress = new Interaction(this.agentIdentifier, eventName, startedAt, this.latestRouteSetByApi)
-    if (eventName === 'click') {
+    if (eventName === INTERACTION_TRIGGERS[0]) { // 'click'
       const sourceElemText = getActionText(sourceElem)
       if (sourceElemText) this.interactionInProgress.customAttributes.actionText = sourceElemText
     }
@@ -131,7 +140,7 @@ export class Aggregate extends AggregateBase {
     for (let idx = interactionsBuffer.length - 1; idx >= 0; idx--) { // reverse search for the latest completed interaction for efficiency
       const finishedInteraction = interactionsBuffer[idx]
       if (finishedInteraction.isActiveDuring(timestamp)) {
-        if (finishedInteraction.trigger !== 'initialPageLoad') return finishedInteraction
+        if (finishedInteraction.trigger !== IPL_TRIGGER_NAME) return finishedInteraction
         // It's possible that a complete interaction occurs before page is fully loaded, so we need to consider if a route-change ixn may have overlapped this iPL
         else saveIxn = finishedInteraction
       }
@@ -196,9 +205,11 @@ export class Aggregate extends AggregateBase {
       // In here, 'this' refers to the EventContext specific to per InteractionHandle instance spawned by each .interaction() api call.
       // Each api call aka IH instance would therefore retain a reference to either the in-progress interaction *at the time of the call* OR a new api-started interaction.
       this.associatedInteraction = thisClass.getInteractionFor(time)
+      if (this.associatedInteraction?.trigger === IPL_TRIGGER_NAME) this.associatedInteraction = null // the api get-interaction method cannot target IPL
       if (!this.associatedInteraction) {
         // This new api-driven interaction will be the target of any subsequent .interaction() call, until it is closed by EITHER .end() OR the regular seenHistoryAndDomChange process.
         this.associatedInteraction = thisClass.interactionInProgress = new Interaction(thisClass.agentIdentifier, API_TRIGGER_NAME, time, thisClass.latestRouteSetByApi)
+        thisClass.domObserver.observe(document.body, { attributes: true, childList: true, subtree: true, characterData: true }) // start observing for DOM changes like a regular UI-driven interaction
         thisClass.setClosureHandlers()
       }
       if (waitForEnd === true) this.associatedInteraction.keepOpenUntilEndApi = true

package/src/features/soft_navigations/aggregate/initial-page-load-interaction.js

@@ -4,10 +4,11 @@ import { numeric } from '../../../common/serialize/bel-serializer'
 import { firstPaint } from '../../../common/vitals/first-paint'
 import { firstContentfulPaint } from '../../../common/vitals/first-contentful-paint'
 import { getInfo } from '../../../common/config/info'
+import { IPL_TRIGGER_NAME } from '../constants'
 
 export class InitialPageLoadInteraction extends Interaction {
   constructor (agentIdentifier) {
-    super(agentIdentifier, 'initialPageLoad', 0, null)
+    super(agentIdentifier, IPL_TRIGGER_NAME, 0, null)
     const agentInfo = getInfo(agentIdentifier)
     this.queueTime = agentInfo.queueTime
     this.appTime = agentInfo.applicationTime

package/src/features/soft_navigations/aggregate/interaction.js

@@ -4,7 +4,7 @@ import { generateUuid } from '../../../common/ids/unique-id'
 import { addCustomAttributes, getAddStringContext, nullable, numeric } from '../../../common/serialize/bel-serializer'
 import { now } from '../../../common/timing/now'
 import { cleanURL } from '../../../common/url/clean-url'
-import { NODE_TYPE, INTERACTION_STATUS, INTERACTION_TYPE, API_TRIGGER_NAME } from '../constants'
+import { NODE_TYPE, INTERACTION_STATUS, INTERACTION_TYPE, API_TRIGGER_NAME, IPL_TRIGGER_NAME } from '../constants'
 import { BelNode } from './bel-node'
 
 /**
@@ -13,8 +13,6 @@ import { BelNode } from './bel-node'
 export class Interaction extends BelNode {
   id = generateUuid() // unique id that is serialized and used to link interactions with errors
   initialPageURL = initialLocation
-  oldURL = '' + globalScope?.location
-  newURL = '' + globalScope?.location
   customName
   customAttributes = {}
   customDataByApi = {}
@@ -30,7 +28,7 @@ export class Interaction extends BelNode {
   onDone = []
   cancellationTimer
 
-  constructor (agentIdentifier, uiEvent, uiEventTimestamp, currentRouteKnown) {
+  constructor (agentIdentifier, uiEvent, uiEventTimestamp, currentRouteKnown, currentUrl) {
     super(agentIdentifier)
     this.belType = NODE_TYPE.INTERACTION
     this.trigger = uiEvent
@@ -42,6 +40,7 @@ export class Interaction extends BelNode {
     ])
     this.forceSave = this.forceIgnore = false
     if (this.trigger === API_TRIGGER_NAME) this.createdByApi = true
+    this.newURL = this.oldURL = (currentUrl || globalScope?.location.href)
   }
 
   updateDom (timestamp) {
@@ -66,6 +65,9 @@ export class Interaction extends BelNode {
   done (customEndTime) {
     // User could've mark this interaction--regardless UI or api started--as "don't close until .end() is called on it". Only .end provides a timestamp; the default flows do not.
     if (this.keepOpenUntilEndApi && customEndTime === undefined) return false
+    // If interaction is already closed, this is a no-op. However, returning true lets startUIInteraction know that it CAN start a new interaction, as this one is done.
+    if (this.status !== INTERACTION_STATUS.IP) return true
+
     this.onDone.forEach(apiProvidedCb => apiProvidedCb(this.customDataByApi)) // this interaction's .save or .ignore can still be set by these user provided callbacks for example
 
     if (this.forceIgnore) this.#cancel() // .ignore() always has precedence over save actions
@@ -76,7 +78,6 @@ export class Interaction extends BelNode {
   }
 
   #finish (customEndTime = 0) {
-    if (this.status !== INTERACTION_STATUS.IP) return // disallow this call if the ixn is already done aka not in-progress
     clearTimeout(this.cancellationTimer)
     this.end = Math.max(this.domTimestamp, this.historyTimestamp, customEndTime)
     this.customAttributes = { ...getInfo(this.agentIdentifier).jsAttributes, ...this.customAttributes } // attrs specific to this interaction should have precedence over the general custom attrs
@@ -88,7 +89,6 @@ export class Interaction extends BelNode {
   }
 
   #cancel () {
-    if (this.status !== INTERACTION_STATUS.IP) return // disallow this call if the ixn is already done aka not in-progress
     clearTimeout(this.cancellationTimer)
     this.status = INTERACTION_STATUS.CAN
 
@@ -105,7 +105,7 @@ export class Interaction extends BelNode {
    */
   isActiveDuring (timestamp) {
     if (this.status === INTERACTION_STATUS.IP) return this.start <= timestamp
-    return (this.status === INTERACTION_STATUS.FIN && this.start <= timestamp && this.end >= timestamp)
+    return (this.status === INTERACTION_STATUS.FIN && this.start <= timestamp && this.end > timestamp)
   }
 
   // Following are virtual properties overridden by a subclass:
@@ -114,10 +114,11 @@ export class Interaction extends BelNode {
   get navTiming () {}
 
   serialize (firstStartTimeOfPayload) {
+    const isFirstIxnOfPayload = firstStartTimeOfPayload === undefined
     const addString = getAddStringContext(this.agentIdentifier)
     const nodeList = []
     let ixnType
-    if (this.trigger === 'initialPageLoad') ixnType = INTERACTION_TYPE.INITIAL_PAGE_LOAD
+    if (this.trigger === IPL_TRIGGER_NAME) ixnType = INTERACTION_TYPE.INITIAL_PAGE_LOAD
     else if (this.newURL !== this.oldURL) ixnType = INTERACTION_TYPE.ROUTE_CHANGE
     else ixnType = INTERACTION_TYPE.UNSPECIFIED
 
@@ -125,7 +126,7 @@ export class Interaction extends BelNode {
     const fields = [
       numeric(this.belType),
       0, // this will be overwritten below with number of attached nodes
-      numeric(this.start - firstStartTimeOfPayload), // relative to first node
+      numeric(this.start - (isFirstIxnOfPayload ? 0 : firstStartTimeOfPayload)), // the very 1st ixn does not require offset so it should fallback to a 0 while rest is offset by the very 1st ixn's start
       numeric(this.end - this.start), // end -- relative to start
       numeric(this.callbackEnd), // cbEnd -- relative to start; not used by BrowserInteraction events
       numeric(this.callbackDuration), // not relative
@@ -144,9 +145,9 @@ export class Interaction extends BelNode {
     const allAttachedNodes = addCustomAttributes(this.customAttributes || {}, addString) // start with all custom attributes
     if (getInfo(this.agentIdentifier).atts) allAttachedNodes.push('a,' + addString(getInfo(this.agentIdentifier).atts)) // add apm provided attributes
     /* Querypack encoder+decoder quirkiness:
-       - If first ixn node of payload is being processed, we use this node's start to offset. (firstStartTime should be 0--or undefined.)
-       - Else for subsequent ixn nodes, we use the first ixn node's start to offset. */
-    this.children.forEach(node => allAttachedNodes.push(node.serialize(firstStartTimeOfPayload || this.start))) // recursively add the serialized string of every child of this (ixn) bel node
+       - If first ixn node of payload is being processed, its children's start time must be offset by this node's start. (firstStartTime should be undefined.)
+       - Else for subsequent ixns in the same payload, we go back to using that first ixn node's start to offset their children's start. */
+    this.children.forEach(node => allAttachedNodes.push(node.serialize(isFirstIxnOfPayload ? this.start : firstStartTimeOfPayload))) // recursively add the serialized string of every child of this (ixn) bel node
 
     fields[1] = numeric(allAttachedNodes.length)
     nodeList.push(fields)

package/src/features/soft_navigations/constants.js

@@ -3,9 +3,11 @@ import { FEATURE_NAMES } from '../../loaders/features/features'
 export const INTERACTION_TRIGGERS = [
   'click', // e.g. user clicks link or the page back/forward buttons
   'keydown', // e.g. user presses left and right arrow key to switch between displayed photo gallery
-  'submit' // e.g. user clicks submit butotn or presses enter while editing a form field
+  'submit', // e.g. user clicks submit butotn or presses enter while editing a form field
+  'popstate' // history api is used to navigate back and forward
 ]
 export const API_TRIGGER_NAME = 'api'
+export const IPL_TRIGGER_NAME = 'initialPageLoad'
 
 export const FEATURE_NAME = FEATURE_NAMES.softNav
 

package/src/loaders/api/api-methods.js

@@ -1,7 +1,7 @@
 import { SR_EVENT_EMITTER_TYPES } from '../../features/session_replay/constants'
 
 export const apiMethods = [
-  'setErrorHandler', 'finished', 'addToTrace', 'addRelease',
+  'setErrorHandler', 'finished', 'addToTrace', 'addRelease', 'recordCustomEvent',
   'addPageAction', 'setCurrentRouteName', 'setPageViewName', 'setCustomAttribute',
   'interaction', 'noticeError', 'setUserId', 'setApplicationVersion', 'start',
   SR_EVENT_EMITTER_TYPES.RECORD, SR_EVENT_EMITTER_TYPES.PAUSE, 'log', 'wrapLogger'