feat: add analytics events for the login flow

decentraland · Dec 24, 2024 · 718238b · 718238b
1 parent 8514b27
commit 718238b
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 7 deletions.
diff --git a/Explorer/Assets/DCL/AuthenticationScreenFlow/AuthenticationScreenController.cs b/Explorer/Assets/DCL/AuthenticationScreenFlow/AuthenticationScreenController.cs
@@ -79,6 +79,7 @@ private enum ViewState
         public override CanvasOrdering.SortingLayer Layer => CanvasOrdering.SortingLayer.Fullscreen;
 
         public ReactiveProperty<AuthenticationStatus> CurrentState { get; } = new (AuthenticationStatus.Init);
+        public string CurrentRequestID { get; private set; } = string.Empty;
 
         public AuthenticationScreenController(
             ViewFactoryMethod viewFactory,
@@ -251,6 +252,8 @@ async UniTaskVoid StartLoginFlowUntilEndAsync(CancellationToken ct)
             {
                 try
                 {
+                    CurrentRequestID = string.Empty;
+
                     viewInstance!.ConnectingToServerContainer.SetActive(true);
                     viewInstance.LoginButton.interactable = false;
 
@@ -289,9 +292,10 @@ async UniTaskVoid StartLoginFlowUntilEndAsync(CancellationToken ct)
             StartLoginFlowUntilEndAsync(loginCancellationToken.Token).Forget();
         }
 
-        private void ShowVerification(int code, DateTime expiration)
+        private void ShowVerification(int code, DateTime expiration, string requestID)
         {
             viewInstance!.VerificationCodeLabel.text = code.ToString();
+            CurrentRequestID = requestID;
 
             CancelVerificationCountdown();
             verificationCountdownCancellationToken = new CancellationTokenSource();

diff --git a/Explorer/Assets/DCL/PerformanceAndDiagnostics/Analytics/AnalyticsConfiguration.asset b/Explorer/Assets/DCL/PerformanceAndDiagnostics/Analytics/AnalyticsConfiguration.asset
@@ -23,6 +23,8 @@ MonoBehaviour:
       isEnabled: 1
     - eventName: error
       isEnabled: 1
+    - eventName: loading_error
+      isEnabled: 1
   - groupName: Map
     events:
     - eventName: map_jump_in
@@ -85,6 +87,16 @@ MonoBehaviour:
       isEnabled: 1
     - eventName: delete_photo
       isEnabled: 1
+  - groupName: Authentication
+    events:
+    - eventName: logged_in_cached
+      isEnabled: 1
+    - eventName: logged_in
+      isEnabled: 1
+    - eventName: login_requested
+      isEnabled: 1
+    - eventName: verification_requested
+      isEnabled: 1
   useLocalEnvVariableFallback: 0
   flushSize: 20
   flushInterval: 30

diff --git a/Explorer/Assets/DCL/PerformanceAndDiagnostics/Analytics/AnalyticsEvents.cs b/Explorer/Assets/DCL/PerformanceAndDiagnostics/Analytics/AnalyticsEvents.cs
@@ -72,5 +72,13 @@ public static class Livekit
         {
             public const string LIVEKIT_HEALTH_CHECK_FAILED = "livekit_health_check_failed"; // 🔴 - needs testing
         }
+
+        public static class Authentication
+        {
+            public const string LOGGED_IN_CACHED = "logged_in_cached";
+            public const string LOGGED_IN = "logged_in";
+            public const string LOGIN_REQUESTED = "login_requested";
+            public const string VERIFICATION_REQUESTED = "verification_requested";
+        }
     }
 }
diff --git a/...ssets/DCL/PerformanceAndDiagnostics/Analytics/EventBased/AuthenticationScreenAnalytics.cs b/...ssets/DCL/PerformanceAndDiagnostics/Analytics/EventBased/AuthenticationScreenAnalytics.cs
@@ -1,12 +1,14 @@
 using DCL.AuthenticationScreenFlow;
 using Segment.Serialization;
 using System;
+using static DCL.AuthenticationScreenFlow.AuthenticationScreenController;
+using static DCL.PerformanceAndDiagnostics.Analytics.AnalyticsEvents;
 
 namespace DCL.PerformanceAndDiagnostics.Analytics
 {
     public class AuthenticationScreenAnalytics : IDisposable
     {
-        private const string STAGE_KEY = "state";
+        private const string STATE_KEY = "state";
 
         private readonly IAnalyticsController analytics;
         private readonly AuthenticationScreenController authenticationController;
@@ -26,12 +28,35 @@ public void Dispose()
             authenticationController.CurrentState.OnUpdate -= OnAuthenticationScreenStateChanged;
         }
 
-        private void OnAuthenticationScreenStateChanged(AuthenticationScreenController.AuthenticationStatus state)
+        private void OnAuthenticationScreenStateChanged(AuthenticationStatus state)
         {
-            analytics.Track(AnalyticsEvents.General.INITIAL_LOADING, new JsonObject
+            analytics.Track(General.INITIAL_LOADING, new JsonObject
             {
-                { STAGE_KEY, $"7.0.{++stepsCounter} - authentication state: {state.ToString()}" },
+                { STATE_KEY, $"7.0.{++stepsCounter} - authentication state: {state.ToString()}" },
             });
+
+            switch (state)
+            {
+                // Triggers when the user is already logged in
+                case AuthenticationStatus.LoggedInCached:
+                    analytics.Track(Authentication.LOGGED_IN_CACHED); break;
+
+                // Triggers when the user is not logged in (login is requested)
+                // TODO: We should also track the auth Request UUID here to link the explorer_v2 event with the auth page view and login events.
+                case AuthenticationStatus.Login:
+                    analytics.Track(Authentication.LOGIN_REQUESTED); break;
+
+                // Triggered when the user tries to log in and is redirected to the authentication site
+                case AuthenticationStatus.VerificationInProgress:
+                    analytics.Track(Authentication.VERIFICATION_REQUESTED, new JsonObject
+                    {
+                        { "requestID", authenticationController.CurrentRequestID },
+                    }); break;
+
+                // Triggered when the user is logged in
+                case AuthenticationStatus.LoggedIn:
+                    analytics.Track(Authentication.LOGGED_IN); break;
+            }
         }
     }
 }
diff --git a/Explorer/Assets/DCL/Web3/Authenticators/DappWeb3Authenticator.cs b/Explorer/Assets/DCL/Web3/Authenticators/DappWeb3Authenticator.cs
@@ -126,7 +126,7 @@ public async UniTask<IWeb3Identity> LoginAsync(CancellationToken ct)
 
                 await UniTask.SwitchToMainThread(ct);
 
-                loginVerificationCallback?.Invoke(authenticationResponse.code, signatureExpiration);
+                loginVerificationCallback?.Invoke(authenticationResponse.code, signatureExpiration, authenticationResponse.requestId);
 
                 LoginResponse response = await RequestWalletConfirmationAsync<LoginResponse>(authenticationResponse.requestId,
                     signatureExpiration, ct);

diff --git a/Explorer/Assets/DCL/Web3/Authenticators/IWeb3VerifiedAuthenticator.cs b/Explorer/Assets/DCL/Web3/Authenticators/IWeb3VerifiedAuthenticator.cs
@@ -4,7 +4,7 @@ namespace DCL.Web3.Authenticators
 {
     public interface IWeb3VerifiedAuthenticator : IWeb3Authenticator
     {
-        public delegate void VerificationDelegate(int code, DateTime expiration);
+        public delegate void VerificationDelegate(int code, DateTime expiration, string requestID);
 
         void SetVerificationListener(VerificationDelegate? callback);
     }