< 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:141
Uncovered lines:10
Coverable lines:151
Total lines:353
Line coverage:93.3% (141 of 151)
Covered branches:0
Total branches:0
Covered methods:30
Total methods:31
Method coverage:96.7% (30 of 31)

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity NPath complexity Sequence coverage
MessagingControllersManager(...)0%110100%
Initialize()0%330100%
MarkBusesDirty()0%110100%
PopulateBusesToBeProcessed()0%2020098%
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%11.2411087.5%
ProcessBus(...)0%4.024090%
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
 253822        public ConcurrentDictionary<int, MessagingController> messagingControllers { get; set; } =
 43223            new ConcurrentDictionary<int, MessagingController>();
 24
 25        private Coroutine mainCoroutine;
 26
 2827        public bool hasPendingMessages => pendingMessagesCount > 0;
 28
 1309029        public float timeBudgetCounter { get; set; } = MAX_GLOBAL_MSG_BUDGET;
 6430        public long processedInitMessagesCount { get; set; }
 26231        public int pendingMessagesCount { get; set; }
 12632        public int pendingInitMessagesCount { get; set; }
 33
 034        public bool isRunning => mainCoroutine != null;
 35
 1231136        public bool paused { get; set; }
 37
 43238        private readonly ConcurrentDictionary<int, MessagingController> globalSceneControllers =
 39            new ConcurrentDictionary<int, MessagingController>();
 40
 43241        private readonly List<MessagingController> sortedControllers = new List<MessagingController>();
 43242        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
 43251        public MessagingControllersManager(IMessageProcessHandler messageHandler = null)
 52        {
 43253            this.messageHandler = messageHandler;
 43254        }
 55
 56        public void Initialize()
 57        {
 42558            if (messageHandler == null)
 42559                messageHandler = Environment.i.world.sceneController;
 60
 42561            globalController = new MessagingController(this, messageHandler, GLOBAL_MESSAGING_CONTROLLER_SCENE_NUMBER);
 42562            messagingControllers[GLOBAL_MESSAGING_CONTROLLER_SCENE_NUMBER] = globalController;
 63
 42564            Environment.i.world.sceneController.OnSortScenes += MarkBusesDirty;
 65
 42566            if (mainCoroutine == null)
 67            {
 42568                mainCoroutine = CoroutineStarter.Start(ProcessMessages());
 69            }
 42570        }
 71
 43272        bool populateBusesDirty = true;
 73
 74        public void MarkBusesDirty()
 75        {
 48476            populateBusesDirty = true;
 48477        }
 78
 79        public void PopulateBusesToBeProcessed()
 80        {
 91881            lock (sortedControllers)
 91882            lock (busesToProcess)
 83            {
 91884                IWorldState worldState = Environment.i.world.state;
 91885                int currentSceneNumber = worldState.GetCurrentSceneNumber();
 91886                var scenesSortedByDistance = worldState.GetScenesSortedByDistance();
 87
 91888                int count = scenesSortedByDistance.Count; // we need to retrieve list count everytime because it
 89                // may change after a yield return
 90
 91891                sortedControllers.Clear();
 92
 91893                if (currentSceneNumber > 0 && messagingControllers.ContainsKey(currentSceneNumber))
 2694                    currentSceneController = messagingControllers[currentSceneNumber];
 95
 228296                for (int i = 0; i < count; i++)
 97                {
 22398                    int controllerSceneNumber = scenesSortedByDistance[i].sceneData.sceneNumber;
 99
 223100                    if (controllerSceneNumber != currentSceneNumber)
 101                    {
 166102                        if (!messagingControllers.ContainsKey(controllerSceneNumber))
 103                            continue;
 104
 147105                        sortedControllers.Add(messagingControllers[controllerSceneNumber]);
 106                    }
 107                }
 108
 918109                sortedControllersCount = sortedControllers.Count;
 110
 918111                bool globalSceneControllerActive = globalSceneControllers.Count > 0;
 918112                bool globalControllerActive = globalController != null && globalController.enabled;
 918113                bool currentSceneControllerActive = currentSceneController != null && currentSceneController.enabled;
 114
 918115                bool atLeastOneControllerShouldBeProcessed = globalSceneControllerActive || globalControllerActive ||
 116                                                             currentSceneControllerActive || sortedControllersCount > 0;
 117
 918118                if (!atLeastOneControllerShouldBeProcessed)
 0119                    return;
 120
 918121                busesToProcess.Clear();
 122
 123                //-------------------------------------------------------------------------------------------
 124                // Global scenes
 918125                using (var globalScenecontrollersIterator = globalSceneControllers.GetEnumerator())
 126                {
 927127                    while (globalScenecontrollersIterator.MoveNext())
 128                    {
 9129                        busesToProcess.Add(globalScenecontrollersIterator.Current.Value.uiBus);
 9130                        busesToProcess.Add(globalScenecontrollersIterator.Current.Value.initBus);
 9131                        busesToProcess.Add(globalScenecontrollersIterator.Current.Value.systemBus);
 132                    }
 918133                }
 134
 918135                if (globalControllerActive)
 136                {
 913137                    busesToProcess.Add(globalController.initBus);
 138                }
 139
 918140                if (currentSceneControllerActive)
 141                {
 29142                    busesToProcess.Add(currentSceneController.initBus);
 29143                    busesToProcess.Add(currentSceneController.uiBus);
 29144                    busesToProcess.Add(currentSceneController.systemBus);
 145                }
 146
 2130147                for (int i = 0; i < sortedControllersCount; ++i)
 148                {
 147149                    MessagingController msgController = sortedControllers[i];
 150
 147151                    busesToProcess.Add(msgController.initBus);
 147152                    busesToProcess.Add(msgController.uiBus);
 153                }
 154
 2130155                for (int i = 0; i < sortedControllersCount; ++i)
 156                {
 147157                    MessagingController msgController = sortedControllers[i];
 147158                    busesToProcess.Add(msgController.systemBus);
 159                }
 160
 918161                busesToProcessCount = busesToProcess.Count;
 918162            }
 918163        }
 164
 165        public void Dispose()
 166        {
 425167            if (mainCoroutine != null)
 168            {
 425169                CoroutineStarter.Stop(mainCoroutine);
 425170                mainCoroutine = null;
 171            }
 172
 425173            using (var controllersIterator = messagingControllers.GetEnumerator())
 174            {
 850175                while (controllersIterator.MoveNext())
 176                {
 425177                    controllersIterator.Current.Value.Stop();
 425178                    DisposeController(controllersIterator.Current.Value);
 179                }
 425180            }
 181
 425182            Environment.i.world.sceneController.OnSortScenes -= PopulateBusesToBeProcessed;
 183
 425184            messagingControllers.Clear();
 425185        }
 186
 187        public bool ContainsController(int sceneNumber)
 188        {
 42189            return messagingControllers.ContainsKey(sceneNumber);
 190        }
 191
 192        public void AddController(IMessageProcessHandler messageHandler, int sceneNumber, bool isGlobal = false)
 193        {
 41194            if (!messagingControllers.ContainsKey(sceneNumber))
 195            {
 41196                messagingControllers.TryAdd(sceneNumber, new MessagingController(this, messageHandler, sceneNumber));
 197            }
 198
 41199            if (isGlobal && sceneNumber > 0)
 200            {
 7201                messagingControllers.TryGetValue(sceneNumber, out MessagingController newGlobalSceneController);
 202
 7203                if (!globalSceneControllers.ContainsKey(sceneNumber))
 7204                    globalSceneControllers.TryAdd(sceneNumber, newGlobalSceneController);
 205            }
 206
 41207            PopulateBusesToBeProcessed();
 41208        }
 209
 210        public void AddControllerIfNotExists(IMessageProcessHandler messageHandler, int sceneNumber,
 211            bool isGlobal = false)
 212        {
 42213            if (!ContainsController(sceneNumber))
 41214                AddController(messageHandler, sceneNumber, isGlobal);
 42215        }
 216
 217        public void RemoveController(int sceneNumber)
 218        {
 269219            if (messagingControllers.ContainsKey(sceneNumber))
 220            {
 221                // In case there is any pending message from a scene being unloaded we decrease the count accordingly
 41222                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
 41229                DisposeController(messagingControllers[sceneNumber]);
 41230                messagingControllers.TryRemove(sceneNumber, out MessagingController _);
 231            }
 232
 269233            globalSceneControllers.TryRemove(sceneNumber, out MessagingController _);
 269234        }
 235
 236        void DisposeController(MessagingController controller)
 237        {
 466238            controller.Stop();
 466239            controller.Dispose();
 466240        }
 241
 242        public void Enqueue(bool isUiBus, QueuedSceneMessage_Scene queuedMessage)
 243        {
 1244            PerformanceAnalytics.MessagesEnqueuedTracker.Track();
 1245            messagingControllers[queuedMessage.sceneNumber].Enqueue(isUiBus, queuedMessage, out MessagingBusType busId);
 1246        }
 247
 248        public void ForceEnqueueToGlobal(MessagingBusType busId, QueuedSceneMessage queuedMessage)
 249        {
 30250            PerformanceAnalytics.MessagesEnqueuedTracker.Track();
 30251            messagingControllers[GLOBAL_MESSAGING_CONTROLLER_SCENE_NUMBER].ForceEnqueue(busId, queuedMessage);
 30252        }
 253
 254        public void SetSceneReady(int sceneNumber)
 255        {
 256            // Start processing SYSTEM queue
 227257            if (messagingControllers.ContainsKey(sceneNumber))
 258            {
 259                // Start processing SYSTEM queue
 1260                MessagingController sceneMessagingController = messagingControllers[sceneNumber];
 1261                sceneMessagingController.StartBus(MessagingBusType.SYSTEM);
 1262                sceneMessagingController.StartBus(MessagingBusType.UI);
 1263                sceneMessagingController.StopBus(MessagingBusType.INIT);
 264            }
 227265        }
 266
 267        public bool HasScenePendingMessages(int sceneNumber)
 268        {
 2269            if (!messagingControllers.TryGetValue(sceneNumber, out MessagingController newGlobalSceneController))
 0270                return false;
 271
 2272            return newGlobalSceneController.initBus.hasPendingMessages
 273                   || newGlobalSceneController.systemBus.hasPendingMessages
 274                   || newGlobalSceneController.uiBus.hasPendingMessages;
 275        }
 276
 277        IEnumerator ProcessMessages()
 278        {
 11886279            while (true)
 280            {
 12311281                if (paused)
 282                {
 0283                    yield return null;
 284
 0285                    continue;
 286                }
 287
 12311288                if (populateBusesDirty)
 289                {
 877290                    PopulateBusesToBeProcessed();
 877291                    populateBusesDirty = false;
 292                }
 293
 12311294                timeBudgetCounter =
 295                    CommonScriptableObjects.rendererState.Get() ? MAX_GLOBAL_MSG_BUDGET : float.MaxValue;
 296
 49836297                for (int i = 0; i < busesToProcessCount; ++i)
 298                {
 299                    MessagingBus bus;
 300
 12607301                    lock (busesToProcess)
 302                    {
 12607303                        bus = busesToProcess[i];
 12607304                    }
 305
 12607306                    if (ProcessBus(bus))
 307                        break;
 308                }
 309
 12311310                yield return null;
 311            }
 312        }
 313
 314        bool ProcessBus(MessagingBus bus)
 315        {
 12607316            if (!bus.enabled || bus.pendingMessagesCount <= 0)
 12596317                return false;
 318
 11319            float startTime = Time.realtimeSinceStartup;
 320
 11321            float timeBudget = timeBudgetCounter;
 322
 323            //TODO(Brian): We should use the returning yieldReturn IEnumerator and MoveNext() it manually each frame to
 324            //             account the coroutine processing into the budget. Until we do that we just skip it.
 11325            bus.ProcessQueue(timeBudget, out _);
 11326            RefreshControllerEnabledState(bus.owner);
 327
 11328            timeBudgetCounter -= Time.realtimeSinceStartup - startTime;
 329
 11330            if (timeBudgetCounter <= 0)
 0331                return true;
 332
 11333            return false;
 334        }
 335
 336        private void RefreshControllerEnabledState(MessagingController controller)
 337        {
 11338            if (controller == null || !controller.enabled)
 0339                return;
 340
 11341            if (controller.uiBus.pendingMessagesCount != 0)
 0342                return;
 343
 11344            if (controller.initBus.pendingMessagesCount != 0)
 0345                return;
 346
 11347            if (controller.systemBus.pendingMessagesCount != 0)
 0348                return;
 349
 11350            controller.enabled = false;
 11351        }
 352    }
 353}
Generated by: ReportGenerator 5.0.4.0
01/24/2025 - 17:50:20
GitHub | www.palmmedia.de

Methods/Properties

messagingControllers()
messagingControllers(System.Collections.Concurrent.ConcurrentDictionary[Int32,MessagingController])
MessagingControllersManager(DCL.IMessageProcessHandler)
hasPendingMessages()
timeBudgetCounter()
timeBudgetCounter(System.Single)
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)