Graph Tessellation Benchmarks (#9651)

QilongTang · web-flow · commit 33b715f47ee2 · 2019-04-15T17:12:16.000-04:00
* Initial Commit

* Updates to use HelixRenderPackageFactory

* Disable tessellation or rendering during graph run

* clean up

* Clean Up

* More Comments

* more comments

* Address Comments

* Move test file into performance test project
diff --git a/src/DynamoCore/DynamoCore.csproj b/src/DynamoCore/DynamoCore.csproj
@@ -142,6 +142,7 @@ limitations under the License.
     <Compile Include="Library\ILibraryLoader.cs" />
     <Compile Include="Graph\Workspaces\ICustomNodeWorkspaceModel.cs" />
     <Compile Include="Visualization\DefaultGraphicPrimitives.cs" />
+    <Compile Include="Visualization\GeometryHolder.cs" />
     <Compile Include="Visualization\IRenderPackageSource.cs" />
     <Compile Include="Graph\Workspaces\IWorkspaceModel.cs" />
     <Compile Include="Logging\LogMessage.cs" />
diff --git a/src/DynamoCore/Models/DynamoModelEvents.cs b/src/DynamoCore/Models/DynamoModelEvents.cs
@@ -320,7 +320,7 @@ public virtual void OnEvaluationCompleted(object sender, EvaluationCompletedEven
             {
                 Action showFailureMessage = () => DisplayEngineFailureMessage(e.Error);
                 OnRequestDispatcherBeginInvoke(showFailureMessage);
-           }
+            }
 
             if (EvaluationCompleted != null)
                 EvaluationCompleted(sender, e);
diff --git a/src/DynamoCore/Properties/AssemblyInfo.cs b/src/DynamoCore/Properties/AssemblyInfo.cs
@@ -28,3 +28,4 @@
 [assembly: InternalsVisibleTo("Dynamo.Storage")]
 [assembly: InternalsVisibleTo("LibraryViewExtension")]
 [assembly: InternalsVisibleTo("ViewExtensionLibraryTests")]
+[assembly: InternalsVisibleTo("DynamoPerformanceTests")]
diff --git a/src/DynamoCore/Visualization/DefaultRenderPackageFactory.cs b/src/DynamoCore/Visualization/DefaultRenderPackageFactory.cs
@@ -1,7 +1,6 @@
 ﻿using System.Collections.Generic;
 using System.Linq;
 using Autodesk.DesignScript.Interfaces;
-using Dynamo.Interfaces;
 
 namespace Dynamo.Visualization
 {
diff --git a/src/DynamoCore/Visualization/GeometryHolder.cs b/src/DynamoCore/Visualization/GeometryHolder.cs
@@ -5,9 +5,8 @@
 using Autodesk.DesignScript.Interfaces;
 using Dynamo.Graph.Nodes;
 using Dynamo.Models;
-using Dynamo.Visualization;
 
-namespace DynamoWPFCLI
+namespace Dynamo.Visualization
 {
     internal class GeometryData
     {
@@ -100,7 +99,7 @@ public GeometryHolder(DynamoModel model, IRenderPackageFactory factory, NodeMode
 
             // Schedule the generation of render packages for this node. NodeRenderPackagesUpdated will be
             // called with the render packages when they are ready. The node will be set do 'Done' if the 
-            // sheduling for some reason is not successful (usually becuase the node have no geometry or is inivisible)
+            // scheduling for some reason is not successful (usually because the node have no geometry or is invisible)
             nodeModel.RenderPackagesUpdated += NodeRenderPackagesUpdated;
             if (!nodeModel.RequestVisualUpdateAsync(model.Scheduler, model.EngineController, factory, true))
             {
diff --git a/src/DynamoCoreWpf/Properties/AssemblyInfo.cs b/src/DynamoCoreWpf/Properties/AssemblyInfo.cs
@@ -35,3 +35,5 @@
 [assembly: InternalsVisibleTo("ViewExtensionLibraryTests")]
 [assembly: InternalsVisibleTo("DynamoWPFCLI")]
 [assembly: InternalsVisibleTo("CommandLineTests")]
+[assembly: InternalsVisibleTo("Watch3DNodeModelsWpf")]
+[assembly: InternalsVisibleTo("DynamoPerformanceTests")]
diff --git a/src/DynamoCoreWpf/ViewModels/Watch3D/DefaultWatch3DViewModel.cs b/src/DynamoCoreWpf/ViewModels/Watch3D/DefaultWatch3DViewModel.cs
@@ -557,7 +557,7 @@ private void RegisterNodeEventHandlers(NodeModel node)
             RegisterPortEventHandlers(node);
         }
 
-        protected void UnregisterNodeEventHandlers(NodeModel node)
+        internal void UnregisterNodeEventHandlers(NodeModel node)
         {
             node.PropertyChanged -= OnNodePropertyChanged;
             node.RenderPackagesUpdated -= OnRenderPackagesUpdated;
diff --git a/src/DynamoWPFCLI/DynamoWPFCLI.csproj b/src/DynamoWPFCLI/DynamoWPFCLI.csproj
@@ -56,7 +56,6 @@
       <Link>AssemblySharedInfo.cs</Link>
     </Compile>
     <Compile Include="CommandLineRunnerWPF.cs" />
-    <Compile Include="GeometryHolder.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
diff --git a/src/Libraries/Watch3DNodeModelsWpf/HelixWatch3DNodeViewModel.cs b/src/Libraries/Watch3DNodeModelsWpf/HelixWatch3DNodeViewModel.cs
@@ -32,7 +32,7 @@ public HelixWatch3DNodeViewModel(Watch3D node, Watch3DViewModelStartupParams par
             Name = string.Format("{0} Preview", node.GUID);
         }
 
-        protected override void OnWatchExecution()
+        protected internal override void OnWatchExecution()
         {
             var watch3D = watchModel as Watch3D;
             if (watch3D != null)
@@ -53,7 +53,7 @@ protected override void PortConnectedHandler(PortModel arg1, ConnectorModel arg2
             UpdateUpstream();
         }
 
-        protected override void UpdateUpstream()
+        protected internal override void UpdateUpstream()
         {
             OnClear();
 
diff --git a/tools/Performance/DynamoPerformanceTests/DynamoPerformanceTests.csproj b/tools/Performance/DynamoPerformanceTests/DynamoPerformanceTests.csproj
@@ -42,6 +42,12 @@
     <Reference Include="CommandLine, Version=2.4.3.0, Culture=neutral, PublicKeyToken=de6f01bd326f8c32, processorArchitecture=MSIL">
       <HintPath>packages\CommandLineParser.2.4.3\lib\netstandard2.0\CommandLine.dll</HintPath>
     </Reference>
+    <Reference Include="DynamoCore">
+      <HintPath>..\..\..\bin\AnyCPU\$(Configuration)\DynamoCore.dll</HintPath>
+    </Reference>
+    <Reference Include="DynamoCoreWpf">
+      <HintPath>..\..\..\bin\AnyCPU\$(Configuration)\DynamoCoreWpf.dll</HintPath>
+    </Reference>
     <Reference Include="DynamoCoreTests">
       <HintPath>..\..\..\bin\AnyCPU\$(Configuration)\DynamoCoreTests.dll</HintPath>
     </Reference>
@@ -228,6 +234,7 @@
     <Compile Include="DynamoModelPerformanceTestBase.cs" />
     <Compile Include="GraphNameColumn.cs" />
     <Compile Include="DynamoViewPerformanceTestBase.cs" />
+    <Compile Include="GraphViewTests.cs" />
     <Compile Include="PerformanceTestConsoleApp.cs" />
     <Compile Include="PerformanceTestHelper.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
diff --git a/tools/Performance/DynamoPerformanceTests/DynamoViewPerformanceTestBase.cs b/tools/Performance/DynamoPerformanceTests/DynamoViewPerformanceTestBase.cs
@@ -8,7 +8,7 @@
 namespace DynamoPerformanceTests
 {
 
-    public class DynamoViewPerformanceTestBase : NodeViewTests
+    public class DynamoViewPerformanceTestBase : GrapViewTests
     {
         /// <summary>
         /// Override this function to preload dlls into Dynamo library
@@ -60,7 +60,7 @@ public static IEnumerable<string> PerformanceTestSource()
 
         #region Iteration setup and cleanup methods for Benchmarks
         /// <summary>
-        /// Setup method to be called before each OpenModel benchmark.
+        /// Setup method to be called before each OpenGraph benchmark.
         /// </summary>
         [IterationSetup(Target = nameof(OpenGraph))]
         public void IterationSetupOpenModelWithUI()
@@ -69,15 +69,34 @@ public void IterationSetupOpenModelWithUI()
         }
 
         /// <summary>
-        /// Setup method to be called before each RunModel benchmark.
+        /// Setup method to be called before each RunGraph benchmark.
         /// </summary>
         [IterationSetup(Target = nameof(RunGraph))]
         public void IterationSetupRunModelWithUI()
         {
             Start();
 
+            // open the dyn file
+            Open(DynamoFilePath);
+
+            // Disable tessellation or rendering
+            DisableRendering();
+        }
+
+        /// <summary>
+        /// Setup method to be called before each GraphTessellationAndRendering  benchmark.
+        /// </summary>
+        [IterationSetup(Target = nameof(GraphTessellationAndRendering))]
+        public void IterationSetupRenderGraph()
+        {
+            Start();
+
             //open the dyn file
             Open(DynamoFilePath);
+            // Disable tessellation or rendering
+            DisableRendering();
+
+            Run();
         }
 
         /// <summary>
@@ -108,6 +127,12 @@ public void RunGraph()
             Run();
         }
 
+        [Benchmark, System.STAThread]
+        public void GraphTessellationAndRendering()
+        {
+            Tessellate();
+        }
+
         #endregion
     }
 }
diff --git a/tools/Performance/DynamoPerformanceTests/GraphViewTests.cs b/tools/Performance/DynamoPerformanceTests/GraphViewTests.cs
@@ -0,0 +1,104 @@
+﻿using System.Collections.Generic;
+using System.Threading;
+using Dynamo.Graph.Workspaces;
+using Dynamo.Models;
+using Dynamo.Visualization;
+using Dynamo.Wpf.Rendering;
+using DynamoCoreWpfTests;
+using DynamoCoreWpfTests.Utility;
+
+namespace DynamoPerformanceTests
+{
+
+    /// <summary>
+    /// This class should not be used for Dynamo View unit tests but performance
+    /// benchmarks because other than evaluation correctness, this test class 
+    /// focuses more on the way to get time consumption of graph evaluation,
+    /// tessellation and rendering
+    /// </summary>
+    public class GrapViewTests : DynamoTestUIBase
+    {
+        /// <summary>
+        /// Signal used for performance time measurement
+        /// </summary>
+        private static ManualResetEvent signalEvent = new ManualResetEvent(false);
+
+        /// <summary>
+        /// Function used to measure file open which saved in manual mode
+        /// </summary>
+        /// <param name="path"></param>
+        public override void Open(string path)
+        {
+            base.Open(path);
+
+            DispatcherUtil.DoEvents();
+        }
+
+        /// <summary>
+        /// Call this to disable the event handler to get render package (Tessellation)
+        /// Rendering in helix view will also be disabled as a result of this
+        /// Currently only used in performance benchmarking
+        /// </summary>
+        public void DisableRendering()
+        {
+            // Dispose the background watch 3D ViewModel so no tessellation or rendering happen
+            foreach (var node in Model.CurrentWorkspace.Nodes)
+            {
+                ViewModel.BackgroundPreviewViewModel.UnregisterNodeEventHandlers(node);
+            }
+        }
+
+        /// <summary>
+        /// Event handler for EvaluationCompleted event
+        /// </summary>
+        /// <param name="sender">sender</param>
+        /// <param name="e">EvaluationCompletedEventArgs</param>
+        void OnGraphEvaluationCompleted(object sender, EvaluationCompletedEventArgs e)
+        {
+            if (e.EvaluationSucceeded)
+            {
+                // Signal the signalEvent ready
+                signalEvent.Set();
+            }
+        }
+
+        /// <summary>
+        /// Function used to measure graph run with view
+        /// </summary>
+        public override void Run()
+        {
+            // A more precise way to measure the time spent is from when
+            // run() called to when even EvaluationCompleted is trigger on workspace
+            (Model.CurrentWorkspace as HomeWorkspaceModel).EvaluationCompleted += OnGraphEvaluationCompleted;
+
+            base.Run();
+            signalEvent.WaitOne();
+            signalEvent.Reset();
+            // Unsubscribe
+            (Model.CurrentWorkspace as HomeWorkspaceModel).EvaluationCompleted -= OnGraphEvaluationCompleted;
+        }
+
+        /// <summary>
+        /// Function used to measure graph geometry tessellation
+        /// </summary>
+        public void Tessellate()
+        {
+            var renderPackageFactory = new HelixRenderPackageFactory();
+
+            // A list of GeometryHolder for all the nodes belong to the graph
+            var nodeGeometries = new List<GeometryHolder>();
+
+            foreach (var node in Model.CurrentWorkspace.Nodes)
+            {
+                // Each Geometry Holder will request render packages and trigger Tessellation and Rendering
+                nodeGeometries.Add(new GeometryHolder(Model, renderPackageFactory, node));
+            }
+
+            foreach (var holder in nodeGeometries)
+            {
+                if (holder.HasGeometry)
+                    continue;
+            }
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -320,7 +320,7 @@ public virtual void OnEvaluationCompleted(object sender, EvaluationCompletedEven`
`320`	`320`	`{`
`321`	`321`	`Action showFailureMessage = () => DisplayEngineFailureMessage(e.Error);`
`322`	`322`	`OnRequestDispatcherBeginInvoke(showFailureMessage);`
`323`		`- }`
	`323`	`+ }`
`324`	`324`
`325`	`325`	`if (EvaluationCompleted != null)`
`326`	`326`	`EvaluationCompleted(sender, e);`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`using System.Collections.Generic;`
`2`	`2`	`using System.Linq;`
`3`	`3`	`using Autodesk.DesignScript.Interfaces;`
`4`		`-using Dynamo.Interfaces;`
`5`	`4`
`6`	`5`	`namespace Dynamo.Visualization`
`7`	`6`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,8 @@`
`5`	`5`	`using Autodesk.DesignScript.Interfaces;`
`6`	`6`	`using Dynamo.Graph.Nodes;`
`7`	`7`	`using Dynamo.Models;`
`8`		`-using Dynamo.Visualization;`
`9`	`8`
`10`		`-namespace DynamoWPFCLI`
	`9`	`+namespace Dynamo.Visualization`
`11`	`10`	`{`
`12`	`11`	`internal class GeometryData`
`13`	`12`	`{`
`@@ -100,7 +99,7 @@ public GeometryHolder(DynamoModel model, IRenderPackageFactory factory, NodeMode`
`100`	`99`
`101`	`100`	`// Schedule the generation of render packages for this node. NodeRenderPackagesUpdated will be`
`102`	`101`	`// called with the render packages when they are ready. The node will be set do 'Done' if the`
`103`		`- // sheduling for some reason is not successful (usually becuase the node have no geometry or is inivisible)`
	`102`	`+ // scheduling for some reason is not successful (usually because the node have no geometry or is invisible)`
`104`	`103`	`nodeModel.RenderPackagesUpdated += NodeRenderPackagesUpdated;`
`105`	`104`	`if (!nodeModel.RequestVisualUpdateAsync(model.Scheduler, model.EngineController, factory, true))`
`106`	`105`	`{`
Original file line number	Diff line number	Diff line change
`@@ -557,7 +557,7 @@ private void RegisterNodeEventHandlers(NodeModel node)`
`557`	`557`	`RegisterPortEventHandlers(node);`
`558`	`558`	`}`
`559`	`559`
`560`		`- protected void UnregisterNodeEventHandlers(NodeModel node)`
	`560`	`+ internal void UnregisterNodeEventHandlers(NodeModel node)`
`561`	`561`	`{`
`562`	`562`	`node.PropertyChanged -= OnNodePropertyChanged;`
`563`	`563`	`node.RenderPackagesUpdated -= OnRenderPackagesUpdated;`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public HelixWatch3DNodeViewModel(Watch3D node, Watch3DViewModelStartupParams par`
`32`	`32`	`Name = string.Format("{0} Preview", node.GUID);`
`33`	`33`	`}`
`34`	`34`
`35`		`- protected override void OnWatchExecution()`
	`35`	`+ protected internal override void OnWatchExecution()`
`36`	`36`	`{`
`37`	`37`	`var watch3D = watchModel as Watch3D;`
`38`	`38`	`if (watch3D != null)`
`@@ -53,7 +53,7 @@ protected override void PortConnectedHandler(PortModel arg1, ConnectorModel arg2`
`53`	`53`	`UpdateUpstream();`
`54`	`54`	`}`
`55`	`55`
`56`		`- protected override void UpdateUpstream()`
	`56`	`+ protected internal override void UpdateUpstream()`
`57`	`57`	`{`
`58`	`58`	`OnClear();`
`59`	`59`