@adobe/helix-rum-enhancer 2.24.0 → 2.26.0-beta.1

package/.releaserc.cjs

@@ -29,5 +29,5 @@ module.exports = {
       slackChannel: "rum-explorers",
     }],
   ],
-  branches: ['main'],
+  branches: ['main', { name: 'beta', prerelease: true }],
 };

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.26.0-beta.1](https://github.com/adobe/helix-rum-enhancer/compare/v2.25.0...v2.26.0-beta.1) (2024-10-09)
+
+
+### Features
+
+* handle pre-rendering ([bb11187](https://github.com/adobe/helix-rum-enhancer/commit/bb11187058b8cb521a270c316323b66414a8d817))
+
+# [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)
 
 

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/index.js

@@ -112,9 +112,21 @@ function addCWVTracking() {
 function addNavigationTracking() {
   // enter checkpoint when referrer is not the current page url
   const navigate = (source, type, redirectCount) => {
+    // target can be 'visible', 'hidden' (background tab) or 'prerendered' (speculation rules)
     const payload = { source, target: document.visibilityState };
-    // reload: same page, navigate: same origin, enter: everything else
-    if (type === 'reload' || source === window.location.href) {
+    if (document.prerendering) {
+      // listen for "activation" of the current pre-rendered page
+      document.addEventListener('prerenderingchange', () => {
+        // pre-rendered page is now "activated"
+        payload.target = 'prerendered';
+        sampleRUM('navigate', payload); // prerendered navigation
+      }, {
+        once: true,
+      });
+      if (type === 'navigate') {
+        sampleRUM('prerender', payload); // prerendering page
+      }
+    } else if (type === 'reload' || source === window.location.href) {
       sampleRUM('reload', payload);
     } else if (type && type !== 'navigate') {
       sampleRUM(type, payload); // back, forward, prerender, etc.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "2.24.0",
+  "version": "2.26.0-beta.1",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
@@ -14,7 +14,7 @@
     "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",
+    "semantic-release-dry": "semantic-release --dry-run --branches $CI_BRANCH 1.x main beta",
     "prepare": "husky"
   },
   "repository": {
@@ -33,7 +33,7 @@
     "reporter-options": "configFile=.mocha-multi.json"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "2.0.7",
+    "@adobe/eslint-config-helix": "2.0.8",
     "@adobe/helix-rum-js": "2.6.0",
     "@esm-bundle/chai": "4.3.4-fix.0",
     "@semantic-release/changelog": "6.0.3",
@@ -47,18 +47,18 @@
     "codecov": "3.8.3",
     "eslint": "8.57.1",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.30.0",
+    "eslint-plugin-import": "2.31.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": "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"
   },

package/src/index.js

@@ -80,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';
@@ -91,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();
   }
@@ -259,7 +266,17 @@
   function addNavigationTracking() {
     const navigate = (source, type, redirectCount) => {
       const payload = { source, target: document.visibilityState };
-      if (type === 'reload' || source === window.location.href) {
+      if (document.prerendering) {
+        document.addEventListener('prerenderingchange', () => {
+          payload.target = 'prerendered';
+          sampleRUM('navigate', payload);
+        }, {
+          once: true,
+        });
+        if (type === 'navigate') {
+          sampleRUM('prerender', payload);
+        }
+      } else if (type === 'reload' || source === window.location.href) {
         sampleRUM('reload', payload);
       } else if (type && type !== 'navigate') {
         sampleRUM(type, payload);

package/src/index.md5

@@ -1 +1 @@
-734919c8255ab6180ebd17f83f09b78f
+81557c0399da9e24aeac8f384303248a