@adobe/spacecat-shared-rum-api-client 2.18.7 → 2.18.9

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.18.9](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.18.8...@adobe/spacecat-shared-rum-api-client-v2.18.9) (2025-01-30)
+
+
+### Bug Fixes
+
+* **rum-api-client:** only consider earned traffic in hi-org-lo-ctr ([#565](https://github.com/adobe/spacecat-shared/issues/565)) ([f7a2019](https://github.com/adobe/spacecat-shared/commit/f7a20193844f40938032a4236f55241fcdefb8d4))
+
+# [@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)
 
 

package/package.json

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

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

@@ -186,11 +186,17 @@ async function fetchBundles(opts, log) {
 
   const chunks = getUrlChunks(urls, CHUNK_SIZE);
 
+  let totalTransferSize = 0;
+
   const result = [];
   for (const chunk of chunks) {
-    const responses = await Promise.all(chunk.map((url) => {
-      log.info(`Retrieving RUM bundles. Granularity: ${granularity}. Domain: ${domain}`);
-      return 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()));
 
@@ -201,6 +207,7 @@ async function fetchBundles(opts, log) {
         .forEach((bundle) => result.push(bundle));
     });
   }
+  log.info(`Retrieved RUM bundles. Total transfer size (in KB): ${(totalTransferSize / 1024).toFixed(2)}`);
   return mergeBundlesWithSameId(result);
 }
 

package/src/functions/opportunities/high-organic-low-ctr.js

@@ -13,7 +13,7 @@
 import trafficAcquisition from '../traffic-acquisition.js';
 import { getCTRByUrlAndVendor, getSiteAvgCTR } from '../../common/aggregateFns.js';
 
-const DAILY_EARNED_THRESHOLD = 5000;
+const DAILY_EARNED_THRESHOLD = 3000;
 const CTR_THRESHOLD_RATIO = 0.95;
 const DAILY_PAGEVIEW_THRESHOLD = 1000;
 const VENDORS_TO_CONSIDER = 5;
@@ -94,8 +94,8 @@ function convertToOpportunity(traffic) {
 }
 
 function hasHighOrganicTraffic(interval, traffic) {
-  const { earned, owned } = traffic;
-  return earned + owned > DAILY_EARNED_THRESHOLD * interval;
+  const { earned } = traffic;
+  return earned >= DAILY_EARNED_THRESHOLD * interval;
 }
 
 function hasLowerCTR(ctr, siteAvgCTR) {

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;
@@ -66,7 +75,7 @@ export default class RUMAPIClient {
 
       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}`);
     }
   }
 
@@ -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}`);
     }
   }
 }