feat: track teleport op duration

Author: lorenzo-ranciaffi

Explorer/Assets/DCL/ApplicationGuards/ApplicationMinimumSpecsGuard/UI/MinimumSpecsScreenController.cs

@@ -43,7 +43,7 @@ protected override void OnViewInstantiated()
 
         protected override void OnViewShow()
         {
-            analytics.Track(AnalyticsEvents.UI.MINIMUM_REQUIREMENTS_SCREEN_SHOWN);
+            analytics.Track(AnalyticsEvents.Ui.MINIMUM_REQUIREMENTS_SCREEN_SHOWN);
         }
 
         private void OnToggleChanged(bool dontShowAgain)
@@ -65,7 +65,7 @@ public override void Dispose()
         private void OnContinueClicked()
         {
             DCLPlayerPrefs.SetBool(DCLPrefKeys.DONT_SHOW_MIN_SPECS_SCREEN, viewInstance!.DontShowAgainToggle.isOn, true);
-            analytics.Track(AnalyticsEvents.UI.SKIP_MINIMUM_REQUIREMENTS_SCREEN);
+            analytics.Track(AnalyticsEvents.Ui.SKIP_MINIMUM_REQUIREMENTS_SCREEN);
             HoldingTask.TrySetResult();
         }
 

Explorer/Assets/DCL/PerformanceAndDiagnostics/Analytics/AnalyticsEvents.cs

@@ -16,6 +16,7 @@ public static class General
             public const string ERROR = "error";
             public const string LOADING_ERROR = "loading_error";
             public const string MEETS_MINIMUM_REQUIREMENTS = "meets_minimum_requirements";
+            public const string TELEPORT_OPERATION_DURATION = "teleport_operation_duration";
         }
 
         public static class World
@@ -29,7 +30,7 @@ public static class Wearables
             public const string USED_EMOTE = "used_emote";
         }
 
-        public static class UI
+        public static class Ui
         {
             public const string MESSAGE_SENT = "chat_message_sent";
             public const string BUBBLE_SWITCHED = "chat_bubble_switched";

Explorer/Assets/DCL/PerformanceAndDiagnostics/Analytics/DecoratorBased/ChatMessagesBusAnalyticsDecorator.cs

@@ -18,7 +18,7 @@ public class ChatMessagesBusAnalyticsDecorator : IChatMessagesBus
         private readonly IProfileCache profileCache;
         private readonly SelfProfile selfProfile;
 
-        public event Action<ChatChannel.ChannelId, ChatChannel.ChatChannelType, ChatMessage> MessageAdded;
+        public event Action<ChatChannel.ChannelId, ChatChannel.ChatChannelType, ChatMessage>? MessageAdded;
 
         public ChatMessagesBusAnalyticsDecorator(IChatMessagesBus core, IAnalyticsController analytics, IProfileCache profileCache, SelfProfile selfProfile)
         {
@@ -64,7 +64,7 @@ public void Send(ChatChannel channel, string message, ChatMessageOrigin origin,
             if (channel.ChannelType == ChatChannel.ChatChannelType.COMMUNITY)
                 jsonObject.Add("community_id", ChatChannel.GetCommunityIdFromChannelId(channel.Id));
 
-            analytics.Track(AnalyticsEvents.UI.MESSAGE_SENT, jsonObject);
+            analytics.Track(AnalyticsEvents.Ui.MESSAGE_SENT, jsonObject);
         }
 
         private bool CheckIfIsMention(string message)

Explorer/Assets/DCL/PerformanceAndDiagnostics/Analytics/EventBased/ChatAnalytics.cs

@@ -25,10 +25,10 @@ public void Dispose()
         }
 
         private void OnConversationClosed() =>
-            analytics.Track(AnalyticsEvents.UI.CHAT_CONVERSATION_CLOSED);
+            analytics.Track(AnalyticsEvents.Ui.CHAT_CONVERSATION_CLOSED);
 
         private void OnConversationOpened(bool wasAlreadyOpen) =>
-            analytics.Track(AnalyticsEvents.UI.CHAT_CONVERSATION_OPENED, new JObject
+            analytics.Track(AnalyticsEvents.Ui.CHAT_CONVERSATION_OPENED, new JObject
             {
                 { "was_already_open", wasAlreadyOpen },
             });

Explorer/Assets/DCL/PerformanceAndDiagnostics/Analytics/EventBased/HomeMarkerAnalytics.cs

@@ -32,7 +32,7 @@ private void OnHomeChanged(HomeMarkerEvents.MessageHomePositionChanged evt)
 				{ "world_name", evt.WorldName ?? string.Empty }
 			};
 
-			analytics.Track(AnalyticsEvents.UI.HOME_POSITION_SET, properties);
+			analytics.Track(AnalyticsEvents.Ui.HOME_POSITION_SET, properties);
 		}
 
 

Explorer/Assets/DCL/PerformanceAndDiagnostics/Analytics/EventBased/SupportAnalytics.cs

@@ -30,7 +30,7 @@ public void Dispose()
         }
 
         private void OnSupportRequested() =>
-            analytics.Track(AnalyticsEvents.UI.OPEN_SUPPORT);
+            analytics.Track(AnalyticsEvents.Ui.OPEN_SUPPORT);
 
         private void OnPlacesOpened() =>
             analytics.Track(AnalyticsEvents.Places.PLACES_SECTION_OPENED, new JObject { { "source", "sidebar" } });

Explorer/Assets/DCL/RealmNavigation/Container/RealmNavigationContainer.cs

@@ -29,8 +29,6 @@ public class RealmNavigationContainer
         /// </summary>
         public IRealmNavigator RealmNavigator { get; private init; } = null!;
 
-        public IWorldAccessGate WorldAccessGate { get; private init; } = null!;
-
         public IWorldPermissionsService WorldPermissionsService { get; private init; } = null!;
 
         public IWorldInfoHub WorldInfoHub { get; private init; } = null!;
@@ -51,7 +49,7 @@ public static RealmNavigationContainer Create(
             ILandscape landscape,
             ExposedGlobalDataContainer exposedGlobalDataContainer,
             ILoadingScreen loadingScreen,
-            IPlacesAPIService placesAPIService,
+            IPlacesAPIService placesApiService,
             IWeb3IdentityCache identityCache,
             ICommunityMembershipChecker communityMembershipChecker,
             IMVCManager mvcManager)
@@ -75,7 +73,7 @@ public static RealmNavigationContainer Create(
                     new RemoveRemoteEntitiesTeleportOperation(remoteEntities, globalWorld),
                     new StopRoomAsyncTeleportOperation(roomHub, LIVEKIT_TIMEOUT),
                     new RemoveCameraSamplingDataTeleportOperation(globalWorld, exposedGlobalDataContainer.ExposedCameraData.CameraEntityProxy),
-                    new ClearWorldsCacheTeleportOperation(placesAPIService),
+                    new ClearWorldsCacheTeleportOperation(placesApiService),
                     new ChangeRealmTeleportOperation(realmContainer.RealmController),
                     new AnalyticsFlushTeleportOperation(analytics),
                     new LoadLandscapeTeleportOperation(landscape),
@@ -115,8 +113,8 @@ public static RealmNavigationContainer Create(
                     analytics,
                     realmChangeOperations,
                     teleportInSameRealmOperation,
-                    worldAccessGate),
-                WorldAccessGate = worldAccessGate,
+                    worldAccessGate,
+                    staticContainer.ScenesCache),
                 WorldPermissionsService = worldPermissionsService,
                 WorldInfoHub = worldInfoHub,
                 widgetBuilder = realmContainer.DebugView.DebugWidgetBuilder

Explorer/Assets/DCL/RealmNavigation/RealmNavigator.cs

@@ -14,8 +14,10 @@
 using DCL.Utility.Types;
 using ECS;
 using ECS.Prioritization.Components;
+using ECS.SceneLifeCycle;
 using ECS.SceneLifeCycle.Realm;
 using Newtonsoft.Json.Linq;
+using SceneRunner.Scene;
 using System;
 using System.Threading;
 using UnityEngine;
@@ -47,6 +49,7 @@ public class RealmNavigator : IRealmNavigator
         private readonly IAnalyticsController analyticsController;
         private readonly ILandscape landscape;
         private readonly IWorldAccessGate worldAccessGate;
+        private readonly IScenesCache scenesCache;
 
         public RealmNavigator(
             ILoadingScreen loadingScreen,
@@ -60,7 +63,8 @@ public RealmNavigator(
             IAnalyticsController analyticsController,
             SequentialLoadingOperation<TeleportParams> realmChangeOperations,
             SequentialLoadingOperation<TeleportParams> teleportInSameRealmOperation,
-            IWorldAccessGate worldAccessGate)
+            IWorldAccessGate worldAccessGate,
+            IScenesCache scenesCache)
         {
             this.loadingScreen = loadingScreen;
             this.realmController = realmController;
@@ -74,6 +78,7 @@ public RealmNavigator(
             this.teleportInSameRealmOperation = teleportInSameRealmOperation;
             this.landscape = landscape;
             this.worldAccessGate = worldAccessGate;
+            this.scenesCache = scenesCache;
         }
 
         public bool IsAlreadyOnRealm(URLDomain realm)
@@ -195,9 +200,14 @@ private async UniTask<EnumResult<TaskError>> ExecuteTeleportOperationsAsync(
             SequentialLoadingOperation<TeleportParams> ops,
             string logOpName,
             int attemptsCount,
+            bool trackDuration,
             CancellationToken ct
         )
         {
+            // Snapshot the source before ops run: realm-change ops clear the scenes cache
+            string source = SceneHashOrParcel(scenesCache.CurrentScene.Value, scenesCache.CurrentParcel.Value);
+            float startTime = UnityEngine.Time.realtimeSinceStartup;
+
             ReportHub.LogProductionInfo($"Trying to teleport to {teleportParams.CurrentDestinationParcel}. Attempt #{attemptsCount}");
             EnumResult<TaskError> lastOpResult = await ops.ExecuteAsync(logOpName, attemptsCount, teleportParams, ct);
 
@@ -220,11 +230,31 @@ CancellationToken ct
                 );
             }
             else
+            {
+                if (trackDuration)
+                {
+                    float loadingTime = UnityEngine.Time.realtimeSinceStartup - startTime;
+
+                    // The destination scene is already cached: teleport ops wait for scene readiness before completing
+                    scenesCache.TryGetByParcel(teleportParams.CurrentDestinationParcel, out ISceneFacade destinationScene);
+
+                    analyticsController.Track(AnalyticsEvents.General.TELEPORT_OPERATION_DURATION, new JObject
+                    {
+                        ["source"] = source,
+                        ["destination"] = SceneHashOrParcel(destinationScene, teleportParams.CurrentDestinationParcel),
+                        ["loading_time"] = loadingTime,
+                    });
+                }
+
                 NavigationExecuted?.Invoke(teleportParams.CurrentDestinationParcel);
+            }
 
             return lastOpResult;
         }
 
+        private static string SceneHashOrParcel(ISceneFacade? scene, Vector2Int parcel) =>
+            scene is { IsEmpty: false } ? scene.Info.Name : parcel.ToString();
+
         private Func<AsyncLoadProcessReport, CancellationToken, UniTask<EnumResult<TaskError>>> DoChangeRealmAsync(URLDomain realm, URLDomain? fallbackRealm, Vector2Int parcelToTeleport, bool allowsWorldPositionOverride, bool landOnParcel = false, string? spawnPointName = null)
         {
             return async (parentLoadReport, ct) =>
@@ -237,7 +267,7 @@ private Func<AsyncLoadProcessReport, CancellationToken, UniTask<EnumResult<TaskE
 
                 var teleportParams = new TeleportParams(realm, parcelToTeleport, parentLoadReport, loadingStatus, allowsWorldPositionOverride, landOnParcel, spawnPointName);
 
-                EnumResult<TaskError> opResult = await ExecuteTeleportOperationsAsync(teleportParams, realmChangeOperations, LOG_NAME, MAX_REALM_CHANGE_RETRIES, ct);
+                EnumResult<TaskError> opResult = await ExecuteTeleportOperationsAsync(teleportParams, realmChangeOperations, LOG_NAME, MAX_REALM_CHANGE_RETRIES, trackDuration: true, ct);
 
                 if (opResult.Success)
                     return opResult;
@@ -253,7 +283,8 @@ private Func<AsyncLoadProcessReport, CancellationToken, UniTask<EnumResult<TaskE
 
                 teleportParams.ChangeDestination(fallbackRealm.Value, currentParcel);
 
-                opResult = await ExecuteTeleportOperationsAsync(teleportParams, realmChangeOperations, FALLBACK_LOG_NAME, 1, ct);
+                // The recovery trip back is not a user-intended teleport: keep it out of the duration metric
+                opResult = await ExecuteTeleportOperationsAsync(teleportParams, realmChangeOperations, FALLBACK_LOG_NAME, 1, trackDuration: false, ct);
 
                 if (!opResult.Success)
                     parentLoadReport.SetProgress(1);
@@ -331,7 +362,7 @@ private Func<AsyncLoadProcessReport, CancellationToken, UniTask<EnumResult<TaskE
                     spawnPointName: spawnPointName
                 );
 
-                EnumResult<TaskError> result = await ExecuteTeleportOperationsAsync(teleportParams, teleportInSameRealmOperation, LOG_NAME, 1, ct);
+                EnumResult<TaskError> result = await ExecuteTeleportOperationsAsync(teleportParams, teleportInSameRealmOperation, LOG_NAME, 1, trackDuration: true, ct);
                 return result;
             };
     }