Prevent node autocomplete from autohiding (#11487)

mmisol · web-flow · commit ffe69d59d508 · 2021-02-11T15:51:15.000-05:00
This happened when the amount of suggestions for an input surpassed a
certain number of suggestions. The cause was the following condition.

It turns out that popups, like autocomplete, close when the left mouse
button up event happens. The problem is that autocomplete itself is
launched by pressing the left mouse button. This would normally mean
that the popup would hide as soon as the button was released, but this
was actually prevented through a time condition, which ignored the
event if it was 'soon enough'.

Unfortunately, in cases where there were a lot of suggestions, the left
mouse button up event can come after the expected timespan. This
resulted in the workaround failing to prevent the popup from hiding
immediately.

The newly implemented solution replaces the previous time-based
workaround with a more robust solution, which is to ignore the next
event after the call to show the popup is made.
diff --git a/src/DynamoCoreWpf/ViewModels/Core/StateMachine.cs b/src/DynamoCoreWpf/ViewModels/Core/StateMachine.cs
@@ -117,11 +117,6 @@ internal void CancelActiveState()
             stateMachine.CancelActiveState();
         }
 
-        internal DateTime GetLastStateTimestamp()
-        {
-            return stateMachine.Timestamp;
-        }
-
         internal void BeginDragSelection(Point2D mouseCursor)
         {
             // This represents the first mouse-move event after the mouse-down
@@ -444,11 +439,6 @@ private enum State
             #endregion
 
             #region Public Class Properties
-            /// <summary>
-            /// Optionally record the last time a particular state is updated.
-            /// Currently only used for Node AutoComplete feature.
-            /// </summary>
-            internal DateTime Timestamp { get; set; }
 
             internal bool IsInIdleState
             {
@@ -819,7 +809,6 @@ internal bool HandlePortClicked(PortViewModel portViewModel)
                         this.currentState = State.Connection;
                         owningWorkspace.CurrentCursor = CursorLibrary.GetCursor(CursorSet.ArcSelect);
                         owningWorkspace.IsCursorForced = false;
-                        Timestamp = DateTime.Now;
                         return true;
                     }
 
diff --git a/src/DynamoCoreWpf/Views/Core/WorkspaceView.xaml.cs b/src/DynamoCoreWpf/Views/Core/WorkspaceView.xaml.cs
@@ -62,6 +62,7 @@ public enum CursorState
         private double currentNodeCascadeOffset;
         private Point inCanvasSearchPosition;
         private List<DependencyObject> hitResultsList = new List<DependencyObject>();
+        private bool isAutoCompleteLoading;
 
         public WorkspaceViewModel ViewModel
         {
@@ -108,7 +109,6 @@ void OnWorkspaceViewLoaded(object sender, RoutedEventArgs e)
             DynamoSelection.Instance.Selection.CollectionChanged += OnSelectionCollectionChanged;
 
             ViewModel.RequestShowInCanvasSearch += ShowHideInCanvasControl;
-            ViewModel.RequestNodeAutoCompleteSearch += ShowHideNodeAutoCompleteControl;
             ViewModel.DynamoViewModel.PropertyChanged += ViewModel_PropertyChanged;
 
             infiniteGridView.AttachToZoomBorder(zoomBorder);
@@ -146,7 +146,6 @@ private void removeViewModelsubscriptions(WorkspaceViewModel ViewModel)
             ViewModel.Model.RequestNodeCentered -= vm_RequestNodeCentered;
             ViewModel.Model.RequestNodeCentered -= vm_RequestNodeCentered;
             ViewModel.Model.CurrentOffsetChanged -= vm_CurrentOffsetChanged;
-            ViewModel.RequestNodeAutoCompleteSearch -= ShowHideNodeAutoCompleteControl;
         }
 
         void OnWorkspaceViewUnloaded(object sender, RoutedEventArgs e)
@@ -164,6 +163,14 @@ void OnWorkspaceViewUnloaded(object sender, RoutedEventArgs e)
 
         private void ShowHideNodeAutoCompleteControl(ShowHideFlags flag)
         {
+            // Prevents hiding the dialog from releasing the left mouse button
+            if (flag == ShowHideFlags.Hide && isAutoCompleteLoading)
+            {
+                isAutoCompleteLoading = false;
+                return;
+            }
+
+            isAutoCompleteLoading = flag == ShowHideFlags.Show && !NodeAutoCompleteSearchBar.IsOpen;
             ShowHidePopup(flag, NodeAutoCompleteSearchBar);
         }
 
@@ -214,13 +221,8 @@ public void HidePopUp()
             }
             if (NodeAutoCompleteSearchBar.IsOpen)
             {
-                // Suppress the mouse action from last 0.2 second otherwise mouse button release 
-                // in Dynamo window will forcefully shutdown all the open SearchBars
-                if ((new TimeSpan(DateTime.Now.Ticks - ViewModel.GetLastStateTimestamp().Ticks)).TotalSeconds > 0.2)
-                {
-                    ShowHideNodeAutoCompleteControl(ShowHideFlags.Hide);
-                    ViewModel.CancelActiveState();
-                }
+                ShowHideNodeAutoCompleteControl(ShowHideFlags.Hide);
+                ViewModel.CancelActiveState();
             }
         }
 
@@ -374,6 +376,7 @@ void OnWorkspaceViewDataContextChanged(object sender, DependencyPropertyChangedE
                 oldViewModel.RequestAddViewToOuterCanvas -= vm_RequestAddViewToOuterCanvas;
                 oldViewModel.WorkspacePropertyEditRequested -= VmOnWorkspacePropertyEditRequested;
                 oldViewModel.RequestSelectionBoxUpdate -= VmOnRequestSelectionBoxUpdate;
+                oldViewModel.RequestNodeAutoCompleteSearch -= ShowHideNodeAutoCompleteControl;
                 removeViewModelsubscriptions(oldViewModel);
             }
 
diff --git a/test/DynamoCoreWpfTests/NodeAutoCompleteSearchTests.cs b/test/DynamoCoreWpfTests/NodeAutoCompleteSearchTests.cs
@@ -131,6 +131,9 @@ public void NodeSuggestions_InputPortZeroTouchNode_AreCorrect()
             Assert.IsTrue(currentWs.NodeAutoCompleteSearchBar.IsOpen);
 
             // Hide Node AutoCompleteSearchBar
+            // Note the event handler needs to be called twice. The first one is ignore because it is
+            // assumed to come from releasing the left mouse button when popping up AutoCompleteSearchBar
+            ViewModel.CurrentSpaceViewModel.OnRequestNodeAutoCompleteSearch(ShowHideFlags.Hide);
             ViewModel.CurrentSpaceViewModel.OnRequestNodeAutoCompleteSearch(ShowHideFlags.Hide);
             Assert.IsFalse(currentWs.NodeAutoCompleteSearchBar.IsOpen);
         }

Original file line number	Diff line number	Diff line change
`@@ -131,6 +131,9 @@ public void NodeSuggestions_InputPortZeroTouchNode_AreCorrect()`
`131`	`131`	`Assert.IsTrue(currentWs.NodeAutoCompleteSearchBar.IsOpen);`
`132`	`132`
`133`	`133`	`// Hide Node AutoCompleteSearchBar`
	`134`	`+ // Note the event handler needs to be called twice. The first one is ignore because it is`
	`135`	`+ // assumed to come from releasing the left mouse button when popping up AutoCompleteSearchBar`
	`136`	`+ ViewModel.CurrentSpaceViewModel.OnRequestNodeAutoCompleteSearch(ShowHideFlags.Hide);`
`134`	`137`	`ViewModel.CurrentSpaceViewModel.OnRequestNodeAutoCompleteSearch(ShowHideFlags.Hide);`
`135`	`138`	`Assert.IsFalse(currentWs.NodeAutoCompleteSearchBar.IsOpen);`
`136`	`139`	`}`