@adobe/helix-rum-enhancer 2.0.0 → 2.1.1

package/.releaserc.cjs

@@ -12,5 +12,5 @@ module.exports = {
     }],
     ["@semantic-release/github", {}]
   ],
-  branches: ['main', "1.x"],
+  branches: ['main', '1.x'],
 };

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [2.1.1](https://github.com/adobe/helix-rum-enhancer/compare/v2.1.0...v2.1.1) (2024-02-28)
+
+
+### Bug Fixes
+
+* **cwv:** only report LCP and CLS eagerly ([9d44949](https://github.com/adobe/helix-rum-enhancer/commit/9d44949701865242ac44255d5080f52b22be2b72))
+* **cwv:** report metrics eagerly ([4cfcad9](https://github.com/adobe/helix-rum-enhancer/commit/4cfcad9e8271a2a3c4571db419e26857b72d0c6d))
+* **cwv:** small change ([542fd6a](https://github.com/adobe/helix-rum-enhancer/commit/542fd6a050fdb911b4fb5faad7f83d0843af4d1e))
+* **cwv:** small change ([3a41b52](https://github.com/adobe/helix-rum-enhancer/commit/3a41b52676484d44585e8b0debe7352fe7a2e5ac))
+
+# [2.1.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.0.0...v2.1.0) (2024-01-22)
+
+
+### Bug Fixes
+
+* **loadresource:** enable loadresource checkpoint for all origins ([0be8de7](https://github.com/adobe/helix-rum-enhancer/commit/0be8de7ee3e57afdd60a2b9af743bedd061e907d))
+
+
+### Features
+
+* **observer:** enable tracking of JSON loading for all browsers that have a PerformanceObserver implementation ([45b5e64](https://github.com/adobe/helix-rum-enhancer/commit/45b5e6428fb9c51e8fc4d477c574d44a361b3ec2))
+
 # [2.0.0](https://github.com/adobe/helix-rum-enhancer/compare/v1.9.1...v2.0.0) (2024-01-16)
 
 

package/README.md

@@ -4,10 +4,9 @@
 
 ## Status
 [![codecov](https://img.shields.io/codecov/c/github/adobe/helix-rum-enhancer.svg)](https://codecov.io/gh/adobe/helix-rum-enhancer)
-[![CircleCI](https://img.shields.io/circleci/project/github/adobe/helix-rum-enhancer.svg)](https://circleci.com/gh/adobe/helix-rum-enhancer)
+[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/adobe/helix-rum-enhancer/main.yaml)](https://github.com/adobe/helix-rum-enhancer/actions/workflows/main.yaml)
 [![GitHub license](https://img.shields.io/github/license/adobe/helix-rum-enhancer.svg)](https://github.com/adobe/helix-rum-enhancer/blob/master/LICENSE.txt)
 [![GitHub issues](https://img.shields.io/github/issues/adobe/helix-rum-enhancer.svg)](https://github.com/adobe/helix-rum-enhancer/issues)
-[![LGTM Code Quality Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/adobe/helix-rum-enhancer.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/adobe/helix-rum-enhancer)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 ## Usage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
@@ -9,6 +9,7 @@
     "lint": "eslint .",
     "docs": "npx jsdoc2md -c .jsdoc.json --files 'src/*.js'  > docs/API.md",
     "semantic-release": "semantic-release",
+    "semantic-release-dry": "semantic-release --dry-run --branches $CI_BRANCH 1.x main",
     "prepare": "husky install"
   },
   "repository": {
@@ -28,20 +29,20 @@
     "reporter-options": "configFile=.mocha-multi.json"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "2.0.5",
+    "@adobe/eslint-config-helix": "2.0.6",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "11.0.2",
     "c8": "9.1.0",
     "codecov": "3.8.3",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.29.1",
-    "husky": "8.0.3",
-    "jsdoc-to-markdown": "8.0.0",
-    "junit-report-builder": "3.1.0",
-    "lint-staged": "15.2.0",
-    "mocha": "10.2.0",
+    "husky": "9.0.11",
+    "jsdoc-to-markdown": "8.0.1",
+    "junit-report-builder": "3.2.1",
+    "lint-staged": "15.2.2",
+    "mocha": "10.3.0",
     "mocha-multi-reporters": "1.5.1",
     "semantic-release": "22.0.12"
   },

package/src/index.js

@@ -11,7 +11,7 @@
  */
 /* eslint-env browser */
 const KNOWN_PROPERTIES = ['weight', 'id', 'referer', 'checkpoint', 't', 'source', 'target', 'cwv', 'CLS', 'FID', 'LCP', 'INP', 'TTFB'];
-const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia'];
+const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia', 'loadresource'];
 const SESSION_STORAGE_KEY = 'aem-rum';
 const { sampleRUM, queue, isSelected } = window.hlx.rum;
 
@@ -67,10 +67,6 @@ function optedIn(checkpoint, data) {
 }
 // Gets configured collection from the config service for the current domain
 function getCollectionConfig() {
-  if (window.location.hostname === 'blog.adobe.com') {
-    return ['loadresource', ...DEFAULT_TRACKING_EVENTS];
-  }
-  // TODO: configured collection should come from config service
   return DEFAULT_TRACKING_EVENTS;
 }
 
@@ -111,14 +107,19 @@ function addCWVTracking() {
         data.cwv[measurement.name] = measurement.value;
         sampleRUM('cwv', data);
       };
+
+      const featureToggle = () => window.location.hostname === 'blog.adobe.com';
+      const isEager = (metric) => ['CLS', 'LCP'].includes(metric);
+
       // When loading `web-vitals` using a classic script, all the public
       // methods can be found on the `webVitals` global namespace.
-      ['CLS', 'FID', 'LCP', 'INP', 'TTFB']
-        .map((metric) => window.webVitals[`get${metric}`])
-        .filter((metric) => typeof metric === 'function')
-        .forEach((invokeMetric) => {
-          invokeMetric(storeCWV);
-        });
+      ['FID', 'INP', 'TTFB', 'CLS', 'LCP'].forEach((metric) => {
+        const metricFn = window.webVitals[`on${metric}`];
+        if (typeof metricFn === 'function') {
+          const opts = isEager(metric) ? { reportAllChanges: featureToggle() } : undefined;
+          metricFn(storeCWV, opts);
+        }
+      });
     };
     document.head.appendChild(script);
   }, 2000); // wait for delayed
@@ -157,18 +158,16 @@ function addEnterLeaveTracking() {
 }
 
 function addLoadResourceTracking() {
-  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 });
-  }
+  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 });
 }
 
 function activateBlocksMutationObserver() {