Improve Package Manager search sort order (#13700)

zeusongit · web-flow · commit 22240a747ce7 · 2023-01-25T15:46:13.000-05:00
* add search sort order
diff --git a/src/DynamoCoreWpf/ViewModels/PackageManager/PackageManagerSearchViewModel.cs b/src/DynamoCoreWpf/ViewModels/PackageManager/PackageManagerSearchViewModel.cs
@@ -43,7 +43,8 @@ public enum PackageSortingKey
             Downloads,
             Votes,
             Maintainers,
-            LastUpdate
+            LastUpdate,
+            Search
         };
 
         /// <summary>
@@ -363,10 +364,15 @@ public PackageSearchState SearchState
         public DelegateCommand ClearCompletedCommand { get; set; }
 
         /// <summary>
-        ///     Sort the search results
+        ///     Sort the default results
         /// </summary>
         public DelegateCommand SortCommand { get; set; }
 
+        /// <summary>
+        ///     Sort the search results
+        /// </summary>
+        public DelegateCommand<object> SearchSortCommand { get; set; }
+
         /// <summary>
         ///     Set the sorting key for search results and resort
         /// </summary>
@@ -418,6 +424,7 @@ internal PackageManagerSearchViewModel()
             SearchDictionary = new SearchDictionary<PackageManagerSearchElement>();
             ClearCompletedCommand = new DelegateCommand(ClearCompleted, CanClearCompleted);
             SortCommand = new DelegateCommand(Sort, CanSort);
+            SearchSortCommand = new DelegateCommand<object>(Sort, CanSort);
             SetSortingKeyCommand = new DelegateCommand<object>(SetSortingKey, CanSetSortingKey);
             SetSortingDirectionCommand = new DelegateCommand<object>(SetSortingDirection, CanSetSortingDirection);
             ViewPackageDetailsCommand = new DelegateCommand<object>(ViewPackageDetails);
@@ -440,7 +447,7 @@ public PackageManagerSearchViewModel(PackageManagerClientViewModel client) : thi
         }
         
         /// <summary>
-        /// Sort the search results in the view based on the sorting key and sorting direction.
+        /// Sort the default package results in the view based on the sorting key and sorting direction.
         /// </summary>
         public void Sort()
         {
@@ -452,8 +459,6 @@ public void Sort()
                 list.Reverse();
             }
 
-            Analytics.TrackEvent(Actions.Sort, Categories.PackageManagerOperations, $"{SortingDirection}");
-
             // temporarily hide binding
             var temp = this.SearchResults;
             this.SearchResults = null;
@@ -468,6 +473,35 @@ public void Sort()
             this.SearchResults = temp;
         }
 
+        /// <summary>
+        /// Sort the package search results in the view based on the closest hit to the search key.
+        /// </summary>
+        private void Sort(object searchQuery = null)
+        {
+            if (searchQuery == null)
+            {
+                this.Sort();
+            }
+            else
+            {
+                var list = this.SearchResults.AsEnumerable().ToList();
+                Sort(list, PackageSortingKey.Search, searchQuery.ToString());
+
+                // temporarily hide binding
+                var temp = this.SearchResults;
+                this.SearchResults = null;
+
+                temp.Clear();
+
+                foreach (var ele in list)
+                {
+                    temp.Add(ele);
+                }
+
+                this.SearchResults = temp;
+            }
+        }
+
         /// <summary>
         /// Based on the known hosts received from Package Manager server,
         /// initialize the host filter in Dynamo
@@ -484,14 +518,23 @@ public List<FilterEntry> InitializeHostFilter()
         }
 
         /// <summary>
-        /// Can search be performed.  Used by the associated command
+        /// Can search be performed.  Used by the associated command : SortCommand
         /// </summary>
         /// <returns></returns>
         public bool CanSort()
         {
             return true;
         }
 
+        /// <summary>
+        /// Can search be performed.  Used by the associated command : SearchSortCommand
+        /// </summary>
+        /// <returns></returns>
+        private bool CanSort(object s)
+        {
+            return true;
+        }
+
         /// <summary>
         /// Set the sorting direction.  Used by the associated command.
         /// </summary>
@@ -619,6 +662,8 @@ public void SetSortingKey(object sortingKey)
                 this.SortingKey = (PackageSortingKey)sortingKey;
             }
 
+            Analytics.TrackEvent(Actions.Sort, Categories.PackageManagerOperations, $"{sortingKey}");
+
             this.Sort();
         }
 
@@ -842,7 +887,7 @@ internal void SearchAndUpdateResults(string query)
                 this.AddToSearchResults(result);
             }
 
-            this.Sort();
+            this.Sort(query);
 
             SearchState = HasNoResults ? PackageSearchState.NoResults : PackageSearchState.Results;
         }
@@ -961,7 +1006,9 @@ internal IEnumerable<PackageManagerSearchElementViewModel> Search(string query)
         /// Sort a list of search results by the given key
         /// </summary>
         /// <param name="results"></param>
-        private static void Sort(List<PackageManagerSearchElementViewModel> results, PackageSortingKey key)
+        /// <param name="key"></param>
+        /// <param name="query"></param>
+        private static void Sort(List<PackageManagerSearchElementViewModel> results, PackageSortingKey key, string query = null)
         {
             switch (key)
             {
@@ -972,14 +1019,26 @@ private static void Sort(List<PackageManagerSearchElementViewModel> results, Pac
                     results.Sort((e1, e2) => e1.Model.Downloads.CompareTo(e2.Model.Downloads));
                     break;
                 case PackageSortingKey.LastUpdate:
-                    results.Sort((e1, e2) => e1.Versions.Last().Item1.created.CompareTo(e2.Versions.Last().Item1.created));
+                    results.Sort((e1, e2) => e1.Versions.FirstOrDefault().Item1.created.CompareTo(e2.Versions.FirstOrDefault().Item1.created));
                     break;
                 case PackageSortingKey.Votes:
                     results.Sort((e1, e2) => e1.Model.Votes.CompareTo(e2.Model.Votes));
                     break;
                 case PackageSortingKey.Maintainers:
                     results.Sort((e1, e2) => e1.Model.Maintainers.ToLower().CompareTo(e2.Model.Maintainers.ToLower()));
                     break;
+                //This sorting key is applied to search results when user submits a search query on package manager search window,
+                //it sorts in the following order: Not Deprecated Packages > search query in Name > Recently Updated
+                case PackageSortingKey.Search:
+                    results.Sort((e1, e2) => {
+                        int ret = e1.Model.IsDeprecated.CompareTo(e2.Model.IsDeprecated);
+                        int i1 = e1.Model.Name.ToLower().IndexOf(query.ToLower(), StringComparison.InvariantCultureIgnoreCase);
+                        int i2 = e2.Model.Name.ToLower().IndexOf(query.ToLower(), StringComparison.InvariantCultureIgnoreCase);
+                        ret = ret != 0 ? ret : ((i1 == -1) ? int.MaxValue : i1).CompareTo((i2 == -1) ? int.MaxValue : i2);
+                        ret = ret != 0 ? ret : -e1.Versions.FirstOrDefault().Item1.created.CompareTo(e2.Versions.FirstOrDefault().Item1.created);
+                        return ret;
+                    });
+                    break;
             }
         }
 
