Cherrypick Heartbeat Log and NodeAutocomplete crash fix (#14756)

zeusongit · web-flow · commit 04d9403a80a9 · 2023-12-14T14:06:48.000+08:00
diff --git a/src/DynamoCore/DynamoCore.csproj b/src/DynamoCore/DynamoCore.csproj
@@ -35,7 +35,7 @@
 	<PackageReference Include="Lucene.Net" Version="4.8.0-beta00016" />
     <PackageReference Include="Lucene.Net.Analysis.Common" Version="4.8.0-beta00016" />
     <PackageReference Include="Lucene.Net.QueryParser" Version="4.8.0-beta00016" />
-    <PackageReference Include="DynamoVisualProgramming.Analytics" Version="4.2.0.3351" />
+    <PackageReference Include="DynamoVisualProgramming.Analytics" Version="4.2.0.3421" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Engine\GraphLayout\GraphLayout.csproj">
@@ -89,10 +89,10 @@
   <ItemGroup>
     <Resource Include="BuiltInAndOperators\BuiltIn.Migrations.xml" />
   </ItemGroup>
-    <ItemGroup>
+  <ItemGroup>
     <Compile Update="Properties\Resources.Designer.cs">
-      <AutoGen>True</AutoGen>
       <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
       <DependentUpon>Resources.resx</DependentUpon>
     </Compile>
   </ItemGroup>
diff --git a/src/DynamoCore/Logging/DynamoAnalyticsClient.cs b/src/DynamoCore/Logging/DynamoAnalyticsClient.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Diagnostics;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Autodesk.Analytics.ADP;
@@ -96,6 +97,10 @@ public void Dispose() { }
 
         public virtual IAnalyticsSession Session { get; private set; }
 
+        private DateTime LastMachineHBLogTime;
+        private DateTime LastUserHBLogTime;
+        private readonly int HeartBeatInterval = 4;
+
         /// <summary>
         /// Return if Analytics Client is allowed to send any analytics information
         /// </summary>
@@ -255,6 +260,55 @@ public void TrackScreenView(string viewName)
                 }
             });
         }
+        /// <summary>
+        /// This API is used to track user/machine's activity status.
+        /// Note: This will not trigger the API at each call, instead it will
+        /// send out one call for every 4(HeartBeatInterval) minutes for each user and machine type activity.
+        /// For example, if the method gets called 100 times in 8 minutes, then it will only
+        /// trigger the HeartBeat API twice. This is to avoid sending out too many calls
+        /// as the API expects a call every 5 minutes, to mark the user/machine active.
+        /// </summary>
+        /// <param name="activityType">Value must be either Machine or User. If no value is provided the API will default to user activity type.</param>
+        public void TrackActivityStatus(string activityType)
+        {
+            if (Analytics.DisableAnalytics) return;
+
+            Task.Run(() =>
+            {
+                serviceInitialized.Wait();
+
+                lock (trackEventLockObj)
+                {
+                    if (!ReportingAnalytics) return;
+
+                    var hbType = (new[] { HeartBeatType.Machine.ToString(), HeartBeatType.User.ToString() }).Contains(activityType) ? activityType : HeartBeatType.User.ToString();
+                    LogHeartBeat(hbType);
+                }
+            });
+        }
+
+        private void LogHeartBeat(string activityType)
+        {
+            if (activityType == HeartBeatType.Machine.ToString())
+            {
+                //Only send log if atleast 4 minutes have been passed since the last log.
+                if (LastMachineHBLogTime != null && DateTime.UtcNow > LastMachineHBLogTime.AddMinutes(HeartBeatInterval))
+                {
+                    LastMachineHBLogTime = DateTime.UtcNow;
+                    var e = new HeartBeatEvent(activityType);
+                    e.Track();
+                }
+            }
+            else
+            {
+                if (LastUserHBLogTime != null && DateTime.UtcNow > LastUserHBLogTime.AddMinutes(HeartBeatInterval))
+                {
+                    LastUserHBLogTime = DateTime.UtcNow;
+                    var e = new HeartBeatEvent(activityType);
+                    e.Track();
+                }
+            }
+        }
 
         public void TrackException(Exception ex, bool isFatal)
         {
diff --git a/src/DynamoCore/Scheduler/UpdateGraphAsyncTask.cs b/src/DynamoCore/Scheduler/UpdateGraphAsyncTask.cs
@@ -6,6 +6,7 @@
 using ProtoScript.Runners;
 using Dynamo.Graph.Nodes;
 using Dynamo.Graph.Workspaces;
+using Dynamo.Logging;
 
 namespace Dynamo.Scheduler
 {
@@ -103,7 +104,10 @@ protected override void HandleTaskExecutionCore()
             // EngineController might be disposed and become invalid.
             // After MAGN-5167 is done, we could remove this checking.
             if (!engineController.IsDisposed)
+            {
+                Analytics.TrackActivityStatus(HeartBeatType.Machine.ToString());
                 engineController.UpdateGraphImmediate(graphSyncData);
+            }
         }
 
         protected override void HandleTaskCompletionCore()
@@ -116,6 +120,7 @@ protected override void HandleTaskCompletionCore()
             }
             else
             {
+                Analytics.TrackActivityStatus(HeartBeatType.Machine.ToString());
                 // Retrieve warnings in the context of ISchedulerThread.
                 BuildWarnings = engineController.GetBuildWarnings();
                 RuntimeWarnings = engineController.GetRuntimeWarnings();
diff --git a/src/DynamoCoreWpf/Controls/NodeAutoCompleteSearchControl.xaml.cs b/src/DynamoCoreWpf/Controls/NodeAutoCompleteSearchControl.xaml.cs
@@ -8,6 +8,7 @@
 using System.Windows.Data;
 using System.Windows.Input;
 using System.Windows.Threading;
+using Dynamo.Graph.Nodes;
 using Dynamo.Graph.Nodes.ZeroTouch;
 using Dynamo.Graph.Workspaces;
 using Dynamo.Logging;
@@ -213,6 +214,19 @@ private void OnNodeAutoCompleteSearchControlVisibilityChanged(object sender, Dep
                 SearchTextBox.Focus();
                 ViewModel.PopulateAutoCompleteCandidates();
             }), DispatcherPriority.Loaded);
+
+            ViewModel.ParentNodeRemoved += OnParentNodeRemoved;
+        }
+
+        //Removes nodeautocomplete menu when the associated parent node is removed.
+        private void OnParentNodeRemoved(NodeModel node)
+        {
+            NodeModel parent_node = ViewModel.PortViewModel?.PortModel.Owner;
+            if (node == parent_node)
+            {
+                OnRequestShowNodeAutoCompleteSearch(ShowHideFlags.Hide);
+                ViewModel.ParentNodeRemoved -= OnParentNodeRemoved;
+            }
         }
 
         private void OnMembersListBoxUpdated(object sender, DataTransferEventArgs e)
@@ -351,12 +365,13 @@ private void OnMoreInfoClicked(object sender, RoutedEventArgs e)
 
         internal void CloseAutocompletionWindow(object sender, RoutedEventArgs e)
         {
-            OnRequestShowNodeAutoCompleteSearch(ShowHideFlags.Hide);
+            CloseAutoCompletion();
         }
 
         internal void CloseAutoCompletion()
         {
             OnRequestShowNodeAutoCompleteSearch(ShowHideFlags.Hide);
+            ViewModel?.OnNodeAutoCompleteWindowClosed();
         }
 
         /// <summary>
diff --git a/src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs b/src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs
@@ -22,7 +22,6 @@
 using Dynamo.Graph.Nodes;
 using Dynamo.Graph.Workspaces;
 using Dynamo.Interfaces;
-using Dynamo.Logging;
 using Dynamo.Models;
 using Dynamo.PackageManager;
 using Dynamo.PackageManager.UI;
@@ -2794,7 +2793,6 @@ internal bool CanDelete(object parameters)
             return DynamoSelection.Instance.Selection.Count > 0;
         }
 
-
         public void SaveImage(object parameters)
         {
             OnRequestSaveImage(this, new ImageSaveEventArgs(parameters.ToString()));
diff --git a/src/DynamoCoreWpf/ViewModels/Core/StateMachine.cs b/src/DynamoCoreWpf/ViewModels/Core/StateMachine.cs
@@ -3,14 +3,12 @@
 using System.Linq;
 using System.Windows;
 using System.Windows.Input;
-using Dynamo.Controls;
 using Dynamo.Graph;
 using Dynamo.Graph.Annotations;
 using Dynamo.Graph.Nodes;
 using Dynamo.Graph.Notes;
 using Dynamo.Graph.Workspaces;
 using Dynamo.Models;
-using Dynamo.Nodes;
 using Dynamo.Selection;
 using Dynamo.Utilities;
 using Dynamo.Wpf.Utilities;
diff --git a/src/DynamoCoreWpf/ViewModels/Search/NodeAutoCompleteSearchViewModel.cs b/src/DynamoCoreWpf/ViewModels/Search/NodeAutoCompleteSearchViewModel.cs
@@ -151,6 +151,8 @@ public bool DisplayLowConfidence
             }
         }
 
+        internal event Action<NodeModel> ParentNodeRemoved;
+
         /// <summary>
         /// Constructor
         /// </summary>
@@ -530,6 +532,7 @@ internal void PopulateAutoCompleteCandidates()
         {
             if (PortViewModel == null) return;
 
+            dynamoViewModel.CurrentSpaceViewModel.Model.NodeRemoved += NodeViewModel_Removed;
             ResetAutoCompleteSearchViewState();
 
             if (IsDisplayingMLRecommendation)
@@ -595,6 +598,16 @@ internal void PopulateDefaultAutoCompleteCandidates()
             }
         }
 
+        internal void OnNodeAutoCompleteWindowClosed()
+        {
+            dynamoViewModel.CurrentSpaceViewModel.Model.NodeRemoved -= NodeViewModel_Removed;
+        }
+
+        internal void NodeViewModel_Removed(NodeModel node)
+        {
+            ParentNodeRemoved?.Invoke(node);
+        }
+
         /// <summary>
         /// Returns a IEnumberable of NodeSearchElementViewModel for respective NodeSearchElements.
         /// </summary>
diff --git a/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs b/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs
@@ -2038,6 +2038,7 @@ private void WindowClosed(object sender, EventArgs e)
         // passes it to thecurrent workspace
         private void DynamoView_KeyDown(object sender, KeyEventArgs e)
         {
+            Analytics.TrackActivityStatus(HeartBeatType.User.ToString());
             if (e.Key != Key.Escape || !IsMouseOver) return;
 
             var vm = dynamoViewModel.BackgroundPreviewViewModel;
@@ -2784,6 +2785,7 @@ private void _resizeTimer_Tick(object sender, EventArgs e)
 
         private void Window_PreviewMouseDown(object sender, MouseButtonEventArgs e)
         {
+            Analytics.TrackActivityStatus(HeartBeatType.User.ToString());
             dynamoViewModel.IsMouseDown = true;
         }
 
diff --git a/src/NodeServices/Analytics.cs b/src/NodeServices/Analytics.cs
@@ -117,6 +117,15 @@ public static void TrackScreenView(string viewName)
             if (client != null) client.TrackScreenView(viewName);
         }
 
+        /// <summary>
+        /// Tracks user/machine idle and active states while using the application.
+        /// </summary>
+        /// <param name="activityType">Defines the activity type i.e: machine or user</param>
+        public static void TrackActivityStatus(string activityType)
+        {
+            if (client != null) client.TrackActivityStatus(activityType);
+        }
+
         /// <summary>
         /// Tracks an exception. If the exception is fatal, its recorded as crash.
         /// </summary>
diff --git a/src/NodeServices/IAnalyticsClient.cs b/src/NodeServices/IAnalyticsClient.cs
@@ -445,6 +445,12 @@ public enum Actions
         Export
     }
 
+    public enum HeartBeatType
+    {
+        User,
+        Machine
+    }
+
     /// <summary>
     /// Implements analytics and logging functions. This interface is defined 
     /// for internal use only to implement analytics functions and mock the tests.
@@ -506,6 +512,13 @@ public interface IAnalyticsClient
         /// <param name="isFatal">If it's fatal</param>
         void TrackException(Exception ex, bool isFatal);
 
+        /// <summary>
+        /// This API is used to track user/machine's activity status.
+        /// </summary>
+        /// <param name="activityType">Value must be: machine or user. If no value is provided the API will default to user activity type.</param>
+        /// <returns>0 if successful, otherwise returns an error code.</returns>
+        void TrackActivityStatus(string activityType);
+
         /// <summary>
         /// Creates a new timed event with start state and tracks its start.
         /// Disposing the returnd event will record the event completion.
diff --git a/test/DynamoCoreTests/AnalyticsTests.cs b/test/DynamoCoreTests/AnalyticsTests.cs
@@ -81,6 +81,9 @@ protected virtual void VerifyEventTracking(Times times)
             Analytics.TrackScreenView("TestScreen");
             clientMoq.Verify(c => c.TrackScreenView("TestScreen"), times);
 
+            Analytics.TrackActivityStatus("User");
+            clientMoq.Verify(c => c.TrackActivityStatus("User"), times);
+
             TestAnalytics.TrackException<InvalidOperationException>(false);
             clientMoq.Verify(c => c.TrackException(It.IsAny<InvalidOperationException>(), false), times);
 
diff --git a/test/DynamoCoreTests/DynamoCoreTests.csproj b/test/DynamoCoreTests/DynamoCoreTests.csproj
@@ -25,7 +25,7 @@
         <PackageReference Include="coverlet.collector" Version="3.1.2" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" ExcludeAssets="none" />
         <PackageReference Include="JunitXml.TestLogger" Version="3.0.124" />
-        <PackageReference Include="DynamoVisualProgramming.Analytics" Version="4.2.0.3351">
+        <PackageReference Include="DynamoVisualProgramming.Analytics" Version="4.2.0.3421">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>compile; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
diff --git a/test/DynamoCoreWpfTests/NodeAutoCompleteSearchTests.cs b/test/DynamoCoreWpfTests/NodeAutoCompleteSearchTests.cs
@@ -500,6 +500,37 @@ public void SearchNodeAutocompletionSuggestions()
             Assert.AreEqual(5 , searchViewModel.FilteredResults.Count());
         }
 
+        [Test]
+        public void CloseNodeAutocompleteWhenParentNodeDeleted()
+        {
+            Open(@"UI\builtin_inputport_suggestion.dyn");
+
+            // Get the node view for a specific node in the graph
+            NodeView nodeView = NodeViewWithGuid(Guid.Parse("77aad5875f124bf59a4ece6b30813d3b").ToString());
+
+            var inPorts = nodeView.ViewModel.InPorts;
+            Assert.AreEqual(2, inPorts.Count());
+            var port = inPorts[0].PortModel;
+            var type = port.GetInputPortType();
+            Assert.AreEqual("DSCore.Color[]", type);
+
+            var searchViewModel = (ViewModel.CurrentSpaceViewModel.NodeAutoCompleteSearchViewModel as NodeAutoCompleteSearchViewModel);
+            searchViewModel.PortViewModel = inPorts[0];
+            searchViewModel.dynamoViewModel.PreferenceSettings.DefaultNodeAutocompleteSuggestion = NodeAutocompleteSuggestion.ObjectType;
+
+            // Get the matching node elements for the specific node port.
+            searchViewModel.PopulateAutoCompleteCandidates();
+            // Show Node AutoCompleteSearchBar
+            ViewModel.CurrentSpaceViewModel.OnRequestNodeAutoCompleteSearch(ShowHideFlags.Show);
+            //remove the parent node
+            searchViewModel.dynamoViewModel.CurrentSpaceViewModel.Model.RemoveAndDisposeNode(nodeView.ViewModel.NodeModel);
+
+            var currentWs = View.ChildOfType<WorkspaceView>();
+            //confirm if the AutoCompleteSearchBar is closed.
+            Assert.IsFalse(currentWs.NodeAutoCompleteSearchBar.IsOpen);
+
+        }
+
         [Test]
         public void NodeSuggestions_SkippedSuggestions()
         {

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`using ProtoScript.Runners;`
`7`	`7`	`using Dynamo.Graph.Nodes;`
`8`	`8`	`using Dynamo.Graph.Workspaces;`
	`9`	`+using Dynamo.Logging;`
`9`	`10`
`10`	`11`	`namespace Dynamo.Scheduler`
`11`	`12`	`{`
`@@ -103,7 +104,10 @@ protected override void HandleTaskExecutionCore()`
`103`	`104`	`// EngineController might be disposed and become invalid.`
`104`	`105`	`// After MAGN-5167 is done, we could remove this checking.`
`105`	`106`	`if (!engineController.IsDisposed)`
	`107`	`+ {`
	`108`	`+ Analytics.TrackActivityStatus(HeartBeatType.Machine.ToString());`
`106`	`109`	`engineController.UpdateGraphImmediate(graphSyncData);`
	`110`	`+ }`
`107`	`111`	`}`
`108`	`112`
`109`	`113`	`protected override void HandleTaskCompletionCore()`
`@@ -116,6 +120,7 @@ protected override void HandleTaskCompletionCore()`
`116`	`120`	`}`
`117`	`121`	`else`
`118`	`122`	`{`
	`123`	`+ Analytics.TrackActivityStatus(HeartBeatType.Machine.ToString());`
`119`	`124`	`// Retrieve warnings in the context of ISchedulerThread.`
`120`	`125`	`BuildWarnings = engineController.GetBuildWarnings();`
`121`	`126`	`RuntimeWarnings = engineController.GetRuntimeWarnings();`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@`
`22`	`22`	`using Dynamo.Graph.Nodes;`
`23`	`23`	`using Dynamo.Graph.Workspaces;`
`24`	`24`	`using Dynamo.Interfaces;`
`25`		`-using Dynamo.Logging;`
`26`	`25`	`using Dynamo.Models;`
`27`	`26`	`using Dynamo.PackageManager;`
`28`	`27`	`using Dynamo.PackageManager.UI;`
`@@ -2794,7 +2793,6 @@ internal bool CanDelete(object parameters)`
`2794`	`2793`	`return DynamoSelection.Instance.Selection.Count > 0;`
`2795`	`2794`	`}`
`2796`	`2795`
`2797`		`-`
`2798`	`2796`	`public void SaveImage(object parameters)`
`2799`	`2797`	`{`
`2800`	`2798`	`OnRequestSaveImage(this, new ImageSaveEventArgs(parameters.ToString()));`
Original file line number	Diff line number	Diff line change
`@@ -151,6 +151,8 @@ public bool DisplayLowConfidence`
`151`	`151`	`}`
`152`	`152`	`}`
`153`	`153`
	`154`	`+ internal event Action<NodeModel> ParentNodeRemoved;`
	`155`	`+`
`154`	`156`	`/// <summary>`
`155`	`157`	`/// Constructor`
`156`	`158`	`/// </summary>`
`@@ -530,6 +532,7 @@ internal void PopulateAutoCompleteCandidates()`
`530`	`532`	`{`
`531`	`533`	`if (PortViewModel == null) return;`
`532`	`534`
	`535`	`+ dynamoViewModel.CurrentSpaceViewModel.Model.NodeRemoved += NodeViewModel_Removed;`
`533`	`536`	`ResetAutoCompleteSearchViewState();`
`534`	`537`
`535`	`538`	`if (IsDisplayingMLRecommendation)`
`@@ -595,6 +598,16 @@ internal void PopulateDefaultAutoCompleteCandidates()`
`595`	`598`	`}`
`596`	`599`	`}`
`597`	`600`
	`601`	`+ internal void OnNodeAutoCompleteWindowClosed()`
	`602`	`+ {`
	`603`	`+ dynamoViewModel.CurrentSpaceViewModel.Model.NodeRemoved -= NodeViewModel_Removed;`
	`604`	`+ }`
	`605`	`+`
	`606`	`+ internal void NodeViewModel_Removed(NodeModel node)`
	`607`	`+ {`
	`608`	`+ ParentNodeRemoved?.Invoke(node);`
	`609`	`+ }`
	`610`	`+`
`598`	`611`	`/// <summary>`
`599`	`612`	`/// Returns a IEnumberable of NodeSearchElementViewModel for respective NodeSearchElements.`
`600`	`613`	`/// </summary>`
Original file line number	Diff line number	Diff line change
`@@ -2038,6 +2038,7 @@ private void WindowClosed(object sender, EventArgs e)`
`2038`	`2038`	`// passes it to thecurrent workspace`
`2039`	`2039`	`private void DynamoView_KeyDown(object sender, KeyEventArgs e)`
`2040`	`2040`	`{`
	`2041`	`+ Analytics.TrackActivityStatus(HeartBeatType.User.ToString());`
`2041`	`2042`	`if (e.Key != Key.Escape \|\| !IsMouseOver) return;`
`2042`	`2043`
`2043`	`2044`	`var vm = dynamoViewModel.BackgroundPreviewViewModel;`
`@@ -2784,6 +2785,7 @@ private void _resizeTimer_Tick(object sender, EventArgs e)`
`2784`	`2785`
`2785`	`2786`	`private void Window_PreviewMouseDown(object sender, MouseButtonEventArgs e)`
`2786`	`2787`	`{`
	`2788`	`+ Analytics.TrackActivityStatus(HeartBeatType.User.ToString());`
`2787`	`2789`	`dynamoViewModel.IsMouseDown = true;`
`2788`	`2790`	`}`
`2789`	`2791`