Node Search performance improvements (#12056)

pinzart90 · pinzart · web-flow · commit f9c7691d8de0 · 2021-10-04T09:06:33.000-04:00
Remove redundancies


Co-authored-by: pinzart &lt;tiberiu.pinzariu@autodesk.com&gt;
diff --git a/src/DynamoCore/Search/SearchDictionary.cs b/src/DynamoCore/Search/SearchDictionary.cs
@@ -4,6 +4,8 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Diagnostics;
+using System.Configuration;
+using System.Reflection;
 
 namespace Dynamo.Search
 {
@@ -13,6 +15,23 @@ namespace Dynamo.Search
     public class SearchDictionary<V>
     {
         private ILogger logger;
+        private static int LIMIT_SEARCH_TAG_SIZE = 300;
+
+        static SearchDictionary()
+        {
+            try
+            {
+                // Look up search tag limit in the assembly configuration
+                var assemblyConfig = ConfigurationManager.OpenExeConfiguration(Assembly.GetExecutingAssembly().Location);
+                if (assemblyConfig != null)
+                {
+                    var searchTagSizeLimit = assemblyConfig.AppSettings.Settings["searchTagSizeLimit"];
+                    if (searchTagSizeLimit != null && int.TryParse(searchTagSizeLimit.Value, out int value))
+                        LIMIT_SEARCH_TAG_SIZE = value;
+                }
+            }
+            catch { }
+        }
 
         /// <summary>
         ///     Construct a SearchDictionary object
@@ -277,7 +296,8 @@ private static bool MatchWithQueryString(string key, string[] subPatterns)
                 for (int i = subPattern.Length; i >= 1; i--)
                 {
                     var part = subPattern.Substring(0, i);
-                    if (key.IndexOf(part) != -1)
+                    // Use OrdinalIgnoreCase to improve performance (with the accepted downside that the culture will be ignored)
+                    if (key.IndexOf(part, StringComparison.OrdinalIgnoreCase) != -1)
                     {   //if we find a match record the amount of the match and goto the next word
                         numberOfMatchSymbols += part.Length;
                         break;
@@ -306,12 +326,12 @@ private static Dictionary<V, double> MatchWithSubset(Dictionary<V,double> search
                 foreach (var ele in subset)
                 {
                     //if any element in tagDictionary matches to any element in subset, return true
-                    if (currentElementName.IndexOf(ele.FullName) != -1)
+                    if (currentElementName.IndexOf(ele.FullName, StringComparison.OrdinalIgnoreCase) != -1)
                     {
                         filteredDict.Add(searchElement.Key, searchElement.Value);
                         break;
                     }
-                }                
+                }
             }
             return filteredDict;
         }
@@ -342,7 +362,7 @@ internal void RebuildTagDictionary()
                             tagAndWeight =>
                                 new
                                 {
-                                    Tag = tagAndWeight.Key,
+                                    Tag = tagAndWeight.Key.Substring(0, tagAndWeight.Key.Length > LIMIT_SEARCH_TAG_SIZE ? LIMIT_SEARCH_TAG_SIZE : tagAndWeight.Key.Length),
                                     Weight = tagAndWeight.Value,
                                     Entry = entryAndTags.Key
                                 }))
@@ -379,12 +399,13 @@ internal IEnumerable<V> Search(string query, int minResultsForTolerantSearch = 0
             query = query.ToLower();
 
             var subPatterns = SplitOnWhiteSpace(query);
-
-            // Add full (unsplit by whitespace) query to subpatterns
-            var subPatternsList = subPatterns.ToList();
-            subPatternsList.Insert(0, query);
-            subPatterns = (subPatternsList).ToArray();
-
+            if (subPatterns.Length > 1)// More than one word
+            {
+                // Add full (unsplit by whitespace) query to subpatterns
+                var subPatternsList = subPatterns.ToList();
+                subPatternsList.Insert(0, query);
+                subPatterns = (subPatternsList).ToArray();
+            }
 
             foreach (var pair in tagDictionary.Where(x => MatchWithQueryString(x.Key, subPatterns)))
             {
diff --git a/src/DynamoCoreWpf/Commands/SearchCommands.cs b/src/DynamoCoreWpf/Commands/SearchCommands.cs
@@ -14,6 +14,7 @@ public DelegateCommand FocusSearchCommand
         public DelegateCommand SearchCommand
         {
             get { return search ?? (search = new DelegateCommand(Search, CanSearch)); }
+            internal set { search = value; }// used by tests
         }
 
         private DelegateCommand showSearch;
diff --git a/src/DynamoCoreWpf/Controls/IncanvasSearchControl.xaml b/src/DynamoCoreWpf/Controls/IncanvasSearchControl.xaml
@@ -105,8 +105,7 @@
                              Text="{Binding Path=SearchText, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}"
                              MinWidth="200"
                              CaretBrush="{StaticResource CommonSidebarTextColor}"
-                             Margin="26,0,0,-1"
-                             TextChanged="OnSearchTextBoxTextChanged" />
+                             Margin="26,0,0,-1"/>
                 </Grid>
             </Border>
         </Grid>
diff --git a/src/DynamoCoreWpf/Controls/IncanvasSearchControl.xaml.cs b/src/DynamoCoreWpf/Controls/IncanvasSearchControl.xaml.cs
@@ -60,16 +60,6 @@ private void OnRequestShowInCanvasSearch(ShowHideFlags flags)
             }
         }
 
-        private void OnSearchTextBoxTextChanged(object sender, TextChangedEventArgs e)
-        {
-            BindingExpression binding = ((TextBox)sender).GetBindingExpression(TextBox.TextProperty);
-            if (binding != null)
-                binding.UpdateSource();
-
-            if (ViewModel != null)
-                ViewModel.SearchCommand.Execute(null);
-        }
-
         private void OnMouseLeftButtonUp(object sender, MouseButtonEventArgs e)
         {
             var listBoxItem = sender as ListBoxItem;
@@ -86,7 +76,7 @@ private void ExecuteSearchElement(ListBoxItem listBoxItem)
             if (searchElement != null)
             {
                 searchElement.Position = ViewModel.InCanvasSearchPosition;
-                searchElement.ClickedCommand.Execute(null);
+                searchElement.ClickedCommand?.Execute(null);
                 Analytics.TrackEvent(
                 Dynamo.Logging.Actions.Select,
                 Dynamo.Logging.Categories.InCanvasSearchOperations,
diff --git a/src/DynamoCoreWpf/ViewModels/Search/NodeSearchElementViewModel.cs b/src/DynamoCoreWpf/ViewModels/Search/NodeSearchElementViewModel.cs
@@ -360,8 +360,6 @@ protected virtual void OnClicked()
             {
                 var nodeModel = Model.CreateNode();
                 Clicked(nodeModel, Position);
-
-                Analytics.LogPiiInfo("Search-NodeAdded", FullName);
             }
         }
 
diff --git a/src/DynamoCoreWpf/ViewModels/Search/SearchViewModel.cs b/src/DynamoCoreWpf/ViewModels/Search/SearchViewModel.cs
@@ -37,10 +37,16 @@ public virtual void OnRequestFocusSearch()
         }
 
         public event EventHandler SearchTextChanged;
+
+        /// <summary>
+        /// Invokes the SearchTextChanged event handler and executes the SearchCommand
+        /// </summary>
         public void OnSearchTextChanged(object sender, EventArgs e)
         {
             if (SearchTextChanged != null)
                 SearchTextChanged(this, e);
+
+            SearchCommand?.Execute(null);
         }
 
         #endregion
@@ -65,13 +71,13 @@ public bool BrowserVisibility
             set { browserVisibility = value; RaisePropertyChanged("BrowserVisibility"); }
         }
 
+        private string searchText;
         /// <summary>
         ///     SearchText property
         /// </summary>
         /// <value>
         ///     This is the core UI for Dynamo, primarily used for logging.
         /// </value>
-        private string searchText;
         public string SearchText
         {
             get { return searchText; }
@@ -208,8 +214,6 @@ internal void Filter()
                 }
                 strBuilder.Append(", ");
             }
-
-            Analytics.LogPiiInfo("Filter-categories", strBuilder.ToString().Trim());
         }
 
         /// <summary>
@@ -822,8 +826,6 @@ public void SearchAndUpdateResults(string query)
             if (Visible != true)
                 return;
 
-            Analytics.LogPiiInfo("Search", query);
-
             // if the search query is empty, go back to the default treeview
             if (string.IsNullOrEmpty(query))
                 return;
diff --git a/test/DynamoCoreTests/Search/SearchDictionaryTest.cs b/test/DynamoCoreTests/Search/SearchDictionaryTest.cs
@@ -1,5 +1,7 @@
 ﻿using System;
 using System.Collections.Generic;
+using System.Diagnostics;
+using System.IO;
 using System.Linq;
 using System.Reflection;
 using Dynamo.Search;
@@ -8,7 +10,7 @@
 namespace Dynamo.Tests.Search
 {
     [TestFixture]
-    class SearchDictionaryTest
+    class SearchDictionaryTest : UnitTestBase
     {
         /// <summary>
         /// This test method will execute several Add methods located in the SearchDictionary class
@@ -57,6 +59,44 @@ public void TestAddItems()
             Assert.AreEqual(searchDictionary.NumTags, 11);
         }
 
+        [Test]
+        [Category("UnitTests")]
+        public void TestSearchDictionaryPerformance()
+        {
+            //Arrange
+            var searchDictionary = new SearchDictionary<string>();
+
+            var tagsPath = System.IO.Path.Combine(TestDirectory, "performance", "search_tags", "searchtags.log");
+            var tags = System.IO.File.ReadAllLines(tagsPath);
+            int value = 0;
+            foreach (var tag in tags)
+            {
+                searchDictionary.Add($"Value:{value++}", tag);
+            }
+
+            Stopwatch stopwatch = new Stopwatch();
+            stopwatch.Start();
+
+            var query1 = "all";
+            searchDictionary.Search(query1);
+            var query2 = "all elements";
+            searchDictionary.Search(query2);
+            var query3 = "all elements of";
+            searchDictionary.Search(query3);
+            var query4 = "all elements of category";
+            searchDictionary.Search(query4);
+            var query = "az";
+            var results = searchDictionary.Search(query);
+
+            stopwatch.Stop();
+
+            Assert.AreEqual(results.Count(), 20);
+
+            double timeLimit = 300;//ms
+            double range = 30;
+            Assert.IsTrue(Math.Abs(stopwatch.ElapsedMilliseconds - timeLimit) < range / 100 * timeLimit, $"Search time should be within a range of +/- {range}% of {timeLimit}ms but we got {stopwatch.ElapsedMilliseconds}ms");
+        }
+
         /// <summary>
         /// This test method will execute several Remove methods located in the SearchDictionary class
         /// int Remove(Func<V, bool> removeCondition)
diff --git a/test/DynamoCoreWpfTests/CoreUITests.cs b/test/DynamoCoreWpfTests/CoreUITests.cs
@@ -4,6 +4,7 @@
 using System.Linq;
 using System.Threading;
 using System.Windows;
+using System.Windows.Controls.Primitives;
 using System.Windows.Input;
 using CoreNodeModels.Input;
 using Dynamo.Configuration;
@@ -19,6 +20,7 @@
 using Dynamo.Scheduler;
 using Dynamo.Selection;
 using Dynamo.Services;
+using Dynamo.UI.Controls;
 using Dynamo.Utilities;
 using Dynamo.ViewModels;
 using Dynamo.Views;
@@ -863,6 +865,30 @@ public void WorkspaceContextMenu_TestIfInCanvasSearchHidesOnOpeningContextMenu()
             Assert.IsFalse(currentWs.InCanvasSearchBar.IsOpen);
         }
 
+        [Test]
+        [Category("UnitTests")]
+        public void InCanvasSearchTextChangeTriggersOneSearchCommand()
+        {
+            var currentWs = View.ChildOfType<WorkspaceView>();
+
+            // open context menu
+            RightClick(currentWs.zoomBorder);
+
+            // show in-canvas search
+            ViewModel.CurrentSpaceViewModel.ShowInCanvasSearchCommand.Execute(ShowHideFlags.Show);
+
+            var searchControl = currentWs.ChildrenOfType<Popup>().Select(x => (x as Popup)?.Child as InCanvasSearchControl).Where(c => c != null).FirstOrDefault();
+            Assert.IsNotNull(searchControl);
+
+            int count = 0;
+            (searchControl.DataContext as SearchViewModel).SearchCommand = new Dynamo.UI.Commands.DelegateCommand((object _) => { count++; });
+            searchControl.SearchTextBox.Text = "dsfdf";
+            
+
+            Assert.IsTrue(currentWs.InCanvasSearchBar.IsOpen);
+            Assert.AreEqual(count, 1);
+        }
+
         [Test]
         [Category("UnitTests")]
         public void WorkspaceContextMenu_TestIfSearchTextClearsOnOpeningContextMenu()
diff --git a/test/performance/search_tags/searchtags.log b/test/performance/search_tags/searchtags.log

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ public DelegateCommand FocusSearchCommand`
`14`	`14`	`public DelegateCommand SearchCommand`
`15`	`15`	`{`
`16`	`16`	`get { return search ?? (search = new DelegateCommand(Search, CanSearch)); }`
	`17`	`+ internal set { search = value; }// used by tests`
`17`	`18`	`}`
`18`	`19`
`19`	`20`	`private DelegateCommand showSearch;`
Original file line number	Diff line number	Diff line change
`@@ -60,16 +60,6 @@ private void OnRequestShowInCanvasSearch(ShowHideFlags flags)`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`		`- private void OnSearchTextBoxTextChanged(object sender, TextChangedEventArgs e)`
`64`		`- {`
`65`		`- BindingExpression binding = ((TextBox)sender).GetBindingExpression(TextBox.TextProperty);`
`66`		`- if (binding != null)`
`67`		`- binding.UpdateSource();`
`68`		`-`
`69`		`- if (ViewModel != null)`
`70`		`- ViewModel.SearchCommand.Execute(null);`
`71`		`- }`
`72`		`-`
`73`	`63`	`private void OnMouseLeftButtonUp(object sender, MouseButtonEventArgs e)`
`74`	`64`	`{`
`75`	`65`	`var listBoxItem = sender as ListBoxItem;`
`@@ -86,7 +76,7 @@ private void ExecuteSearchElement(ListBoxItem listBoxItem)`
`86`	`76`	`if (searchElement != null)`
`87`	`77`	`{`
`88`	`78`	`searchElement.Position = ViewModel.InCanvasSearchPosition;`
`89`		`- searchElement.ClickedCommand.Execute(null);`
	`79`	`+ searchElement.ClickedCommand?.Execute(null);`
`90`	`80`	`Analytics.TrackEvent(`
`91`	`81`	`Dynamo.Logging.Actions.Select,`
`92`	`82`	`Dynamo.Logging.Categories.InCanvasSearchOperations,`
Original file line number	Diff line number	Diff line change
`@@ -360,8 +360,6 @@ protected virtual void OnClicked()`
`360`	`360`	`{`
`361`	`361`	`var nodeModel = Model.CreateNode();`
`362`	`362`	`Clicked(nodeModel, Position);`
`363`		`-`
`364`		`- Analytics.LogPiiInfo("Search-NodeAdded", FullName);`
`365`	`363`	`}`
`366`	`364`	`}`
`367`	`365`
Original file line number	Diff line number	Diff line change
`@@ -37,10 +37,16 @@ public virtual void OnRequestFocusSearch()`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`public event EventHandler SearchTextChanged;`
	`40`	`+`
	`41`	`+ /// <summary>`
	`42`	`+ /// Invokes the SearchTextChanged event handler and executes the SearchCommand`
	`43`	`+ /// </summary>`
`40`	`44`	`public void OnSearchTextChanged(object sender, EventArgs e)`
`41`	`45`	`{`
`42`	`46`	`if (SearchTextChanged != null)`
`43`	`47`	`SearchTextChanged(this, e);`
	`48`	`+`
	`49`	`+ SearchCommand?.Execute(null);`
`44`	`50`	`}`
`45`	`51`
`46`	`52`	`#endregion`
`@@ -65,13 +71,13 @@ public bool BrowserVisibility`
`65`	`71`	`set { browserVisibility = value; RaisePropertyChanged("BrowserVisibility"); }`
`66`	`72`	`}`
`67`	`73`
	`74`	`+ private string searchText;`
`68`	`75`	`/// <summary>`
`69`	`76`	`/// SearchText property`
`70`	`77`	`/// </summary>`
`71`	`78`	`/// <value>`
`72`	`79`	`/// This is the core UI for Dynamo, primarily used for logging.`
`73`	`80`	`/// </value>`
`74`		`- private string searchText;`
`75`	`81`	`public string SearchText`
`76`	`82`	`{`
`77`	`83`	`get { return searchText; }`
`@@ -208,8 +214,6 @@ internal void Filter()`
`208`	`214`	`}`
`209`	`215`	`strBuilder.Append(", ");`
`210`	`216`	`}`
`211`		`-`
`212`		`- Analytics.LogPiiInfo("Filter-categories", strBuilder.ToString().Trim());`
`213`	`217`	`}`
`214`	`218`
`215`	`219`	`/// <summary>`
`@@ -822,8 +826,6 @@ public void SearchAndUpdateResults(string query)`
`822`	`826`	`if (Visible != true)`
`823`	`827`	`return;`
`824`	`828`
`825`		`- Analytics.LogPiiInfo("Search", query);`
`826`		`-`
`827`	`829`	`// if the search query is empty, go back to the default treeview`
`828`	`830`	`if (string.IsNullOrEmpty(query))`
`829`	`831`	`return;`