@adobe/spacecat-shared-utils 1.29.0 → 1.30.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.30.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.30.0...@adobe/spacecat-shared-utils-v1.30.1) (2025-02-06)
+
+
+### Bug Fixes
+
+* composeAuditURL user agent failing for some sites ([#583](https://github.com/adobe/spacecat-shared/issues/583)) ([81bd136](https://github.com/adobe/spacecat-shared/commit/81bd136693ded29130b73b1c0258b6727104f5e1))
+
+# [@adobe/spacecat-shared-utils-v1.30.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.29.0...@adobe/spacecat-shared-utils-v1.30.0) (2025-02-06)
+
+
+### Features
+
+* adding more opportunities utils for forms ([#580](https://github.com/adobe/spacecat-shared/issues/580)) ([4cb7d5d](https://github.com/adobe/spacecat-shared/commit/4cb7d5d94ff887932809416b3cf918fc3b56a58d))
+
 # [@adobe/spacecat-shared-utils-v1.29.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.28.4...@adobe/spacecat-shared-utils-v1.29.0) (2025-02-03)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.29.0",
+  "version": "1.30.1",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "engines": {
@@ -39,7 +39,7 @@
     "chai": "5.1.2",
     "chai-as-promised": "8.0.1",
     "husky": "9.1.7",
-    "nock": "13.5.6",
+    "nock": "14.0.0",
     "sinon": "19.0.2",
     "sinon-chai": "4.0.0"
   },

package/src/formcalc.js

@@ -68,6 +68,16 @@ function hasLowerConversionRate(formSubmit, formViews) {
   return formSubmit / formViews < CR_THRESHOLD_RATIO;
 }
 
+function hasLowFormViews(pageViews, formViews) {
+  return formViews > 0 && (formViews / pageViews) < 0.7;
+}
+
+function hasHighPageViewLowFormCtr(ctaPageViews, ctaClicks, ctaPageTotalClicks, formPageViews) {
+  return ctaPageTotalClicks > 0
+      && (ctaClicks / ctaPageTotalClicks) < 0.4
+      && (formPageViews / ctaPageViews) < 0.1;
+}
+
 /**
  * Returns the form urls with high form views and low conversion rate
  *
@@ -96,3 +106,91 @@ export function getHighFormViewsLowConversionMetrics(formVitalsCollection, inter
   });
   return urls;
 }
+
+/**
+ * Returns the form urls with high page views and low form views
+ *
+ * @param resultMap
+ * @returns {*[]}
+ */
+export function getHighPageViewsLowFormViewsMetrics(formVitalsCollection, interval) {
+  const urls = [];
+  const resultMap = aggregateFormVitalsByDevice(formVitalsCollection);
+  resultMap.forEach((metrics, url) => {
+    const { total: pageViews } = metrics.pageview;
+    const { total: formViews } = metrics.formview;
+    const { total: formEngagement } = metrics.formengagement;
+
+    if (hasHighPageViews(interval, pageViews) && hasLowFormViews(pageViews, formViews)) {
+      urls.push({
+        url,
+        pageViews,
+        formViews,
+        formEngagement,
+      });
+    }
+  });
+  return urls;
+}
+
+/**
+ * Returns the form urls with high page views containing ctr and low form views
+ * @param formVitalsCollection
+ * @param formVitalsByDevice
+ * @returns {*[]}
+ */
+export function getHighPageViewsLowFormCtrMetrics(formVitalsCollection, interval) {
+  const urls = [];
+  const formVitalsByDevice = aggregateFormVitalsByDevice(formVitalsCollection);
+  formVitalsCollection.forEach((entry) => {
+    const { forminternalnavigation, pageview } = entry;
+    // Calculate `x`: sum of pageview for the URL with the highest sum
+    let x = 0;
+    let maxPageviewUrl = null;
+    if (forminternalnavigation) {
+      forminternalnavigation.forEach((nav) => {
+        if (nav.pageview) {
+          const pageviewSum = Object.values(nav.pageview).reduce((sum, val) => sum + val, 0);
+          if (pageviewSum > x) {
+            x = pageviewSum;
+            maxPageviewUrl = nav;
+          }
+        }
+      });
+    }
+
+    // Skip entry if no valid maxPageviewUrl is found
+    if (!maxPageviewUrl) return;
+
+    // Calculate `y`: find the CTA with the highest clicks and include the source
+    const y = maxPageviewUrl.CTAs.reduce((maxCta, cta) => {
+      if (cta.clicks > (maxCta.clicks || 0)) {
+        return cta;
+      }
+      return maxCta;
+    }, { clicks: 0, source: '' });
+
+    // Get `z`: totalClicksOnPage for the matched URL
+    const z = maxPageviewUrl.totalClicksOnPage || 0;
+    // Calculate `f`: sum of `pageview` for `formengagement`
+    const f = Object.values(pageview).reduce((sum, val) => sum + val, 0);
+
+    // Evaluate conditions and add URL to the result if all are met
+    if (hasHighPageViews(interval, x) && hasHighPageViewLowFormCtr(x, y.clicks, z, f)) {
+      const deviceData = formVitalsByDevice.get(entry.url);
+      if (deviceData != null) {
+        urls.push({
+          url: entry.url,
+          pageViews: deviceData.pageview.total,
+          formViews: deviceData.formview.total,
+          formEngagement: deviceData.formengagement.total,
+          CTA: {
+            url: maxPageviewUrl.url,
+            source: y.source,
+          },
+        });
+      }
+    }
+  });
+  return urls;
+}

package/src/index.d.ts

@@ -99,10 +99,11 @@ declare function composeBaseURL(domain: string): string;
 
 /**
  * Composes an audit URL by applying a series of transformations to the given url.
- * @param url - The url to compose the audit URL from.
+ * @param {string} url - The url to compose the audit URL from.
+ * @param {string} [userAgent] - Optional user agent to use in the audit URL.
  * @returns a promise that resolves the composed audit URL.
  */
-declare function composeAuditURL(url: string): Promise<string>;
+declare function composeAuditURL(url: string, userAgent: string): Promise<string>;
 
 /**
  * Resolves the name of the secret based on the function version.
@@ -174,6 +175,22 @@ declare function getPrompt(placeholders: object, filename: string, log: object):
 declare function getHighFormViewsLowConversionMetrics(formVitals: object[], interval: number):
   object[];
 
+/**
+ * Retrieves the high-page-view-low-form-view metrics from the provided array of form vitals.
+ * @param {Object[]} formVitals - An array of form vitals.
+ * @returns {Object[]} - An array of high-page-view-low-form-view metrics.
+ */
+declare function getHighPageViewsLowFormViewsMetrics(formVitals: object[], interval: number):
+    object[];
+
+/**
+ * Retrieves the high-page-view-low-form-ctr metrics from the provided array of form vitals.
+ * @param {Object[]} formVitals - An array of form vitals.
+ * @returns {Object[]} - An array of high-page-view-low-form-ctr metrics.
+ */
+declare function getHighPageViewsLowFormCtrMetrics(formVitals: object[], interval: number):
+    object[];
+
 /**
  * Retrieves stored metrics from S3.
  * @param config - Configuration object

package/src/index.js

@@ -61,4 +61,4 @@ export { s3Wrapper } from './s3.js';
 
 export { fetch } from './adobe-fetch.js';
 export { tracingFetch } from './tracing-fetch.js';
-export { getHighFormViewsLowConversionMetrics } from './formcalc.js';
+export { getHighFormViewsLowConversionMetrics, getHighPageViewsLowFormViewsMetrics, getHighPageViewsLowFormCtrMetrics } from './formcalc.js';

package/src/url-helpers.js

@@ -83,13 +83,23 @@ function composeBaseURL(domain) {
   return baseURL;
 }
 
-async function composeAuditURL(url) {
+/**
+ * Composes an audit URL by applying a series of transformations to the given url.
+ * @param {string} url - The url to compose the audit URL from.
+ * @param {string} [userAgent] - Optional user agent to use in the audit URL.
+ * @returns a promise that resolves the composed audit URL.
+ */
+async function composeAuditURL(url, userAgent) {
   const urlWithScheme = prependSchema(url);
+
+  const headers = {};
+  if (userAgent) {
+    headers['User-Agent'] = userAgent;
+  }
+
   const resp = await fetch(urlWithScheme, {
     method: 'GET',
-    headers: {
-      'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36',
-    },
+    headers,
   });
   const finalUrl = resp.url.split('://')[1];
   return stripTrailingSlash(finalUrl);