@adobe/helix-rum-enhancer 2.17.1 → 2.19.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.19.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.18.0...v2.19.0) (2024-08-13)
+
+
+### Features
+
+* **onetrust:** enable on all domains ([6039f11](https://github.com/adobe/helix-rum-enhancer/commit/6039f1198f6484d623a3e42ffdd24807b6ed7c54))
+
+# [2.18.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.17.1...v2.18.0) (2024-08-08)
+
+
+### Features
+
+* **loadresource:** include API calls in `loadresouce` requests for content request counting ([45449c2](https://github.com/adobe/helix-rum-enhancer/commit/45449c2e6a1602d80321f4ffa8698cbd116f1383))
+
 ## [2.17.1](https://github.com/adobe/helix-rum-enhancer/compare/v2.17.0...v2.17.1) (2024-08-02)
 
 

package/modules/defaults.js

@@ -9,5 +9,8 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+import { fflags } from './fflags.js';
+
 export const KNOWN_PROPERTIES = ['weight', 'id', 'referer', 'checkpoint', 't', 'source', 'target', 'cwv', 'CLS', 'FID', 'LCP', 'INP', 'TTFB'];
-export const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia', 'loadresource', 'utm', 'paid', 'email'];
+export const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia', 'loadresource', 'utm', 'paid', 'email', 'consent'];
+fflags.enabled('example', () => DEFAULT_TRACKING_EVENTS.push('example'));

package/modules/fflags.js

@@ -16,5 +16,5 @@ export const fflags = {
       .reduce((a, b) => a + b, 1) % 1371) !== -1,
   enabled: (flag, callback) => fflags.has(flag) && callback(),
   disabled: (flag, callback) => !fflags.has(flag) && callback(),
-  onetrust: [543, 770, 1136],
+  example: [543, 770, 1136],
 };

package/modules/index.js

@@ -12,9 +12,14 @@
 /* eslint-env browser */
 
 import { KNOWN_PROPERTIES, DEFAULT_TRACKING_EVENTS } from './defaults.js';
-import { fflags } from './fflags.js';
 import { urlSanitizers } from './utils.js';
 import { targetSelector, sourceSelector } from './dom.js';
+import {
+  addAdsParametersTracking,
+  addCookieConsentTracking,
+  addEmailParameterTracking,
+  addUTMParametersTracking,
+} from './martech.js';
 
 const { sampleRUM, queue, isSelected } = (window.hlx && window.hlx.rum) ? window.hlx.rum : {};
 
@@ -22,21 +27,9 @@ const formSubmitListener = (e) => sampleRUM('formsubmit', { target: targetSelect
 // eslint-disable-next-line no-use-before-define
 const mutationObserver = window.MutationObserver ? new MutationObserver(mutationsCallback) : null;
 
-// eslint-disable-next-line no-unused-vars
-function optedIn(checkpoint, data) {
-  // TODO: check config service to know if
-  return true;
-}
-// Gets configured collection from the config service for the current domain
-function getCollectionConfig() {
-  // eslint-disable-next-line max-len
-  fflags.enabled('onetrust', () => DEFAULT_TRACKING_EVENTS.push('consent'));
-  return DEFAULT_TRACKING_EVENTS;
-}
-
 function trackCheckpoint(checkpoint, data, t) {
   const { weight, id } = window.hlx.rum;
-  if (optedIn(checkpoint, data) && isSelected) {
+  if (isSelected) {
     const sendPing = (pdata = data) => {
       // eslint-disable-next-line object-curly-newline, max-len
       const body = JSON.stringify({ weight, id, referer: urlSanitizers[window.hlx.RUM_MASK_URL || 'path'](), checkpoint, t, ...data }, KNOWN_PROPERTIES);
@@ -146,7 +139,7 @@ function addLoadResourceTracking() {
       list.getEntries()
         .filter((entry) => !entry.responseStatus || entry.responseStatus < 400)
         .filter((entry) => window.location.hostname === new URL(entry.name).hostname)
-        .filter((entry) => new URL(entry.name).pathname.match('.*(\\.plain\\.html$|\\.json|graphql)'))
+        .filter((entry) => new URL(entry.name).pathname.match('.*(\\.plain\\.html$|\\.json|graphql|api)'))
         .forEach((entry) => {
           sampleRUM('loadresource', { source: entry.name, target: Math.round(entry.duration) });
         });
@@ -216,45 +209,6 @@ function addViewMediaTracking(parent) {
   }
 }
 
-function addUTMParametersTracking() {
-  const usp = new URLSearchParams(window.location.search);
-  [...usp.entries()]
-    .filter(([key]) => key.startsWith('utm_'))
-    // exclude keys that may leak PII
-    .filter(([key]) => key !== 'utm_id')
-    .filter(([key]) => key !== 'utm_term')
-    .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) => {
@@ -263,42 +217,7 @@ function addFormTracking(parent) {
   });
 }
 
-function addCookieConsentTracking() {
-  const cmpCookie = document.cookie.split(';')
-    .map((c) => c.trim())
-    .find((cookie) => cookie.startsWith('OptanonAlertBoxClosed='));
-
-  if (cmpCookie) {
-    sampleRUM('consent', { source: 'onetrust', target: 'hidden' });
-    return;
-  }
-
-  let consentMutationObserver;
-  const trackShowConsent = () => {
-    if (document.querySelector('body > div#onetrust-consent-sdk')) {
-      sampleRUM('consent', { source: 'onetrust', target: 'show' });
-      if (consentMutationObserver) {
-        consentMutationObserver.disconnect();
-      }
-      return true;
-    }
-    return false;
-  };
-
-  if (!trackShowConsent()) {
-    // eslint-disable-next-line max-len
-    consentMutationObserver = window.MutationObserver ? new MutationObserver(trackShowConsent) : null;
-    if (consentMutationObserver) {
-      consentMutationObserver.observe(
-        document.body,
-        // eslint-disable-next-line object-curly-newline
-        { attributes: false, childList: true, subtree: false },
-      );
-    }
-  }
-}
-
-const addObserver = (ck, fn, block) => getCollectionConfig().includes(ck) && fn(block);
+const addObserver = (ck, fn, block) => DEFAULT_TRACKING_EVENTS.includes(ck) && fn(block);
 function mutationsCallback(mutations) {
   mutations.filter((m) => m.type === 'attributes' && m.attributeName === 'data-block-status')
     .filter((m) => m.target.dataset.blockStatus === 'loaded')
@@ -320,15 +239,15 @@ function addTrackingFromConfig() {
     form: () => addFormTracking(window.document.body),
     enterleave: () => addEnterLeaveTracking(),
     loadresource: () => addLoadResourceTracking(),
-    utm: () => addUTMParametersTracking(),
+    utm: () => addUTMParametersTracking(sampleRUM),
     viewblock: () => addViewBlockTracking(window.document.body),
     viewmedia: () => addViewMediaTracking(window.document.body),
-    consent: () => addCookieConsentTracking(),
-    paid: () => addAdsParametersTracking(),
-    email: () => addEmailParameterTracking(),
+    consent: () => addCookieConsentTracking(sampleRUM),
+    paid: () => addAdsParametersTracking(sampleRUM),
+    email: () => addEmailParameterTracking(sampleRUM),
   };
 
-  getCollectionConfig().filter((ck) => trackingFunctions[ck])
+  DEFAULT_TRACKING_EVENTS.filter((ck) => trackingFunctions[ck])
     .forEach((ck) => trackingFunctions[ck]());
 }
 

package/modules/martech.js

@@ -0,0 +1,81 @@
+/*
+ * 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.
+ */
+export function addCookieConsentTracking(sampleRUM) {
+  const cmpCookie = document.cookie.split(';')
+    .map((c) => c.trim())
+    .find((cookie) => cookie.startsWith('OptanonAlertBoxClosed='));
+
+  if (cmpCookie) {
+    sampleRUM('consent', { source: 'onetrust', target: 'hidden' });
+    return;
+  }
+
+  let consentMutationObserver;
+  const trackShowConsent = () => {
+    if (document.querySelector('body > div#onetrust-consent-sdk')) {
+      sampleRUM('consent', { source: 'onetrust', target: 'show' });
+      if (consentMutationObserver) {
+        consentMutationObserver.disconnect();
+      }
+      return true;
+    }
+    return false;
+  };
+
+  if (!trackShowConsent()) {
+    // eslint-disable-next-line max-len
+    consentMutationObserver = window.MutationObserver ? new MutationObserver(trackShowConsent) : null;
+    if (consentMutationObserver) {
+      consentMutationObserver.observe(
+        document.body,
+        // eslint-disable-next-line object-curly-newline
+        { attributes: false, childList: true, subtree: false },
+      );
+    }
+  }
+}
+
+export function addUTMParametersTracking(sampleRUM) {
+  const usp = new URLSearchParams(window.location.search);
+  [...usp.entries()]
+    .filter(([key]) => key.startsWith('utm_'))
+    // exclude keys that may leak PII
+    .filter(([key]) => key !== 'utm_id')
+    .filter(([key]) => key !== 'utm_term')
+    .forEach(([source, target]) => sampleRUM('utm', { source, target }));
+}
+export function addAdsParametersTracking(sampleRUM) {
+  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 }));
+  });
+}
+export function addEmailParameterTracking(sampleRUM) {
+  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 }));
+  });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "2.17.1",
+  "version": "2.19.0",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
@@ -39,7 +39,7 @@
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "12.0.1",
-    "@web/test-runner": "0.18.2",
+    "@web/test-runner": "0.18.3",
     "@web/test-runner-commands": "0.9.0",
     "@web/test-runner-mocha": "0.9.0",
     "@web/test-runner-playwright": "0.11.0",
@@ -48,17 +48,17 @@
     "eslint": "8.57.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.29.1",
-    "husky": "9.1.3",
+    "husky": "9.1.4",
     "jsdoc-to-markdown": "8.0.3",
-    "junit-report-builder": "4.0.0",
-    "lint-staged": "15.2.7",
-    "mocha": "10.7.0",
+    "junit-report-builder": "5.0.0",
+    "lint-staged": "15.2.8",
+    "mocha": "10.7.3",
     "mocha-multi-reporters": "1.5.1",
-    "rollup": "4.19.1",
+    "rollup": "4.20.0",
     "rollup-plugin-cleanup": "3.2.1",
     "rollup-plugin-eslint-bundle": "9.0.0",
     "semantic-release": "24.0.0",
-    "web-vitals": "4.2.2"
+    "web-vitals": "4.2.3"
   },
   "lint-staged": {
     "*.js": "eslint",

package/src/index.js

@@ -15,9 +15,6 @@
 (function () {
   'use strict';
 
-  const KNOWN_PROPERTIES = ['weight', 'id', 'referer', 'checkpoint', 't', 'source', 'target', 'cwv', 'CLS', 'FID', 'LCP', 'INP', 'TTFB'];
-  const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia', 'loadresource', 'utm', 'paid', 'email'];
-
   const fflags = {
     has: (flag) => !!window.origin.match(/localhost/)
       || fflags[flag].indexOf(Array.from(window.origin)
@@ -25,9 +22,13 @@
         .reduce((a, b) => a + b, 1) % 1371) !== -1,
     enabled: (flag, callback) => fflags.has(flag) && callback(),
     disabled: (flag, callback) => !fflags.has(flag) && callback(),
-    onetrust: [543, 770, 1136],
+    example: [543, 770, 1136],
   };
 
+  const KNOWN_PROPERTIES = ['weight', 'id', 'referer', 'checkpoint', 't', 'source', 'target', 'cwv', 'CLS', 'FID', 'LCP', 'INP', 'TTFB'];
+  const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia', 'loadresource', 'utm', 'paid', 'email', 'consent'];
+  fflags.enabled('example', () => DEFAULT_TRACKING_EVENTS.push('example'));
+
   const urlSanitizers = {
     /**
      * Returns the full url.
@@ -123,17 +124,82 @@
     }
   };
 
+  function addCookieConsentTracking(sampleRUM) {
+    const cmpCookie = document.cookie.split(';')
+      .map((c) => c.trim())
+      .find((cookie) => cookie.startsWith('OptanonAlertBoxClosed='));
+
+    if (cmpCookie) {
+      sampleRUM('consent', { source: 'onetrust', target: 'hidden' });
+      return;
+    }
+
+    let consentMutationObserver;
+    const trackShowConsent = () => {
+      if (document.querySelector('body > div#onetrust-consent-sdk')) {
+        sampleRUM('consent', { source: 'onetrust', target: 'show' });
+        if (consentMutationObserver) {
+          consentMutationObserver.disconnect();
+        }
+        return true;
+      }
+      return false;
+    };
+
+    if (!trackShowConsent()) {
+      // eslint-disable-next-line max-len
+      consentMutationObserver = window.MutationObserver ? new MutationObserver(trackShowConsent) : null;
+      if (consentMutationObserver) {
+        consentMutationObserver.observe(
+          document.body,
+          // eslint-disable-next-line object-curly-newline
+          { attributes: false, childList: true, subtree: false },
+        );
+      }
+    }
+  }
+
+  function addUTMParametersTracking(sampleRUM) {
+    const usp = new URLSearchParams(window.location.search);
+    [...usp.entries()]
+      .filter(([key]) => key.startsWith('utm_'))
+      // exclude keys that may leak PII
+      .filter(([key]) => key !== 'utm_id')
+      .filter(([key]) => key !== 'utm_term')
+      .forEach(([source, target]) => sampleRUM('utm', { source, target }));
+  }
+  function addAdsParametersTracking(sampleRUM) {
+    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(sampleRUM) {
+    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 }));
+    });
+  }
+
   const { sampleRUM, queue, isSelected } = (window.hlx && window.hlx.rum) ? window.hlx.rum : {};
 
   const formSubmitListener = (e) => sampleRUM('formsubmit', { target: targetSelector(e.target), source: sourceSelector(e.target) });
   // eslint-disable-next-line no-use-before-define
   const mutationObserver = window.MutationObserver ? new MutationObserver(mutationsCallback) : null;
-  // Gets configured collection from the config service for the current domain
-  function getCollectionConfig() {
-    // eslint-disable-next-line max-len
-    fflags.enabled('onetrust', () => DEFAULT_TRACKING_EVENTS.push('consent'));
-    return DEFAULT_TRACKING_EVENTS;
-  }
 
   function trackCheckpoint(checkpoint, data, t) {
     const { weight, id } = window.hlx.rum;
@@ -245,7 +311,7 @@
         list.getEntries()
           .filter((entry) => !entry.responseStatus || entry.responseStatus < 400)
           .filter((entry) => window.location.hostname === new URL(entry.name).hostname)
-          .filter((entry) => new URL(entry.name).pathname.match('.*(\\.plain\\.html$|\\.json|graphql)'))
+          .filter((entry) => new URL(entry.name).pathname.match('.*(\\.plain\\.html$|\\.json|graphql|api)'))
           .forEach((entry) => {
             sampleRUM('loadresource', { source: entry.name, target: Math.round(entry.duration) });
           });
@@ -313,45 +379,6 @@
     }
   }
 
-  function addUTMParametersTracking() {
-    const usp = new URLSearchParams(window.location.search);
-    [...usp.entries()]
-      .filter(([key]) => key.startsWith('utm_'))
-      // exclude keys that may leak PII
-      .filter(([key]) => key !== 'utm_id')
-      .filter(([key]) => key !== 'utm_term')
-      .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) => {
@@ -360,42 +387,7 @@
     });
   }
 
-  function addCookieConsentTracking() {
-    const cmpCookie = document.cookie.split(';')
-      .map((c) => c.trim())
-      .find((cookie) => cookie.startsWith('OptanonAlertBoxClosed='));
-
-    if (cmpCookie) {
-      sampleRUM('consent', { source: 'onetrust', target: 'hidden' });
-      return;
-    }
-
-    let consentMutationObserver;
-    const trackShowConsent = () => {
-      if (document.querySelector('body > div#onetrust-consent-sdk')) {
-        sampleRUM('consent', { source: 'onetrust', target: 'show' });
-        if (consentMutationObserver) {
-          consentMutationObserver.disconnect();
-        }
-        return true;
-      }
-      return false;
-    };
-
-    if (!trackShowConsent()) {
-      // eslint-disable-next-line max-len
-      consentMutationObserver = window.MutationObserver ? new MutationObserver(trackShowConsent) : null;
-      if (consentMutationObserver) {
-        consentMutationObserver.observe(
-          document.body,
-          // eslint-disable-next-line object-curly-newline
-          { attributes: false, childList: true, subtree: false },
-        );
-      }
-    }
-  }
-
-  const addObserver = (ck, fn, block) => getCollectionConfig().includes(ck) && fn(block);
+  const addObserver = (ck, fn, block) => DEFAULT_TRACKING_EVENTS.includes(ck) && fn(block);
   function mutationsCallback(mutations) {
     mutations.filter((m) => m.type === 'attributes' && m.attributeName === 'data-block-status')
       .filter((m) => m.target.dataset.blockStatus === 'loaded')
@@ -417,15 +409,15 @@
       form: () => addFormTracking(window.document.body),
       enterleave: () => addEnterLeaveTracking(),
       loadresource: () => addLoadResourceTracking(),
-      utm: () => addUTMParametersTracking(),
+      utm: () => addUTMParametersTracking(sampleRUM),
       viewblock: () => addViewBlockTracking(window.document.body),
       viewmedia: () => addViewMediaTracking(window.document.body),
-      consent: () => addCookieConsentTracking(),
-      paid: () => addAdsParametersTracking(),
-      email: () => addEmailParameterTracking(),
+      consent: () => addCookieConsentTracking(sampleRUM),
+      paid: () => addAdsParametersTracking(sampleRUM),
+      email: () => addEmailParameterTracking(sampleRUM),
     };
 
-    getCollectionConfig().filter((ck) => trackingFunctions[ck])
+    DEFAULT_TRACKING_EVENTS.filter((ck) => trackingFunctions[ck])
       .forEach((ck) => trackingFunctions[ck]());
   }