Update readme

README.md

@@ -305,8 +305,8 @@ public class FeatureController2a : ControllerWithResultBase
 
     protected override void OnStop()
     {
-        base.OnStop();
         _engineEvents.Win -= OnWin;
+        base.OnStop();
     }
 
     private void OnWin()
@@ -395,7 +395,7 @@ Alternatively, you can replace any controllers with mocks (for controllers with
 ```
 ```csharp
 [Test]
-public async Task LevelFlowController_ExecuteAndWaitResult_OOMEventAddMoves()
+public async Task FeatureController2_ExecuteAndWaitResult_NoExceptionThrown()
 {
     var substituteControllerFactory = new SubstituteControllerFactory();
     var myModelMock = Substitute.For<IMyModel>();

README_ru.md

@@ -287,8 +287,8 @@ public class FeatureController2a : ControllerWithResultBase
 
     protected override void OnStop()
     {
-        base.OnStop();
         _engineEvents.Win -= OnWin;
+        base.OnStop();
     }
 
     private void OnWin()
@@ -378,7 +378,7 @@ public async Task FeatureController2_ExecuteAndWaitResult_NoExceptionThrown()
 ```
 ```csharp
 [Test]
-public async Task LevelFlowController_ExecuteAndWaitResult_OOMEventAddMoves()
+public async Task FeatureController2_ExecuteAndWaitResult_NoExceptionThrown()
 {
     var substituteControllerFactory = new SubstituteControllerFactory();
     var myModelMock = Substitute.For<IMyModel>();

docs/AUTHORS.rst

@@ -13,6 +13,7 @@ We thank the following people for their contributions (in alphabetical order):
 - Aliaksandr Shchamialiou
 - Andrei Batseka
 - Andrei Navoichyk
+- Andrew Chaiko
 - Andrey Makarevich
 - Artem Svirid
 - Artur Sushkov

src/ControllersTree/Core/Controllers/ControllerBase.Profiler.cs

@@ -0,0 +1,103 @@
+#if UNITY_CONTROLLERS_PROFILER
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Threading;
+using Unity.Collections;
+using UnityEngine.Profiling;
+
+namespace Playtika.Controllers
+{
+    public partial class ControllerBase
+    {
+        protected static int _totalCount;
+        protected static int _activeCount;
+        protected static int _createdThisFrameCount;
+
+        internal int _instanceId;
+        internal long _startTimeMSec;
+        private readonly Stopwatch _stopwatch = Stopwatch.StartNew();
+
+        internal List<IController> ChildControllers => _childControllers;
+        internal string ScopeName => _controllerFactory?.ToString();
+
+        internal long GetLifetime() => _stopwatch.ElapsedMilliseconds;
+        private HashSet<int> _savedNames = new HashSet<int>();
+
+        partial void ProfileOnCreated()
+        {
+            ++_totalCount;
+            ++_activeCount;
+            ++_createdThisFrameCount;
+        }
+
+        partial void ProfileOnStart()
+        {
+            _startTimeMSec = _stopwatch.ElapsedMilliseconds;
+            PushCreateControllerToProfilerStream(Name, _startTimeMSec);
+            _stopwatch.Restart();
+        }
+
+        partial void ProfileOnStop()
+        {
+            --_activeCount;
+            var elapsedMilliseconds = _stopwatch.ElapsedMilliseconds;
+            PushStopControllerToProfilerStream(Name, elapsedMilliseconds);
+        }
+
+        private void PushCreateControllerToProfilerStream(
+            string name,
+            long startTimeMSec)
+        {
+            if (!Profiler.enabled || string.IsNullOrEmpty(name))
+            {
+                return;
+            }
+
+            var nameHash = name.GetHashCode();
+            var data = new NativeArray<CreateControllerFrameData>(1, Allocator.Persistent);
+            data[0] = new CreateControllerFrameData()
+            {
+                NameHash = nameHash,
+                StartTimeMSec = startTimeMSec
+            };
+
+            Profiler.EmitFrameMetaData(Helper.ControllerProfilerGuid, Helper.ControllerStartTag, data);
+            data.Dispose();
+
+            if (_savedNames.Contains(nameHash))
+            {
+                return;
+            }
+
+            var nameData = new NativeArray<NameSessionData>(1, Allocator.Persistent);
+            nameData[0] = new NameSessionData()
+            {
+                NameHash = nameHash,
+                Name = name
+            };
+            Profiler.EmitSessionMetaData(Helper.ControllerProfilerGuid, Helper.ControllerNameTag, nameData);
+            nameData.Dispose();
+            _savedNames.Add(nameHash);
+        }
+
+        private static void PushStopControllerToProfilerStream(string name, long elapsedMilliseconds)
+        {
+            if (!Profiler.enabled || string.IsNullOrEmpty(name))
+            {
+                return;
+            }
+
+            var data = new NativeArray<StopControllerFrameData>(1, Allocator.Persistent);
+            data[0] = new StopControllerFrameData()
+            {
+                NameHash = name.GetHashCode(),
+                ElapsedMilliseconds = elapsedMilliseconds
+            };
+
+            Profiler.EmitFrameMetaData(Helper.ControllerProfilerGuid, Helper.ControllerStopTag, data);
+            data.Dispose();
+        }
+    }
+}
+#endif

src/ControllersTree/Core/Controllers/ControllerBase.cs

@@ -20,6 +20,10 @@ public abstract partial class ControllerBase : IController, IDisposable
 
         CancellationToken IController.CancellationToken => _lifetimeToken;
 
+        partial void ProfileOnCreated();
+        partial void ProfileOnStart();
+        partial void ProfileOnStop();
+
         protected ControllerBase(IControllerFactory controllerFactory)
         {
             _controllerFactory = controllerFactory;
@@ -58,6 +62,7 @@ void IController.Initialize(
                     _lifetimeToken = _lifetimeTokenSource.Token;
                     _lifetimeToken.ThrowIfCancellationRequested();
                     _state = ControllerState.Initialized;
+                    ProfileOnCreated();
                     break;
                 }
                 default:
@@ -72,8 +77,8 @@ void IController.Start()
                 case ControllerState.Initialized:
                 {
                     _state = ControllerState.Running;
-
                     OnStart();
+                    ProfileOnStart();
                     break;
                 }
                 default:
@@ -101,6 +106,7 @@ void IController.Stop()
                 case ControllerState.Initialized:
                 case ControllerState.Running:
                     StopChildrenAndSelf();
+                    ProfileOnStop();
                     break;
                 case ControllerState.Stopped:
                 case ControllerState.Disposed:

src/ControllersTree/Core/Controllers/RootController.Profiler.cs

@@ -0,0 +1,111 @@
+#if UNITY_CONTROLLERS_PROFILER
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Threading;
+using Cysharp.Threading.Tasks;
+using Unity.Collections;
+using Unity.Profiling;
+using UnityEngine.Profiling;
+
+namespace Playtika.Controllers
+{
+    public partial class RootController
+    {
+        private static readonly ProfilerCategory ControllerProfilerCategory = ProfilerCategory.Scripts;
+
+        private static readonly ProfilerCounterValue<int> TotalControllersCount =
+            new ProfilerCounterValue<int>(
+                ControllerProfilerCategory, Helper.TotalControllersCount,
+                ProfilerMarkerDataUnit.Count, ProfilerCounterOptions.FlushOnEndOfFrame);
+
+        private static readonly ProfilerCounterValue<int> ActiveControllersCount =
+            new ProfilerCounterValue<int>(
+                ControllerProfilerCategory, Helper.ActiveControllersCount,
+                ProfilerMarkerDataUnit.Count, ProfilerCounterOptions.FlushOnEndOfFrame);
+
+        private static readonly ProfilerCounterValue<int> CreateThisFrameControllersCount =
+            new ProfilerCounterValue<int>(
+                ControllerProfilerCategory, Helper.CreateThisFrameControllersCount,
+                ProfilerMarkerDataUnit.Count, ProfilerCounterOptions.FlushOnEndOfFrame);
+        private HashSet<int> _savedNames = new HashSet<int>();
+
+        partial void ProfileOnStart()
+        {
+            MadeSnapshot(CancellationToken).Forget();
+        }
+
+        private async UniTaskVoid MadeSnapshot(CancellationToken cancellationToken)
+        {
+            while (!cancellationToken.IsCancellationRequested)
+            {
+                await UniTask.Yield(PlayerLoopTiming.LastUpdate);
+                PushToProfilerStream();
+            }
+        }
+
+        private void PushToProfilerStream()
+        {
+            if (!Profiler.enabled)
+            {
+                return;
+            }
+
+            TotalControllersCount.Value = _totalCount;
+            ActiveControllersCount.Value = _activeCount;
+            CreateThisFrameControllersCount.Value = _createdThisFrameCount;
+            _createdThisFrameCount = 0;
+
+            var count = _activeCount;
+            var frameData = new NativeArray<RunControllerFrameData>(count, Allocator.Persistent);
+            var frameDataIndex = 0;
+            ProfilerDumpTree((ControllerBase) this, frameData, ref frameDataIndex, 0);
+            Profiler.EmitFrameMetaData(Helper.ControllerProfilerGuid, Helper.ControllerRunTag, frameData);
+            frameData.Dispose();
+        }
+
+        private void ProfilerDumpTree(
+            ControllerBase controllerBase,
+            NativeArray<RunControllerFrameData> frameData,
+            ref int frameDataIndex,
+            int level)
+        {
+            var scopeName = controllerBase.ScopeName;
+            frameData[frameDataIndex] = new RunControllerFrameData()
+            {
+                NameHash = controllerBase.Name.GetHashCode(),
+                ScopeHash = scopeName.GetHashCode(),
+                InstanceId = controllerBase._instanceId,
+                Level = level,
+                StartTimeMSec = controllerBase._startTimeMSec,
+                ElapsedMilliseconds = controllerBase.GetLifetime(),
+            };
+
+            ++frameDataIndex;
+
+            var nameHash = scopeName.GetHashCode();
+            if (!_savedNames.Contains(nameHash))
+            {
+                PushScopeNameToStream(scopeName, nameHash);
+                _savedNames.Add(nameHash);
+            }
+
+            foreach (var child in controllerBase.ChildControllers)
+            {
+                ProfilerDumpTree((ControllerBase) child, frameData, ref frameDataIndex, level + 2);
+            }
+        }
+
+        private static void PushScopeNameToStream(string name, int nameHash)
+        {
+            var nameData = new NativeArray<NameSessionData>(1, Allocator.Persistent);
+            nameData[0] = new NameSessionData()
+            {
+                NameHash = nameHash,
+                Name = name
+            };
+            Profiler.EmitSessionMetaData(Helper.ControllerProfilerGuid, Helper.ScopeNameTag, nameData);
+            nameData.Dispose();
+        }
+    }
+}
+#endif

src/ControllersTree/Core/Controllers/RootController.cs

@@ -4,12 +4,15 @@
 
 namespace Playtika.Controllers
 {
-    public abstract class RootController : ControllerBase
+    public abstract partial class RootController : ControllerBase
     {
-        protected RootController(IControllerFactory controllerFactory) : base(controllerFactory)
+        protected RootController(IControllerFactory controllerFactory)
+            : base(controllerFactory)
         {
         }
 
+        partial void ProfileOnStart();
+
         /// <summary>
         /// Launches the execution of the controller tree.
         /// This method initializes the root controller with the provided cancellation token, starts it, and registers a callback to stop the root controller when the cancellation token is cancelled.
@@ -31,6 +34,7 @@ private void StopRootController()
         protected override void OnStart()
         {
             SetRootController(this);
+            ProfileOnStart();
         }
 
         protected override void OnStop()
@@ -55,4 +59,4 @@ private static void SetRootController(ControllerBase controller)
         public static ControllerBase Instance { get; private set; }
 #endif
     }
-}
+}

src/ControllersTree/Core/Playtika.Controllers.asmdef

@@ -2,11 +2,12 @@
     "name": "Playtika.Controllers",
     "rootNamespace": "",
     "references": [
-        "UniTask"
+        "UniTask",
+        "Unity.Profiling.Core"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],
-    "allowUnsafeCode": false,
+    "allowUnsafeCode": true,
     "overrideReferences": false,
     "precompiledReferences": [],
     "autoReferenced": true,