DYN-6397 Fix crash when parent node is deleted while node autocomplete menu is displayed (#14715)

zeusongit · QilongTang · web-flow · commit bcdeccbb109c · 2023-12-13T12:11:12.000-05:00
* Fix PostDiff job * fix * Revert different commit This reverts commit a588d14. * comments * add unsub * add test * Update NodeAutoCompleteSearchControl.xaml.cs --------- Co-authored-by: Aaron (Qilong) <173288704@qq.com>
diff --git a/src/DynamoCore/DynamoCore.csproj b/src/DynamoCore/DynamoCore.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/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/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/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
`@@ -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>`