@adobe/spacecat-shared-rum-api-client 2.22.6 → 2.23.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.23.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.22.6...@adobe/spacecat-shared-rum-api-client-v2.23.0) (2025-04-16)
+
+
+### Features
+
+* formsource wise segregation of audit result ([#692](https://github.com/adobe/spacecat-shared/issues/692)) ([0f4f503](https://github.com/adobe/spacecat-shared/commit/0f4f503facbd81538a0d445a462735766e7bfffa))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.22.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.22.5...@adobe/spacecat-shared-rum-api-client-v2.22.6) (2025-04-15)
 
 

package/package.json

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

package/src/functions/form-vitals.js

@@ -14,8 +14,7 @@ import { DataChunks } from '@adobe/rum-distiller';
 import trafficAcquisition from './traffic-acquisition.js';
 import { generateKey, DELIMITER, loadBundles } from '../utils.js';
 
-const FORM_SOURCE = [/\bform\b/, /\.marketo/];
-const METRICS = ['formview', 'formengagement', 'formsubmit', 'formbuttonclick'];
+const METRICS = ['formview', 'formengagement', 'formsubmit'];
 const CHECKPOINTS = ['viewblock', 'click', 'fill', 'formsubmit', 'navigate'];
 const KEYWORDS_TO_FILTER = ['search'];
 
@@ -25,7 +24,6 @@ function initializeResult(url) {
     formsubmit: {},
     formview: {},
     formengagement: {},
-    formbuttonclick: {},
     pageview: {},
     forminternalnavigation: [],
   };
@@ -51,39 +49,48 @@ function filterEvents(bundles) {
   }));
 }
 
+function isFormSource(source, eventSource) {
+  const excludeSrc = ['form.', 'form#'];
+  if (source === 'unknown') {
+    return /\bform\b/.test(eventSource?.toLowerCase()) && !excludeSrc.some((exclude) => eventSource?.includes(exclude));
+  } else {
+    return eventSource?.includes(source);
+  }
+}
+
 const metricFns = {
-  formview: (bundle) => {
-    const formView = bundle.events.find((e) => e.checkpoint === 'viewblock' && FORM_SOURCE.some((regex) => regex.test(e.source)));
+  formview: (source) => (bundle) => {
+    const formView = bundle.events.find((e) => e.checkpoint === 'viewblock' && isFormSource(source, e.source));
     return formView ? bundle.weight : 0;
   },
-  formengagement: (bundle) => {
-    const formClick = bundle.events.find((e) => e.checkpoint === 'click' && e.source && /\bform\b/.test(e.source.toLowerCase()));
+  formengagement: (source) => (bundle) => {
+    const formClick = bundle.events.find((e) => (e.checkpoint === 'click' || e.checkpoint === 'fill') && isFormSource(source, e.source));
     return formClick ? bundle.weight : 0;
   },
-  formsubmit: (bundle) => {
-    const formSubmit = bundle.events.find((e) => e.checkpoint === 'formsubmit');
+  formsubmit: (source) => (bundle) => {
+    const formSubmit = bundle.events.find((e) => e.checkpoint === 'formsubmit' && isFormSource(source, e.source));
     return formSubmit ? bundle.weight : 0;
   },
-  formbuttonclick: (bundle) => {
-    const formButtonClick = bundle.events.find((e) => e.checkpoint === 'click' && e.source
-        && /\bform\b/.test(e.source.toLowerCase())
-        && /\bbutton\b/.test(e.source.toLowerCase()));
-    return formButtonClick ? bundle.weight : 0;
-  },
 };
 
+function findByUrl(formVitals, url) {
+  return Object.values(formVitals).find((item) => item.url === url);
+}
+
 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,
+    const formInternalNav = bundle.events.find((e) => e.checkpoint === 'navigate');
+    const formVital = findByUrl(formVitals, bundle.url);
+    if (formInternalNav && formVital
+        && !formVital.forminternalnavigation
+          .some((e) => e.url === formInternalNav.source)) {
+      const fv = findByUrl(formVitals, formInternalNav.source);
+      formVital.forminternalnavigation.push({
+        url: formInternalNav.source,
+        pageview: fv?.pageview,
       });
     }
   });
@@ -134,34 +141,49 @@ function handler(bundles) {
   const dataChunks = new DataChunks();
   loadBundles(bundlesWithFilteredEvents, dataChunks);
 
-  // groups by url and user agent
-  dataChunks.addFacet('urlUserAgents', (bundle) => generateKey(bundle.url, bundle.userAgent));
-
-  // counts metrics per each group
-  METRICS.forEach((metric) => dataChunks.addSeries(metric, metricFns[metric]));
-
+  const formViewdataChunks = new DataChunks();
+  loadBundles(bundlesWithFilteredEvents, formViewdataChunks);
+  const formSourceMap = {};
+  const globalFormSourceSet = new Set();
+  formViewdataChunks.filter = { checkpoint: ['viewblock'] };
+  formViewdataChunks.filtered.forEach(({ url, events }) => {
+    formSourceMap[url] = formSourceMap[url] || new Set();
+    events.forEach(({ checkpoint, source }) => {
+      if (checkpoint === 'viewblock' && source) {
+        formSourceMap[url].add(source);
+        globalFormSourceSet.add(source);
+      }
+    });
+  });
   // 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) => {
-        acc[url][metric][userAgent] = metrics[metric].sum;
-      });
-
-    return acc;
-  }, {});
-
+  const formVitals = {};
+
+  globalFormSourceSet.forEach((source) => {
+    // counts metrics per each group
+    const match = source.match(/form[#.](\w+)/);
+    const formsource = match ? match[1] : 'unknown';
+    // groups by url and user agent
+    dataChunks.addFacet('urlUserAgents', (bundle) => generateKey(bundle.url, bundle.userAgent));
+    METRICS.forEach((metric) => dataChunks.addSeries(metric, metricFns[metric](formsource)));
+    // 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;
+      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;
+        });
+      return acc;
+    }, formVitals);
+  });
   // populate internal navigation data
   populateFormsInternalNavigation(bundles, formVitals);
   // filter out pages with no form vitals