@adobe/spacecat-shared-rum-api-client 2.5.1 → 2.5.3

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.5.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.5.2...@adobe/spacecat-shared-rum-api-client-v2.5.3) (2024-07-31)
+
+
+### Bug Fixes
+
+* work-around for bamboos custom exp engine ([#308](https://github.com/adobe/spacecat-shared/issues/308)) ([56b3b62](https://github.com/adobe/spacecat-shared/commit/56b3b62ea4c330d3d1003ab82e8c90ae890914f8))
+
+# [@adobe/spacecat-shared-rum-api-client-v2.5.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.5.1...@adobe/spacecat-shared-rum-api-client-v2.5.2) (2024-07-30)
+
+
+### Bug Fixes
+
+* updating inferred start and end dates to reflect old and latest from RUM bundles ([#303](https://github.com/adobe/spacecat-shared/issues/303)) ([92852bd](https://github.com/adobe/spacecat-shared/commit/92852bd5e5f033fbc568c70cc7d6f5d5eda50deb))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.5.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.5.0...@adobe/spacecat-shared-rum-api-client-v2.5.1) (2024-07-27)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.5.1",
+  "version": "2.5.3",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "main": "src/index.js",

package/src/functions/experiment.js

@@ -55,31 +55,20 @@ function updateInferredStartAndEndDate(experimentObject, time) {
   const bundleDate = new Date(bundleTime);
   bundleDate.setHours(0, 0, 0, 0);
   if (!experimentObject.inferredStartDate && !experimentObject.inferredEndDate) {
-    // adding the inferredStartDate and inferredEndDate properties for the first time
     // eslint-disable-next-line no-param-reassign
     experimentObject.inferredStartDate = time;
-    // check if bundleTime is before yesterday
-    if (bundleDate < yesterday) {
-      // RUM data is delayed by a day, so if we don't have
-      // any RUM data for yesterday, so we can infer the endDate
-      // eslint-disable-next-line no-param-reassign
-      experimentObject.inferredEndDate = time;
-    } else {
-      // eslint-disable-next-line no-param-reassign
-      experimentObject.inferredEndDate = null;
-    }
+    // eslint-disable-next-line no-param-reassign
+    experimentObject.inferredEndDate = time;
   } else {
     const inferredStartDateObj = new Date(experimentObject.inferredStartDate);
+    const inferredEndDateObj = new Date(experimentObject.inferredEndDate);
     if (bundleTime < inferredStartDateObj) {
       // eslint-disable-next-line no-param-reassign
       experimentObject.inferredStartDate = time;
     }
-    if (bundleDate < yesterday) {
-      if (!experimentObject.inferredEndDate
-        || (bundleTime > new Date(experimentObject.inferredEndDate))) {
-        // eslint-disable-next-line no-param-reassign
-        experimentObject.inferredEndDate = time;
-      }
+    if (bundleTime > inferredEndDateObj) {
+      // eslint-disable-next-line no-param-reassign
+      experimentObject.inferredEndDate = time;
     }
   }
 }

package/src/functions/traffic-acquisition.js

@@ -11,6 +11,7 @@
  */
 
 import { classifyTrafficSource } from '../common/traffic.js';
+import { fetch } from '../utils.js';
 
 function extractHints(bundle) {
   const findEvent = (checkpoint, source = '') => bundle.events.find((e) => e.checkpoint === checkpoint && (!source || e.source === source)) || {};
@@ -47,8 +48,81 @@ function transformFormat(trafficSources) {
   }));
 }
 
-function handler(bundles) {
-  const trafficSources = bundles
+/* c8 ignore start */
+/*
+ * throw-away code for a single customer who customized the experimentation engine
+ * this code will be removed once they start using the default exp engine
+ *
+ * this function fetches experiment manifests, then merges variants data into controls data
+ *
+ * ie:
+ *
+ * if the customer runs for an experiment where variants are as following:
+ *   control: /
+ *   challenger-1: /a1/
+ *   challenger-2: /a2/
+ *
+ * then data for the `/a1/` and `/a2` are counted towards `/`'s data
+ */
+async function mergeBundlesWithSameId(bundles) {
+  if (!bundles[0]?.url.includes('bamboohr.com')) return bundles;
+  const manifestUrls = [
+    ...new Set(bundles.flatMap((bundle) => bundle.events
+      .filter((e) => e.checkpoint === 'experiment')
+      .map((e) => e.source))),
+  ].map((experiment) => fetch(`https://www.bamboohr.com/experiments/${experiment}/manifest.json`));
+
+  const experiments = await Promise.all(manifestUrls);
+  const variants = (await Promise.all(experiments.map((e) => e.json().catch(() => {}))))
+    .filter((json) => json && Object.keys(json).length > 0)
+    .flatMap((json) => json.experiences?.data ?? [])
+    .filter((data) => data.Name === 'Pages');
+
+  const mapping = variants.reduce((acc, cur) => {
+    Object.entries(cur)
+      .filter(([k]) => !['Name', 'Control'].includes(k))
+      .forEach(([, v]) => {
+        acc[new URL(v).pathname] = new URL(cur.Control).pathname;
+      });
+    return acc;
+  }, {});
+
+  const variantPaths = Object.keys(mapping);
+
+  const getControlPath = (url) => {
+    const path = new URL(url).pathname;
+    if (variantPaths.includes(path)) return mapping[path];
+    return path;
+  };
+
+  const byIdAndPath = bundles.reduce((acc, cur) => {
+    const controlPath = getControlPath(cur.url);
+    const key = `${cur.id}-${controlPath}`;
+    if (!acc[key]) acc[key] = [];
+    if (variantPaths.includes(new URL(cur.url).pathname)) {
+      // eslint-disable-next-line no-param-reassign
+      cur.url = new URL(controlPath, cur.url).href;
+    }
+    acc[key].push(cur);
+    return acc;
+  }, {});
+
+  const merged = Object.entries(byIdAndPath).flatMap(([, v]) => {
+    let value = v;
+    if (v.length > 1) {
+      v[0].events.push(...v.slice(1).flatMap((bundle) => bundle.events));
+      value = [v[0]];
+    }
+    return value;
+  });
+
+  return Object.values(merged);
+}
+/* c8 ignore end */
+
+async function handler(bundles) {
+  const merged = await mergeBundlesWithSameId(bundles);
+  const trafficSources = merged
     .map(extractHints)
     .map((row) => {
       const {
@@ -69,5 +143,5 @@ function handler(bundles) {
 
 export default {
   handler,
-  checkpoints: ['email', 'enter', 'paid', 'utm'],
+  checkpoints: ['email', 'enter', 'paid', 'utm', 'experiment'],
 };