DYN-1754: As a developer I want detailed per node profiling during perf benchmarks

src/DynamoCore/Engine/CodeGeneration/AstBuilder.cs

@@ -20,7 +20,11 @@ public class AstBuilder : LogSourceBase
     {
         private readonly IAstNodeContainer nodeContainer;
 
-        private ProfilingSession profilingSession = null;
+        internal ProfilingSession profilingSession = null;
+        internal void SetProfilingSession(ProfilingSession profilingSession)
+        {
+            this.profilingSession = profilingSession;
+        }
 
         /// <summary>
         /// Construct a AstBuilder with AST node contiainer.

src/DynamoCore/Engine/EngineController.cs

@@ -7,6 +7,7 @@
 using Dynamo.Engine.NodeToCode;
 using Dynamo.Engine.Profiling;
 using Dynamo.Graph.Nodes;
+using Dynamo.Graph.Workspaces;
 using Dynamo.Logging;
 using Dynamo.Scheduler;
 using ProtoCore.AST.AssociativeAST;
@@ -69,7 +70,7 @@ private void OnTraceReconciliationComplete(TraceReconciliationEventArgs e)
         /// </summary>
         public static CompilationServices CompilationServices;
 
-        internal ProfilingSession profilingSession;
+        internal ProfilingSession profilingSession = null;
 
         /// <summary>
         /// Returns DesignScript core.
@@ -125,7 +126,6 @@ public EngineController(LibraryServices libraryServices, string geometryFactoryF
             this.libraryServices = libraryServices;
             libraryServices.LibraryLoaded += LibraryLoaded;
             CompilationServices = new CompilationServices(libraryServices);
-            profilingSession = new ProfilingSession();
 
             liveRunnerServices = new LiveRunnerServices(this, geometryFactoryFileName);
 
@@ -151,6 +151,33 @@ public void Dispose()
             codeCompletionServices = null;
         }
 
+        /// <summary>
+        /// Enables or disables profiling depending on the given argument
+        /// </summary>
+        /// <param name="enable">Indicates enabling or disabling of profiling.</param>
+        /// <param name="workspace">The workspace to enable or disable profiling for.</param>
+        /// <param name="nodes">The list of nodes to enable or disable profiling for.</param>
+        public void EnableProfiling(bool enable, HomeWorkspaceModel workspace, IEnumerable<NodeModel> nodes)
+        {
+            Validity.Assert(workspace != null, "Workspace csannot be null");
+            Validity.Assert(nodes != null, "Node list csannot be null");
+
+            if (enable)
+            {
+                if (profilingSession == null)
+                {
+                    profilingSession = new ProfilingSession();
+                }
+            }
+            else
+            {
+                profilingSession = null;
+            }
+
+            astBuilder.SetProfilingSession(profilingSession);
+            workspace.MarkNodesAsModifiedAndRequestRun(nodes);
+        }
+
         #region Function Groups
 
         /// <summary>

src/DynamoCore/Engine/Profiling/ProfilingSession.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using Dynamo.Core;
 using Dynamo.Events;
 using Dynamo.Graph.Nodes;
 using ProtoCore.AST.AssociativeAST;
@@ -12,7 +11,7 @@ namespace Dynamo.Engine.Profiling
     /// <summary>
     /// This class manages a diagnostic session and the data collected in a session.
     /// </summary>
-    class ProfilingSession : NotificationObject, IDisposable
+    class ProfilingSession : IDisposable
     {
         private ProfilingData profilingData;
 

test/DynamoCoreTests/ProfilingTest.cs

@@ -1,11 +1,8 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 
-using Dynamo.Engine.CodeGeneration;
-using Dynamo.Graph;
-using Dynamo.Graph.Nodes;
+using Dynamo.Graph.Workspaces;
 using Dynamo.Models;
 using NUnit.Framework;
 
@@ -29,15 +26,30 @@ public void TestProfilingSingleNode()
             string openPath = Path.Combine(TestDirectory, @"core\profiling\SingleNode.dyn");
             OpenModel(openPath);
 
-            Assert.IsNotNull(CurrentDynamoModel.EngineController.profilingSession);
-            var profilingData = CurrentDynamoModel.EngineController.profilingSession.ProfilingData;
-            var node = CurrentDynamoModel.CurrentWorkspace.Nodes.FirstOrDefault();
+            // Assert that profiling is disabled by default
+            var engineController = CurrentDynamoModel.EngineController;
+            Assert.IsNull(engineController.profilingSession);
 
+            // Assert that no profiling data is created after a run when profiling is disabled
+            BeginRun();
+            Assert.IsNull(engineController.profilingSession);
+
+            var homeWorkspace = CurrentDynamoModel.Workspaces.OfType<HomeWorkspaceModel>().FirstOrDefault();
+            var nodes = CurrentDynamoModel.CurrentWorkspace.Nodes;
+
+            // Assert that profiling can be enabled
+            engineController.EnableProfiling(true, homeWorkspace, nodes);
+            Assert.IsNotNull(engineController.profilingSession);
+
+            // Assert that there is no profiling data before the graph is run
+            var profilingData = engineController.profilingSession.ProfilingData;
+            var node = nodes.FirstOrDefault();
             Assert.IsNull(profilingData.TotalExecutionTime);
             Assert.IsNull(profilingData.NodeExecutionTime(node));
 
             BeginRun();
 
+            // Assert that profiling data exists after a run occurs
             Assert.IsNotNull(profilingData.TotalExecutionTime);
             Assert.Greater(profilingData.TotalExecutionTime?.Ticks, 0);
             Assert.IsNotNull(profilingData.NodeExecutionTime(node));
@@ -47,9 +59,14 @@ public void TestProfilingSingleNode()
                 new DynamoModel.DeleteModelCommand(node.GUID));
             BeginRun();
 
+            // Assert that per-node profiling data is deleted after a node is deleted
             Assert.IsNotNull(profilingData.TotalExecutionTime);
             Assert.Greater(profilingData.TotalExecutionTime?.Ticks, 0);
             Assert.IsNull(profilingData.NodeExecutionTime(node));
+
+            // Assert that profiling can be disabled
+            engineController.EnableProfiling(false, homeWorkspace, nodes);
+            Assert.IsNull(engineController.profilingSession);
         }
     }
 }