feat(analytics): setup analytics client + add some trackEvents

Author: ecp4224

packages/analytics-client/src/v2/client.ts

@@ -84,8 +84,6 @@ export type BaseAnalyticsProps = {
     id: string;
     originatorInfo?: OriginatorInfo; // Now uses local type
     sdkVersion?: string;
-    commLayerVersion?: string;
-    walletVersion?: string;
     // TODO What is this?
     anonId: string;
 };

packages/sdk-communication-layer/src/services/RemoteCommunication/ConnectionManager/rejectChannel.ts

@@ -1,6 +1,6 @@
 // packages/sdk-communication-layer/src/services/RemoteCommunication/ConnectionManager/connectToChannel.ts
 import { validate } from 'uuid';
-import { SendAnalytics } from '@metamask/analytics-client';
+import { SendAnalytics, trackEvent } from '@metamask/analytics-client';
 import { TrackingEvents } from '@metamask/sdk-types';
 import { RemoteCommunicationState } from '../../../RemoteCommunication';
 import { EventType } from '../../../types/EventType';
@@ -47,6 +47,11 @@ export async function rejectChannel({
   }
 
   // Send analytics event
+  trackEvent({
+    name: 'sdk_connection_rejected',
+    transport_type: 'websocket',
+  });
+  
   SendAnalytics(
     {
       id: channelId,

packages/sdk-communication-layer/src/services/RemoteCommunication/EventListeners/handleClientsConnectedEvent.ts

@@ -1,4 +1,4 @@
-import { SendAnalytics } from '@metamask/analytics-client';
+import { SendAnalytics, trackEvent } from '@metamask/analytics-client';
 import { TrackingEvents } from '@metamask/sdk-types';
 import packageJson from '../../../../package.json';
 import { RemoteCommunication } from '../../../RemoteCommunication';
@@ -28,6 +28,19 @@ export function handleClientsConnectedEvent(instance: RemoteCommunication) {
     );
 
     if (state.analytics && state.channelId) {
+
+      if (!state.isOriginator) {
+        trackEvent({
+          name: 'sdk_connection_established',
+          transport_type: 'websocket',
+        })
+      } else {
+        trackEvent({
+          name: 'wallet_connection_request_received',
+          platform: 'mobile',
+        })
+      }
+      
       SendAnalytics(
         {
           id: state.channelId,

packages/sdk-communication-layer/src/services/RemoteCommunication/EventListeners/handleKeysExchangedEvent.ts

@@ -1,4 +1,4 @@
-import { SendAnalytics } from '@metamask/analytics-client';
+import { SendAnalytics, trackEvent } from '@metamask/analytics-client';
 import { type OriginatorInfo, TrackingEvents } from '@metamask/sdk-types';
 import packageJson from '../../../../package.json';
 import { DEFAULT_SESSION_TIMEOUT_MS } from '../../../config';
@@ -63,6 +63,18 @@ export function handleKeysExchangedEvent(instance: RemoteCommunication) {
     setLastActiveDate(instance, new Date());
 
     if (state.analytics && state.channelId) {
+      if (state.isOriginator) {
+        trackEvent({
+          name: 'wallet_connection_user_approved',
+          platform: 'mobile',
+        })
+      } else {
+        trackEvent({
+          name: 'sdk_connection_established',
+          transport_type: 'websocket',
+        })
+      }
+        
       SendAnalytics(
         {
           id: state.channelId,

packages/sdk-communication-layer/src/services/SocketService/ConnectionManager/handleJoinChannelResult.ts

@@ -1,4 +1,4 @@
-import { SendAnalytics } from '@metamask/analytics-client';
+import { SendAnalytics, trackEvent } from '@metamask/analytics-client';
 import { TrackingEvents } from '@metamask/sdk-types';
 import { SocketService } from '../../../SocketService';
 import { EventType } from '../../../types/EventType';
@@ -102,6 +102,18 @@ export const handleJoinChannelResults = async (
     remote.state.authorized = true;
     remote.emit(EventType.AUTHORIZED);
 
+    if (isOriginator) {
+      trackEvent({
+        name: 'wallet_connection_user_approved',
+        platform: 'mobile',
+      })
+    } else {
+      trackEvent({
+        name: 'sdk_connection_established',
+        transport_type: 'websocket',
+      })
+    }
+
     SendAnalytics(
       {
         id: channelId ?? '',

packages/sdk-communication-layer/src/services/SocketService/EventListeners/handleChannelRejected.ts

@@ -1,4 +1,4 @@
-import { SendAnalytics } from '@metamask/analytics-client';
+import { SendAnalytics, trackEvent } from '@metamask/analytics-client';
 import { TrackingEvents } from '@metamask/sdk-types';
 import { SocketService } from '../../../SocketService';
 import { ConnectionStatus } from '../../../types/ConnectionStatus';
@@ -32,6 +32,11 @@ export function handleChannelRejected(
       instance.remote.state.originatorInfo,
     );
 
+    trackEvent({
+      name: 'wallet_connection_user_rejected',
+      platform: 'mobile',
+    })
+
     // Emit analytics event
     SendAnalytics(
       {

packages/sdk-communication-layer/src/services/SocketService/EventListeners/handleMessage.ts

@@ -1,4 +1,4 @@
-import { SendAnalytics } from '@metamask/analytics-client';
+import { SendAnalytics, trackEvent } from '@metamask/analytics-client';
 import { TrackingEvents } from '@metamask/sdk-types';
 import packageJson from '../../../../package.json';
 import { SocketService } from '../../../SocketService';
@@ -212,6 +212,11 @@ export function handleMessage(instance: SocketService, channelId: string) {
           instance.remote.state.analytics &&
           lcLogguedRPCs.includes(initialRPCMethod.method.toLowerCase())
         ) {
+          trackEvent({
+            name: 'sdk_action_succeeded',
+            action: initialRPCMethod.method,
+          })
+
           SendAnalytics(
             {
               id: instance.remote.state.channelId ?? '',

packages/sdk-communication-layer/src/services/SocketService/MessageHandlers/handleSendMessage.ts

@@ -1,5 +1,5 @@
 import { TrackingEvents } from '@metamask/sdk-types';
-import { SendAnalytics } from '@metamask/analytics-client';
+import { SendAnalytics, trackEvent } from '@metamask/analytics-client';
 import { SocketService } from '../../../SocketService';
 import { CommunicationLayerMessage } from '../../../types/CommunicationLayerMessage';
 import { logger } from '../../../utils/logger';
@@ -74,6 +74,10 @@ export async function handleSendMessage(
       message.method &&
       lcLogguedRPCs.includes(message.method.toLowerCase())
     ) {
+      trackEvent({
+        name: 'sdk_action_requested',
+        action: message.method,
+      })
       SendAnalytics(
         {
           id: instance.remote.state.channelId ?? '',

packages/sdk/src/services/MetaMaskSDK/InitializerManager/setupAnalytics.ts

@@ -2,6 +2,7 @@ import { DEFAULT_SERVER_URL } from '@metamask/sdk-communication-layer';
 import { type OriginatorInfo } from '@metamask/sdk-types';
 import { Analytics } from '../../Analytics';
 import { MetaMaskSDK } from '../../../sdk';
+import { initAnalyticsClient } from '@metamask/analytics-client';
 
 /**
  * Sets up the analytics instance for the MetaMask SDK.
@@ -34,4 +35,14 @@ export async function setupAnalytics(instance: MetaMaskSDK) {
     enabled: options.enableAnalytics,
     originatorInfo: originator,
   });
+
+  initAnalyticsClient({
+    originatorInfo: originator,
+    sdkVersion: instance.getVersion(),
+    // TODO Set ID and anonId
+    id: 'TODO: SET ID',
+    anonId: 'TODO: SET ANON ID',
+    pushInterval: 1000,
+    analyticsUrl: options.communicationServerUrl ?? DEFAULT_SERVER_URL,
+  });
 }