Improve and fix query result update logic issue & provide access to exact query typed by user (Flow-Launcher#3502)

Author: Jack251970

Flow.Launcher.Core/Plugin/JsonRPCPluginV2.cs

@@ -100,11 +100,11 @@ private void SetupJsonRPC()
 
             RPC = new JsonRpc(handler, new JsonRPCPublicAPI(Context.API));
 
-            RPC.AddLocalRpcMethod("UpdateResults", new Action<string, JsonRPCQueryResponseModel>((rawQuery, response) =>
+            RPC.AddLocalRpcMethod("UpdateResults", new Action<string, JsonRPCQueryResponseModel>((trimmedQuery, response) =>
             {
                 var results = ParseResults(response);
                 ResultsUpdated?.Invoke(this,
-                    new ResultUpdatedEventArgs { Query = new Query() { RawQuery = rawQuery }, Results = results });
+                    new ResultUpdatedEventArgs { Query = new Query() { TrimmedQuery = trimmedQuery }, Results = results });
             }));
             RPC.SynchronizationContext = null;
             RPC.StartListening();

Flow.Launcher.Core/Plugin/PluginManager.cs

@@ -365,7 +365,7 @@ public static async Task<List<Result>> QueryForPluginAsync(PluginPair pair, Quer
                 {
                     Title = Localize.pluginStillInitializing(metadata.Name),
                     SubTitle = Localize.pluginStillInitializingSubtitle(),
-                    AutoCompleteText = query.RawQuery,
+                    AutoCompleteText = query.TrimmedQuery,
                     IcoPath = metadata.IcoPath,
                     PluginDirectory = metadata.PluginDirectory,
                     ActionKeywordAssigned = query.ActionKeyword,
@@ -407,7 +407,7 @@ public static async Task<List<Result>> QueryForPluginAsync(PluginPair pair, Quer
                 {
                     Title = Localize.pluginFailedToRespond(metadata.Name),
                     SubTitle = Localize.pluginFailedToRespondSubtitle(),
-                    AutoCompleteText = query.RawQuery,
+                    AutoCompleteText = query.TrimmedQuery,
                     IcoPath = Constant.ErrorIcon,
                     PluginDirectory = metadata.PluginDirectory,
                     ActionKeywordAssigned = query.ActionKeyword,
@@ -431,7 +431,7 @@ public static async Task<List<Result>> QueryHomeForPluginAsync(PluginPair pair,
                 {
                     Title = Localize.pluginStillInitializing(metadata.Name),
                     SubTitle = Localize.pluginStillInitializingSubtitle(),
-                    AutoCompleteText = query.RawQuery,
+                    AutoCompleteText = query.TrimmedQuery,
                     IcoPath = metadata.IcoPath,
                     PluginDirectory = metadata.PluginDirectory,
                     ActionKeywordAssigned = query.ActionKeyword,

Flow.Launcher.Core/Plugin/QueryBuilder.cs

@@ -6,30 +6,30 @@ namespace Flow.Launcher.Core.Plugin
 {
     public static class QueryBuilder
     {
-        public static Query Build(string text, Dictionary<string, PluginPair> nonGlobalPlugins)
+        public static Query Build(string originalQuery, string trimmedQuery, Dictionary<string, PluginPair> nonGlobalPlugins)
         {
             // home query
-            if (string.IsNullOrEmpty(text))
+            if (string.IsNullOrEmpty(trimmedQuery))
             {
                 return new Query()
                 {
                     Search = string.Empty,
-                    RawQuery = string.Empty,
+                    OriginalQuery = string.Empty,
+                    TrimmedQuery = string.Empty,
                     SearchTerms = Array.Empty<string>(),
                     ActionKeyword = string.Empty,
                     IsHomeQuery = true
                 };
             }
 
             // replace multiple white spaces with one white space
-            var terms = text.Split(Query.TermSeparator, StringSplitOptions.RemoveEmptyEntries);
+            var terms = trimmedQuery.Split(Query.TermSeparator, StringSplitOptions.RemoveEmptyEntries);
             if (terms.Length == 0)
             {
                 // nothing was typed
                 return null;
             }
 
-            var rawQuery = text;
             string actionKeyword, search;
             string possibleActionKeyword = terms[0];
             string[] searchTerms;
@@ -38,21 +38,22 @@ public static Query Build(string text, Dictionary<string, PluginPair> nonGlobalP
             {
                 // use non global plugin for query
                 actionKeyword = possibleActionKeyword;
-                search = terms.Length > 1 ? rawQuery[(actionKeyword.Length + 1)..].TrimStart() : string.Empty;
+                search = terms.Length > 1 ? trimmedQuery[(actionKeyword.Length + 1)..].TrimStart() : string.Empty;
                 searchTerms = terms[1..];
             }
             else
             {
                 // non action keyword
                 actionKeyword = string.Empty;
-                search = rawQuery.TrimStart();
+                search = trimmedQuery.TrimStart();
                 searchTerms = terms;
             }
 
             return new Query()
             {
                 Search = search,
-                RawQuery = rawQuery,
+                OriginalQuery = originalQuery,
+                TrimmedQuery = trimmedQuery,
                 SearchTerms = searchTerms,
                 ActionKeyword = actionKeyword,
                 IsHomeQuery = false

Flow.Launcher.Plugin/Query.cs

@@ -1,4 +1,5 @@
-using System.Text.Json.Serialization;
+using System;
+using System.Text.Json.Serialization;
 
 namespace Flow.Launcher.Plugin
 {
@@ -7,12 +8,30 @@ namespace Flow.Launcher.Plugin
     /// </summary>
     public class Query
     {
+        /// <summary>
+        /// Original query, exactly how the user has typed into the search box.
+        /// We don't recommend using this property directly. You should always use Search property.
+        /// </summary>
+        public string OriginalQuery { get; internal init; }
+
         /// <summary>
         /// Raw query, this includes action keyword if it has.
-        /// It has handled buildin custom query shortkeys and build-in shortcuts, and it trims the whitespace.
-        /// We didn't recommend use this property directly. You should always use Search property.
+        /// It has handled built-in custom query hotkeys and built-in shortcuts, and it trims the whitespace.
+        /// We don't recommend using this property directly. You should always use Search property.
+        /// </summary>
+        [Obsolete("RawQuery is renamed to TrimmedQuery. This property will be removed. Update the code to use TrimmedQuery instead.")]
+        public string RawQuery {
+            get => TrimmedQuery;
+            internal init { TrimmedQuery = value; }
+        }
+
+        /// <summary>
+        /// Original query but with trimmed whitespace. Includes action keyword.
+        /// It has handled built-in custom query hotkeys and build-in shortcuts.
+        /// If you need the exact original query from the search box, use OriginalQuery property instead.
+        /// We don't recommend using this property directly. You should always use Search property.
         /// </summary>
-        public string RawQuery { get; internal init; }
+        public string TrimmedQuery { get; internal init; }
 
         /// <summary>
         /// Determines whether the query was forced to execute again.
@@ -28,7 +47,7 @@ public class Query
 
         /// <summary>
         /// Search part of a query.
-        /// This will not include action keyword if exclusive plugin gets it, otherwise it should be same as RawQuery.
+        /// This will not include action keyword if exclusive plugin gets it, otherwise it should be same as TrimmedQuery.
         /// Since we allow user to switch a exclusive plugin to generic plugin,
         /// so this property will always give you the "real" query part of the query
         /// </summary>
@@ -103,6 +122,6 @@ private string SplitSearch(int index)
         }
 
         /// <inheritdoc />
-        public override string ToString() => RawQuery;
+        public override string ToString() => TrimmedQuery;
     }
 }

Flow.Launcher.Test/QueryBuilderTest.cs

@@ -16,9 +16,9 @@ public void ExclusivePluginQueryTest()
                 {">", new PluginPair {Metadata = new PluginMetadata {ActionKeywords = new List<string> {">"}}}}
             };
 
-            Query q = QueryBuilder.Build(">   ping    google.com   -n 20  -6", nonGlobalPlugins);
+            Query q = QueryBuilder.Build(">   ping    google.com   -n 20  -6", ">   ping    google.com   -n 20  -6", nonGlobalPlugins);
 
-            ClassicAssert.AreEqual(">   ping    google.com   -n 20  -6", q.RawQuery);
+            ClassicAssert.AreEqual(">   ping    google.com   -n 20  -6", q.TrimmedQuery);
             ClassicAssert.AreEqual("ping    google.com   -n 20  -6", q.Search, "Search should not start with the ActionKeyword.");
             ClassicAssert.AreEqual(">", q.ActionKeyword);
 
@@ -39,10 +39,10 @@ public void ExclusivePluginQueryIgnoreDisabledTest()
                 {">", new PluginPair {Metadata = new PluginMetadata {ActionKeywords = new List<string> {">"}, Disabled = true}}}
             };
 
-            Query q = QueryBuilder.Build(">   ping    google.com   -n 20  -6", nonGlobalPlugins);
+            Query q = QueryBuilder.Build(">   ping    google.com   -n 20  -6", ">   ping    google.com   -n 20  -6", nonGlobalPlugins);
 
             ClassicAssert.AreEqual(">   ping    google.com   -n 20  -6", q.Search);
-            ClassicAssert.AreEqual(q.Search, q.RawQuery, "RawQuery should be equal to Search.");
+            ClassicAssert.AreEqual(q.Search, q.TrimmedQuery, "TrimmedQuery should be equal to Search.");
             ClassicAssert.AreEqual(6, q.SearchTerms.Length, "The length of SearchTerms should match.");
             ClassicAssert.AreNotEqual(">", q.ActionKeyword, "ActionKeyword should not match that of a disabled plugin.");
             ClassicAssert.AreEqual("ping google.com -n 20 -6", q.SecondToEndSearch, "SecondToEndSearch should be trimmed of multiple whitespace characters");
@@ -51,7 +51,7 @@ public void ExclusivePluginQueryIgnoreDisabledTest()
         [Test]
         public void GenericPluginQueryTest()
         {
-            Query q = QueryBuilder.Build("file.txt file2 file3", new Dictionary<string, PluginPair>());
+            Query q = QueryBuilder.Build("file.txt file2 file3", "file.txt file2 file3", new Dictionary<string, PluginPair>());
 
             ClassicAssert.AreEqual("file.txt file2 file3", q.Search);
             ClassicAssert.AreEqual("", q.ActionKeyword);

Flow.Launcher/Helper/ResultHelper.cs

@@ -16,11 +16,11 @@ public static class ResultHelper
         return await PopulateResultsAsync(item.PluginID, item.Query, item.Title, item.SubTitle, item.RecordKey);
     }
 
-    public static async Task<Result?> PopulateResultsAsync(string pluginId, string rawQuery, string title, string subTitle, string recordKey)
+    public static async Task<Result?> PopulateResultsAsync(string pluginId, string trimmedQuery, string title, string subTitle, string recordKey)
     {
         var plugin = PluginManager.GetPluginForId(pluginId);
         if (plugin == null) return null;
-        var query = QueryBuilder.Build(rawQuery, PluginManager.GetNonGlobalPlugins());
+        var query = QueryBuilder.Build(trimmedQuery, trimmedQuery, PluginManager.GetNonGlobalPlugins());
         if (query == null) return null;
         try
         {

Flow.Launcher/MainWindow.xaml.cs

@@ -351,7 +351,7 @@ private void OnKeyDown(object sender, KeyEventArgs e)
                             && QueryTextBox.CaretIndex == QueryTextBox.Text.Length)
                         {
                             var queryWithoutActionKeyword =
-                                QueryBuilder.Build(QueryTextBox.Text.Trim(), PluginManager.GetNonGlobalPlugins())?.Search;
+                                QueryBuilder.Build(QueryTextBox.Text, QueryTextBox.Text.Trim(), PluginManager.GetNonGlobalPlugins())?.Search;
 
                             if (FilesFolders.IsLocationPathString(queryWithoutActionKeyword))
                             {

Flow.Launcher/ResultListBox.xaml.cs

@@ -1,5 +1,6 @@
 using System;
 using System.IO;
+using System.Threading;
 using System.Windows;
 using System.Windows.Controls;
 using System.Windows.Input;
@@ -9,7 +10,7 @@ namespace Flow.Launcher
 {
     public partial class ResultListBox
     {
-        protected object _lock = new object();
+        protected Lock _lock = new();
         private Point _lastpos;
         private ListBoxItem curItem = null;
         public ResultListBox()
@@ -89,12 +90,11 @@ private void ListBox_PreviewMouseDown(object sender, MouseButtonEventArgs e)
             }
         }
 
-
-        private Point start;
-        private string path;
-        private string query;
+        private Point _start;
+        private string _path;
+        private string _trimmedQuery;
         // this method is called by the UI thread, which is single threaded, so we can be sloppy with locking
-        private bool isDragging;
+        private bool _isDragging;
 
         private void ResultList_PreviewMouseLeftButtonDown(object sender, MouseButtonEventArgs e)
         {
@@ -105,60 +105,63 @@ private void ResultList_PreviewMouseLeftButtonDown(object sender, MouseButtonEve
                         Result:
                         {
                             CopyText: { } copyText,
-                            OriginQuery.RawQuery: { } rawQuery
+                            OriginQuery.TrimmedQuery: { } trimmedQuery
                         }
                     }
                 }) return;
 
-            path = copyText;
-            query = rawQuery;
-            start = e.GetPosition(null);
-            isDragging = true;
+            _path = copyText;
+            _trimmedQuery = trimmedQuery;
+            _start = e.GetPosition(null);
+            _isDragging = true;
         }
+
         private void ResultList_MouseMove(object sender, MouseEventArgs e)
         {
-            if (e.LeftButton != MouseButtonState.Pressed || !isDragging)
+            if (e.LeftButton != MouseButtonState.Pressed || !_isDragging)
             {
-                start = default;
-                path = string.Empty;
-                query = string.Empty;
-                isDragging = false;
+                _start = default;
+                _path = string.Empty;
+                _trimmedQuery = string.Empty;
+                _isDragging = false;
                 return;
             }
 
-            if (!File.Exists(path) && !Directory.Exists(path))
+            if (!File.Exists(_path) && !Directory.Exists(_path))
                 return;
 
             Point mousePosition = e.GetPosition(null);
-            Vector diff = this.start - mousePosition;
+            Vector diff = _start - mousePosition;
 
             if (Math.Abs(diff.X) < SystemParameters.MinimumHorizontalDragDistance
                 || Math.Abs(diff.Y) < SystemParameters.MinimumVerticalDragDistance)
                 return;
 
-            isDragging = false;
+            _isDragging = false;
 
             App.API.HideMainWindow();
 
             var data = new DataObject(DataFormats.FileDrop, new[]
             {
-                path
+                _path
             });
 
             // Reassigning query to a new variable because for some reason
             // after DragDrop.DoDragDrop call, 'query' loses its content, i.e. becomes empty string
-            var rawQuery = query;
+            var trimmedQuery = _trimmedQuery;
             var effect = DragDrop.DoDragDrop((DependencyObject)sender, data, DragDropEffects.Move | DragDropEffects.Copy);
             if (effect == DragDropEffects.Move)
-                App.API.ChangeQuery(rawQuery, true);
+                App.API.ChangeQuery(trimmedQuery, true);
         }
+
         private void ResultListBox_OnPreviewMouseRightButtonDown(object sender, MouseButtonEventArgs e)
         {
             if (Mouse.DirectlyOver is not FrameworkElement { DataContext: ResultViewModel result })
                 return;
 
             RightClickResultCommand?.Execute(result.Result);
         }
+
         private void ResultListBox_OnPreviewMouseUp(object sender, MouseButtonEventArgs e)
         {
             if (Mouse.DirectlyOver is not FrameworkElement { DataContext: ResultViewModel result })

Flow.Launcher/Storage/LastOpenedHistoryItem.cs

@@ -19,13 +19,13 @@ public bool Equals(Result r)
             return Title == r.Title
                 && SubTitle == r.SubTitle
                 && PluginID == r.PluginID
-                && Query == r.OriginQuery.RawQuery;
+                && Query == r.OriginQuery.TrimmedQuery;
         }
         else
         {
             return RecordKey == r.RecordKey
                 && PluginID == r.PluginID
-                && Query == r.OriginQuery.RawQuery;
+                && Query == r.OriginQuery.TrimmedQuery;
         }
     }
 }