@adobe/helix-rum-enhancer 2.12.0 → 2.14.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [2.14.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.13.0...v2.14.0) (2024-06-11)
+
+
+### Features
+
+* **viewmedia:** expand view media tracking to all images that are there at render time ([d7a1715](https://github.com/adobe/helix-rum-enhancer/commit/d7a17158cf6ef2023ca36811ac5e436b6f18847e))
+
+# [2.13.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.12.0...v2.13.0) (2024-06-11)
+
+
+### Bug Fixes
+
+* proper linted output ([f2548ee](https://github.com/adobe/helix-rum-enhancer/commit/f2548eeda287e5a8abf75a9dc2156643640406eb))
+
+
+### Features
+
+* **bundle:** first step to build enhancer as a bundle ([56255db](https://github.com/adobe/helix-rum-enhancer/commit/56255db63e4d9fcd5f9dd685ee942ebda3052130))
+
 # [2.12.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.11.4...v2.12.0) (2024-06-10)
 
 

package/dist/rum-enhancer.js

@@ -0,0 +1,416 @@
+/*
+ * 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.
+ */
+
+/* eslint-disable max-classes-per-file, wrap-iife */
+// eslint-disable-next-line func-names
+(function () {
+  'use strict';
+
+  /* eslint-env browser */
+  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'];
+  const { sampleRUM, queue, isSelected } = (window.hlx && window.hlx.rum) ? window.hlx.rum : {};
+
+  const fflags = {
+    has: (flag) => fflags[flag].indexOf(Array.from(window.origin)
+      .map((a) => a.charCodeAt(0))
+      .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],
+    ads: [1139, 543, 770, 984],
+    email: [1139, 543, 770, 984],
+  };
+
+  const urlSanitizers = {
+    full: () => window.location.href,
+    origin: () => window.location.origin,
+    path: () => window.location.href.replace(/\?.*$/, ''),
+  };
+
+  const getTargetValue = (element) => element.getAttribute('data-rum-target') || element.getAttribute('href')
+      || element.currentSrc || element.getAttribute('src') || element.dataset.action || element.action;
+
+  const targetselector = (element) => {
+    try {
+      if (!element) return undefined;
+      let value = getTargetValue(element);
+      if (!value && element.tagName !== 'A' && element.closest('a')) {
+        value = getTargetValue(element.closest('a'));
+      }
+      if (value && !value.startsWith('https://')) {
+        // resolve relative links
+        value = new URL(value, window.location).href;
+      }
+      return value;
+    } catch (error) {
+      // something went wrong
+      return null;
+    }
+  };
+
+  const sourceselector = (element) => {
+    try {
+      if (element === document.body || element === document.documentElement || !element) {
+        return undefined;
+      }
+      if (element.getAttribute('data-rum-source')) {
+        return element.getAttribute('data-rum-source');
+      }
+      const form = element.closest('form');
+      let formElementSelector = '';
+      if (form && Array.from(form.elements).includes(element)) {
+        formElementSelector = element.tagName === 'INPUT' ? `form input[type='${element.getAttribute('type')}']` : `form ${element.tagName.toLowerCase()}`;
+      }
+
+      const blockName = element.closest('.block') ? element.closest('.block').getAttribute('data-block-name') : '';
+      if (element.id || formElementSelector) {
+        const id = element.id ? `#${element.id}` : '';
+        return blockName ? `.${blockName} ${formElementSelector}${id}` : `${formElementSelector}${id}`;
+      }
+
+      if (element.getAttribute('data-block-name')) {
+        return `.${element.getAttribute('data-block-name')}`;
+      }
+
+      if (Array.from(element.classList).some((className) => className.match(/button|cta/))) {
+        return blockName ? `.${blockName} .button` : '.button';
+      }
+
+      return sourceselector(element.parentElement);
+    } catch (error) {
+      return null;
+    }
+  };
+
+  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'));
+    fflags.enabled('ads', () => DEFAULT_TRACKING_EVENTS.push('paid'));
+    fflags.enabled('email', () => DEFAULT_TRACKING_EVENTS.push('email'));
+    return DEFAULT_TRACKING_EVENTS;
+  }
+
+  function trackCheckpoint(checkpoint, data, t) {
+    const { weight, id } = window.hlx.rum;
+    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);
+        const { href: url, origin } = new URL(`.rum/${weight}`, sampleRUM.collectBaseURL || sampleRUM.baseURL);
+        if (window.location.origin === origin) {
+          const headers = { type: 'application/json' };
+          navigator.sendBeacon(url, new Blob([body], headers));
+        } else {
+          navigator.sendBeacon(url, body);
+        }
+        // eslint-disable-next-line no-console
+        console.debug(`ping:${checkpoint}`, pdata);
+      };
+      sendPing(data);
+    }
+  }
+
+  function processQueue() {
+    while (queue.length) {
+      const ck = queue.shift();
+      trackCheckpoint(...ck);
+    }
+  }
+
+  function addCWVTracking() {
+    setTimeout(() => {
+      try {
+        const cwvScript = new URL('.rum/web-vitals/dist/web-vitals.iife.js', sampleRUM.baseURL).href;
+        if (document.querySelector(`script[src="${cwvScript}"]`)) {
+          // web vitals script has been loaded already
+          return;
+        }
+        const script = document.createElement('script');
+        script.src = cwvScript;
+        script.onload = () => {
+          const storeCWV = (measurement) => {
+            const data = { cwv: {} };
+            data.cwv[measurement.name] = measurement.value;
+            if (measurement.name === 'LCP' && measurement.entries.length > 0) {
+              const { element } = measurement.entries.pop();
+              data.target = targetselector(element);
+              data.source = sourceselector(element) || (element && element.outerHTML.slice(0, 30));
+            }
+            sampleRUM('cwv', data);
+          };
+
+          const featureToggle = () => window.location.hostname === 'blog.adobe.com';
+          const isEager = (metric) => ['CLS', 'LCP'].includes(metric);
+
+          // When loading `web-vitals` using a classic script, all the public
+          // methods can be found on the `webVitals` global namespace.
+          ['FID', 'INP', 'TTFB', 'CLS', 'LCP'].forEach((metric) => {
+            const metricFn = window.webVitals[`on${metric}`];
+            if (typeof metricFn === 'function') {
+              const opts = isEager(metric) ? { reportAllChanges: featureToggle() } : undefined;
+              metricFn(storeCWV, opts);
+            }
+          });
+        };
+        document.head.appendChild(script);
+      } catch (error) {
+        // something went wrong
+      }
+    }, 2000); // wait for delayed
+  }
+
+  function addEnterLeaveTracking() {
+    // enter checkpoint when referrer is not the current page url
+    const navigate = (source, type) => {
+      const payload = { source, target: document.visibilityState };
+      // reload: same page, navigate: same origin, enter: everything else
+      if (type === 'reload' || source === window.location.href) {
+        sampleRUM('reload', payload);
+      } else if (type && type !== 'navigate') {
+        sampleRUM(type, payload); // back, forward, prerender, etc.
+      } else if (source && window.location.origin === new URL(source).origin) {
+        sampleRUM('navigate', payload); // internal navigation
+      } else {
+        sampleRUM('enter', payload); // enter site
+      }
+    };
+
+    new PerformanceObserver((list) => list
+      .getEntries().map((entry) => navigate(document.referrer, entry.type)))
+      .observe({ type: 'navigation', buffered: true });
+
+    const leave = ((event) => {
+      try {
+        if (leave.left || (event.type === 'visibilitychange' && document.visibilityState !== 'hidden')) {
+          return;
+        }
+        leave.left = true;
+        sampleRUM('leave');
+      } catch (error) {
+        // something went wrong
+      }
+    });
+    window.addEventListener('visibilitychange', ((event) => leave(event)));
+    window.addEventListener('pagehide', ((event) => leave(event)));
+  }
+
+  function addLoadResourceTracking() {
+    const observer = new PerformanceObserver((list) => {
+      try {
+        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)$'))
+          .forEach((entry) => {
+            sampleRUM('loadresource', { source: entry.name, target: Math.round(entry.duration) });
+          });
+        list.getEntries()
+          .filter((entry) => entry.responseStatus === 404)
+          .forEach((entry) => {
+            sampleRUM('missingresource', { source: entry.name, target: entry.hostname });
+          });
+      } catch (error) {
+        // something went wrong
+      }
+    });
+    observer.observe({ type: 'resource', buffered: true });
+  }
+
+  function activateBlocksMutationObserver() {
+    if (!mutationObserver || mutationObserver.active) {
+      return;
+    }
+    mutationObserver.active = true;
+    mutationObserver.observe(
+      document.body,
+      // eslint-disable-next-line object-curly-newline
+      { subtree: true, attributes: true, attributeFilter: ['data-block-status'] },
+    );
+  }
+
+  function getIntersectionObsever(checkpoint) {
+    if (!window.IntersectionObserver) {
+      return null;
+    }
+    activateBlocksMutationObserver();
+    const observer = new IntersectionObserver((entries) => {
+      try {
+        entries
+          .filter((entry) => entry.isIntersecting)
+          .forEach((entry) => {
+            observer.unobserve(entry.target); // observe only once
+            const target = targetselector(entry.target);
+            const source = sourceselector(entry.target);
+            sampleRUM(checkpoint, { target, source });
+          });
+      } catch (error) {
+        // something went wrong
+      }
+    }, { threshold: 0.25 });
+    return observer;
+  }
+  function addViewBlockTracking(element) {
+    const blockobserver = getIntersectionObsever('viewblock');
+    if (blockobserver) {
+      const blocks = element.getAttribute('data-block-status') ? [element] : element.querySelectorAll('div[data-block-status="loaded"]');
+      blocks.forEach((b) => blockobserver.observe(b));
+    }
+  }
+
+  function addViewMediaTracking(parent) {
+    const mediaobserver = getIntersectionObsever('viewmedia');
+    if (mediaobserver) {
+      parent.querySelectorAll('img, video, audio, iframe').forEach((m) => {
+        if (!m.closest('div .block') || m.closest('div[data-block-status="loaded"]')) {
+          mediaobserver.observe(m);
+        }
+      });
+    }
+  }
+
+  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) => {
+      form.removeEventListener('submit', formSubmitListener); // listen only once
+      form.addEventListener('submit', formSubmitListener);
+    });
+  }
+
+  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);
+  function mutationsCallback(mutations) {
+    mutations.filter((m) => m.type === 'attributes' && m.attributeName === 'data-block-status')
+      .filter((m) => m.target.dataset.blockStatus === 'loaded')
+      .forEach((m) => {
+        addObserver('form', addFormTracking, m.target);
+        addObserver('viewblock', addViewBlockTracking, m.target);
+        addObserver('viewmedia', addViewMediaTracking, m.target);
+      });
+  }
+
+  function addTrackingFromConfig() {
+    const trackingFunctions = {
+      click: () => {
+        document.addEventListener('click', (event) => {
+          sampleRUM('click', { target: targetselector(event.target), source: sourceselector(event.target) });
+        });
+      },
+      cwv: () => addCWVTracking(),
+      form: () => addFormTracking(window.document.body),
+      enterleave: () => addEnterLeaveTracking(),
+      loadresource: () => addLoadResourceTracking(),
+      utm: () => addUTMParametersTracking(),
+      viewblock: () => addViewBlockTracking(window.document.body),
+      viewmedia: () => addViewMediaTracking(window.document.body),
+      consent: () => addCookieConsentTracking(),
+      paid: () => addAdsParametersTracking(),
+      email: () => addEmailParameterTracking(),
+    };
+
+    getCollectionConfig().filter((ck) => trackingFunctions[ck])
+      .forEach((ck) => trackingFunctions[ck]());
+  }
+
+  function initEnhancer() {
+    try {
+      if (sampleRUM) {
+        addTrackingFromConfig();
+        window.hlx.rum.collector = trackCheckpoint;
+        processQueue();
+      }
+    } catch (error) {
+      // something went wrong
+    }
+  }
+
+  // eslint-disable-next-line padded-blocks
+  initEnhancer();
+
+})();

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "2.12.0",
+  "version": "2.14.0",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
   "scripts": {
-    "test": "web-test-runner --node--resolve --coverage",
-    "test:ci": "web-test-runner --node-resolve --coverage --playwright",
+    "setup-playwright": "npx playwright install --with-deps chromium firefox webkit",
+    "test": "npm run setup-playwright && web-test-runner --node-resolve --coverage --playwright --browsers chromium firefox webkit",
+    "test:ci": "npm run setup-playwright && web-test-runner --node-resolve --coverage --playwright --browsers chromium firefox webkit",
     "test:watch": "web-test-runner --node-resolve --coverage --watch",
     "lint": "eslint .",
     "docs": "npx jsdoc2md -c .jsdoc.json --files 'src/*.js'  > docs/API.md",
+    "build-bundle": "rollup --config",
+    "prepack": "npm run build-bundle",
     "semantic-release": "semantic-release",
     "semantic-release-dry": "semantic-release --dry-run --branches $CI_BRANCH 1.x main",
     "prepare": "husky install"
@@ -37,10 +40,10 @@
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "12.0.1",
     "@web/test-runner": "0.18.2",
-    "@web/test-runner-core": "0.13.2",
+    "@web/test-runner-commands": "0.9.0",
     "@web/test-runner-mocha": "0.9.0",
     "@web/test-runner-playwright": "0.11.0",
-    "c8": "9.1.0",
+    "c8": "10.0.0",
     "codecov": "3.8.3",
     "eslint": "8.57.0",
     "eslint-plugin-header": "3.1.1",
@@ -51,6 +54,8 @@
     "lint-staged": "15.2.5",
     "mocha": "10.4.0",
     "mocha-multi-reporters": "1.5.1",
+    "rollup": "4.18.0",
+    "rollup-plugin-cleanup": "3.2.1",
     "semantic-release": "24.0.0"
   },
   "lint-staged": {

package/rollup.config.js

@@ -0,0 +1,54 @@
+/*
+ * 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.
+ */
+
+import cleanup from 'rollup-plugin-cleanup';
+
+const banner = `/*
+ * 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.
+ */
+
+/* eslint-disable max-classes-per-file, wrap-iife */
+// eslint-disable-next-line func-names`;
+
+const bundles = [
+  {
+    source: 'src/index.js',
+    outputFile: 'dist/rum-enhancer',
+  },
+];
+
+export default [...bundles.map(({ outputFile, source }) => ({
+  input: source,
+  output: [
+    {
+      file: `${outputFile}.js`,
+      format: 'iife',
+      sourcemap: false,
+      exports: 'auto',
+      banner,
+    },
+  ],
+  plugins: [
+    cleanup({
+      comments: ['eslint', 'jsdoc', /^\//, /^\*(?!\sc8\s)(?!\n \* Copyright)/],
+      maxEmptyLines: -1,
+    }),
+  ],
+}))];

package/src/index.js

@@ -274,7 +274,7 @@ function addViewBlockTracking(element) {
 function addViewMediaTracking(parent) {
   const mediaobserver = getIntersectionObsever('viewmedia');
   if (mediaobserver) {
-    parent.querySelectorAll('picture > img, video, audio, iframe').forEach((m) => {
+    parent.querySelectorAll('img, video, audio, iframe').forEach((m) => {
       if (!m.closest('div .block') || m.closest('div[data-block-status="loaded"]')) {
         mediaobserver.observe(m);
       }
@@ -410,4 +410,5 @@ function initEnhancer() {
   }
 }
 
+// eslint-disable-next-line padded-blocks
 initEnhancer();