@adobe/helix-rum-enhancer 2.22.0 → 2.24.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.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)
+
+
+### Features
+
+* **index:** support  to attach custom URL parameters to collection URL ([02f4d0b](https://github.com/adobe/helix-rum-enhancer/commit/02f4d0b366505fc17bc251e29364efa2e497c299))
+
 # [2.22.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.21.1...v2.22.0) (2024-09-18)
 
 

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

@@ -41,7 +41,8 @@ function trackCheckpoint(checkpoint, data, t) {
     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);
+      const urlParams = window.RUM_PARAMS ? `?${new URLSearchParams(window.RUM_PARAMS).toString()}` : '';
+      const { href: url, origin } = new URL(`.rum/${weight}${urlParams}`, sampleRUM.collectBaseURL);
       if (window.location.origin === origin) {
         const headers = { type: 'application/json' };
         navigator.sendBeacon(url, new Blob([body], headers));
@@ -110,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) {
@@ -122,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.22.0",
+  "version": "2.24.0",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
@@ -34,7 +34,7 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.7",
-    "@adobe/helix-rum-js": "2.5.3",
+    "@adobe/helix-rum-js": "2.6.0",
     "@esm-bundle/chai": "4.3.4-fix.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
@@ -55,10 +55,11 @@
     "mocha": "10.7.3",
     "mocha-multi-reporters": "1.5.1",
     "rollup": "4.21.3",
-    "rollup-plugin-cleanup": "3.2.1",
     "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-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],
   };
@@ -199,7 +200,8 @@
     if (isSelected) {
       const sendPing = (pdata = data) => {
         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);
+        const urlParams = window.RUM_PARAMS ? `?${new URLSearchParams(window.RUM_PARAMS).toString()}` : '';
+        const { href: url, origin } = new URL(`.rum/${weight}${urlParams}`, sampleRUM.collectBaseURL);
         if (window.location.origin === origin) {
           const headers = { type: 'application/json' };
           navigator.sendBeacon(url, new Blob([body], headers));
@@ -255,7 +257,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);
@@ -266,9 +268,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 @@
-294dc58195b0b6a3a3163004bfb8e10b
+734919c8255ab6180ebd17f83f09b78f