@adobe/spacecat-shared-rum-api-client 2.15.6 → 2.15.7

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.15.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.15.6...@adobe/spacecat-shared-rum-api-client-v2.15.7) (2024-12-16)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/rum-distiller to v1.13.1 ([#495](https://github.com/adobe/spacecat-shared/issues/495)) ([5f50c2f](https://github.com/adobe/spacecat-shared/commit/5f50c2f2757cbe0c6ec7d46c919b97c0b2ae7193)), closes [#8203](https://github.com/adobe/spacecat-shared/issues/8203)
+
 # [@adobe/spacecat-shared-rum-api-client-v2.15.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.15.5...@adobe/spacecat-shared-rum-api-client-v2.15.6) (2024-12-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.15.6",
+  "version": "2.15.7",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "engines": {
@@ -39,7 +39,7 @@
     "@adobe/helix-shared-wrap": "2.0.2",
     "@adobe/helix-universal": "5.0.8",
     "@adobe/spacecat-shared-utils": "1.22.4",
-    "@adobe/rum-distiller": "1.13.0",
+    "@adobe/rum-distiller": "1.13.1",
     "aws4": "1.13.2",
     "urijs": "^1.19.11"
   },

package/src/functions/404-internal-links.js

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { DataChunks, series } from '@adobe/rum-distiller';
+import { DELIMITER, generateKey, loadBundles } from '../utils.js';
+/**
+ * Processes RUM data to identify broken internal links associated views.
+ * Uses the 404 and navigate checkpoints to identify broken internal links.
+ * The handler function:
+ * 1. Loads RUM bundles into data chunks
+ * 2. Groups data by unique URL combinations (404 target URL + source URL)
+ * 3. Calculates pageviews for each broken link. Duplicate combinations will have
+ * their views summed.
+ * 4. Returns array of broken link objects with:
+ *    - url_to: The 404 target URL that is broken
+ *    - url_from: The source URL containing the broken link
+ *    - traffic_domain: Number of pageviews to the broken URL
+ * @param {Array} bundles - Array of RUM data bundles
+ * @returns {Array} Array of broken internal link objects with views
+ */
+
+function handler(bundles) {
+  const dataChunks = new DataChunks();
+  loadBundles(bundles, dataChunks);
+
+  // groups by combination of url and 404 source
+  dataChunks.addFacet('uniqueUrlCombinations', (bundle) => {
+    const eventNavigate = bundle.events.find((e) => e.checkpoint === 'navigate');
+    const event404 = bundle.events.find((e) => e.checkpoint === '404');
+    if (eventNavigate && event404) {
+      return generateKey(bundle.url, event404.source);
+    }
+    return undefined;
+  });
+
+  // counts pageviews per each group
+  dataChunks.addSeries('traffic_domain', series.pageViews);
+
+  return dataChunks.facets.uniqueUrlCombinations.map((facet) => {
+    const [urlTo, urlFrom] = facet.value.split(DELIMITER);
+
+    return {
+      traffic_domain: facet.metrics.traffic_domain.sum,
+      url_to: urlTo,
+      url_from: urlFrom,
+    };
+  });
+}
+
+export default {
+  handler,
+  checkpoints: ['404', 'navigate'],
+};

package/src/index.js

@@ -11,6 +11,7 @@
  */
 import { fetchBundles } from './common/rum-bundler-client.js';
 import notfound from './functions/404.js';
+import notfoundInternalLinks from './functions/404-internal-links.js';
 import cwv from './functions/cwv.js';
 import formVitals from './functions/form-vitals.js';
 import experiment from './functions/experiment.js';
@@ -22,6 +23,7 @@ import highOrganicLowCtr from './functions/opportunities/high-organic-low-ctr.js
 
 const HANDLERS = {
   404: notfound,
+  '404-internal-links': notfoundInternalLinks,
   cwv,
   'form-vitals': formVitals,
   experiment,