@adobe/spacecat-shared-rum-api-client 2.12.1 → 2.12.3

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.12.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.12.2...@adobe/spacecat-shared-rum-api-client-v2.12.3) (2024-11-26)
+
+
+### Bug Fixes
+
+* **rum-api-client:** migrate form vitals to rum-distiller ([#451](https://github.com/adobe/spacecat-shared/issues/451)) ([7509143](https://github.com/adobe/spacecat-shared/commit/7509143f9b9a9aa1971ebdcd55aa3b6d221f1812))
+
+# [@adobe/spacecat-shared-rum-api-client-v2.12.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.12.1...@adobe/spacecat-shared-rum-api-client-v2.12.2) (2024-11-25)
+
+
+### Bug Fixes
+
+* **deps:** bump rum-distiller to 1.9.1 ([#459](https://github.com/adobe/spacecat-shared/issues/459)) ([d5eec57](https://github.com/adobe/spacecat-shared/commit/d5eec5726cfeb991c96ddc49d5325d85fef5e7b1))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.12.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.12.0...@adobe/spacecat-shared-rum-api-client-v2.12.1) (2024-11-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.12.1",
+  "version": "2.12.3",
   "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.6",
     "@adobe/spacecat-shared-utils": "1.22.4",
-    "@adobe/rum-distiller": "1.9.0",
+    "@adobe/rum-distiller": "1.9.1",
     "aws4": "1.13.2",
     "urijs": "^1.19.11"
   },

package/src/functions/form-vitals.js

@@ -10,82 +10,68 @@
  * governing permissions and limitations under the License.
  */
 
+import { DataChunks } from '@adobe/rum-distiller';
+import { generateKey, DELIMITER, loadBundles } from '../utils.js';
+
 const FORM_SOURCE = ['.form', '.marketo', '.marketo-form'];
-const BOT = 'bot';
-const CHECKPOINT_MAPPING = { formsubmit: 'formsubmit', viewblock: 'formview', click: 'formengagement' };
+const METRICS = ['formview', 'formengagement', 'formsubmit'];
 
-function initializeResult(url, pageViews) {
+function initializeResult(url) {
   return {
     url,
     formsubmit: {},
     formview: {},
     formengagement: {},
-    pageview: pageViews[url],
+    pageview: {},
   };
 }
 
-function collectFormVitals(bundles, pageViews) {
-  const results = {};
+const metricFns = {
+  formview: (bundle) => {
+    const formView = bundle.events.find((e) => e.checkpoint === 'viewblock' && FORM_SOURCE.includes(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()));
+    return formClick ? bundle.weight : 0;
+  },
+  formsubmit: (bundle) => {
+    const formSubmit = bundle.events.find((e) => e.checkpoint === 'formsubmit');
+    return formSubmit ? bundle.weight : 0;
+  },
+};
 
-  // Helper functions to identify event types
-  const isFormViewEvent = ({ checkpoint, source }) => checkpoint === 'viewblock' && FORM_SOURCE.includes(source);
-  const isFormClickEvent = ({ checkpoint, source }) => checkpoint === 'click' && source && /\bform\b/.test(source.toLowerCase());
-  const isFormSubmitEvent = ({ checkpoint }) => checkpoint === 'formsubmit';
+function containsFormVitals(row) {
+  return METRICS.some((metric) => Object.keys(row[metric]).length > 0);
+}
 
-  for (const bundle of bundles) {
-    const {
-      url, userAgent, weight, events,
-    } = bundle;
+function handler(bundles) {
+  const dataChunks = new DataChunks();
+  loadBundles(bundles, dataChunks);
 
-    if (userAgent && !userAgent.startsWith(BOT)) {
-      // Track if each condition has been processed for this event
-      const processedCheckpoints = {
-        formsubmit: false,
-        click: false,
-      };
+  // groups by url and user agent
+  dataChunks.addFacet('urlUserAgents', (bundle) => generateKey(bundle.url, bundle.userAgent));
 
-      // Process each event within the bundle
-      for (const event of events) {
-        const { checkpoint, source } = event;
+  // counts metrics per each group
+  METRICS.forEach((metric) => dataChunks.addSeries(metric, metricFns[metric]));
 
-        // Only process the checkpoint once per event
-        if (!processedCheckpoints[checkpoint]) {
-          if (isFormViewEvent({ checkpoint, source })
-              || isFormSubmitEvent({ checkpoint })
-              || isFormClickEvent({ checkpoint, source })) {
-            results[url] = results[url] || initializeResult(url, pageViews);
-            const key = CHECKPOINT_MAPPING[checkpoint];
-            const res = results[url];
-            res[key] = {
-              ...res[key],
-              [userAgent]: (res[key][userAgent] || 0) + weight,
-            };
-            // Mark this checkpoint as processed - click and formsubmit as processed
-            if (checkpoint === 'click' || checkpoint === 'formsubmit') {
-              processedCheckpoints[checkpoint] = true;
-            }
-          }
-        }
-      }
-    }
-  }
-  return results;
-}
+  // 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;
+
+    METRICS.filter((metric) => metrics[metric].sum) // filter out user-agents with no form vitals
+      .forEach((metric) => {
+        acc[url][metric][userAgent] = metrics[metric].sum;
+      });
 
-function pageviewsByUrlAndUserAgent(bundles) {
-  return bundles.reduce((acc, cur) => {
-    const { userAgent } = cur;
-    if (!userAgent || userAgent.startsWith(BOT)) return acc;
-    acc[cur.url] = acc[cur.url] || {};
-    acc[cur.url][userAgent] = (acc[cur.url][userAgent] || 0) + cur.weight;
     return acc;
   }, {});
-}
 
-function handler(bundles) {
-  const pageViews = pageviewsByUrlAndUserAgent(bundles);
-  const formVitals = collectFormVitals(bundles, pageViews);
-  return Object.values(formVitals);
+  return Object.values(formVitals)
+    .filter(containsFormVitals); // filter out pages with no form vitals
 }
 
 export default {