@ada-support/embed2 1.12.3 → 1.12.4

package/dist/npm-entry/common/helpers/host-telemetry.d.ts

@@ -0,0 +1,22 @@
+import type { StartOptions } from "@ada-support/embed-types";
+export type HostTelemetrySurface = "mobile" | "browser";
+export type HostTelemetryPlatform = "ios" | "android" | "react_native" | "web" | "unknown";
+export type HostTelemetryWebSdkOrigin = "legacy" | "messaging";
+export interface HostTelemetryContext {
+    surface: HostTelemetrySurface;
+    hostPlatform: HostTelemetryPlatform;
+    webSdkOrigin: HostTelemetryWebSdkOrigin;
+    mobilePackage?: string;
+    sdkVariant?: string;
+}
+export declare const HOST_TELEMETRY_QUERY_PARAM = "ada_host_telemetry";
+type StartOptionsWithHostTelemetry = StartOptions & {
+    hostTelemetry?: unknown;
+};
+export declare function resolveHostTelemetryFromStartOptions(adaSettings: StartOptionsWithHostTelemetry, options?: {
+    pathname?: string;
+}): HostTelemetryContext;
+export declare function serializeHostTelemetry(hostTelemetry: HostTelemetryContext): string;
+export declare function shouldPropagateHostTelemetry(hostTelemetry: HostTelemetryContext): boolean;
+export declare function toMonitoringContext(hostTelemetry: HostTelemetryContext): Record<string, string>;
+export {};

package/dist/npm-entry/index.js

@@ -15919,7 +15919,7 @@ const client = new BrowserClient({
     return event;
   },
   environment: "production",
-  release: "1.12.3-84129bb",
+  release: "1.12.4-1c18649",
   sampleRate: 0.25,
   autoSessionTracking: false,
   // Integrations don't seem to work with Sentry: https://github.com/getsentry/sentry-javascript/issues/2541
@@ -16502,7 +16502,7 @@ function getEmbedURL(_ref) {
   } else {
     host = `http://${handle}.localhost:9001`;
   }
-  return `${host}/embed/${frameName}/${"84129bb"}/index.html`;
+  return `${host}/embed/${frameName}/${"1c18649"}/index.html`;
 }
 function constructQueryString(query) {
   return Object.keys(query).map(key => {
@@ -17656,6 +17656,13 @@ function logger_objectSpread(e) { for (var r = 1; r < arguments.length; r++) { v
 const DEFAULT_LOG_SAMPLE_RATE = 0.01;
 const DD_BASE_URL = "https://browser-http-intake.logs.datadoghq.com/v1/input/";
 const DD_TOKEN = "pubfe23baedd2ea322bebb5ed2020fa2fa1";
+let globalLogContext = {};
+function setGlobalLogContext(context) {
+  globalLogContext = logger_objectSpread({}, context);
+}
+function clearGlobalLogContext() {
+  globalLogContext = {};
+}
 
 // We need memoization to ensure consistency of logs
 const shouldLog = lodash_memoize_default()(sampleRate => {
@@ -17675,17 +17682,17 @@ async function log(message, extra, options) {
   await httpRequest({
     url: `${DD_BASE_URL}${DD_TOKEN}?ddsource=browser&ddtags=version:1.5.0,env:${"production"}`,
     method: "POST",
-    body: JSON.stringify(logger_objectSpread(logger_objectSpread({
+    body: JSON.stringify(logger_objectSpread(logger_objectSpread(logger_objectSpread({
       message
-    }, extra), {}, {
+    }, extra), globalLogContext), {}, {
       level: (options === null || options === void 0 ? void 0 : options.level) || "info",
       sampleRate: (options === null || options === void 0 ? void 0 : options.sampleRate) || DEFAULT_LOG_SAMPLE_RATE,
       service: "embed",
       env: "production",
       embedVersion: 2,
-      version: "1.12.3",
+      version: "1.12.4",
       isNpm: true,
-      commitHash: "84129bb"
+      commitHash: "1c18649"
     }))
   });
 }
@@ -19072,6 +19079,134 @@ class LightboxOverlay extends preact_module_d {
 const ANIMATION_DELAY = 50;
 const CHAT_FRAME_TIMEOUT_EVENT_MS = 5000;
 const CHAT_FALLBACK_DELAY_MS = 10000;
+;// CONCATENATED MODULE: ./src/common/helpers/host-telemetry.ts
+
+function host_telemetry_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 host_telemetry_objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? host_telemetry_ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : host_telemetry_ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+const HOST_TELEMETRY_QUERY_PARAM = "ada_host_telemetry";
+const TRUSTED_MOBILE_SDK_PATH = "/mobile-sdk-webview/";
+const MAX_TELEMETRY_TAG_LENGTH = 100;
+const TELEMETRY_TAG_VALUE_PATTERN = /^[a-z0-9_-]+$/;
+
+// Private mobile-sdk handshake used only on the trusted /mobile-sdk-webview/ page.
+
+// Keep this normalization logic in sync with
+// chat/src/shared/services/host-telemetry.ts. Both sides normalize across the
+// embed/chat iframe boundary on purpose.
+function asRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value) ? value : null;
+}
+function normalizeSurface(value) {
+  if (value === "mobile" || value === "browser") {
+    return value;
+  }
+  return undefined;
+}
+function normalizeHostPlatform(value) {
+  if (typeof value !== "string") {
+    return undefined;
+  }
+  switch (value.trim().toLowerCase()) {
+    case "ios":
+      return "ios";
+    case "android":
+      return "android";
+    case "react_native":
+    case "reactnative":
+      return "react_native";
+    case "web":
+      return "web";
+    case "unknown":
+      return "unknown";
+    default:
+      return undefined;
+  }
+}
+function normalizeOrigin(value) {
+  if (value === "legacy" || value === "messaging") {
+    return value;
+  }
+  return undefined;
+}
+function normalizeTelemetryTagValue(value) {
+  if (typeof value !== "string") {
+    return undefined;
+  }
+  const normalizedValue = value.trim().toLowerCase();
+  if (!normalizedValue || normalizedValue.length > MAX_TELEMETRY_TAG_LENGTH || !TELEMETRY_TAG_VALUE_PATTERN.test(normalizedValue)) {
+    return undefined;
+  }
+  return normalizedValue;
+}
+function deriveSdkVariant(mobilePackage, webSdkOrigin) {
+  if (!mobilePackage || !webSdkOrigin) {
+    return undefined;
+  }
+  return `${mobilePackage}-${webSdkOrigin}`;
+}
+function normalizeHostTelemetry(value) {
+  const record = asRecord(value);
+  if (!record) {
+    return undefined;
+  }
+  const surface = normalizeSurface(record.surface);
+  const hostPlatform = normalizeHostPlatform(record.hostPlatform);
+  const webSdkOrigin = normalizeOrigin(record.webSdkOrigin);
+  const mobilePackage = normalizeTelemetryTagValue(record.mobilePackage);
+  if (!surface || !hostPlatform || !webSdkOrigin) {
+    return undefined;
+  }
+  const sdkVariant = normalizeTelemetryTagValue(record.sdkVariant) ?? deriveSdkVariant(mobilePackage, webSdkOrigin);
+  return host_telemetry_objectSpread(host_telemetry_objectSpread({
+    surface,
+    hostPlatform,
+    webSdkOrigin
+  }, mobilePackage ? {
+    mobilePackage
+  } : {}), sdkVariant ? {
+    sdkVariant
+  } : {});
+}
+function isTrustedMobileSdkHostPage() {
+  let pathname = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : window.location.pathname;
+  return pathname === TRUSTED_MOBILE_SDK_PATH || pathname === TRUSTED_MOBILE_SDK_PATH.slice(0, -1);
+}
+function resolveHostTelemetryFromStartOptions(adaSettings) {
+  let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  const trustedMobileSdkHostPage = isTrustedMobileSdkHostPage(options.pathname);
+  const explicit = trustedMobileSdkHostPage ? normalizeHostTelemetry(adaSettings.hostTelemetry) : undefined;
+  const webSdkOrigin = (explicit === null || explicit === void 0 ? void 0 : explicit.webSdkOrigin) ?? "legacy";
+  const hostPlatform = (explicit === null || explicit === void 0 ? void 0 : explicit.hostPlatform) ?? (trustedMobileSdkHostPage ? "unknown" : "web");
+  const surface = (explicit === null || explicit === void 0 ? void 0 : explicit.surface) ?? (trustedMobileSdkHostPage ? "mobile" : "browser");
+  const mobilePackage = explicit === null || explicit === void 0 ? void 0 : explicit.mobilePackage;
+  const sdkVariant = explicit === null || explicit === void 0 ? void 0 : explicit.sdkVariant;
+  return host_telemetry_objectSpread(host_telemetry_objectSpread({
+    surface,
+    hostPlatform,
+    webSdkOrigin
+  }, mobilePackage ? {
+    mobilePackage
+  } : {}), sdkVariant ? {
+    sdkVariant
+  } : {});
+}
+function serializeHostTelemetry(hostTelemetry) {
+  return JSON.stringify(hostTelemetry);
+}
+function shouldPropagateHostTelemetry(hostTelemetry) {
+  return hostTelemetry.surface !== "browser" || hostTelemetry.hostPlatform !== "web" || hostTelemetry.webSdkOrigin !== "legacy" || Boolean(hostTelemetry.mobilePackage) || Boolean(hostTelemetry.sdkVariant);
+}
+function toMonitoringContext(hostTelemetry) {
+  return host_telemetry_objectSpread(host_telemetry_objectSpread({
+    surface: hostTelemetry.surface,
+    host_platform: hostTelemetry.hostPlatform,
+    web_sdk_origin: hostTelemetry.webSdkOrigin
+  }, hostTelemetry.mobilePackage ? {
+    mobile_package: hostTelemetry.mobilePackage
+  } : {}), hostTelemetry.sdkVariant ? {
+    sdk_variant: hostTelemetry.sdkVariant
+  } : {});
+}
 ;// CONCATENATED MODULE: ./src/common/helpers/is-mobile.ts
 const isMobile = /(iPhone)|(iPod)|(android)|(webOS)/i.exec(navigator.userAgent) !== null;
 ;// CONCATENATED MODULE: ./src/client/components/ChatFrame/chatFrameEvents/chatterEvent/index.ts
@@ -19242,6 +19377,7 @@ function getFallbackDataURI() {
 
 
 
+
 
 class ChatFrame extends preact_module_d {
   constructor() {
@@ -19292,7 +19428,7 @@ class ChatFrame extends preact_module_d {
     log("Chat frame mount", {
       handle,
       chatUrl: this.url,
-      embedVersion: "84129bb".slice(0, 7),
+      embedVersion: "1c18649".slice(0, 7),
       embedSettings: adaSettings
     });
 
@@ -19380,7 +19516,7 @@ class ChatFrame extends preact_module_d {
     const hostPageUrlParams = new URL(window.location.href).searchParams;
     const smsToken = hostPageUrlParams.get("adaSMSToken");
     const queryParams = {
-      embedVersion: "84129bb".slice(0, 7),
+      embedVersion: "1c18649".slice(0, 7),
       greeting,
       language,
       skipGreeting,
@@ -19390,6 +19526,10 @@ class ChatFrame extends preact_module_d {
       test_user: testMode ? 1 : null,
       align: getAlignment(adaSettings)
     };
+    const hostTelemetry = resolveHostTelemetryFromStartOptions(adaSettings);
+    if (shouldPropagateHostTelemetry(hostTelemetry)) {
+      queryParams[HOST_TELEMETRY_QUERY_PARAM] = serializeHostTelemetry(hostTelemetry);
+    }
     if (smsToken) {
       queryParams.adaSMSToken = smsToken;
     }
@@ -21688,6 +21828,7 @@ function createEmbed(adaSettings) {
 
 
 
+
 const EMBED_NOT_INITIALIZED_ERROR = new AdaEmbedError("Actions cannot be called until Embed has been instantiated. Try running `adaEmbed.start({...})`.");
 
 /**
@@ -21713,17 +21854,24 @@ function createEmbedInterface() {
       if (embed) {
         throw new AdaEmbedError("Ada Embed has already been started.");
       }
-      embed = createEmbed(adaSettings);
-      if (window.adaEmbedLoadedCallback) {
-        window.adaEmbedLoadedCallback();
+      setGlobalLogContext(toMonitoringContext(resolveHostTelemetryFromStartOptions(adaSettings)));
+      try {
+        embed = createEmbed(adaSettings);
+        if (window.adaEmbedLoadedCallback) {
+          window.adaEmbedLoadedCallback();
+        }
+        log("Embed start", {
+          handle: adaSettings.handle,
+          embedSettings: adaSettings,
+          hostPage: window.location.href,
+          adaScriptURL: (scriptElement => scriptElement ? scriptElement.src : null)(document.getElementById("__ada"))
+        });
+        await embed.initialized;
+      } catch (error) {
+        embed = null;
+        clearGlobalLogContext();
+        throw error;
       }
-      log("Embed start", {
-        handle: adaSettings.handle,
-        embedSettings: adaSettings,
-        hostPage: window.location.href,
-        adaScriptURL: (scriptElement => scriptElement ? scriptElement.src : null)(document.getElementById("__ada"))
-      });
-      return embed.initialized;
     },
     stop: async () => {
       if (!embed) {
@@ -21731,7 +21879,11 @@ function createEmbedInterface() {
       }
       const stopPromise = embed.stop();
       embed = null;
-      return stopPromise;
+      try {
+        await stopPromise;
+      } finally {
+        clearGlobalLogContext();
+      }
     },
     toggle,
     deleteHistory: async () => {

package/dist/npm-entry/services/logger/index.d.ts

@@ -1,4 +1,6 @@
 export declare const DEFAULT_LOG_SAMPLE_RATE = 0.01;
+export declare function setGlobalLogContext(context: Record<string, unknown>): void;
+export declare function clearGlobalLogContext(): void;
 export declare const shouldLog: ((sampleRate?: number) => boolean) & import("lodash").MemoizedFunction;
 /**
  * Sends log to Datadog

package/package.json

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