@adobe/helix-rum-enhancer 2.16.0 → 2.17.1

package/.husky/pre-commit

@@ -1 +1,2 @@
+npx lint-staged
 npm test

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [2.17.1](https://github.com/adobe/helix-rum-enhancer/compare/v2.17.0...v2.17.1) (2024-08-02)
+
+
+### Bug Fixes
+
+* **loadresource:** fix closing bracket ([0978b71](https://github.com/adobe/helix-rum-enhancer/commit/0978b7138f16421b5eb22c49b3c757116cb7053b))
+* **loadresource:** include all JSON resources, and GraphQL resources ([8ebaa97](https://github.com/adobe/helix-rum-enhancer/commit/8ebaa97e844ff605ec2e6a458fc43adc3c5a37dd))
+
+# [2.17.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.16.0...v2.17.0) (2024-07-03)
+
+
+### Features
+
+* **email:** rollout for all customers 2.x ([#222](https://github.com/adobe/helix-rum-enhancer/issues/222)) ([bb71ae6](https://github.com/adobe/helix-rum-enhancer/commit/bb71ae656fbb8c34ca5de3436f950a9e10e8f188))
+
 # [2.16.0](https://github.com/adobe/helix-rum-enhancer/compare/v2.15.0...v2.16.0) (2024-07-02)
 
 

package/modules/defaults.js

@@ -10,4 +10,4 @@
  * governing permissions and limitations under the License.
  */
 export const KNOWN_PROPERTIES = ['weight', 'id', 'referer', 'checkpoint', 't', 'source', 'target', 'cwv', 'CLS', 'FID', 'LCP', 'INP', 'TTFB'];
-export const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia', 'loadresource', 'utm', 'paid'];
+export const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia', 'loadresource', 'utm', 'paid', 'email'];

package/modules/fflags.js

@@ -10,11 +10,11 @@
  * governing permissions and limitations under the License.
  */
 export const fflags = {
-  has: (flag) => fflags[flag].indexOf(Array.from(window.origin)
-    .map((a) => a.charCodeAt(0))
-    .reduce((a, b) => a + b, 1) % 1371) !== -1,
+  has: (flag) => !!window.origin.match(/localhost/)
+    || fflags[flag].indexOf(Array.from(window.origin)
+      .map((a) => a.charCodeAt(0))
+      .reduce((a, b) => a + b, 1) % 1371) !== -1,
   enabled: (flag, callback) => fflags.has(flag) && callback(),
   disabled: (flag, callback) => !fflags.has(flag) && callback(),
   onetrust: [543, 770, 1136],
-  email: [1139, 543],
 };

package/modules/index.js

@@ -31,7 +31,6 @@ function optedIn(checkpoint, data) {
 function getCollectionConfig() {
   // eslint-disable-next-line max-len
   fflags.enabled('onetrust', () => DEFAULT_TRACKING_EVENTS.push('consent'));
-  fflags.enabled('email', () => DEFAULT_TRACKING_EVENTS.push('email'));
   return DEFAULT_TRACKING_EVENTS;
 }
 
@@ -45,6 +44,7 @@ function trackCheckpoint(checkpoint, data, t) {
       if (window.location.origin === origin) {
         const headers = { type: 'application/json' };
         navigator.sendBeacon(url, new Blob([body], headers));
+        /* c8 ignore next 3 */
       } else {
         navigator.sendBeacon(url, body);
       }
@@ -98,6 +98,7 @@ function addCWVTracking() {
         });
       };
       document.head.appendChild(script);
+      /* c8 ignore next 3 */
     } catch (error) {
       // something went wrong
     }
@@ -145,7 +146,7 @@ function addLoadResourceTracking() {
       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)$'))
+        .filter((entry) => new URL(entry.name).pathname.match('.*(\\.plain\\.html$|\\.json|graphql)'))
         .forEach((entry) => {
           sampleRUM('loadresource', { source: entry.name, target: Math.round(entry.duration) });
         });
@@ -154,6 +155,7 @@ function addLoadResourceTracking() {
         .forEach((entry) => {
           sampleRUM('missingresource', { source: entry.name, target: entry.hostname });
         });
+      /* c8 ignore next 3 */
     } catch (error) {
       // something went wrong
     }
@@ -188,6 +190,7 @@ function getIntersectionObsever(checkpoint) {
           const source = sourceSelector(entry.target);
           sampleRUM(checkpoint, { target, source });
         });
+      /* c8 ignore next 3 */
     } catch (error) {
       // something went wrong
     }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@adobe/helix-rum-enhancer",
-  "version": "2.16.0",
+  "version": "2.17.1",
   "description": "Helix RUM Enhancer",
   "main": "src/index.js",
   "type": "module",
   "scripts": {
     "setup-playwright": "npx playwright install --with-deps chromium firefox webkit",
-    "test": "npm run setup-playwright && web-test-runner --node-resolve --coverage --playwright --browsers chromium firefox webkit",
-    "test:ci": "npm run setup-playwright && web-test-runner --node-resolve --coverage --playwright --browsers chromium firefox webkit",
+    "test": "npm run build-bundle && npm run setup-playwright && web-test-runner --node-resolve --coverage --playwright --browsers chromium firefox webkit",
+    "test:ci": "npm run build-bundle && npm run setup-playwright && web-test-runner --node-resolve --coverage --playwright --browsers chromium firefox webkit",
     "test:watch": "web-test-runner --node-resolve --playwright --coverage --watch",
     "lint": "eslint .",
     "docs": "npx jsdoc2md -c .jsdoc.json --files 'src/*.js'  > docs/API.md",
@@ -34,6 +34,7 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.6",
+    "@adobe/helix-rum-js": "2.1.4",
     "@esm-bundle/chai": "4.3.4-fix.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
@@ -47,16 +48,17 @@
     "eslint": "8.57.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.29.1",
-    "husky": "9.0.11",
-    "jsdoc-to-markdown": "8.0.1",
-    "junit-report-builder": "3.2.1",
+    "husky": "9.1.3",
+    "jsdoc-to-markdown": "8.0.3",
+    "junit-report-builder": "4.0.0",
     "lint-staged": "15.2.7",
-    "mocha": "10.5.2",
+    "mocha": "10.7.0",
     "mocha-multi-reporters": "1.5.1",
-    "rollup": "4.18.0",
+    "rollup": "4.19.1",
     "rollup-plugin-cleanup": "3.2.1",
     "rollup-plugin-eslint-bundle": "9.0.0",
-    "semantic-release": "24.0.0"
+    "semantic-release": "24.0.0",
+    "web-vitals": "4.2.2"
   },
   "lint-staged": {
     "*.js": "eslint",

package/rollup.config.js

@@ -45,6 +45,13 @@ export default [...bundles.map(({ outputFile, source }) => ({
       exports: 'auto',
       banner,
     },
+    {
+      file: `${outputFile}.map.js`,
+      format: 'iife',
+      sourcemap: 'inline',
+      exports: 'auto',
+      banner,
+    },
   ],
   plugins: [
     cleanup({

package/src/index.js

@@ -16,16 +16,16 @@
   'use strict';
 
   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', 'loadresource', 'utm', 'paid'];
+  const DEFAULT_TRACKING_EVENTS = ['click', 'cwv', 'form', 'enterleave', 'viewblock', 'viewmedia', 'loadresource', 'utm', 'paid', 'email'];
 
   const fflags = {
-    has: (flag) => fflags[flag].indexOf(Array.from(window.origin)
-      .map((a) => a.charCodeAt(0))
-      .reduce((a, b) => a + b, 1) % 1371) !== -1,
+    has: (flag) => !!window.origin.match(/localhost/)
+      || fflags[flag].indexOf(Array.from(window.origin)
+        .map((a) => a.charCodeAt(0))
+        .reduce((a, b) => a + b, 1) % 1371) !== -1,
     enabled: (flag, callback) => fflags.has(flag) && callback(),
     disabled: (flag, callback) => !fflags.has(flag) && callback(),
     onetrust: [543, 770, 1136],
-    email: [1139, 543],
   };
 
   const urlSanitizers = {
@@ -132,7 +132,6 @@
   function getCollectionConfig() {
     // eslint-disable-next-line max-len
     fflags.enabled('onetrust', () => DEFAULT_TRACKING_EVENTS.push('consent'));
-    fflags.enabled('email', () => DEFAULT_TRACKING_EVENTS.push('email'));
     return DEFAULT_TRACKING_EVENTS;
   }
 
@@ -246,7 +245,7 @@
         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)$'))
+          .filter((entry) => new URL(entry.name).pathname.match('.*(\\.plain\\.html$|\\.json|graphql)'))
           .forEach((entry) => {
             sampleRUM('loadresource', { source: entry.name, target: Math.round(entry.duration) });
           });

package/web-test-runner.config.js

@@ -10,16 +10,54 @@
  * governing permissions and limitations under the License.
  */
 export default {
+  testFramework: {
+    type: 'mocha',
+    config: {
+      timeout: 10000,
+    },
+  },
   coverageConfig: {
     report: true,
     reportDir: 'coverage',
     exclude: [
       'test/fixtures/**',
       'node_modules/**',
+      '.rum/**',
     ],
   },
   files: [
     'test/**/*.test.{html,js}',
     'test/*.test.{html,js}',
   ],
+  middleware: [
+    async function emulateRUM(context, next) {
+      if (context.url.startsWith('/src/index.map.js')) {
+        await next();
+        context.body = context.body
+          .replace(/navigator\.sendBeacon/g, 'fakeSendBeacon');
+        return true;
+      } else if (context.url.startsWith('/.rum')) {
+        if (context.url.startsWith('/.rum/@adobe/helix-rum-js@%5E2/dist/')
+          || context.url.startsWith('/.rum/@adobe/helix-rum-js@^2/dist/')
+        ) {
+          context.url = '/node_modules/@adobe/helix-rum-js/dist/rum-standalone.js';
+          await next();
+          context.body = context.body
+            .replace(/const weight.*/, 'const weight = 1;')
+            .replace(/navigator\.sendBeacon/g, 'fakeSendBeacon')
+            .replace('.rum/@adobe/helix-rum-enhancer@^2/src/index.js', 'src/index.map.js');
+          return true;
+        } else if (context.url.startsWith('/.rum/web-vitals')) {
+          context.url = '/node_modules/web-vitals/dist/web-vitals.iife.js';
+          await next();
+          return true;
+        } else if (context.url === '/.rum/1') {
+          // return a 201 response and do nothing
+          context.status = 201;
+          return true;
+        }
+      }
+      return next();
+    },
+  ],
 };