@adobe/helix-rum-enhancer 2.23.0 → 2.25.0

package/.releaserc.cjs

@@ -21,7 +21,13 @@ module.exports = {
           "label": "RUM Enhancer Hash"
         }
       ]
-    }]
+    }],
+    ["semantic-release-slack-bot", {
+      notifyOnSuccess: true,
+      notifyOnFail: true,
+      markdownReleaseNotes: true,
+      slackChannel: "rum-explorers",
+    }],
   ],
   branches: ['main'],
 };

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [2.25.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.24.0...v2.25.0) (2024-10-03)
+
+
+### Features
+
+* capturing id of form and button type inside a form ([#293](https://github.com/adobe/helix-rum-enhancer/issues/293)) ([530572f](https://github.com/adobe/helix-rum-enhancer/commit/530572f7c441c72f8d5f7683bef7490d37186a9f))
+
+# [2.24.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.23.0...v2.24.0) (2024-09-20)
+
+
+### Features
+
+* **navigation:** add support for `redirect` checkpoint ([87b2c05](https://github.com/adobe/helix-rum-enhancer/commit/87b2c057a5e0afbe21cd6224bd995f48ebafa30e))
+* **redirect:** support soft-redirects ([00392c1](https://github.com/adobe/helix-rum-enhancer/commit/00392c18ad8a0677437f5846b9e63ea32df163cb))
+
 # [2.23.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.22.0...v2.23.0) (2024-09-19)
 
 

package/modules/dom.js

@@ -61,7 +61,9 @@ function isButton(element) {
 }
 
 function getSourceContext(element) {
-  if (element.closest('form')) return 'form';
+  if (element.closest('form')) {
+    return `form${element.id ? `#${element.id}` : ''}`;
+  }
   const block = element.closest('.block[data-block-name]');
   if (block) return `.${block.getAttribute('data-block-name')}`;
   if (walk(element, isDialog)) return 'dialog';
@@ -73,7 +75,12 @@ function getSourceContext(element) {
 }
 
 function getSourceElement(element) {
-  if (element.closest('form') && Array.from(element.closest('form').elements).includes(element)) return element.tagName.toLowerCase() + (element.tagName === 'INPUT' ? `[type='${element.getAttribute('type') || ''}']` : '');
+  if (element.closest('form') && Array.from(element.closest('form').elements).includes(element)) {
+    return (element.tagName.toLowerCase()
+        + (['INPUT', 'BUTTON'].includes(element.tagName)
+          ? `[type='${element.getAttribute('type') || ''}']`
+          : ''));
+  }
   if (walk(element, isButton)) return 'button';
   return element.tagName.toLowerCase().match(/^(a|img|video)$/) && element.tagName.toLowerCase();
 }

package/modules/fflags.js

@@ -18,6 +18,7 @@ export const fflags = {
   /* c8 ignore next */
   disabled: (flag, callback) => !fflags.has(flag) && callback(),
   eagercwv: [683],
+  redirect: [620, 1139],
   example: [543, 770, 1136],
   language: [543, 959, 1139, 620],
 };

package/modules/index.js

@@ -111,7 +111,7 @@ function addCWVTracking() {
 
 function addNavigationTracking() {
   // enter checkpoint when referrer is not the current page url
-  const navigate = (source, type) => {
+  const navigate = (source, type, redirectCount) => {
     const payload = { source, target: document.visibilityState };
     // reload: same page, navigate: same origin, enter: everything else
     if (type === 'reload' || source === window.location.href) {
@@ -123,10 +123,20 @@ function addNavigationTracking() {
     } else {
       sampleRUM('enter', payload); // enter site
     }
+    fflags.enabled('redirect', () => {
+      const from = new URLSearchParams(window.location.search).get('redirect-from');
+      if (redirectCount || from) {
+        sampleRUM('redirect', { source: from, target: redirectCount || 1 });
+      }
+    });
   };
 
   new PerformanceObserver((list) => list
-    .getEntries().map((entry) => navigate(window.hlx.referrer || document.referrer, entry.type)))
+    .getEntries().map((entry) => navigate(
+      window.hlx.referrer || document.referrer,
+      entry.type,
+      entry.redirectCount,
+    )))
     .observe({ type: 'navigation', buffered: true });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "2.23.0",
+  "version": "2.25.0",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
@@ -49,16 +49,17 @@
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.30.0",
     "husky": "9.1.6",
-    "jsdoc-to-markdown": "9.0.1",
-    "junit-report-builder": "5.0.0",
+    "jsdoc-to-markdown": "9.0.2",
+    "junit-report-builder": "5.1.1",
     "lint-staged": "15.2.10",
     "mocha": "10.7.3",
     "mocha-multi-reporters": "1.5.1",
-    "rollup": "4.21.3",
-    "rollup-plugin-cleanup": "3.2.1",
+    "rollup": "4.24.0",
     "rollup-plugin-checksum": "1.0.1",
+    "rollup-plugin-cleanup": "3.2.1",
     "rollup-plugin-eslint-bundle": "9.0.0",
-    "semantic-release": "24.1.1",
+    "semantic-release": "24.1.2",
+    "semantic-release-slack-bot": "^4.0.2",
     "web-vitals": "4.2.3"
   },
   "lint-staged": {

package/src/index.js

@@ -20,6 +20,7 @@
     enabled: (flag, callback) => fflags.has(flag) && callback(),
     disabled: (flag, callback) => !fflags.has(flag) && callback(),
     eagercwv: [683],
+    redirect: [620, 1139],
     example: [543, 770, 1136],
     language: [543, 959, 1139, 620],
   };
@@ -79,7 +80,9 @@
     return element.getAttribute('role') === 'button';
   }
   function getSourceContext(element) {
-    if (element.closest('form')) return 'form';
+    if (element.closest('form')) {
+      return `form${element.id ? `#${element.id}` : ''}`;
+    }
     const block = element.closest('.block[data-block-name]');
     if (block) return `.${block.getAttribute('data-block-name')}`;
     if (walk(element, isDialog)) return 'dialog';
@@ -90,7 +93,12 @@
     return (walk(element, (e) => e.id && `#${e.id}`));
   }
   function getSourceElement(element) {
-    if (element.closest('form') && Array.from(element.closest('form').elements).includes(element)) return element.tagName.toLowerCase() + (element.tagName === 'INPUT' ? `[type='${element.getAttribute('type') || ''}']` : '');
+    if (element.closest('form') && Array.from(element.closest('form').elements).includes(element)) {
+      return (element.tagName.toLowerCase()
+          + (['INPUT', 'BUTTON'].includes(element.tagName)
+            ? `[type='${element.getAttribute('type') || ''}']`
+            : ''));
+    }
     if (walk(element, isButton)) return 'button';
     return element.tagName.toLowerCase().match(/^(a|img|video)$/) && element.tagName.toLowerCase();
   }
@@ -256,7 +264,7 @@
     }, 2000);
   }
   function addNavigationTracking() {
-    const navigate = (source, type) => {
+    const navigate = (source, type, redirectCount) => {
       const payload = { source, target: document.visibilityState };
       if (type === 'reload' || source === window.location.href) {
         sampleRUM('reload', payload);
@@ -267,9 +275,19 @@
       } else {
         sampleRUM('enter', payload);
       }
+      fflags.enabled('redirect', () => {
+        const from = new URLSearchParams(window.location.search).get('redirect-from');
+        if (redirectCount || from) {
+          sampleRUM('redirect', { source: from, target: redirectCount || 1 });
+        }
+      });
     };
     new PerformanceObserver((list) => list
-      .getEntries().map((entry) => navigate(window.hlx.referrer || document.referrer, entry.type)))
+      .getEntries().map((entry) => navigate(
+        window.hlx.referrer || document.referrer,
+        entry.type,
+        entry.redirectCount,
+      )))
       .observe({ type: 'navigation', buffered: true });
   }
   function addLoadResourceTracking() {

package/src/index.md5

@@ -1 +1 @@
-976e9a76103a41b4ee4ddcb398932250
+f87fdcb7d5c1e4526225b185d4f392fb