@adobe/spacecat-shared-rum-api-client 2.9.10 → 2.10.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.10.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.9.10...@adobe/spacecat-shared-rum-api-client-v2.10.0) (2024-11-18)
+
+
+### Features
+
+* form vitals ([#429](https://github.com/adobe/spacecat-shared/issues/429)) ([1b0f92f](https://github.com/adobe/spacecat-shared/commit/1b0f92f682070ffc7db379602d94fa04cb442b10))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.9.10](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.9.9...@adobe/spacecat-shared-rum-api-client-v2.9.10) (2024-11-11)
 
 

package/README.md

@@ -298,6 +298,48 @@ Calculates the amount of non-inorganic (earned and owned) traffic and the click-
 
 ```
 
+### form-vitals
+
+Collects form vitals for a specified domain within a given time interval. Identifies whether each URL has embedded forms and counts form views/submission/engagement. This data can infer opportunities, such as URLs with low CTR and limited form engagement, URLs with high page views but fewer form submissions etc.
+An example response:
+
+```json
+[
+  {
+    "url": "https://business.adobe.com/",
+    "formsubmit": {},
+    "formview": {
+      "desktop:mac": 800,
+      "desktop:windows": 1900,
+      "mobile:ios": 100,
+      "mobile:android": 300
+    },
+    "formengagement": {
+      "desktop:windows": 100
+    },
+    "pageview": {
+      "desktop:mac": 800,
+      "desktop:windows": 1900,
+      "mobile:ios": 100,
+      "mobile:android": 300
+    }
+  },
+  {
+    "url": "https://business.adobe.com/se/resources/main.html",
+    "formsubmit": {      
+      "desktop:windows": 100
+    },
+    "formview": {},
+    "formengagement": {
+      "desktop:windows": 100
+    },
+    "pageview": {
+      "desktop:windows": 100
+    }
+  }
+]
+```
+
 ## Linting
 Lint the codebase using:
 ```

package/package.json

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

package/src/functions/form-vitals.js

@@ -0,0 +1,94 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+const FORM_SOURCE = ['.form', '.marketo', '.marketo-form'];
+const BOT = 'bot';
+const CHECKPOINT_MAPPING = { formsubmit: 'formsubmit', viewblock: 'formview', click: 'formengagement' };
+
+function initializeResult(url, pageViews) {
+  return {
+    url,
+    formsubmit: {},
+    formview: {},
+    formengagement: {},
+    pageview: pageViews[url],
+  };
+}
+
+function collectFormVitals(bundles, pageViews) {
+  const results = {};
+
+  // 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';
+
+  for (const bundle of bundles) {
+    const {
+      url, userAgent, weight, events,
+    } = bundle;
+
+    if (userAgent && !userAgent.startsWith(BOT)) {
+      // Track if each condition has been processed for this event
+      const processedCheckpoints = {
+        formsubmit: false,
+        click: false,
+      };
+
+      // Process each event within the bundle
+      for (const event of events) {
+        const { checkpoint, source } = event;
+
+        // 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;
+}
+
+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);
+}
+
+export default {
+  handler,
+  checkpoints: ['viewblock', 'formsubmit', 'click'],
+};

package/src/index.js

@@ -12,6 +12,7 @@
 import { fetchBundles } from './common/rum-bundler-client.js';
 import notfound from './functions/404.js';
 import cwv from './functions/cwv.js';
+import formVitals from './functions/form-vitals.js';
 import experiment from './functions/experiment.js';
 import trafficAcquisition from './functions/traffic-acquisition.js';
 import variant from './functions/variant.js';
@@ -22,6 +23,7 @@ import highOrganicLowCtr from './functions/opportunities/high-organic-low-ctr.js
 const HANDLERS = {
   404: notfound,
   cwv,
+  'form-vitals': formVitals,
   experiment,
   'traffic-acquisition': trafficAcquisition,
   variant,