@adobe/spacecat-shared-rum-api-client 2.38.6 → 2.38.8

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.38.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.38.7...@adobe/spacecat-shared-rum-api-client-v2.38.8) (2025-10-31)
+
+
+### Bug Fixes
+
+* **traffic-attribution:** limit vendors per source ([#1079](https://github.com/adobe/spacecat-shared/issues/1079)) ([9165913](https://github.com/adobe/spacecat-shared/commit/9165913f379a00df409fe86961ba5df1f5a2a840))
+
+# [@adobe/spacecat-shared-rum-api-client-v2.38.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.38.6...@adobe/spacecat-shared-rum-api-client-v2.38.7) (2025-10-29)
+
+
+### Bug Fixes
+
+* **traffic-attribution:** handle direct referrers from rum-distiller ([#1061](https://github.com/adobe/spacecat-shared/issues/1061)) ([99b1262](https://github.com/adobe/spacecat-shared/commit/99b1262638c978579770f63715ed1dd5090bffa4))
+
+
+### Reverts
+
+* Revert "fix(traffic-attribution): handle non standard referrers ([#1040](https://github.com/adobe/spacecat-shared/issues/1040))" ([3686145](https://github.com/adobe/spacecat-shared/commit/3686145d16b0cc39d0da88c0bd2ca10dc249f93c))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.38.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.38.5...@adobe/spacecat-shared-rum-api-client-v2.38.6) (2025-10-28)
 
 

package/package.json

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

package/src/common/traffic.js

@@ -26,9 +26,17 @@ import URI from 'urijs';
  */
 export function getSecondLevelDomain(url) {
   if (!hasText(url)) return url;
-  const uri = new URI(prependSchema(url));
-  const tld = uri.tld();
-  return uri.hostname().split(`.${tld}`)[0];
+  if (url === '(direct)') return '';
+
+  try {
+    const uri = new URI(prependSchema(url));
+    const tld = uri.tld();
+    return uri.hostname().split(`.${tld}`)[0];
+    /* c8 ignore next 4 */
+  } catch (error) {
+    // future-proof for the cases where url cannot be parsed for some reason
+    return url;
+  }
 }
 
 /*
@@ -138,27 +146,61 @@ const not = (truth) => (text) => {
 
 const notEmpty = (text) => hasText(text);
 
-/*
- * --------- ENFORCEMENTS ----------------
- */
+// overrides
+const OVERRIDES = [
+  { when: (ctx) => (ctx.utmSource || '').toLowerCase() === 'chatgpt.com', set: { type: 'earned', category: 'llm', vendor: 'openai' } },
+];
 
-const ENFORCEMENTS = [
-  // vendors 'openai', 'claude', and 'perplexity' can only be earned/llm
-  {
-    when: (state) => state.vendor === 'openai' || state.vendor === 'claude' || state.vendor === 'perplexity',
-    enforce: (state) => ({ ...state, type: 'earned', category: 'llm' }),
+function applyOverrides(classification, context) {
+  const override = OVERRIDES.find((rule) => rule.when(context));
+  return override ? { ...classification, ...override.set } : classification;
+}
+
+// allowed known vendors per category
+const ALLOWED_VENDORS = {
+  earned: {
+    llm: ['openai', 'claude', 'perplexity', 'microsoft', 'google'],
+    search: ['google', 'bing', 'yahoo', 'yandex', 'baidu', 'duckduckgo', 'brave', 'ecosia', 'aol'],
+    social: null, // any vendor allowed
+    video: ['youtube', 'vimeo', 'twitch', 'tiktok', 'dailymotion'],
+    referral: null, // any vendor allowed
   },
-  // if utm_source=chatgpt.com, force earned/llm and vendor=openai
-  {
-    when: (state, ctx) => (ctx.utmSourceRaw || '').toLowerCase() === 'chatgpt.com',
-    enforce: (state) => ({ ...state, type: 'earned', category: 'llm', vendor: 'openai' }),
+  paid: {
+    search: ['google', 'bing', 'yahoo', 'yandex', 'baidu', 'microsoft'],
+    social: null, // any vendor allowed
+    video: ['youtube', 'vimeo', 'twitch', 'dailymotion'],
+    display: null, // any vendor allowed
+    affiliate: null, // any vendor allowed
+    uncategorized: null, // any vendor allowed
   },
-];
+  owned: {
+    direct: ['direct'],
+    internal: null, // any vendor allowed
+    email: null, // any vendor allowed
+    sms: null, // any vendor allowed
+    qr: null, // any vendor allowed
+    push: null, // any vendor allowed
+    uncategorized: null, // any vendor allowed
+  },
+};
+
+/**
+ * Validates if a vendor is allowed for the given type/category combination.
+ * @param {string} type - Traffic type (earned, paid, owned)
+ * @param {string} category - Traffic category (llm, search, social, etc.)
+ * @param {string} vendor - Vendor name to validate
+ * @returns {string} The vendor if allowed, empty string otherwise
+ */
+function validateVendor(type, category, vendor) {
+  if (!vendor) return '';
 
-function applyEnforcements(initialState, context) {
-  return ENFORCEMENTS
-    .reduce((acc, rule) => (
-      rule.when(acc, context) ? rule.enforce(acc, context) : acc), initialState);
+  const allowedVendors = ALLOWED_VENDORS[type]?.[category];
+
+  // null/undefined means any vendor is allowed
+  if (!allowedVendors) return vendor;
+
+  // Check if vendor is in the allowed list
+  return allowedVendors.includes(vendor) ? vendor : '';
 }
 
 /*
@@ -275,23 +317,25 @@ export function classifyTrafficSource(url, referrer, utmSource, utmMedium, track
     && rule.utmMedium(sanitize(utmMedium))
     && rule.tracking(trackingParams)
   ));
-  const { type, category } = match;
-  const vendor = classifyVendor(referrerDomain, utmSource, utmMedium);
+  let { type, category } = match;
+  let vendor = classifyVendor(referrerDomain, utmSource, utmMedium);
 
-  const enforced = applyEnforcements(
+  // apply overrides
+  const overridden = applyOverrides(
     { type, category, vendor },
-    {
-      utmSourceRaw: utmSource,
-      utmSource: sanitize(utmSource),
-      utmMedium: sanitize(utmMedium),
-      referrerDomain,
-    },
+    { utmSource, utmMedium, referrerDomain },
   );
+  type = overridden.type;
+  category = overridden.category;
+  vendor = overridden.vendor;
+
+  // validate vendor against allowed vendors for this type/category
+  const validatedVendor = validateVendor(type, category, vendor);
 
   return {
-    type: enforced.type,
-    category: enforced.category,
-    vendor: enforced.vendor,
+    type,
+    category,
+    vendor: validatedVendor,
   };
 }