@adobe/helix-rum-enhancer 1.6.0 → 1.8.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [1.8.0](https://github.com/adobe/helix-rum-enhancer/compare/v1.7.0...v1.8.0) (2023-11-21)
+
+
+### Bug Fixes
+
+* **navigation:** use correct buffered perf observer ([39ed811](https://github.com/adobe/helix-rum-enhancer/commit/39ed811cdb6ccf5471b30a0d147317c724c4220c))
+
+
+### Features
+
+* **navigate:** refine checkpoints for `enter`, `navigate`, `reload`, `back_forward`, and `prerender`, track `visibilityState` ([70f622a](https://github.com/adobe/helix-rum-enhancer/commit/70f622a62aa93ff96219420b5c5357348b9ef050))
+
+# [1.7.0](https://github.com/adobe/helix-rum-enhancer/compare/v1.6.0...v1.7.0) (2023-10-31)
+
+
+### Features
+
+* **checkpoint:**  new loadresource checkpoint ([d818efc](https://github.com/adobe/helix-rum-enhancer/commit/d818efc854241119979300387b3dcd4d59c6c8f5))
+* **checkpoint:** introduce new resource checkpoint ([2845a20](https://github.com/adobe/helix-rum-enhancer/commit/2845a202281c09f1c75b4e8a52de000663410b1c))
+
 # [1.6.0](https://github.com/adobe/helix-rum-enhancer/compare/v1.5.0...v1.6.0) (2023-10-18)
 
 

package/README.md

@@ -19,7 +19,7 @@ It will add following new checkpoints:
 - `cwv`: Core Web Vitals Collection
 - `click`: A click anywhere in the document
 - `viewblock`: A Helix block has been scrolled into the viewport
-- `viewmedia`: An image or viedo hosted by Helix Media Bus has been scrolled into the viewport
+- `viewmedia`: An image or video hosted by Helix Media Bus has been scrolled into the viewport
 - `enter`: when page loads and the referrer is different than the current page.
 
 ## Development

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
@@ -28,22 +28,22 @@
     "reporter-options": "configFile=.mocha-multi.json"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "2.0.3",
+    "@adobe/eslint-config-helix": "2.0.5",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/npm": "11.0.0",
+    "@semantic-release/npm": "11.0.1",
     "c8": "8.0.1",
     "codecov": "3.8.3",
-    "eslint": "8.51.0",
+    "eslint": "8.54.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.28.1",
+    "eslint-plugin-import": "2.29.0",
     "husky": "8.0.3",
     "jsdoc-to-markdown": "8.0.0",
     "junit-report-builder": "3.1.0",
-    "lint-staged": "15.0.1",
+    "lint-staged": "15.1.0",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
-    "semantic-release": "22.0.5"
+    "semantic-release": "22.0.8"
   },
   "lint-staged": {
     "*.js": "eslint",

package/src/index.js

@@ -48,10 +48,24 @@ sampleRUM.drain('observe', ((elements) => {
   });
 }));
 
-// enter checkpoint when referrer is not the current page url
-if (!!document.referrer && (document.referrer !== window.location.href)) {
-  sampleRUM('enter', { target: undefined, source: document.referrer });
-}
+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 !== '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
+  }
+};
+navigate(document.referrer);
+
+new PerformanceObserver((list) => list
+  .getEntries().map((entry) => navigate(document.referrer, entry.type)))
+  .observe({ type: 'navigation', buffered: true });
 
 sampleRUM.targetselector = (element) => {
   let value = element.getAttribute('href') || element.currentSrc || element.getAttribute('src')
@@ -134,3 +148,16 @@ document.querySelectorAll('form').forEach((form) => {
 
 window.addEventListener('visibilitychange', ((event) => sampleRUM.leave(event)));
 window.addEventListener('pagehide', ((event) => sampleRUM.leave(event)));
+
+if (window.location.hostname === 'blog.adobe.com') {
+  const observer = new PerformanceObserver((list) => {
+    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) });
+      });
+  });
+  observer.observe({ type: 'resource', buffered: true });
+}