< Summary

Class:DCL.MessagingControllersManager
Assembly:DCL.Runtime
File(s):/tmp/workspace/unity-renderer/unity-renderer/Assets/Scripts/MainScripts/DCL/WorldRuntime/Messaging/MessagingControllersManager.cs
Covered lines:146
Uncovered lines:8
Coverable lines:154
Total lines:363
Line coverage:94.8% (146 of 154)
Covered branches:0
Total branches:0

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity NPath complexity Sequence coverage
MessagingControllersManager(...)0%110100%
Initialize()0%330100%
MarkBusesDirty()0%110100%
PopulateBusesToBeProcessed()0%20200100%
Dispose()0%440100%
ContainsController(...)0%110100%
AddController(...)0%550100%
AddControllerIfNotExists(...)0%220100%
RemoveController(...)0%220100%
DisposeController(...)0%110100%
Enqueue(...)0%110100%
ForceEnqueueToGlobal(...)0%110100%
SetSceneReady(...)0%220100%
HasScenePendingMessages(...)0%4.594066.67%
ProcessMessages()0%12.1712089.47%
ProcessBus(...)0%440100%
RefreshControllerEnabledState(...)0%8.36060%

File(s)

/tmp/workspace/unity-renderer/unity-renderer/Assets/Scripts/MainScripts/DCL/WorldRuntime/Messaging/MessagingControllersManager.cs

#LineLine coverage
 1using DCL.Controllers;
 2using System.Collections;
 3using System.Collections.Concurrent;
 4using System.Collections.Generic;
 5using MainScripts.DCL.Analytics.PerformanceAnalytics;
 6using UnityEngine;
 7
 8namespace DCL
 9{
 10    public class MessagingControllersManager : IMessagingControllersManager
 11    {
 12        public static bool VERBOSE = false;
 13
 14        private const float MAX_GLOBAL_MSG_BUDGET = 0.02f;
 15        private const float MAX_SYSTEM_MSG_BUDGET_FOR_FAR_SCENES = 0.003f;
 16
 17        private const float GLTF_BUDGET_MAX = 0.033f;
 18        private const float GLTF_BUDGET_MIN = 0.008f;
 19
 20        private const int GLOBAL_MESSAGING_CONTROLLER_SCENE_NUMBER = 999999;
 21
 297522        public ConcurrentDictionary<int, MessagingController> messagingControllers { get; set; } =
 56523            new ConcurrentDictionary<int, MessagingController>();
 24
 25        private Coroutine mainCoroutine;
 26
 3427        public bool hasPendingMessages => pendingMessagesCount > 0;
 28
 56529        public float timeBudgetCounter = MAX_GLOBAL_MSG_BUDGET;
 7430        public long processedInitMessagesCount { get; set; }
 27231        public int pendingMessagesCount { get; set; }
 2922332        public int pendingInitMessagesCount { get; set; }
 33
 034        public bool isRunning => mainCoroutine != null;
 35
 2912336        public bool paused { get; set; }
 37
 56538        private readonly ConcurrentDictionary<int, MessagingController> globalSceneControllers =
 39            new ConcurrentDictionary<int, MessagingController>();
 40
 56541        private readonly List<MessagingController> sortedControllers = new List<MessagingController>();
 56542        private readonly List<MessagingBus> busesToProcess = new List<MessagingBus>();
 43        private int busesToProcessCount = 0;
 44        private int sortedControllersCount = 0;
 45
 46        private MessagingController globalController = null;
 47        private MessagingController currentSceneController = null;
 48
 49        private IMessageProcessHandler messageHandler;
 50
 56551        public MessagingControllersManager(IMessageProcessHandler messageHandler = null)
 52        {
 56553            this.messageHandler = messageHandler;
 56554        }
 55
 56        public void Initialize()
 57        {
 55858            if (messageHandler == null)
 55859                messageHandler = Environment.i.world.sceneController;
 60
 55861            globalController = new MessagingController(this, messageHandler, GLOBAL_MESSAGING_CONTROLLER_SCENE_NUMBER);
 55862            messagingControllers[GLOBAL_MESSAGING_CONTROLLER_SCENE_NUMBER] = globalController;
 63
 55864            Environment.i.world.sceneController.OnSortScenes += MarkBusesDirty;
 65
 55866            if (mainCoroutine == null)
 67            {
 55868                mainCoroutine = CoroutineStarter.Start(ProcessMessages());
 69            }
 55870        }
 71
 56572        bool populateBusesDirty = true;
 73
 74        public void MarkBusesDirty()
 75        {
 62076            populateBusesDirty = true;
 62077        }
 78
 79        public void PopulateBusesToBeProcessed()
 80        {
 117881            lock (sortedControllers)
 117882            lock (busesToProcess)
 83            {
 117884                IWorldState worldState = Environment.i.world.state;
 117885                int currentSceneNumber = worldState.GetCurrentSceneNumber();
 117886                var scenesSortedByDistance = worldState.GetScenesSortedByDistance();
 87
 117888                int count = scenesSortedByDistance.Count; // we need to retrieve list count everytime because it
 89                // may change after a yield return
 90
 117891                sortedControllers.Clear();
 92
 117893                if (currentSceneNumber > 0 && messagingControllers.ContainsKey(currentSceneNumber))
 1994                    currentSceneController = messagingControllers[currentSceneNumber];
 95
 277496                for (int i = 0; i < count; i++)
 97                {
 20998                    int controllerSceneNumber = scenesSortedByDistance[i].sceneData.sceneNumber;
 99
 209100                    if (controllerSceneNumber != currentSceneNumber)
 101                    {
 162102                        if (!messagingControllers.ContainsKey(controllerSceneNumber))
 103                            continue;
 104
 144105                        sortedControllers.Add(messagingControllers[controllerSceneNumber]);
 106                    }
 107                }
 108
 1178109                sortedControllersCount = sortedControllers.Count;
 110
 1178111                bool globalSceneControllerActive = globalSceneControllers.Count > 0;
 1178112                bool globalControllerActive = globalController != null && globalController.enabled;
 1178113                bool currentSceneControllerActive = currentSceneController != null && currentSceneController.enabled;
 114
 1178115                bool atLeastOneControllerShouldBeProcessed = globalSceneControllerActive || globalControllerActive ||
 116                                                             currentSceneControllerActive || sortedControllersCount > 0;
 117
 1178118                if (!atLeastOneControllerShouldBeProcessed)
 1119                    return;
 120
 1177121                busesToProcess.Clear();
 122
 123                //-------------------------------------------------------------------------------------------
 124                // Global scenes
 1177125                using (var globalScenecontrollersIterator = globalSceneControllers.GetEnumerator())
 126                {
 1183127                    while (globalScenecontrollersIterator.MoveNext())
 128                    {
 6129                        busesToProcess.Add(globalScenecontrollersIterator.Current.Value.uiBus);
 6130                        busesToProcess.Add(globalScenecontrollersIterator.Current.Value.initBus);
 6131                        busesToProcess.Add(globalScenecontrollersIterator.Current.Value.systemBus);
 132                    }
 1177133                }
 134
 1177135                if (globalControllerActive)
 136                {
 1171137                    busesToProcess.Add(globalController.initBus);
 138                }
 139
 1177140                if (currentSceneControllerActive)
 141                {
 19142                    busesToProcess.Add(currentSceneController.initBus);
 19143                    busesToProcess.Add(currentSceneController.uiBus);
 19144                    busesToProcess.Add(currentSceneController.systemBus);
 145                }
 146
 2642147                for (int i = 0; i < sortedControllersCount; ++i)
 148                {
 144149                    MessagingController msgController = sortedControllers[i];
 150
 144151                    busesToProcess.Add(msgController.initBus);
 144152                    busesToProcess.Add(msgController.uiBus);
 153                }
 154
 2642155                for (int i = 0; i < sortedControllersCount; ++i)
 156                {
 144157                    MessagingController msgController = sortedControllers[i];
 144158                    busesToProcess.Add(msgController.systemBus);
 159                }
 160
 1177161                busesToProcessCount = busesToProcess.Count;
 1177162            }
 1178163        }
 164
 165        public void Dispose()
 166        {
 558167            if (mainCoroutine != null)
 168            {
 558169                CoroutineStarter.Stop(mainCoroutine);
 558170                mainCoroutine = null;
 171            }
 172
 558173            using (var controllersIterator = messagingControllers.GetEnumerator())
 174            {
 1116175                while (controllersIterator.MoveNext())
 176                {
 558177                    controllersIterator.Current.Value.Stop();
 558178                    DisposeController(controllersIterator.Current.Value);
 179                }
 558180            }
 181
 558182            Environment.i.world.sceneController.OnSortScenes -= PopulateBusesToBeProcessed;
 183
 558184            messagingControllers.Clear();
 558185        }
 186
 187        public bool ContainsController(int sceneNumber)
 188        {
 39189            return messagingControllers.ContainsKey(sceneNumber);
 190        }
 191
 192        public void AddController(IMessageProcessHandler messageHandler, int sceneNumber, bool isGlobal = false)
 193        {
 35194            if (!messagingControllers.ContainsKey(sceneNumber))
 195            {
 35196                messagingControllers.TryAdd(sceneNumber, new MessagingController(this, messageHandler, sceneNumber));
 197            }
 198
 35199            if (isGlobal && sceneNumber > 0)
 200            {
 5201                messagingControllers.TryGetValue(sceneNumber, out MessagingController newGlobalSceneController);
 202
 5203                if (!globalSceneControllers.ContainsKey(sceneNumber))
 5204                    globalSceneControllers.TryAdd(sceneNumber, newGlobalSceneController);
 205            }
 206
 35207            PopulateBusesToBeProcessed();
 35208        }
 209
 210        public void AddControllerIfNotExists(IMessageProcessHandler messageHandler, int sceneNumber,
 211            bool isGlobal = false)
 212        {
 37213            if (!ContainsController(sceneNumber))
 35214                AddController(messageHandler, sceneNumber, isGlobal);
 37215        }
 216
 217        public void RemoveController(int sceneNumber)
 218        {
 315219            if (messagingControllers.ContainsKey(sceneNumber))
 220            {
 221                // In case there is any pending message from a scene being unloaded we decrease the count accordingly
 35222                pendingMessagesCount -= messagingControllers[sceneNumber].messagingBuses[MessagingBusType.INIT]
 223                                                                         .pendingMessagesCount +
 224                                        messagingControllers[sceneNumber].messagingBuses[MessagingBusType.UI]
 225                                                                         .pendingMessagesCount +
 226                                        messagingControllers[sceneNumber].messagingBuses[MessagingBusType.SYSTEM]
 227                                                                         .pendingMessagesCount;
 228
 35229                DisposeController(messagingControllers[sceneNumber]);
 35230                messagingControllers.TryRemove(sceneNumber, out MessagingController _);
 231            }
 232
 315233            globalSceneControllers.TryRemove(sceneNumber, out MessagingController _);
 315234        }
 235
 236        void DisposeController(MessagingController controller)
 237        {
 593238            controller.Stop();
 593239            controller.Dispose();
 593240        }
 241
 242        public void Enqueue(bool isUiBus, QueuedSceneMessage_Scene queuedMessage)
 243        {
 2244            PerformanceAnalytics.MessagesEnqueuedTracker.Track();
 2245            messagingControllers[queuedMessage.sceneNumber].Enqueue(isUiBus, queuedMessage, out MessagingBusType busId);
 2246        }
 247
 248        public void ForceEnqueueToGlobal(MessagingBusType busId, QueuedSceneMessage queuedMessage)
 249        {
 33250            PerformanceAnalytics.MessagesEnqueuedTracker.Track();
 33251            messagingControllers[GLOBAL_MESSAGING_CONTROLLER_SCENE_NUMBER].ForceEnqueue(busId, queuedMessage);
 33252        }
 253
 254        public void SetSceneReady(int sceneNumber)
 255        {
 256            // Start processing SYSTEM queue
 279257            if (messagingControllers.ContainsKey(sceneNumber))
 258            {
 259                // Start processing SYSTEM queue
 2260                MessagingController sceneMessagingController = messagingControllers[sceneNumber];
 2261                sceneMessagingController.StartBus(MessagingBusType.SYSTEM);
 2262                sceneMessagingController.StartBus(MessagingBusType.UI);
 2263                sceneMessagingController.StopBus(MessagingBusType.INIT);
 264            }
 279265        }
 266
 267        public bool HasScenePendingMessages(int sceneNumber)
 268        {
 6269            if (!messagingControllers.TryGetValue(sceneNumber, out MessagingController newGlobalSceneController))
 0270                return false;
 271
 6272            return newGlobalSceneController.initBus.hasPendingMessages
 273                   || newGlobalSceneController.systemBus.hasPendingMessages
 274                   || newGlobalSceneController.uiBus.hasPendingMessages;
 275        }
 276
 277        IEnumerator ProcessMessages()
 278        {
 28521279            while (true)
 280            {
 29079281                if (paused)
 282                {
 0283                    yield return null;
 284
 0285                    continue;
 286                }
 287
 29079288                if (populateBusesDirty)
 289                {
 1143290                    PopulateBusesToBeProcessed();
 1143291                    populateBusesDirty = false;
 292                }
 293
 29079294                timeBudgetCounter =
 295                    CommonScriptableObjects.rendererState.Get() ? MAX_GLOBAL_MSG_BUDGET : float.MaxValue;
 296
 116796297                for (int i = 0; i < busesToProcessCount; ++i)
 298                {
 299                    MessagingBus bus;
 300
 29322301                    lock (busesToProcess)
 302                    {
 29322303                        bus = busesToProcess[i];
 29322304                    }
 305
 29322306                    if (ProcessBus(bus))
 307                        break;
 308                }
 309
 29079310                if (pendingInitMessagesCount == 0)
 311                {
 29069312                    AssetPromiseKeeper_GLTF.i.throttlingCounter.budgetPerFrameInMilliseconds =
 313                        Mathf.Clamp(timeBudgetCounter, GLTF_BUDGET_MIN, GLTF_BUDGET_MAX) * 1000f;
 314                }
 315                else
 316                {
 10317                    AssetPromiseKeeper_GLTF.i.throttlingCounter.budgetPerFrameInMilliseconds = 0;
 318                }
 319
 29079320                yield return null;
 321            }
 322        }
 323
 324        bool ProcessBus(MessagingBus bus)
 325        {
 29322326            if (!bus.enabled || bus.pendingMessagesCount <= 0)
 29307327                return false;
 328
 15329            float startTime = Time.realtimeSinceStartup;
 330
 15331            float timeBudget = timeBudgetCounter;
 332
 333            //TODO(Brian): We should use the returning yieldReturn IEnumerator and MoveNext() it manually each frame to
 334            //             account the coroutine processing into the budget. Until we do that we just skip it.
 15335            bus.ProcessQueue(timeBudget, out _);
 15336            RefreshControllerEnabledState(bus.owner);
 337
 15338            timeBudgetCounter -= Time.realtimeSinceStartup - startTime;
 339
 15340            if (timeBudgetCounter <= 0)
 3341                return true;
 342
 12343            return false;
 344        }
 345
 346        private void RefreshControllerEnabledState(MessagingController controller)
 347        {
 15348            if (controller == null || !controller.enabled)
 0349                return;
 350
 15351            if (controller.uiBus.pendingMessagesCount != 0)
 0352                return;
 353
 15354            if (controller.initBus.pendingMessagesCount != 0)
 0355                return;
 356
 15357            if (controller.systemBus.pendingMessagesCount != 0)
 0358                return;
 359
 15360            controller.enabled = false;
 15361        }
 362    }
 363}
Generated by: ReportGenerator 4.8.9.0
01/11/2023 - 16:53:42
GitHub | www.palmmedia.de

Methods/Properties

messagingControllers()
messagingControllers(System.Collections.Concurrent.ConcurrentDictionary[Int32,MessagingController])
MessagingControllersManager(DCL.IMessageProcessHandler)
hasPendingMessages()
processedInitMessagesCount()
processedInitMessagesCount(System.Int64)
pendingMessagesCount()
pendingMessagesCount(System.Int32)
pendingInitMessagesCount()
pendingInitMessagesCount(System.Int32)
isRunning()
paused()
paused(System.Boolean)
Initialize()
MarkBusesDirty()
PopulateBusesToBeProcessed()
Dispose()
ContainsController(System.Int32)
AddController(DCL.IMessageProcessHandler, System.Int32, System.Boolean)
AddControllerIfNotExists(DCL.IMessageProcessHandler, System.Int32, System.Boolean)
RemoveController(System.Int32)
DisposeController(DCL.MessagingController)
Enqueue(System.Boolean, DCL.QueuedSceneMessage_Scene)
ForceEnqueueToGlobal(DCL.MessagingBusType, DCL.QueuedSceneMessage)
SetSceneReady(System.Int32)
HasScenePendingMessages(System.Int32)
ProcessMessages()
ProcessBus(DCL.MessagingBus)
RefreshControllerEnabledState(DCL.MessagingController)