@ada-support/embed2 1.7.8 → 1.7.9

package/dist/npm-entry/client/helpers/rollout.d.ts

@@ -1 +1,14 @@
+/** The logic below determines whether or not the chat button is visible if the rollout is not 100%
+ * GROUP A - DOES NOT SEE CHAT BUTTON
+ * GROUP B - SEE'S CHAT BUTTON
+ *
+ * First we check if the rollout is either 100% or 0%. In either of these cases we do not need to check the probability score to determine their grouping.
+ * - If the rollout is 100% we put the user in group B and they see the button.
+ * - If the rollout is 0% we put the user in group A and they do not see the button.
+ * - If the rollout is between 0% and 100% we need to check the probability score to determine their grouping and store the result.
+ *
+ * - If the user has not been put in a group yet we need to put them in a group and store the result.
+ * - If the user has already been put in a group and the rollout has not changed we do not need to move them.
+ * - If the user has already been put in a group and the rollout has changed we need to check if they should be moved to the other group and store the result.
+ */
 export declare function checkRollout(rollout: number, handle: string): boolean;

package/dist/npm-entry/index.js

@@ -13260,7 +13260,7 @@ const client = new error_tracker_BrowserClient({
     return event;
   },
   environment: "production",
-  release: "1.7.8-eceb93f",
+  release: "1.7.9-9921e9b",
   sampleRate: 0.25,
   autoSessionTracking: false,
   // Integrations don't seem to work with Sentry: https://github.com/getsentry/sentry-javascript/issues/2541
@@ -13832,7 +13832,7 @@ function getEmbedURL(_ref) {
   } else {
     host = `http://${handle}.localhost:9001`;
   }
-  return `${host}/embed/${frameName}/${"eceb93f"}/index.html`;
+  return `${host}/embed/${frameName}/${"9921e9b"}/index.html`;
 }
 function constructQueryString(query) {
   return Object.keys(query).map(key => {
@@ -14993,9 +14993,9 @@ async function log(message, extra, options) {
       service: "embed",
       env: "production",
       embedVersion: 2,
-      version: "1.7.8",
+      version: "1.7.9",
       isNpm: true,
-      commitHash: "eceb93f"
+      commitHash: "9921e9b"
     }))
   });
 }
@@ -15221,6 +15221,7 @@ function unbindLocationChangeOverrides() {
 function rollout_ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function rollout_objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? rollout_ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : rollout_ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 
+
 function storeRollout(handle, group, lastProb) {
   dist/* adaLocalStorage.setFnItem */.wG.setFnItem("rolloutGroup", rollout_objectSpread(rollout_objectSpread({}, dist/* adaLocalStorage.getFnItem */.wG.getFnItem("rolloutGroup")), {}, {
     [handle]: group
@@ -15245,64 +15246,71 @@ function readRollout(handle) {
   rollout.lastProb = (dist/* adaLocalStorage.getFnItem */.wG.getFnItem("rolloutLastValue") || {})[handle] || null;
   return rollout;
 }
+
+/** The logic below determines whether or not the chat button is visible if the rollout is not 100%
+ * GROUP A - DOES NOT SEE CHAT BUTTON
+ * GROUP B - SEE'S CHAT BUTTON
+ *
+ * First we check if the rollout is either 100% or 0%. In either of these cases we do not need to check the probability score to determine their grouping.
+ * - If the rollout is 100% we put the user in group B and they see the button.
+ * - If the rollout is 0% we put the user in group A and they do not see the button.
+ * - If the rollout is between 0% and 100% we need to check the probability score to determine their grouping and store the result.
+ *
+ * - If the user has not been put in a group yet we need to put them in a group and store the result.
+ * - If the user has already been put in a group and the rollout has not changed we do not need to move them.
+ * - If the user has already been put in a group and the rollout has changed we need to check if they should be moved to the other group and store the result.
+ */
 function checkRollout(rollout, handle) {
-  if (rollout >= 0 && rollout <= 1) {
-    // We should first check the storage to see if this user is already grouped
-    const rg = readRollout(handle);
-    const rand = Math.random();
-    if (rg.group === null || rg.lastProb === 0) {
-      // No group assigned yet
-      // A is control (does not see button)
-      // B is variant (sees chat button)
-      const roll = rand <= rollout;
-      const group = roll ? "B" : "A";
-      storeRollout(handle, group, rollout);
-      return roll;
-    }
-    if (rg.group === "A" || rg.group === "B") {
-      // Check to see if the remote rollout probability has changed from the last time it was set
-      if (rg.lastProb !== null && rg.lastProb !== rollout) {
-        // Probability has changed since the last time it was set
-        // Use Gordon's function to determine who should move where
-        if (rollout === 0) {
-          // Move all B's to group A
-          storeRollout(handle, "A", 0);
-          return false;
-        }
-        if (rollout === 1) {
-          // Move all A's to group B
-          storeRollout(handle, "B", 1);
-          return true;
-        }
-        if (rollout < rg.lastProb) {
-          // DOWNGRADE CASE
-          // If you are in group B you now could be moved to group A
-          if (rg.group === "B") {
-            const adjustedProb = 1 - rollout / rg.lastProb;
-            const shouldMove = rand <= adjustedProb;
-            const group = shouldMove ? "B" : "A";
-            storeRollout(handle, group, rollout);
-            return shouldMove;
-          }
-        } else if (rollout > rg.lastProb) {
-          // UPGRADE CASE
-          // If you are in group A, you now have an opportunity to become group B
-          if (rg.group === "A") {
-            const adjustedProb = 1 - rg.lastProb / rollout;
-            const shouldMove = rand <= adjustedProb;
-            const group = shouldMove ? "B" : "A";
-            storeRollout(handle, group, rollout);
-            return shouldMove;
-          }
-        }
-      } else {
-        // Probability is the same as before.
-        return rg.group === "B";
-      }
-    }
+  // Get current rollout percentage in browser storage
+  const userRolloutGroup = readRollout(handle);
+
+  // If somehow the rollout doesn't fall within the 0% to 100% range - just show the button
+  if (rollout < 0 || rollout > 1) {
+    warn("Rollout value must be between 0 and 1 - defaulting to 1");
+    return true;
+  }
+
+  // If rollout is 1 or 0 - just check if we should show the button or not and store the result
+  // This also acts as a reset if someone accidentally gets put in group A but the rollout changed to
+  // 100% - they will now be put in group B
+  if (rollout === 1 || rollout === 0) {
+    const group = rollout ? "B" : "A";
+    storeRollout(handle, group, rollout);
+    return group === "B";
+  }
+
+  // If the user has already been put in a group and it hasn't changed - don't move them
+  if (rollout === userRolloutGroup.lastProb) {
+    return userRolloutGroup.group === "B";
+  }
+
+  // Generate a random number to test against the probability score
+  const rand = Math.random();
+
+  // If the user has not been put in a group yet - test against the probability score to determine their group and assign it to them
+  if (userRolloutGroup.group === null || userRolloutGroup.lastProb === 0) {
+    const roll = rand <= rollout;
+    const group = roll ? "B" : "A";
+    storeRollout(handle, group, rollout);
+    return roll;
+  }
+
+  // If we got here the rollout value has changed and is either higher or lower than the previous value
+  if (userRolloutGroup.lastProb !== null && rollout > 0) {
+    // If the rollout is higher than previous we want to test against the probability score to see if they get upgraded to group B
+    // If the rollout is lower than previous we want to test against the probability score to see if they get downgraded to group A
+    const adjustedProb = rollout > userRolloutGroup.lastProb ? 1 - userRolloutGroup.lastProb / rollout // This is the math to see if the user gets upgraded to group B
+    : 1 - rollout / userRolloutGroup.lastProb; // This is the math to see if the user gets downgraded to group A
+
+    // If the random number is less than or equal to the adjusted probability score - we will upgrade the user to group B, otherwise they will go to group A
+    const shouldBeVisible = rand <= adjustedProb;
+    const group = shouldBeVisible ? "B" : "A";
+    storeRollout(handle, group, rollout);
+    return shouldBeVisible;
   }
 
-  // Default to being on just in case of unforeseen failure cases
+  // If all else fails show the button
+  warn("Unable to detemrine rollout group - defaulting to showing chat button");
   return true;
 }
 ;// CONCATENATED MODULE: ./src/client/helpers/web-notifications/web-notification-events.ts
@@ -16016,7 +16024,7 @@ class ChatFrame extends d {
     const hostPageUrlParams = new URL(window.location.href).searchParams;
     const smsToken = hostPageUrlParams.get("adaSMSToken");
     const queryParams = {
-      embedVersion: "eceb93f".slice(0, 7),
+      embedVersion: "9921e9b".slice(0, 7),
       greeting,
       language,
       skipGreeting,
@@ -17575,7 +17583,8 @@ class Container extends d {
       return;
     }
     const primaryBotClient = new Client(clientResponse.client);
-    const shouldHideEmbedButton = !checkRollout(rolloutOverride || primaryBotClient.rollout, primaryBotClient.handle);
+    const rolloutPercentage = rolloutOverride !== undefined ? rolloutOverride : primaryBotClient.rollout;
+    const shouldHideEmbedButton = !checkRollout(rolloutPercentage, primaryBotClient.handle);
 
     // if there is a bot override handle in the URL, we should ignore the primary rollout which determines whether any embed button is shown
     if (shouldHideEmbedButton && !getBotOverrideHandleFromWebpageURL()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ada-support/embed2",
-  "version": "1.7.8",
+  "version": "1.7.9",
   "description": "",
   "main": "dist/npm-entry",
   "typings": "dist/npm-entry/index-npm.d.ts",