@adobe/spacecat-shared-rum-api-client 2.18.9 → 2.19.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.19.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.19.0...@adobe/spacecat-shared-rum-api-client-v2.19.1) (2025-01-31)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/rum-distiller to v1.16.2 ([#568](https://github.com/adobe/spacecat-shared/issues/568)) ([bfaa326](https://github.com/adobe/spacecat-shared/commit/bfaa3266e5760a031f3234b1bd60c95844cf17b6)), closes [#8203](https://github.com/adobe/spacecat-shared/issues/8203)
+
+# [@adobe/spacecat-shared-rum-api-client-v2.19.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.18.9...@adobe/spacecat-shared-rum-api-client-v2.19.0) (2025-01-30)
+
+
+### Features
+
+* introduce navigation and traffic acquisition data in form audit ([#544](https://github.com/adobe/spacecat-shared/issues/544)) ([550f917](https://github.com/adobe/spacecat-shared/commit/550f9174b21c346938a353feef347d160e194e70))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.18.9](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.18.8...@adobe/spacecat-shared-rum-api-client-v2.18.9) (2025-01-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.18.9",
+  "version": "2.19.1",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "engines": {
@@ -39,7 +39,7 @@
     "@adobe/helix-shared-wrap": "2.0.2",
     "@adobe/helix-universal": "5.0.8",
     "@adobe/spacecat-shared-utils": "1.26.4",
-    "@adobe/rum-distiller": "1.16.1",
+    "@adobe/rum-distiller": "1.16.2",
     "aws4": "1.13.2",
     "urijs": "1.19.11"
   },

package/src/functions/form-vitals.js

@@ -11,6 +11,7 @@
  */
 
 import { DataChunks } from '@adobe/rum-distiller';
+import trafficAcquisition from './traffic-acquisition.js';
 import { generateKey, DELIMITER, loadBundles } from '../utils.js';
 
 const FORM_SOURCE = ['.form', '.marketo', '.marketo-form'];
@@ -24,6 +25,7 @@ function initializeResult(url) {
     formengagement: {},
     formbuttonclick: {},
     pageview: {},
+    forminternalnavigation: [],
   };
 }
 
@@ -48,6 +50,57 @@ const metricFns = {
   },
 };
 
+function populateFormsInternalNavigation(bundles, formVitals) {
+  const dataChunks = new DataChunks();
+  loadBundles(bundles, dataChunks);
+  dataChunks.filter = { checkpoint: ['navigate'] };
+  dataChunks.filtered.forEach((bundle) => {
+    const forminternalnavigation = bundle.events.find((e) => e.checkpoint === 'navigate');
+    if (forminternalnavigation && formVitals[bundle.url]
+        && !formVitals[bundle.url].forminternalnavigation
+          .some((e) => e.url === forminternalnavigation.source)) {
+      formVitals[bundle.url].forminternalnavigation.push({
+        url: forminternalnavigation.source,
+        pageview: formVitals[forminternalnavigation.source]?.pageview || null,
+      });
+    }
+  });
+}
+
+function findFormCTAForInternalNavigation(bundles, formVitals) {
+  formVitals.forEach((item) => {
+    const { url, forminternalnavigation } = item;
+    if (forminternalnavigation && Array.isArray(forminternalnavigation)) {
+      forminternalnavigation.forEach((nav) => {
+        if (nav.url) {
+          let totalClickOnPage = 0;
+          const CTAs = new Map();
+          const clickCheckpointBundles = bundles.filter((bundle) => bundle.url === nav.url && bundle.events.find((e) => e.checkpoint === 'click'));
+          clickCheckpointBundles.forEach((bundle) => {
+            totalClickOnPage += bundle.weight;
+            const clickCheckpoint = bundle.events.find((e) => e.checkpoint === 'click' && e.target === url);
+
+            if (clickCheckpoint) {
+              const { source } = clickCheckpoint;
+              // Retrieves the existing CTA object if it exists; otherwise,
+              // initializes a new one with default values.
+              const existingCTA = CTAs.get(source) || { source, clicks: 0 };
+              existingCTA.clicks += bundle.weight;
+              CTAs.set(source, existingCTA);
+            }
+          });
+
+          // Convert CTAs Map to an array and store it in the nav object
+          // eslint-disable-next-line no-param-reassign
+          nav.CTAs = Array.from(CTAs.values());
+          // eslint-disable-next-line no-param-reassign
+          nav.totalClicksOnPage = totalClickOnPage;
+        }
+      });
+    }
+  });
+}
+
 function containsFormVitals(row) {
   return METRICS.some((metric) => Object.keys(row[metric]).length > 0);
 }
@@ -62,12 +115,19 @@ function handler(bundles) {
   // counts metrics per each group
   METRICS.forEach((metric) => dataChunks.addSeries(metric, metricFns[metric]));
 
+  // traffic acquisition data per url
+  const trafficByUrl = trafficAcquisition.handler(bundles);
+  const trafficByUrlMap = Object.fromEntries(
+    trafficByUrl.map(({ url, ...item }) => [url, item]),
+  );
+
   // aggregates metrics per group (url and user agent)
   const formVitals = dataChunks.facets.urlUserAgents.reduce((acc, { value, metrics, weight }) => {
     const [url, userAgent] = value.split(DELIMITER);
 
     acc[url] = acc[url] || initializeResult(url);
     acc[url].pageview[userAgent] = weight;
+    acc[url].trafficacquisition = trafficByUrlMap[url];
 
     METRICS.filter((metric) => metrics[metric].sum) // filter out user-agents with no form vitals
       .forEach((metric) => {
@@ -77,11 +137,15 @@ function handler(bundles) {
     return acc;
   }, {});
 
-  return Object.values(formVitals)
-    .filter(containsFormVitals); // filter out pages with no form vitals
+  // 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;
 }
 
 export default {
   handler,
-  checkpoints: ['viewblock', 'formsubmit', 'click'],
+  checkpoints: ['viewblock', 'formsubmit', 'click', 'navigate'],
 };