@adobe/spacecat-shared-rum-api-client 2.18.6 → 2.18.8

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.18.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.18.7...@adobe/spacecat-shared-rum-api-client-v2.18.8) (2025-01-24)
+
+
+### Bug Fixes
+
+* **rum-api-client:** extra RUM Bundler requests logging ([#558](https://github.com/adobe/spacecat-shared/issues/558)) ([b80160a](https://github.com/adobe/spacecat-shared/commit/b80160a84feea4247db25172f023e3f8132b4d13))
+
+# [@adobe/spacecat-shared-rum-api-client-v2.18.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.18.6...@adobe/spacecat-shared-rum-api-client-v2.18.7) (2025-01-23)
+
+
+### Bug Fixes
+
+* **rum-api-client:** log RUM Bundler requests ([#555](https://github.com/adobe/spacecat-shared/issues/555)) ([9b3ed87](https://github.com/adobe/spacecat-shared/commit/9b3ed87d12d0838ef922d6f373a287b4782dd197))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.18.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.18.5...@adobe/spacecat-shared-rum-api-client-v2.18.6) (2025-01-20)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.18.6",
+  "version": "2.18.8",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "engines": {

package/src/common/rum-bundler-client.js

@@ -157,7 +157,7 @@ async function mergeBundlesWithSameId(bundles) {
 }
 /* c8 ignore end */
 
-async function fetchBundles(opts = {}) {
+async function fetchBundles(opts, log) {
   const {
     domain,
     domainkey,
@@ -186,9 +186,18 @@ async function fetchBundles(opts = {}) {
 
   const chunks = getUrlChunks(urls, CHUNK_SIZE);
 
+  let totalTransferSize = 0;
+
   const result = [];
   for (const chunk of chunks) {
-    const responses = await Promise.all(chunk.map((url) => fetch(url)));
+    // eslint-disable-next-line no-loop-func
+    const responses = await Promise.all(chunk.map(async (url) => {
+      const response = await fetch(url);
+      const xCache = response.headers.get('x-cache')?.toLowerCase().includes('hit');
+      log.info(`Retrieving RUM bundles. Source: ${xCache ? 'CDN' : 'ORIGIN'}. Granularity: ${granularity}. Domain: ${domain}`);
+      totalTransferSize += parseInt(response.headers.get('content-length'), 10);
+      return response;
+    }));
     const bundles = await Promise.all(responses.map((response) => response.json()));
 
     bundles.forEach((b) => {
@@ -198,6 +207,7 @@ async function fetchBundles(opts = {}) {
         .forEach((bundle) => result.push(bundle));
     });
   }
+  log.info(`Retrieved RUM bundles. Total transfer size (in KB): ${(totalTransferSize / 1024).toFixed(2)}`);
   return mergeBundlesWithSameId(result);
 }
 

package/src/index.js

@@ -9,6 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+import { hasText } from '@adobe/spacecat-shared-utils';
 import { fetchBundles } from './common/rum-bundler-client.js';
 import notfound from './functions/404.js';
 import notfoundInternalLinks from './functions/404-internal-links.js';
@@ -36,6 +37,14 @@ const HANDLERS = {
   'high-organic-low-ctr': highOrganicLowCtr,
 };
 
+function sanitize(opts) {
+  return {
+    ...opts,
+    /* c8 ignore next 1 */
+    ...(hasText(opts.domainkey) && { domainkey: `${opts.domainkey.slice(0, 3)}***` }),
+  };
+}
+
 export default class RUMAPIClient {
   static createFrom(context) {
     const { log = console } = context;
@@ -60,13 +69,13 @@ export default class RUMAPIClient {
       const bundles = await fetchBundles({
         ...opts,
         checkpoints,
-      });
+      }, this.log);
 
       this.log.info(`Query "${query}" fetched ${bundles.length} bundles`);
 
       return handler(bundles, opts);
     } catch (e) {
-      throw new Error(`Query '${query}' failed. Opts: ${JSON.stringify(opts)}. Reason: ${e.message}`);
+      throw new Error(`Query '${query}' failed. Opts: ${JSON.stringify(sanitize(opts))}. Reason: ${e.message}`);
     }
   }
 
@@ -91,7 +100,7 @@ export default class RUMAPIClient {
       const bundles = await fetchBundles({
         ...opts,
         checkpoints: [...allCheckpoints],
-      });
+      }, this.log);
 
       const results = {};
 
@@ -105,7 +114,7 @@ export default class RUMAPIClient {
 
       return results;
     } catch (e) {
-      throw new Error(`Multi query failed. Queries: ${JSON.stringify(queries)}, Opts: ${JSON.stringify(opts)}. Reason: ${e.message}`);
+      throw new Error(`Multi query failed. Queries: ${JSON.stringify(queries)}, Opts: ${JSON.stringify(sanitize(opts))}. Reason: ${e.message}`);
     }
   }
 }