feat: Pages with steady decline of conversion

packages/spacecat-shared-rum-api-client/src/functions/404.js

@@ -22,7 +22,6 @@ function collect404s(groupedByUrlAndSource) {
 
   // calculate the total number of views per 404 event
   const views = itemsByUrl.flatMap((item) => item.items).reduce((acc, cur) => acc + cur.weight, 0);
-
   return {
     url,
     views,

packages/spacecat-shared-rum-api-client/src/functions/opportunities.js

@@ -0,0 +1,131 @@
+/*
+ * 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.
+ */
+
+/* c8 ignore start */
+const PAGEVIEW_THRESHOLD = 35000;
+
+function getWeekIndex(time) {
+  const date = new Date(time);
+  const currentDate = new Date();
+  const diff = Math.abs(currentDate - date);
+  const diffDays = Math.floor(diff / (1000 * 60 * 60 * 24));
+  switch (true) {
+    case diffDays < 7: return 4;
+    case diffDays < 14: return 3;
+    case diffDays < 21: return 2;
+    case diffDays < 28: return 1;
+    default: return 0;
+  }
+}
+
+function processBundles(bundles) {
+  const data = {};
+
+  for (const bundle of bundles) {
+    const weekIndex = getWeekIndex(bundle.time);
+    const weekKey = `week${weekIndex}`;
+
+    if (!data[bundle.url]) {
+      data[bundle.url] = {};
+    }
+
+    if (!data[bundle.url][weekKey]) {
+      data[bundle.url][weekKey] = {
+        pageViews: 0,
+        clicks: 0,
+        pageCTR: 0,
+        metrics: [],
+      };
+    }
+
+    data[bundle.url][weekKey].pageViews += bundle.weight;
+    const selector = {};
+    const bundleWeight = bundle.weight;
+    for (const event of bundle.events) {
+      if (event.checkpoint === 'click') {
+        selector[event.source] = selector[event.source] ? selector[event.source] + 1 : 1;
+      }
+    }
+
+    for (const source of Object.keys(selector)) {
+      // eslint-disable-next-line max-len
+      const existingMetric = data[bundle.url][weekKey].metrics.find((metric) => metric.selector === source);
+      if (existingMetric) {
+        existingMetric.clicks += bundleWeight;
+      } else {
+        data[bundle.url][weekKey].metrics.push({ selector: source, clicks: bundleWeight });
+      }
+    }
+
+    data[bundle.url][weekKey].clicks += Object.keys(selector).length > 0 ? bundleWeight : 0;
+  }
+
+  // eslint-disable-next-line guard-for-in,no-restricted-syntax
+  for (const url in data) {
+    // eslint-disable-next-line guard-for-in,no-restricted-syntax
+    for (const weekKey in data[url]) {
+      // eslint-disable-next-line max-len
+      data[url][weekKey].pageCTR = parseFloat((data[url][weekKey].clicks / data[url][weekKey].pageViews).toFixed(2));
+      data[url][weekKey].metrics = data[url][weekKey].metrics.map((metric) => {
+        // eslint-disable-next-line no-param-reassign
+        metric.ctr = parseFloat((metric.clicks / data[url][weekKey].pageViews).toFixed(2));
+        return metric;
+      }).filter((metric) => metric.ctr >= 0.05);
+    }
+  }
+
+  // eslint-disable-next-line guard-for-in,no-restricted-syntax
+  for (const url in data) {
+    let hasEnoughPageViews = true;
+    // eslint-disable-next-line guard-for-in,no-restricted-syntax
+    for (const weekKey in data[url]) {
+      if (data[url][weekKey].pageViews < PAGEVIEW_THRESHOLD) {
+        hasEnoughPageViews = false;
+        break;
+      }
+    }
+    if (!hasEnoughPageViews) {
+      delete data[url];
+    }
+  }
+
+  return data;
+}
+
+function handler(bundles) {
+  const acquisitionBundles = [];
+  const nonAcquisitionBundles = [];
+
+  for (const bundle of bundles) {
+    const hasAcquisition = bundle.events.some((event) => event.checkpoint === 'acquisition');
+    if (hasAcquisition) {
+      acquisitionBundles.push(bundle);
+    } else {
+      nonAcquisitionBundles.push(bundle);
+    }
+  }
+
+  const acquisitionData = processBundles(acquisitionBundles);
+  const nonAcquisitionData = processBundles(nonAcquisitionBundles);
+
+  return {
+    acquisitionData,
+    nonAcquisitionData,
+  };
+}
+
+export default {
+  handler,
+};
+
+// eslint-disable-next-line guard-for-in,no-restricted-syntax
+/* c8 ignore end */

packages/spacecat-shared-rum-api-client/src/index.js

@@ -15,13 +15,15 @@ import cwv from './functions/cwv.js';
 import experiment from './functions/experiment.js';
 import trafficAcquisition from './functions/traffic-acquisition.js';
 import variant from './functions/variant.js';
+import opportunities from './functions/opportunities.js';
 
 const HANDLERS = {
   404: notfound,
   cwv,
   experiment,
   'traffic-acquisition': trafficAcquisition,
   variant,
+  opportunities,
 };
 
 export default class RUMAPIClient {

packages/spacecat-shared-rum-api-client/test/fixtures/oppty.json

@@ -0,0 +1,194 @@
+[
+  {
+    "url": "https://www.aem.live/docs/sidekick-extension",
+    "views": 1400,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/placeholders",
+    "views": 1300,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/home",
+    "views": 1000,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/block-collection",
+    "views": 900,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/importer",
+    "views": 800,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/docs/",
+    "views": 700,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/tools/rum/explorer.html",
+    "views": 600,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/tutorial",
+    "views": 600,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/docs/davidsmodel",
+    "views": 600,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/docs/byo-cdn-cloudflare-worker-setup",
+    "views": 500,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/block-collection/breadcrumbs",
+    "views": 400,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/rum",
+    "views": 400,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/docs/go-live-checklist",
+    "views": 400,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/web-components",
+    "views": 200,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/keeping-it-100",
+    "views": 200,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/docs/dev-collab-and-good-practices",
+    "views": 200,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/target-integration",
+    "views": 100,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/developer/anatomy-of-a-franklin-project",
+    "views": 100,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/tools/bot/setup",
+    "views": 100,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/docs/placeholders",
+    "views": 100,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/docs/custom-headers",
+    "views": 100,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/tools/rum/list.html",
+    "views": 100,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/docs/authentication-setup-site",
+    "views": 100,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  },
+  {
+    "url": "https://www.aem.live/vip/intake",
+    "views": 100,
+    "week1CTR": 0.01,
+    "week2CTR": 0.01,
+    "week3CTR": 0.01,
+    "week4CTR": 0.01
+  }
+]

packages/spacecat-shared-rum-api-client/test/functions.test.js

@@ -13,6 +13,7 @@
 
 import { expect } from 'chai';
 import cwv from '../src/functions/cwv.js';
+import opportunity from '../src/functions/opportunities.js';
 import notfound from '../src/functions/404.js';
 import experiment from '../src/functions/experiment.js';
 import trafficAcquisition from '../src/functions/traffic-acquisition.js';
@@ -24,6 +25,7 @@
 import expectedExperimentsResult from './fixtures/experiments.json' assert { type: 'json' };
 import expectedTrafficSourcesResult from './fixtures/trafficSources.json' assert { type: 'json' };
 import expectedVariantResult from './fixtures/variant.json' assert { type: 'json' };
+import expectedOpportunitiesResult from './fixtures/petplace_bundles.json' assert { type: 'json' };
 
 describe('Query functions', () => {
   it('crunches cwv data', async () => {
@@ -50,4 +52,11 @@
     const trafficSourcesResult = await trafficAcquisition.handler(bundles.rumBundles);
     expect(expectedTrafficSourcesResult).to.eql(trafficSourcesResult);
   });
+
+  it('crunches CTR opportunity data', async () => {
+    const opportunitiesResult = opportunity.handler(expectedOpportunitiesResult.rumBundles);
+    // expect(expectedOpportunitiesResult).to.eql(opportunitiesResult);
+    // eslint-disable-next-line no-console
+    console.log(JSON.stringify(opportunitiesResult, null, 2));
+  });
 });