feat: Automatically Detect MFE Logs (#1721)

Author: metal-messiah

src/common/util/v2.js

@@ -17,7 +17,7 @@ export const V2_TYPES = {
 }
 
 /**
- * Returns the registered target associated with a given ID. Returns undefined if not found.
+ * Returns the registered target associated with a given ID. Returns an empty array if no target is found.
  * @param {string|number} id
  * @param {*} agentRef the agent reference
  * @returns {import("../../interfaces/registered-entity").RegisterAPIMetadataTarget[]}
@@ -29,7 +29,7 @@ export function getRegisteredTargetsFromId (id, agentRef) {
 }
 
 /**
- * Returns the registered target(s) associated with a given filename if found in the resource timing API during registration. Returns an empty array if not found.
+ * Returns the registered target(s) associated with a given filename if found in the resource timing API during registration. Returns an empty array if no target is found.
  * @param {string} filename
  * @param {*} agentRef
  * @returns {import("../../interfaces/registered-entity").RegisterAPIMetadataTarget[]}
@@ -49,7 +49,7 @@ export function getRegisteredTargetsFromFilename (filename, agentRef) {
  * @returns {Object} returns an empty object if args are not supplied or the aggregate instance is not supporting version 2
  */
 export function getVersion2Attributes (target, aggregateInstance) {
-  if (aggregateInstance?.harvestEndpointVersion !== 2) return {}
+  if (!supportsV2(aggregateInstance)) return {}
   const containerAgentEntityGuid = aggregateInstance.agentRef.runtime.appMetadata.agents[0].entityGuid
   /** if there's no target, but we are in v2 mode, this means the data belongs to the container agent */
   if (!target) {
@@ -63,22 +63,36 @@ export function getVersion2Attributes (target, aggregateInstance) {
 }
 
 /**
- * Returns the attributes used for duplicating data in version 2 of the harvest endpoint. If not valid for duplication, returns an empty object.
+ * Returns the attributes used for duplicating data in version 2 of the harvest endpoint.
+ * If not valid for duplication, returns an empty object.
+ * @note BEST PRACTICE - Caller should call shouldDuplicate() before utilizing this method to determine if duplication attributes should be added to the event.
  * @param {import("../../interfaces/registered-entity").RegisterAPIMetadataTarget} target
  * @param {*} aggregateInstance the aggregate instance calling the method
  * @returns {Object}
  */
 export function getVersion2DuplicationAttributes (target, aggregateInstance) {
-  if (aggregateInstance?.harvestEndpointVersion !== 2 || !shouldDuplicate(target, aggregateInstance?.agentRef)) return {}
+  if (!shouldDuplicate(target, aggregateInstance)) return {}
   return { 'child.id': target.id, 'child.type': target.type, ...getVersion2Attributes(undefined, aggregateInstance) }
 }
 
-export function shouldDuplicate (target, agentRef) {
-  return !!target && agentRef.init.api.duplicate_registered_data
+/**
+ * Determines if an event should be duplicated for a given target and aggregate instance.  This is used to determine if duplication attributes should be added to an event and if the event should be sent to the soft nav feature for evaluation.
+ * @note This method is intended to be used in conjunction with getVersion2DuplicationAttributes and should be called before it to determine if duplication attributes should be added to an event.
+ * @param {import("../../interfaces/registered-entity").RegisterAPIMetadataTarget} target
+ * @param {*} aggregateInstance The aggregate instance calling the method.  This is needed to check if duplication is enabled and if the harvest endpoint version supports it.
+ * @returns {boolean} returns true if the event should be duplicated for the target, false otherwise
+ */
+export function shouldDuplicate (target, aggregateInstance) {
+  return !!target && !!supportsV2(aggregateInstance) && aggregateInstance.agentRef.init.api.duplicate_registered_data
 }
 
+/**
+ * Finds the registered targets from the stack trace for a given agent reference.
+ * @param {*} agentRef The agent reference to use for finding targets.
+ * @returns {Array} An array of targets found from the stack trace. If no targets are found or allowed, returns an array with undefined.
+ */
 export function findTargetsFromStackTrace (agentRef) {
-  if (!agentRef?.init.api.allow_registered_children) return []
+  if (!agentRef?.init.api.allow_registered_children) return [undefined]
 
   const targets = []
   try {
@@ -90,5 +104,17 @@ export function findTargetsFromStackTrace (agentRef) {
   } catch (err) {
     // Silent catch to prevent errors from propagating
   }
+  if (!targets.length) targets.push(undefined) // if we can't find any targets from the stack trace, return an array with undefined to signify the container agent is the target
   return targets
 }
+
+/**
+ * Determines if the aggregate instance supports version 2 of the harvest endpoint. Nearly all the V2 logic "depends" on
+ * the harvest endpoint version, so this is the main gatekeeper method for whether or not V2 logic should be executed across the
+ * various functions in this module.
+ * @param {*} aggregateInstance The aggregate instance to check.
+ * @returns {boolean} Returns true if the aggregate instance supports version 2, false otherwise.
+ */
+function supportsV2 (aggregateInstance) {
+  return aggregateInstance?.harvestEndpointVersion === 2
+}

src/common/wrap/wrap-fetch.js

@@ -78,8 +78,6 @@ export function wrapFetch (sharedEE, agentRef) {
 
         const ctx = {}
         const targets = findTargetsFromStackTrace(agentRef)
-        // undefined target reports to container
-        if (!targets.length) targets.push(undefined)
 
         // we are wrapping args in an array so we can preserve the reference
         ee.emit(prefix + 'before-start', [args], ctx)

src/common/wrap/wrap-function.js

@@ -9,6 +9,7 @@
 
 import { ee } from '../event-emitter/contextual-ee'
 import { bundleId } from '../ids/bundle-id'
+import { findTargetsFromStackTrace } from '../util/v2'
 
 export const flag = `nr@original:${bundleId}`
 const LONG_TASK_THRESHOLD = 50
@@ -34,7 +35,7 @@ export default createWrapperWithEmitter
  * @param {boolean} always - If `true`, emit events even if already emitting an event.
  * @returns {function} The wrapped function.
  */
-export function createWrapperWithEmitter (emitter, always) {
+export function createWrapperWithEmitter (emitter, always, agentRef) {
   emitter || (emitter = ee)
 
   wrapFn.inPlace = inPlace
@@ -55,9 +56,10 @@ export function createWrapperWithEmitter (emitter, always) {
    * @param {function|object} getContext - The function or object that will serve as the 'this' context for handlers of events emitted by this wrapper.
    * @param {string} methodName - The name of the method being wrapped.
    * @param {boolean} bubble - If true, emitted events should also bubble up to the old emitter upon which the `emitter` in the current scope was based (if it defines one).
+   * @param {boolean} [evaluateStack] - If true, the wrapper will attempt to evaluate the stack of the executed wrapped function to find targets of the execution (ex. the MFE source of a console.log).
    * @returns {function} The wrapped function.
    */
-  function wrapFn (fn, prefix, getContext, methodName, bubble) {
+  function wrapFn (fn, prefix, getContext, methodName, bubble, evaluateStack) {
     // Unless fn is both wrappable and unwrapped, return it unchanged.
     if (notWrappable(fn)) return fn
 
@@ -78,11 +80,16 @@ export function createWrapperWithEmitter (emitter, always) {
       var ctx
       var result
       let thrownError
+      let targets
 
       try {
         originalThis = this
         args = [...arguments]
 
+        // certain wrappers can inform the function wrapper to evaluate the stack of the executed wrapped function to find targets of the execution
+        // (e.g. wrap-logger can inform this method to find try to find the MFE source of a console.log)
+        targets = evaluateStack ? findTargetsFromStackTrace(agentRef) : [undefined] // undefined target always maps to the container agent
+
         if (typeof getContext === 'function') {
           ctx = getContext(args, originalThis)
         } else {
@@ -93,7 +100,7 @@ export function createWrapperWithEmitter (emitter, always) {
       }
 
       // Warning: start events may mutate args!
-      safeEmit(prefix + 'start', [args, originalThis, methodName], ctx, bubble)
+      safeEmit(prefix + 'start', [args, originalThis, methodName, targets], ctx, bubble)
 
       const fnStartTime = performance.now()
       let fnEndTime
@@ -103,7 +110,7 @@ export function createWrapperWithEmitter (emitter, always) {
         return result
       } catch (err) {
         fnEndTime = performance.now()
-        safeEmit(prefix + 'err', [args, originalThis, err], ctx, bubble)
+        safeEmit(prefix + 'err', [args, originalThis, err, targets], ctx, bubble)
         // rethrow error so we don't effect execution by observing.
         thrownError = err
         throw thrownError
@@ -120,10 +127,10 @@ export function createWrapperWithEmitter (emitter, always) {
         }
         // standalone long task message
         if (task.isLongTask) {
-          safeEmit('long-task', [task, originalThis], ctx, bubble)
+          safeEmit('long-task', [task, originalThis, targets], ctx, bubble)
         }
         // -end message also includes the task execution info
-        safeEmit(prefix + 'end', [args, originalThis, result], ctx, bubble)
+        safeEmit(prefix + 'end', [args, originalThis, result, targets], ctx, bubble)
       }
     }
   }
@@ -139,7 +146,7 @@ export function createWrapperWithEmitter (emitter, always) {
    * @param {boolean} [bubble=false] If `true`, emitted events should also bubble up to the old emitter upon which
    * the `emitter` in the current scope was based (if it defines one).
    */
-  function inPlace (obj, methods, prefix, getContext, bubble) {
+  function inPlace (obj, methods, prefix, getContext, bubble, evaluateStack) {
     if (!prefix) prefix = ''
 
     // If prefix starts with '-' set this boolean to add the method name to the prefix before passing each one to wrap.
@@ -152,7 +159,7 @@ export function createWrapperWithEmitter (emitter, always) {
       // Unless fn is both wrappable and unwrapped, bail so we don't add extra properties with undefined values.
       if (notWrappable(fn)) continue
 
-      obj[method] = wrapFn(fn, (prependMethodPrefix ? method + prefix : prefix), getContext, method, bubble)
+      obj[method] = wrapFn(fn, (prependMethodPrefix ? method + prefix : prefix), getContext, method, bubble, evaluateStack)
     }
   }
 

src/common/wrap/wrap-logger.js

@@ -24,10 +24,10 @@ const contextMap = new Map()
  * @returns {Object} Scoped event emitter with a debug ID of `logger`.
  */
 // eslint-disable-next-line
-export function wrapLogger(sharedEE, parent, loggerFn, context, autoCaptured = true) {
+export function wrapLogger(sharedEE, parent, loggerFn, context, autoCaptured = true, agentRef) {
   if (!(typeof parent === 'object' && !!parent && typeof loggerFn === 'string' && !!loggerFn && typeof parent[loggerFn] === 'function')) return warn(29)
   const ee = scopedEE(sharedEE)
-  const wrapFn = wfn(ee)
+  const wrapFn = wfn(ee, undefined, agentRef)
 
   /**
    * This section contains the context that will be shared across all invoked calls of the wrapped function,
@@ -41,8 +41,10 @@ export function wrapLogger(sharedEE, parent, loggerFn, context, autoCaptured = t
   const contextLookupKey = parent[loggerFn]?.[flag] || parent[loggerFn]
   contextMap.set(contextLookupKey, ctx)
 
-  /** observe calls to <loggerFn> and emit events prefixed with `wrap-logger-` */
-  wrapFn.inPlace(parent, [loggerFn], 'wrap-logger-', () => contextMap.get(contextLookupKey))
+  /** observe calls to <loggerFn> and emit events prefixed with `wrap-logger-`
+   * inform the inplace wrapper to evaluate the stack for targets of the log execution,
+   * so that logs can be attributed to a matching MFE source if being used. */
+  wrapFn.inPlace(parent, [loggerFn], 'wrap-logger-', () => contextMap.get(contextLookupKey), undefined, true)
 
   return ee
 }

src/common/wrap/wrap-xhr.js

@@ -56,8 +56,6 @@ export function wrapXhr (sharedEE, agentRef) {
     const xhr = new OrigXHR(opts)
     const context = ee.context(xhr)
     context.targets = findTargetsFromStackTrace(agentRef)
-    // undefined target reports to container
-    if (!context.targets.length) context.targets.push(undefined)
 
     try {
       ee.emit('new-xhr', [xhr], context)

src/features/ajax/aggregate/index.js

@@ -112,7 +112,7 @@ export class Aggregate extends AggregateBase {
     /** make a copy of the event for the MFE target if it exists */
     if (target) {
       this.events.add({ ...event, targetAttributes: getVersion2Attributes(target, this) })
-      if (shouldDuplicate(target, this.agentRef)) this.reportContainerEvent({ ...event, targetAttributes: getVersion2DuplicationAttributes(target, this) }, ctx)
+      if (shouldDuplicate(target, this)) this.reportContainerEvent({ ...event, targetAttributes: getVersion2DuplicationAttributes(target, this) }, ctx)
     } else {
       this.reportContainerEvent(event, ctx)
     }

src/features/logging/aggregate/index.js

@@ -13,7 +13,7 @@ import { applyFnToProps } from '../../../common/util/traverse'
 import { SESSION_EVENT_TYPES, SESSION_EVENTS } from '../../../common/session/constants'
 import { ABORT_REASONS } from '../../session_replay/constants'
 import { canEnableSessionTracking } from '../../utils/feature-gates'
-import { getVersion2Attributes } from '../../../common/util/v2'
+import { getVersion2Attributes, getVersion2DuplicationAttributes, shouldDuplicate } from '../../../common/util/v2'
 
 const LOGGING_EVENT = 'Logging/Event/'
 
@@ -73,12 +73,6 @@ export class Aggregate extends AggregateBase {
 
     if (!attributes || typeof attributes !== 'object') attributes = {}
 
-    attributes = {
-      ...attributes,
-      /** Specific attributes only supplied if harvesting to endpoint version 2 */
-      ...(getVersion2Attributes(target, this))
-    }
-
     if (typeof level === 'string') level = level.toUpperCase()
     if (!isValidLogLevel(level)) return warn(30, level)
     if (modeForThisLog < (LOGGING_MODE[level] || Infinity)) {
@@ -104,14 +98,19 @@ export class Aggregate extends AggregateBase {
     }
     if (typeof message !== 'string' || !message) return warn(32)
 
-    const log = new Log(
-      Math.floor(this.agentRef.runtime.timeKeeper.correctRelativeTimestamp(timestamp)),
-      message,
-      attributes,
-      level
-    )
+    const addEvent = (attributes) => {
+      const log = new Log(
+        Math.floor(this.agentRef.runtime.timeKeeper.correctRelativeTimestamp(timestamp)),
+        message,
+        attributes,
+        level
+      )
+
+      if (this.events.add(log)) this.reportSupportabilityMetric(LOGGING_EVENT + (autoCaptured ? 'Auto' : 'API') + '/Added')
+    }
 
-    if (this.events.add(log)) this.reportSupportabilityMetric(LOGGING_EVENT + (autoCaptured ? 'Auto' : 'API') + '/Added')
+    addEvent({ ...attributes, ...getVersion2Attributes(target, this) })
+    if (shouldDuplicate(target, this)) addEvent({ ...attributes, ...getVersion2DuplicationAttributes(target, this) })
   }
 
   serializer (eventBuffer) {

src/features/logging/instrument/index.js

@@ -27,13 +27,15 @@ export class Instrument extends InstrumentBase {
 
     globals.forEach((method) => {
       isNative(globalScope.console[method])
-      wrapLogger(instanceEE, globalScope.console, method, { level: method === 'log' ? 'info' : method })
+      wrapLogger(instanceEE, globalScope.console, method, { level: method === 'log' ? 'info' : method }, undefined, agentRef)
     })
 
     /** emitted by wrap-logger function */
-    this.ee.on('wrap-logger-end', function handleLog ([message]) {
+    this.ee.on('wrap-logger-end', function handleLog ([message], _, __, targets = []) {
       const { level, customAttributes, autoCaptured } = this
-      bufferLog(instanceEE, message, customAttributes, level, autoCaptured)
+      targets.forEach(target => {
+        bufferLog(instanceEE, message, customAttributes, level, autoCaptured, target)
+      })
     })
     this.importAggregator(agentRef, () => import(/* webpackChunkName: "logging-aggregate" */ '../aggregate'))
   }

src/features/logging/shared/utils.js

@@ -14,11 +14,11 @@ import { LOGGING_EVENT_EMITTER_CHANNEL, LOG_LEVELS } from '../constants'
    * @param {{[key: string]: *}} customAttributes - The log's custom attributes if any
    * @param {enum} level - the log level enum
    * @param {boolean} [autoCaptured=true] - True if log was captured from auto wrapping. False if it was captured from the API manual usage.
-   * @param {object=} target - the optional target provided by an api call
+   * @param {object=} targets - the optional targets found
    */
-export function bufferLog (ee, message, customAttributes = {}, level = LOG_LEVELS.INFO, autoCaptured = true, target, timestamp = now()) {
+export function bufferLog (ee, message, customAttributes = {}, level = LOG_LEVELS.INFO, autoCaptured = true, targets, timestamp = now()) {
   handle(SUPPORTABILITY_METRIC_CHANNEL, [`API/logging/${level.toLowerCase()}/called`], undefined, FEATURE_NAMES.metrics, ee)
-  handle(LOGGING_EVENT_EMITTER_CHANNEL, [timestamp, message, customAttributes, level, autoCaptured, target], undefined, FEATURE_NAMES.logging, ee)
+  handle(LOGGING_EVENT_EMITTER_CHANNEL, [timestamp, message, customAttributes, level, autoCaptured, targets], undefined, FEATURE_NAMES.logging, ee)
 }
 
 /**

src/loaders/api/register.js

@@ -130,7 +130,7 @@ function register (agentRef, target, parent) {
     setUserId: (value) => setLocalValue('enduser.id', value),
     /** metadata */
     metadata: {
-      customAttributes: attrs,
+      get customAttributes () { return attrs },
       target,
       timings
     }