Analytics: update error message and code in events

Author: tanguyenvn

packages/modal/src/modalManager.ts

@@ -15,6 +15,7 @@ import {
   CONNECTOR_STATUS,
   fetchProjectConfig,
   fetchWalletRegistry,
+  getErrorAnalyticsProperties,
   type IConnector,
   type IProvider,
   type IWeb3AuthCoreOptions,
@@ -28,7 +29,6 @@ import {
   WALLET_CONNECTORS,
   WalletInitializationError,
   type WalletRegistry,
-  Web3AuthError,
   Web3AuthNoModal,
   withAbort,
 } from "@web3auth/no-modal";
@@ -154,14 +154,13 @@ export class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal {
       if (error instanceof DOMException && error.name === "AbortError") return;
 
       // track failure event
-      const serializedError = await serializeError(error);
       this.analytics.track(ANALYTICS_EVENTS.SDK_INITIALIZATION_FAILED, {
         ...trackData,
+        ...getErrorAnalyticsProperties(error),
         duration: Date.now() - startTime,
-        error_code: error instanceof Web3AuthError ? error.code : undefined,
-        error_message: serializedError.message,
       });
       log.error("Failed to initialize modal", error);
+      throw error;
     }
   }
 

packages/no-modal/src/base/analytics.ts

@@ -2,7 +2,7 @@ import { AnalyticsBrowser, type EventProperties, type UserTraits } from "@segmen
 
 import { log } from "./loglevel";
 
-const SEGMENT_WRITE_KEY = "gGjtk5XxaH2OAIlErcBgydrHpoRZ2hkZ"; // TODO: use the production key
+const SEGMENT_WRITE_KEY = "rpE5pCcpA6ME2oFu2TbuVydhOXapjHs3"; // TODO: this is dev key, use the production key
 
 export class Analytics {
   private segment: AnalyticsBrowser;
@@ -93,7 +93,7 @@ export const ANALYTICS_EVENTS = {
   MFA_ENABLEMENT_STARTED: "MFA Enablement Started",
   MFA_ENABLEMENT_COMPLETED: "MFA Enablement Completed",
   MFA_ENABLEMENT_FAILED: "MFA Enablement Failed",
-  MFA_MANAGEMENT_STARTED: "MFA Management Started",
+  MFA_MANAGEMENT_SELECTED: "MFA Management Selected",
   MFA_MANAGEMENT_FAILED: "MFA Management Failed",
   LOGIN_MODAL_OPENED: "Login Modal Opened",
   LOGIN_MODAL_CLOSED: "Login Modal Closed",

packages/no-modal/src/base/utils.ts

@@ -8,6 +8,7 @@ import { type Chain } from "viem";
 import { type CustomChainConfig } from "./chain/IChainInterface";
 import { WEB3AUTH_NETWORK, type WEB3AUTH_NETWORK_TYPE } from "./connector";
 import { type UIConfig, type WalletServicesConfig } from "./core/IWeb3Auth";
+import { Web3AuthError } from "./errors";
 import type { ProjectConfig, WalletRegistry } from "./interfaces";
 
 export const isHexStrict = (hex: string): boolean => {
@@ -161,3 +162,13 @@ export const getWalletServicesAnalyticsProperties = (walletServicesConfig?: Wall
 };
 
 export const sdkVersion = process.env.WEB3AUTH_VERSION;
+
+export const getErrorAnalyticsProperties = (error: unknown): { error_message?: string; error_code?: number } => {
+  try {
+    const code = error instanceof Web3AuthError ? error.code : (error as { code?: number })?.code;
+    const message = error instanceof Error ? error.message : (error as { message?: string })?.message || error?.toString();
+    return { error_message: message, error_code: code };
+  } catch {
+    return { error_message: "Unknown error", error_code: undefined };
+  }
+};

packages/no-modal/src/noModal.ts

@@ -19,6 +19,7 @@ import {
   type CustomChainConfig,
   fetchProjectConfig,
   getAaAnalyticsProperties,
+  getErrorAnalyticsProperties,
   getWalletServicesAnalyticsProperties,
   getWhitelabelAnalyticsProperties,
   type IBaseProvider,
@@ -220,14 +221,13 @@ export class Web3AuthNoModal extends SafeEventEmitter<Web3AuthNoModalEvents> imp
       if (error instanceof DOMException && error.name === "AbortError") return;
 
       // track failure event
-      const serializedError = await serializeError(error);
       this.analytics.track(ANALYTICS_EVENTS.SDK_INITIALIZATION_FAILED, {
         ...trackData,
+        ...getErrorAnalyticsProperties(error),
         duration: Date.now() - startTime,
-        error_code: error instanceof Web3AuthError ? error.code : undefined,
-        error_message: serializedError.message,
       });
       log.error("Failed to initialize modal", error);
+      throw error;
     }
   }
 
@@ -337,11 +337,9 @@ export class Web3AuthNoModal extends SafeEventEmitter<Web3AuthNoModalEvents> imp
       });
       this.once(CONNECTOR_EVENTS.ERRORED, async (err) => {
         // track connection failed event
-        const serializedError = await serializeError(err);
         this.analytics.track(ANALYTICS_EVENTS.CONNECTION_FAILED, {
           ...eventData,
-          error_code: err instanceof Web3AuthError ? err.code : undefined,
-          error_message: serializedError.message,
+          ...getErrorAnalyticsProperties(err),
           duration: Date.now() - startTime,
         });
         reject(err);
@@ -373,11 +371,9 @@ export class Web3AuthNoModal extends SafeEventEmitter<Web3AuthNoModalEvents> imp
       this.analytics.track(ANALYTICS_EVENTS.MFA_ENABLEMENT_STARTED, trackData);
       await this.connectedConnector.enableMFA(loginParams);
     } catch (error) {
-      const serializedError = await serializeError(error);
       this.analytics.track(ANALYTICS_EVENTS.MFA_ENABLEMENT_FAILED, {
         ...trackData,
-        error_code: error instanceof Web3AuthError ? error.code : undefined,
-        error_message: serializedError.message,
+        ...getErrorAnalyticsProperties(error),
       });
       throw error;
     }
@@ -391,14 +387,12 @@ export class Web3AuthNoModal extends SafeEventEmitter<Web3AuthNoModalEvents> imp
     const authConnector = this.connectedConnector as AuthConnectorType;
     const trackData = { connector: this.connectedConnector.name, auth_ux_mode: authConnector.authInstance?.options?.uxMode };
     try {
-      this.analytics.track(ANALYTICS_EVENTS.MFA_MANAGEMENT_STARTED, trackData);
+      this.analytics.track(ANALYTICS_EVENTS.MFA_MANAGEMENT_SELECTED, trackData);
       await this.connectedConnector.manageMFA(loginParams);
     } catch (error) {
-      const serializedError = await serializeError(error);
       this.analytics.track(ANALYTICS_EVENTS.MFA_MANAGEMENT_FAILED, {
         ...trackData,
-        error_code: error instanceof Web3AuthError ? error.code : undefined,
-        error_message: serializedError.message,
+        ...getErrorAnalyticsProperties(error),
       });
       throw error;
     }
@@ -414,11 +408,9 @@ export class Web3AuthNoModal extends SafeEventEmitter<Web3AuthNoModalEvents> imp
       this.analytics.track(ANALYTICS_EVENTS.IDENTITY_TOKEN_COMPLETED, trackData);
       return identityToken;
     } catch (error) {
-      const serializedError = await serializeError(error);
       this.analytics.track(ANALYTICS_EVENTS.IDENTITY_TOKEN_FAILED, {
         ...trackData,
-        error_code: error instanceof Web3AuthError ? error.code : undefined,
-        error_message: serializedError.message,
+        ...getErrorAnalyticsProperties(error),
       });
       throw error;
     }