@adobe/spacecat-shared-rum-api-client 2.23.3 → 2.24.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.24.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.23.4...@adobe/spacecat-shared-rum-api-client-v2.24.0) (2025-05-09)
+
+
+### Features
+
+* identify iframe forms ([#715](https://github.com/adobe/spacecat-shared/issues/715)) ([d2e0a47](https://github.com/adobe/spacecat-shared/commit/d2e0a47f1020471a6f22f9d713e6bf9c03df2279))
+
+# [@adobe/spacecat-shared-rum-api-client-v2.23.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.23.3...@adobe/spacecat-shared-rum-api-client-v2.23.4) (2025-04-30)
+
+
+### Bug Fixes
+
+* form source proper handling in form vitals ([#711](https://github.com/adobe/spacecat-shared/issues/711)) ([e37bf0a](https://github.com/adobe/spacecat-shared/commit/e37bf0a6df28952a0e51f8689c4016a9bbff82e0))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.23.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.23.2...@adobe/spacecat-shared-rum-api-client-v2.23.3) (2025-04-26)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.23.3",
+  "version": "2.24.0",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "engines": {

package/src/functions/form-vitals.js

@@ -14,7 +14,7 @@ import { DataChunks } from '@adobe/rum-distiller';
 import { generateKey, DELIMITER, loadBundles } from '../utils.js';
 
 const METRICS = ['formview', 'formengagement', 'formsubmit'];
-const CHECKPOINTS = ['viewblock', 'click', 'fill', 'formsubmit', 'navigate'];
+const CHECKPOINTS = ['viewblock', 'click', 'fill', 'formsubmit', 'navigate', 'viewmedia'];
 const KEYWORDS_TO_FILTER = ['search'];
 
 function initializeResult(url) {
@@ -41,7 +41,7 @@ function filterEvents(bundles) {
       }
 
       const isFormRelatedEvent = ['fill', 'formsubmit'].includes(event.checkpoint)
-          || /\bform\b/.test(event.source);
+          || /\bform\b|aemform\w*/i.test(event.source);
       return isFormRelatedEvent && !KEYWORDS_TO_FILTER.some((keyword) => event.source
           && event.source.toLowerCase().includes(keyword));
     }),
@@ -82,6 +82,7 @@ function populateFormsInternalNavigation(bundles, formVitals) {
   dataChunks.filter = { checkpoint: ['navigate'] };
   dataChunks.filtered.forEach((bundle) => {
     const formInternalNav = bundle.events.find((e) => e.checkpoint === 'navigate');
+
     const formVital = findByUrl(formVitals, bundle.url);
     if (formInternalNav && formVital
         && !formVital.forminternalnavigation
@@ -89,7 +90,7 @@ function populateFormsInternalNavigation(bundles, formVitals) {
       const fv = findByUrl(formVitals, formInternalNav.source);
       formVital.forminternalnavigation.push({
         url: formInternalNav.source,
-        pageview: fv?.pageview,
+        ...(fv && { pageview: fv.pageview }),
       });
     }
   });
@@ -133,8 +134,58 @@ function containsFormVitals(row) {
   return METRICS.some((metric) => Object.keys(row[metric]).length > 0);
 }
 
+function getParentPageVitalsGroupedByIFrame(bundles, dataChunks, iframeParentMap) {
+  const iframeVitals = {};
+  if (dataChunks.facets.urlUserAgents) {
+    dataChunks.facets.urlUserAgents.reduce((acc, { value, weight }) => {
+      const [url, userAgent] = value.split(DELIMITER);
+
+      let iframeSrc = null;
+      for (const iframeUrl of Object.keys(iframeParentMap)) {
+        for (const parentUrl of iframeParentMap[iframeUrl]) {
+          if (parentUrl === url) {
+            iframeSrc = iframeUrl;
+            break;
+          }
+        }
+      }
+      if (iframeSrc) {
+        acc[url] = acc[url] || { url, pageview: {}, forminternalnavigation: [] };
+        acc[url].pageview[userAgent] = acc[url].pageview[userAgent] || weight;
+        acc[url].iframeSrc = iframeSrc;
+      }
+      return acc;
+    }, iframeVitals);
+  }
+  const groupedByIframeSrc = {};
+  const parentWebVitals = {};
+
+  // select the parent page with the most views
+  for (const [url, obj] of Object.entries(iframeVitals)) {
+    const { iframeSrc } = obj;
+    const totalViews = (obj.pageview.mobile || 0) + (obj.pageview.desktop || 0);
+    if (!groupedByIframeSrc[iframeSrc] || totalViews > groupedByIframeSrc[iframeSrc].totalViews) {
+      groupedByIframeSrc[iframeSrc] = { url, totalViews };
+    }
+  }
+
+  for (const { url } of Object.values(groupedByIframeSrc)) {
+    parentWebVitals[url] = iframeVitals[url];
+  }
+
+  populateFormsInternalNavigation(bundles, parentWebVitals);
+  findFormCTAForInternalNavigation(bundles, Object.values(parentWebVitals));
+
+  const iframeParentVitalsMap = {};
+  for (const vitals of Object.values(parentWebVitals)) {
+    iframeParentVitalsMap[vitals.iframeSrc] = vitals;
+  }
+  return iframeParentVitalsMap;
+}
+
 function handler(bundles) {
   // Filter out search related events
+
   const bundlesWithFilteredEvents = filterEvents(bundles);
 
   const dataChunks = new DataChunks();
@@ -143,17 +194,26 @@ function handler(bundles) {
   const formViewdataChunks = new DataChunks();
   loadBundles(bundlesWithFilteredEvents, formViewdataChunks);
   const formSourceMap = {};
+  const iframeParentMap = {};
   const globalFormSourceSet = new Set();
-  formViewdataChunks.filter = { checkpoint: ['viewblock'] };
+  formViewdataChunks.filter = { checkpoint: ['viewblock', 'viewmedia'] };
   formViewdataChunks.filtered.forEach(({ url, events }) => {
     formSourceMap[url] = formSourceMap[url] || new Set();
-    events.forEach(({ checkpoint, source }) => {
+    events.forEach(({ checkpoint, source, target }) => {
       if (checkpoint === 'viewblock' && source) {
         formSourceMap[url].add(source);
         globalFormSourceSet.add(source);
       }
+      if (checkpoint === 'viewmedia' && target) {
+        const regex = /aemform[\w.]*\.iframe[\w.]*/;
+        if (regex.test(target)) {
+          iframeParentMap[target] = iframeParentMap[target] || new Set();
+          iframeParentMap[target].add(url);
+        }
+      }
     });
   });
+
   // traffic acquisition data per url - uncomment this when required
   // const trafficByUrl = trafficAcquisition.handler(bundles);
   // const trafficByUrlMap = Object.fromEntries(
@@ -176,25 +236,57 @@ function handler(bundles) {
     // aggregates metrics per group (url and user agent)
     dataChunks.facets.urlUserAgents.reduce((acc, { value, metrics, weight }) => {
       const [url, userAgent] = value.split(DELIMITER);
-      const key = formSourceMap[url].has(source) ? generateKey(url, source) : url;
-      acc[key] = acc[key] || initializeResult(url);
-      acc[key].pageview[userAgent] = acc[key].pageview[userAgent] || weight;
-      // Enable traffic acquisition for persistence by uncommenting this line
-      // acc[key].trafficacquisition = trafficByUrlMap[url];
-      acc[key].formsource = source;
-      METRICS.filter((metric) => metrics[metric].sum) // filter out user-agents with no form vitals
-        .forEach((metric) => {
-          acc[key][metric][userAgent] = metrics[metric].sum;
-        });
+      if (formSourceMap[url].has(source)) {
+        const key = generateKey(url, source);
+        acc[key] = acc[key] || initializeResult(url);
+        acc[key].pageview[userAgent] = acc[key].pageview[userAgent] || weight;
+        // Enable traffic acquisition for persistence by uncommenting this line
+        // acc[key].trafficacquisition = trafficByUrlMap[url];
+        acc[key].formsource = source;
+        // filter out user-agents with no form vitals
+        METRICS.filter((metric) => metrics[metric].sum)
+          .forEach((metric) => {
+            acc[key][metric][userAgent] = metrics[metric].sum;
+          });
+      }
       return acc;
     }, formVitals);
   });
+
+  const iframeParentVitalsMap = getParentPageVitalsGroupedByIFrame(
+    bundles,
+    dataChunks,
+    iframeParentMap,
+  );
+
   // populate internal navigation data
   populateFormsInternalNavigation(bundles, formVitals);
   // filter out pages with no form vitals
   const filteredFormVitals = Object.values(formVitals).filter(containsFormVitals);
   findFormCTAForInternalNavigation(bundles, filteredFormVitals);
-  return filteredFormVitals;
+
+  const updatedFormVitals = filteredFormVitals.map((formVital) => {
+    const formVitalCopy = { ...formVital };
+    const parentFormVital = iframeParentVitalsMap[formVital.url];
+    if (parentFormVital) {
+      const {
+        url,
+        pageview,
+        forminternalnavigation,
+        iframeSrc,
+      } = parentFormVital;
+      Object.assign(formVitalCopy, {
+        url,
+        pageview: { ...pageview },
+        forminternalnavigation,
+
+        iframeSrc,
+      });
+    }
+    return formVitalCopy;
+  });
+
+  return [...updatedFormVitals];
 }
 
 export default {