@adobe/helix-rum-enhancer 2.9.0 → 2.11.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.11.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.10.0...v2.11.0) (2024-05-31)
+
+
+### Features
+
+* **index:** report ad clicks and email clicks ([f5b0779](https://github.com/adobe/helix-rum-enhancer/commit/f5b0779e4286962d881b69411efb8045660ff5de))
+
+# [2.10.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.9.0...v2.10.0) (2024-05-31)
+
+
+### Features
+
+* **index:** add new feature flag system ([7ef9f20](https://github.com/adobe/helix-rum-enhancer/commit/7ef9f20cd9e3ec07ac06c3924fb4ca33f68a49e1))
+
 # [2.9.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.8.0...v2.9.0) (2024-05-24)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
@@ -41,7 +41,7 @@
     "husky": "9.0.11",
     "jsdoc-to-markdown": "8.0.1",
     "junit-report-builder": "3.2.1",
-    "lint-staged": "15.2.2",
+    "lint-staged": "15.2.5",
     "mocha": "10.4.0",
     "mocha-multi-reporters": "1.5.1",
     "semantic-release": "23.1.1"

package/src/index.js

@@ -14,6 +14,17 @@ const KNOWN_PROPERTIES = ['weight', 'id', 'referer', 'checkpoint', 't', 'source'
 const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia', 'loadresource', 'utm'];
 const { sampleRUM, queue, isSelected } = (window.hlx && window.hlx.rum) ? window.hlx.rum : {};
 
+const fflags = {
+  has: (flag) => this[flag].indexOf(Array.from(window.origin)
+    .map((a) => a.charCodeAt(0))
+    .reduce((a, b) => a + b, 1) % 1371) !== -1,
+  enabled: (flag, callback) => this.has(flag) && callback(),
+  disabled: (flag, callback) => !this.has(flag) && callback(),
+  onetrust: [543, 770, 1136],
+  ads: [1339],
+  email: [1339],
+};
+
 const urlSanitizers = {
   full: () => window.location.href,
   origin: () => window.location.origin,
@@ -87,9 +98,9 @@ function optedIn(checkpoint, data) {
 // Gets configured collection from the config service for the current domain
 function getCollectionConfig() {
   // eslint-disable-next-line max-len
-  if ([770, 1136].includes(Array.from(window.origin).map((a) => a.charCodeAt(0)).reduce((a, b) => a + b, 1) % 1371)) {
-    return DEFAULT_TRACKING_EVENTS.concat('consent');
-  }
+  fflags.enabled('onetrust', () => DEFAULT_TRACKING_EVENTS.push('consent'));
+  fflags.enabled('ads', () => DEFAULT_TRACKING_EVENTS.push('paid'));
+  fflags.enabled('email', () => DEFAULT_TRACKING_EVENTS.push('email'));
   return DEFAULT_TRACKING_EVENTS;
 }
 
@@ -277,6 +288,35 @@ function addUTMParametersTracking() {
     .forEach(([source, target]) => sampleRUM('utm', { source, target }));
 }
 
+function addAdsParametersTracking() {
+  const networks = {
+    google: /gclid|gclsrc|wbraid|gbraid/,
+    doubleclick: /dclid/,
+    microsoft: /msclkid/,
+    facebook: /fb(cl|ad_|pxl_)id/,
+    twitter: /tw(clid|src|term)/,
+    linkedin: /li_fat_id/,
+    pinterest: /epik/,
+    tiktok: /ttclid/,
+  };
+  const params = Array.from(new URLSearchParams(window.location.search).keys());
+  Object.entries(networks).forEach(([network, regex]) => {
+    params.filter((param) => regex.test(param)).forEach((param) => sampleRUM('paid', { source: network, target: param }));
+  });
+}
+
+function addEmailParameterTracking() {
+  const networks = {
+    mailchimp: /mc_(c|e)id/,
+    marketo: /mkt_tok/,
+
+  };
+  const params = Array.from(new URLSearchParams(window.location.search).keys());
+  Object.entries(networks).forEach(([network, regex]) => {
+    params.filter((param) => regex.test(param)).forEach((param) => sampleRUM('email', { source: network, target: param }));
+  });
+}
+
 function addFormTracking(parent) {
   activateBlocksMutationObserver();
   parent.querySelectorAll('form').forEach((form) => {
@@ -346,6 +386,8 @@ function addTrackingFromConfig() {
     viewblock: () => addViewBlockTracking(window.document.body),
     viewmedia: () => addViewMediaTracking(window.document.body),
     consent: () => addCookieConsentTracking(),
+    paid: () => addAdsParametersTracking(),
+    email: () => addEmailParameterTracking(),
   };
 
   getCollectionConfig().filter((ck) => trackingFunctions[ck])