@adobe/helix-rum-enhancer 2.31.0-beta.5 → 2.31.0-beta.7

package/CHANGELOG.md

@@ -1,48 +1,55 @@
-# [2.31.0-beta.5](https://github.com/adobe/helix-rum-enhancer/compare/v2.31.0-beta.4...v2.31.0-beta.5) (2025-01-17)
+# [2.31.0-beta.7](https://github.com/adobe/helix-rum-enhancer/compare/v2.31.0-beta.6...v2.31.0-beta.7) (2025-02-19)
 
 
 ### Bug Fixes
 
-* just forcing a release ([84ab687](https://github.com/adobe/helix-rum-enhancer/commit/84ab68734b5862816a532d4847df0ffa753b0717))
+* collect repeating clicks upto max configuration ([6daba19](https://github.com/adobe/helix-rum-enhancer/commit/6daba19b6dcf3717e8330a923a0d87e61e3080ee))
+* comment for max events tracking ([b4b1c6d](https://github.com/adobe/helix-rum-enhancer/commit/b4b1c6da79a31485bb2165382f9fb9ece611a716))
+* do not trigger fill checkpoint for hidden fields ([f6f4c51](https://github.com/adobe/helix-rum-enhancer/commit/f6f4c519d38c48740ace4ba64f47cafc6cea2f47))
+* form elements having name/id as id breaks the sourceSelector logic. ([37bd0ab](https://github.com/adobe/helix-rum-enhancer/commit/37bd0ab4c6bb1aac1326bc9be0097a7ccf038870))
+* implement flood control with 1024 max events ([e06e1e5](https://github.com/adobe/helix-rum-enhancer/commit/e06e1e51b6dd3db0a015f4dcccb3ab8dcfb11b9f))
+* Implement flood control with 1024 max events ([ddfdb1e](https://github.com/adobe/helix-rum-enhancer/commit/ddfdb1e9dd58ff41cbd761774af9ad616290aae0))
+* just forcing a release ([0a643d5](https://github.com/adobe/helix-rum-enhancer/commit/0a643d55440216adc5ca8b66e5cf70b31997b800))
+* plugin path resolution ([f77d736](https://github.com/adobe/helix-rum-enhancer/commit/f77d736a5e52b6e01fb83defe74b5e0f9622c127))
+* plugins are not executing because they are exported as iife ([dfc1eea](https://github.com/adobe/helix-rum-enhancer/commit/dfc1eea7bf230d95456ee2f7ee200e6a37c2f8c3))
+* review feedback ([f4e6dd1](https://github.com/adobe/helix-rum-enhancer/commit/f4e6dd1b3fae8e37024045156c85923e776f40c3))
 
-# [2.31.0-beta.4](https://github.com/adobe/helix-rum-enhancer/compare/v2.31.0-beta.3...v2.31.0-beta.4) (2025-01-16)
 
+### Features
 
-### Bug Fixes
-
-* plugin path resolution ([f464652](https://github.com/adobe/helix-rum-enhancer/commit/f464652df5bef5f42e0b32c1f10bebef013dd1b0))
+* handle pre-rendering ([3181698](https://github.com/adobe/helix-rum-enhancer/commit/3181698ea202ebb389dd82ab35a8d206a82b2006))
+* **loadresource:** add `allresources` feature flag that enables tracking all resources, not just same host ([a8fa936](https://github.com/adobe/helix-rum-enhancer/commit/a8fa936035f56b13ff8db66f32db17c828318972))
+* **missingresource:** report all resource error with http status code ([e3ad482](https://github.com/adobe/helix-rum-enhancer/commit/e3ad482454e5fe874e5cef5842a08915c53dbad4))
 
-# [2.31.0-beta.3](https://github.com/adobe/helix-rum-enhancer/compare/v2.31.0-beta.2...v2.31.0-beta.3) (2025-01-16)
 
+### Reverts
 
-### Bug Fixes
+* Revert "feat: handle pre-rendering" ([9603927](https://github.com/adobe/helix-rum-enhancer/commit/9603927774966fcfadb3ba3f8f7b42a0c003fd2e))
 
-* bugs and failing tests ([5c9adbc](https://github.com/adobe/helix-rum-enhancer/commit/5c9adbc2502203495a05d4fd2be6e05cc11102df))
-* cross-browser compatibility ([1c21afd](https://github.com/adobe/helix-rum-enhancer/commit/1c21afd8cd982d4c33feba863d2251311f36e153))
-* set proper url base for plugins ([9726dc8](https://github.com/adobe/helix-rum-enhancer/commit/9726dc8f98bd71936c8a8f430cae73b6a8f5d63f))
-* use proper fully qualified URLs for plugin path to avoid CORS ([c73eb31](https://github.com/adobe/helix-rum-enhancer/commit/c73eb31461115529922b82c3a8b678f21052b918))
+## [2.30.3](https://github.com/adobe/helix-rum-enhancer/compare/v2.30.2...v2.30.3) (2025-02-03)
 
 
-### Features
+### Bug Fixes
 
-* allow external extension via window.RUM_PLUGINS ([4613b00](https://github.com/adobe/helix-rum-enhancer/commit/4613b004c617f4d503355b5c43008149df9101ef))
-* inline web-vitals.js ([7d89e9f](https://github.com/adobe/helix-rum-enhancer/commit/7d89e9f664686d3a475ce829d7fb4f68f29ed71b))
-* introduce minimal plugin system to offset non-essenial logic ([8642557](https://github.com/adobe/helix-rum-enhancer/commit/8642557beaef5161d1d4d51d2b04ce06bf7dbeb7))
-* introduce minimal plugin system to offset non-essenial logic ([6066f0b](https://github.com/adobe/helix-rum-enhancer/commit/6066f0bd56393a10391e190b9a338f9a65b772b0))
+* collect repeating clicks upto max configuration ([6daba19](https://github.com/adobe/helix-rum-enhancer/commit/6daba19b6dcf3717e8330a923a0d87e61e3080ee))
+* comment for max events tracking ([b4b1c6d](https://github.com/adobe/helix-rum-enhancer/commit/b4b1c6da79a31485bb2165382f9fb9ece611a716))
+* implement flood control with 1024 max events ([e06e1e5](https://github.com/adobe/helix-rum-enhancer/commit/e06e1e51b6dd3db0a015f4dcccb3ab8dcfb11b9f))
+* Implement flood control with 1024 max events ([ddfdb1e](https://github.com/adobe/helix-rum-enhancer/commit/ddfdb1e9dd58ff41cbd761774af9ad616290aae0))
+* review feedback ([f4e6dd1](https://github.com/adobe/helix-rum-enhancer/commit/f4e6dd1b3fae8e37024045156c85923e776f40c3))
 
-# [2.31.0-beta.2](https://github.com/adobe/helix-rum-enhancer/compare/v2.31.0-beta.1...v2.31.0-beta.2) (2025-01-16)
+## [2.30.2](https://github.com/adobe/helix-rum-enhancer/compare/v2.30.1...v2.30.2) (2025-01-17)
 
 
-### Reverts
+### Bug Fixes
 
-* Revert "feat: handle pre-rendering" ([6471af5](https://github.com/adobe/helix-rum-enhancer/commit/6471af5cce4d895ca036a7b04a33530a3715b810))
+* do not trigger fill checkpoint for hidden fields ([f6f4c51](https://github.com/adobe/helix-rum-enhancer/commit/f6f4c519d38c48740ace4ba64f47cafc6cea2f47))
 
-# [2.31.0-beta.1](https://github.com/adobe/helix-rum-enhancer/compare/v2.30.0...v2.31.0-beta.1) (2025-01-16)
+## [2.30.1](https://github.com/adobe/helix-rum-enhancer/compare/v2.30.0...v2.30.1) (2025-01-17)
 
 
-### Features
+### Bug Fixes
 
-* handle pre-rendering ([bb11187](https://github.com/adobe/helix-rum-enhancer/commit/bb11187058b8cb521a270c316323b66414a8d817))
+* form elements having name/id as id breaks the sourceSelector logic. ([37bd0ab](https://github.com/adobe/helix-rum-enhancer/commit/37bd0ab4c6bb1aac1326bc9be0097a7ccf038870))
 
 # [2.30.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.29.0...v2.30.0) (2025-01-15)
 

package/README.md

@@ -62,10 +62,6 @@ All three parts are optional
 Even if an `identifier` is provided, having a `context` and `element` is recommended, as it makes the `source` parameter more readable and easier to understand.
 
 
-#### Examples
-
-- ``
-
 ## Development
 
 ### Build
@@ -85,3 +81,6 @@ $ npm test
 ```bash
 $ npm run lint
 ```
+### Cutting a Pre-Release
+
+Releases are handled by [semantic-release](https://github.com/semantic-release/semantic-release), and will happen automatically when a PR is merged into the `main` or the `1.x` branch. By merging into `beta`, a pre-release will be created.

package/modules/dom.js

@@ -41,12 +41,10 @@ function isDialog(el) {
   // doing it well
   if (el.tagName === 'DIALOG') return true;
   // making the best of it
-  if (el.getAttribute('role') === 'dialog') return true;
-  if (el.getAttribute('role') === 'alertdialog') return true;
-  if (el.getAttribute('aria-modal') === 'true') return true;
-  // doing it wrong
   const cs = window.getComputedStyle(el);
-  return (cs && cs.position === 'fixed' && cs.zIndex > 100);
+  return ['dialog', 'alertdialog'].find((r) => el.getAttribute('role') === r)
+    || el.getAttribute('aria-modal') === 'true'
+    || (cs && cs.position === 'fixed' && cs.zIndex > 100);
 }
 
 function isButton(el) {
@@ -62,16 +60,14 @@ function isButton(el) {
 function getSourceContext(el) {
   const formEl = el.closest('form');
   if (formEl) {
-    return `form${formEl.id ? `#${formEl.id}` : ''}`;
+    const id = formEl.getAttribute('id');
+    return `form${id ? `#${id}` : ''}`;
   }
   const block = el.closest('.block[data-block-name]');
-  if (block) return `.${block.getAttribute('data-block-name')}`;
-  if (walk(el, isDialog)) return 'dialog';
-  if (el.closest('nav')) return 'nav';
-  if (el.closest('header')) return 'header';
-  if (el.closest('footer')) return 'footer';
-  if (el.closest('aside')) return 'aside';
-  return (walk(el, (e) => e.id && `#${e.id}`));
+  return ((block && `.${block.getAttribute('data-block-name')}`)
+    || (walk(el, isDialog) && 'dialog')
+    || ['nav', 'header', 'footer', 'aside'].find((t) => el.closest(t))
+    || walk(el, (e) => e.id && `#${e.id}`));
 }
 
 function getSourceElement(el) {

package/modules/index.js

@@ -73,10 +73,16 @@ function loadPlugins(filter = () => true, params = PLUGIN_PARAMETERS) {
     .filter(([, plugin]) => filter(plugin))
     .map(([key]) => loadPlugin(key, params));
 }
+/**
+ * Maximum number of events. The first call will be made by rum-js,
+ * leaving 1023 events for the enhancer to track
+ */
+let maxEvents = 1023;
 
 function trackCheckpoint(checkpoint, data, t) {
   const { weight, id } = window.hlx.rum;
-  if (isSelected) {
+  if (isSelected && maxEvents) {
+    maxEvents -= 1;
     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);
@@ -271,16 +277,8 @@ function addTrackingFromConfig() {
   activateBlocksMO();
   activateMediaMO();
 
-  let lastSource;
-  let lastTarget;
   document.addEventListener('click', (event) => {
-    const source = sourceSelector(event.target);
-    const target = targetSelector(event.target);
-    if (source !== lastSource || target !== lastTarget) {
-      sampleRUM('click', { target, source });
-      lastSource = source;
-      lastTarget = target;
-    }
+    sampleRUM('click', { target: targetSelector(event.target), source: sourceSelector(event.target) });
   });
 
   // Core tracking

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "2.31.0-beta.5",
+  "version": "2.31.0-beta.7",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
@@ -33,16 +33,16 @@
     "reporter-options": "configFile=.mocha-multi.json"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "2.0.8",
+    "@adobe/eslint-config-helix": "2.0.9",
     "@adobe/helix-rum-js": "2.10.0",
     "@esm-bundle/chai": "4.3.4-fix.0",
     "@rollup/plugin-babel": "6.0.4",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "12.0.1",
-    "@web/test-runner": "0.19.0",
+    "@web/test-runner": "0.20.0",
     "@web/test-runner-commands": "0.9.0",
-    "@web/test-runner-junit-reporter": "0.7.2",
+    "@web/test-runner-junit-reporter": "0.8.0",
     "@web/test-runner-mocha": "0.9.0",
     "@web/test-runner-playwright": "0.11.0",
     "c8": "10.1.3",
@@ -53,13 +53,13 @@
     "husky": "9.1.7",
     "jsdoc-to-markdown": "9.1.1",
     "junit-report-builder": "5.1.1",
-    "lint-staged": "15.3.0",
-    "mocha": "11.0.1",
+    "lint-staged": "15.4.3",
+    "mocha": "11.1.0",
     "mocha-multi-reporters": "1.5.1",
-    "rollup": "4.30.1",
+    "rollup": "4.34.8",
     "rollup-plugin-checksum": "1.0.1",
     "rollup-plugin-eslint-bundle": "9.0.0",
-    "semantic-release": "24.2.1",
+    "semantic-release": "24.2.3",
     "semantic-release-slack-bot": "^4.0.2",
     "web-vitals": "4.2.4"
   },

package/plugins/cwv.js

@@ -19,6 +19,7 @@ export default function addCWVTracking({
   setTimeout(() => {
     try {
       const cwvScript = new URL('.rum/web-vitals/dist/web-vitals.iife.js', sampleRUM.baseURL).href;
+      /* c8 ignore next 3 */
       if (document.querySelector(`script[src="${cwvScript}"]`)) {
         // web vitals script has been loaded already
         return;

package/plugins/form.js

@@ -16,10 +16,12 @@ export default function addFormTracking({
     form.addEventListener('submit', (e) => sampleRUM('formsubmit', { target: targetSelector(e.target), source: sourceSelector(e.target) }), { once: true });
     let lastSource;
     form.addEventListener('change', (e) => {
-      const source = sourceSelector(e.target);
-      if (source !== lastSource) {
-        sampleRUM('fill', { source });
-        lastSource = source;
+      if (e.target.checkVisibility()) {
+        const source = sourceSelector(e.target);
+        if (source !== lastSource) {
+          sampleRUM('fill', { source });
+          lastSource = source;
+        }
       }
     });
     form.addEventListener('focusin', (e) => {

package/rollup.config.js

@@ -38,22 +38,23 @@ const bundles = [
   ...['cwv', 'form', 'martech', 'onetrust', 'video'].map((plugin) => ({
     source: `plugins/${plugin}.js`,
     outputFile: `src/plugins/${plugin}`,
+    format: 'es',
   })),
 ];
 
-export default [...bundles.map(({ outputFile, source }) => ({
+export default [...bundles.map(({ outputFile, source, format }) => ({
   input: source,
   output: [
     {
       file: `${outputFile}.map.js`,
-      format: 'iife',
+      format: format || 'iife',
       sourcemap: 'inline',
       exports: 'auto',
       banner,
     },
     {
       file: `${outputFile}.js`,
-      format: 'iife',
+      format: format || 'iife',
       sourcemap: false,
       exports: 'auto',
       banner,

package/src/index.js

@@ -64,11 +64,8 @@
   }
   function isDialog(el) {
     if (el.tagName === 'DIALOG') return true;
-    if (el.getAttribute('role') === 'dialog') return true;
-    if (el.getAttribute('role') === 'alertdialog') return true;
-    if (el.getAttribute('aria-modal') === 'true') return true;
     const cs = window.getComputedStyle(el);
-    return cs && cs.position === 'fixed' && cs.zIndex > 100;
+    return ['dialog', 'alertdialog'].find(r => el.getAttribute('role') === r) || el.getAttribute('aria-modal') === 'true' || cs && cs.position === 'fixed' && cs.zIndex > 100;
   }
   function isButton(el) {
     if (el.tagName === 'BUTTON') return true;
@@ -82,16 +79,11 @@
   function getSourceContext(el) {
     const formEl = el.closest('form');
     if (formEl) {
-      return `form${formEl.id ? `#${formEl.id}` : ''}`;
+      const id = formEl.getAttribute('id');
+      return `form${id ? `#${id}` : ''}`;
     }
     const block = el.closest('.block[data-block-name]');
-    if (block) return `.${block.getAttribute('data-block-name')}`;
-    if (walk(el, isDialog)) return 'dialog';
-    if (el.closest('nav')) return 'nav';
-    if (el.closest('header')) return 'header';
-    if (el.closest('footer')) return 'footer';
-    if (el.closest('aside')) return 'aside';
-    return walk(el, e => e.id && `#${e.id}`);
+    return block && `.${block.getAttribute('data-block-name')}` || walk(el, isDialog) && 'dialog' || ['nav', 'header', 'footer', 'aside'].find(t => el.closest(t)) || walk(el, e => e.id && `#${e.id}`);
   }
   function getSourceElement(el) {
     const f = el.closest('form');
@@ -181,12 +173,14 @@
   function loadPlugins(filter = () => true, params = PLUGIN_PARAMETERS) {
     Object.entries(PLUGINS).filter(([, plugin]) => filter(plugin)).map(([key]) => loadPlugin(key, params));
   }
+  let maxEvents = 1023;
   function trackCheckpoint(checkpoint, data, t) {
     const {
       weight,
       id
     } = window.hlx.rum;
-    if (isSelected) {
+    if (isSelected && maxEvents) {
+      maxEvents -= 1;
       const sendPing = (pdata = data) => {
         const body = JSON.stringify({
           weight,
@@ -365,19 +359,11 @@
   function addTrackingFromConfig() {
     activateBlocksMO();
     activateMediaMO();
-    let lastSource;
-    let lastTarget;
     document.addEventListener('click', event => {
-      const source = sourceSelector(event.target);
-      const target = targetSelector(event.target);
-      if (source !== lastSource || target !== lastTarget) {
-        sampleRUM('click', {
-          target,
-          source
-        });
-        lastSource = source;
-        lastTarget = target;
-      }
+      sampleRUM('click', {
+        target: targetSelector(event.target),
+        source: sourceSelector(event.target)
+      });
     });
     addNavigationTracking();
     addLoadResourceTracking();

package/src/index.md5

@@ -1 +1 @@
-6927b0ca98e3d69c532b6b104f0ffb14
+bae386a44a51c5b754217dd50889bce5