@adobe/spacecat-shared-rum-api-client 2.24.3 → 2.25.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.25.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.24.3...@adobe/spacecat-shared-rum-api-client-v2.25.0) (2025-05-16)
+
+
+### Features
+
+* optel traffic group metrics ([#741](https://github.com/adobe/spacecat-shared/issues/741)) ([cdfef6a](https://github.com/adobe/spacecat-shared/commit/cdfef6a42731bf5fb5056619df605e9db67e724e))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.24.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.24.2...@adobe/spacecat-shared-rum-api-client-v2.24.3) (2025-05-15)
 
 

package/package.json

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

package/src/common/constants.js

@@ -14,3 +14,95 @@ export const GRANULARITY = {
   HOURLY: 'HOURLY',
   DAILY: 'DAILY',
 };
+
+export const COOKIE_CONSENT_SELECTORS = [
+  // OneTrust
+  'onetrust',
+  '.onetrust-banner',
+  '#onetrust-consent-sdk',
+  '#onetrust-banner-sdk',
+  '#ot-sdk-cookie-policy',
+  '.ot-sdk-container',
+  '.ot-sdk-row',
+  '.ot-sdk-column',
+  '.ot-sdk-show-settings',
+  '#ot-',
+  '.ot-',
+
+  // Cookiebot / Usercentrics
+  '#CybotCookiebotDialog',
+  '.CybotCookiebotDialog',
+  '#CookiebotWidget',
+  '.CookiebotWidget',
+  '.cookie-consent__banner',
+  '.cookie-consent__dialog',
+  '.cookie-consent__button',
+
+  // TrustArc
+  'truste-',
+  '#truste-',
+  '#truste-consent-banner',
+  '.truste-consent-banner',
+  '#truste-consent-button',
+  '.truste-consent-button',
+  '.truste-consent-text',
+  '.truste-consent-close',
+
+  // CookieYes
+  '#cookieyes-banner',
+  '.cky-consent',
+  '.cky-banner',
+  '.cky-btn',
+  '.cky-btn-accept',
+  '.cky-btn-reject',
+  '.cky-btn-settings',
+
+  // Termly
+  '#termly-consent-banner',
+  '.termly-consent-banner',
+  '.termly-consent-button',
+  '.termly-consent-text',
+  '.termly-consent-close',
+
+  // CookieScript
+  '#cookiescript_injected',
+  '.cookiescript-consent',
+  '.cookiescript-banner',
+  '.cookiescript-btn',
+  '.cookiescript-btn-accept',
+  '.cookiescript-btn-reject',
+  '.cookiescript-btn-settings',
+
+  // CookieFirst
+  '#cookiefirst-root',
+  '.cookiefirst-banner',
+  '.cookiefirst-button',
+  '.cookiefirst-text',
+  '.cookiefirst-close',
+
+  // Quantcast Choice
+  '#qc-cmp2-ui',
+  '.qc-cmp2-ui',
+  '.qc-cmp2-summary',
+  '.qc-cmp2-footer',
+  '.qc-cmp2-header',
+  '.qc-cmp2-buttons',
+  '.qc-cmp2-button',
+  '.qc-cmp2-button-accept',
+  '.qc-cmp2-button-reject',
+
+  // Crownpeak (Evidon)
+  '#evidon-banner',
+  '.evidon-banner',
+  '.evidon-button',
+  '.evidon-text',
+  '.evidon-close',
+
+  // Popupsmart
+  '#popupsmart-consent',
+  '.popupsmart-consent',
+  '.popupsmart-banner',
+  '.popupsmart-button',
+  '.popupsmart-text',
+  '.popupsmart-close',
+];

package/src/common/page.js

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2025 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.
+ */
+
+import { hasText, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+import { COOKIE_CONSENT_SELECTORS } from './constants.js';
+
+const uncategorized = 'uncategorized';
+
+export function getPageType(bundle, pageTypes) {
+  if (!isNonEmptyObject(pageTypes)) {
+    return uncategorized;
+  }
+
+  const pageTypeEntries = Object.entries(pageTypes);
+
+  const classify = ([, regEx]) => {
+    if (regEx instanceof RegExp) {
+      return regEx.test(bundle.url);
+    }
+
+    return new RegExp(regEx).test(bundle.url);
+  };
+
+  const entry = pageTypeEntries.find(classify);
+
+  if (!hasText(entry?.[0]) || entry?.[0] === 'other | Other Pages') {
+    return uncategorized;
+  }
+  return entry?.[0] ?? uncategorized;
+}
+
+export function isConsentClick(source) {
+  if (typeof source !== 'string' || !source) {
+    return false;
+  }
+
+  const sourceLower = source.toLowerCase();
+  return COOKIE_CONSENT_SELECTORS.some((keyword) => sourceLower.includes(keyword.toLowerCase()));
+}

package/src/functions/traffic-metrics.js

@@ -0,0 +1,234 @@
+/*
+ * Copyright 2025 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.
+ */
+
+import { DataChunks } from '@adobe/rum-distiller';
+import { DELIMITER, generateKey, loadBundles } from '../utils.js';
+import { classifyTraffic } from '../common/traffic.js';
+import { getPageType, isConsentClick } from '../common/page.js';
+
+function getTrafficSource(bundle) {
+  return classifyTraffic(bundle).type;
+}
+
+function getDeviceType(bundle) {
+  return bundle.userAgent.split(':')?.[0];
+}
+
+function addPageTypeFacet(dataChunks, pageTypes) {
+  dataChunks.addFacet('pageType', (bundle) => getPageType(bundle, pageTypes));
+}
+
+function addPageTypeDeviceTypeFacet(dataChunks, pageTypes) {
+  dataChunks.addFacet('pageTypeDeviceTypes', (bundle) => {
+    const deviceType = getDeviceType(bundle);
+    const pageType = getPageType(bundle, pageTypes);
+    return generateKey(pageType, deviceType);
+  });
+}
+
+function addPageTypeTrafficSourceDeviceTypes(dataChunks, pageTypes) {
+  dataChunks.addFacet('pageTrafficDeviceTypes', (bundle) => {
+    const deviceType = getDeviceType(bundle);
+    const pageType = getPageType(bundle, pageTypes);
+    return generateKey(pageType, getTrafficSource(bundle), deviceType);
+  });
+}
+
+function addPageTypeTrafficSourceFacet(dataChunks, pageTypes) {
+  dataChunks.addFacet('pageTypeTrafficSources', (bundle) => {
+    const pageType = getPageType(bundle, pageTypes);
+    return generateKey(pageType, getTrafficSource(bundle));
+  });
+}
+
+function handler(bundles, options = { pageTypes: null }) {
+  const dataChunks = new DataChunks();
+  const { pageTypes: pageTypeOpt } = options;
+
+  loadBundles(bundles, dataChunks);
+
+  const metricFilter = (metrics) => {
+    const { ctr, enters, sumOfAllClicks } = metrics;
+    return {
+      ctr: ctr.sum / ctr.weight,
+      clickedSessions: ctr.sum,
+      totalSessions: ctr.weight,
+      sessionsWithEnter: enters.sum,
+      clicksOverViews: ctr.weight ? ctr.sum / ctr.weight : 0,
+      bounceRate: ctr.weight ? (1 - (ctr.sum / ctr.weight)) : 0,
+      totalNumClicks: sumOfAllClicks.sum,
+      avgClicksPerSession: ctr.sum ? sumOfAllClicks.sum / ctr.sum : 0,
+    };
+  };
+
+  dataChunks.addFacet('urls', (bundle) => bundle.url);
+
+  dataChunks.addFacet('trafficSources', (bundle) => getTrafficSource(bundle));
+
+  dataChunks.addFacet('urlTrafficSources', (bundle) => generateKey(bundle.url, getTrafficSource(bundle)));
+
+  dataChunks.addFacet('urlDeviceTypes', (bundle) => generateKey(bundle.url, getDeviceType(bundle)));
+
+  dataChunks.addFacet('deviceTypes', (bundle) => getDeviceType(bundle));
+
+  dataChunks.addFacet('urlTrafficSourceDeviceTypes', (bundle) => generateKey(bundle.url, getTrafficSource(bundle), getDeviceType(bundle)));
+
+  dataChunks.addFacet('deviceTypeTrafficSources', (bundle) => generateKey(getDeviceType(bundle), getTrafficSource(bundle)));
+
+  addPageTypeFacet(dataChunks, pageTypeOpt);
+
+  addPageTypeTrafficSourceFacet(dataChunks, pageTypeOpt);
+
+  addPageTypeDeviceTypeFacet(dataChunks, pageTypeOpt);
+
+  addPageTypeTrafficSourceDeviceTypes(dataChunks, pageTypeOpt);
+
+  dataChunks.addSeries('ctr', (bundle) => {
+    const isClicked = bundle.events.some((e) => e.checkpoint === 'click');
+    return isClicked ? bundle.weight : 0;
+  });
+
+  dataChunks.addSeries('sumOfAllClicks', (bundle) => {
+    const nonConsentClicks = bundle.events
+      .filter((e) => e.checkpoint === 'click' && !isConsentClick(e.source))
+      .map(() => bundle.weight)
+      .reduce((sum, weight) => sum + weight, 0);
+
+    return nonConsentClicks;
+  });
+
+  dataChunks.addSeries('enters', (bundle) => {
+    const containsEnter = bundle.events.some((e) => e.checkpoint === 'enter');
+    return containsEnter ? bundle.weight : 0;
+  });
+
+  const urls = dataChunks.facets.urls.map((facet) => {
+    const url = facet.value;
+    return {
+      ...metricFilter(facet.metrics),
+      url,
+    };
+  });
+
+  const pageType = dataChunks.facets.pageType.map((facet) => {
+    const type = facet.value;
+    return {
+      ...metricFilter(facet.metrics),
+      type,
+    };
+  });
+
+  const deviceTypes = dataChunks.facets.deviceTypes.map((facet) => {
+    const deviceType = facet.value;
+    return {
+      ...metricFilter(facet.metrics),
+      deviceType,
+    };
+  });
+
+  const urlDeviceTypes = dataChunks.facets.urlDeviceTypes.map((facet) => {
+    const [url, deviceType] = facet.value.split(DELIMITER);
+    return {
+      ...metricFilter(facet.metrics),
+      url,
+      deviceType,
+    };
+  });
+
+  const trafficSources = dataChunks.facets.trafficSources.map((facet) => {
+    const source = facet.value;
+    return {
+      ...metricFilter(facet.metrics),
+      source,
+    };
+  });
+
+  const urlTrafficSources = dataChunks.facets.urlTrafficSources.map((facet) => {
+    const [url, source] = facet.value.split(DELIMITER);
+    return {
+      ...metricFilter(facet.metrics),
+      url,
+      source,
+    };
+  });
+
+  const urlTrafficSourceDeviceTypes = dataChunks.facets.urlTrafficSourceDeviceTypes.map((facet) => {
+    const [url, source, deviceType] = facet.value.split(DELIMITER);
+    return {
+      ...metricFilter(facet.metrics),
+      url,
+      source,
+      deviceType,
+    };
+  });
+
+  const pageTypeTrafficSources = dataChunks.facets.pageTypeTrafficSources.map((facet) => {
+    const [type, source] = facet.value.split(DELIMITER);
+    return {
+      ...metricFilter(facet.metrics),
+      type,
+      source,
+    };
+  });
+
+  const pageTypeDeviceTypes = dataChunks.facets.pageTypeDeviceTypes.map((facet) => {
+    const [type, deviceType] = facet.value.split(DELIMITER);
+    return {
+      ...metricFilter(facet.metrics),
+      type,
+      deviceType,
+    };
+  });
+
+  const deviceTypeTrafficSources = dataChunks.facets.deviceTypeTrafficSources.map((facet) => {
+    const [deviceType, source] = facet.value.split(DELIMITER);
+    return {
+      ...metricFilter(facet.metrics),
+      deviceType,
+      source,
+    };
+  });
+
+  const pageTrafficDeviceTypes = dataChunks.facets.pageTrafficDeviceTypes.map((facet) => {
+    const [type, source, deviceType] = facet.value.split(DELIMITER);
+    return {
+      ...metricFilter(facet.metrics),
+      type,
+      source,
+      deviceType,
+    };
+  });
+
+  const metrics = {
+    url: urls,
+    urlTrafficSource: urlTrafficSources,
+    urlDeviceType: urlDeviceTypes,
+    urlTrafficSourceDeviceType: urlTrafficSourceDeviceTypes,
+    pageType,
+    pageTypeTrafficSource: pageTypeTrafficSources,
+    pageTypeDeviceType: pageTypeDeviceTypes,
+    pageTypeTrafficSourceDeviceType: pageTrafficDeviceTypes,
+    deviceType: deviceTypes,
+    deviceTypeTrafficSource: deviceTypeTrafficSources,
+    trafficSource: trafficSources,
+  };
+
+  return Object.entries(metrics)
+    .map(([key, value]) => ({
+      key,
+      value,
+    }));
+}
+
+export default {
+  handler,
+};

package/src/index.js

@@ -20,6 +20,7 @@ import trafficAcquisition from './functions/traffic-acquisition.js';
 import totalMetrics from './functions/total-metrics.js';
 import variant from './functions/variant.js';
 import pageviews from './functions/pageviews.js';
+import trafficMetrics from './functions/traffic-metrics.js';
 import rageclick from './functions/opportunities/rageclick.js';
 import highInorganicHighBounceRate from './functions/opportunities/high-inorganic-high-bounce-rate.js';
 import highOrganicLowCtr from './functions/opportunities/high-organic-low-ctr.js';
@@ -40,6 +41,7 @@ const HANDLERS = {
   'high-inorganic-high-bounce-rate': highInorganicHighBounceRate,
   'high-organic-low-ctr': highOrganicLowCtr,
   pageviews,
+  trafficMetrics,
 };
 
 function sanitize(opts) {