Improve update logic & Fix update logic issue & Input for Query

Flow.Launcher.Core/Plugin/QueryBuilder.cs

@@ -6,14 +6,15 @@ namespace Flow.Launcher.Core.Plugin
 {
     public static class QueryBuilder
     {
-        public static Query Build(string text, Dictionary<string, PluginPair> nonGlobalPlugins)
+        public static Query Build(string input, string text, Dictionary<string, PluginPair> nonGlobalPlugins)
         {
             // home query
             if (string.IsNullOrEmpty(text))
             {
                 return new Query()
                 {
                     Search = string.Empty,
+                    Input = string.Empty,
                     RawQuery = string.Empty,
                     SearchTerms = Array.Empty<string>(),
                     ActionKeyword = string.Empty,
@@ -52,6 +53,7 @@ public static Query Build(string text, Dictionary<string, PluginPair> nonGlobalP
             return new Query()
             {
                 Search = search,
+                Input = input,
                 RawQuery = rawQuery,
                 SearchTerms = searchTerms,
                 ActionKeyword = actionKeyword,

Flow.Launcher.Plugin/Query.cs

@@ -7,6 +7,12 @@ namespace Flow.Launcher.Plugin
     /// </summary>
     public class Query
     {
+        /// <summary>
+        /// Input text in query box.
+        /// We didn't recommend use this property directly. You should always use Search property.
+        /// </summary>
+        public string Input { 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.

Flow.Launcher.Test/QueryBuilderTest.cs

@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 using NUnit.Framework;
 using NUnit.Framework.Legacy;
 using Flow.Launcher.Core.Plugin;
 using Flow.Launcher.Plugin;
 
@@ -16,16 +16,16 @@
                 {">", 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.Search, "Search should not start with the ActionKeyword.");
             ClassicAssert.AreEqual(">", q.ActionKeyword);
 
             ClassicAssert.AreEqual(5, q.SearchTerms.Length, "The length of SearchTerms should match.");
 
             ClassicAssert.AreEqual("ping", q.FirstSearch);
             ClassicAssert.AreEqual("google.com", q.SecondSearch);
             ClassicAssert.AreEqual("-n", q.ThirdSearch);
 
             ClassicAssert.AreEqual("google.com -n 20 -6", q.SecondToEndSearch, "SecondToEndSearch should be trimmed of multiple whitespace characters");
@@ -39,7 +39,7 @@
                 {">", 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.");
@@ -51,7 +51,7 @@
         [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/MainWindow.xaml.cs

@@ -113,7 +113,7 @@
         {
             var handle = Win32Helper.GetWindowHandle(this, true);
             _hwndSource = HwndSource.FromHwnd(handle);
             _hwndSource.AddHook(WndProc);
             Win32Helper.HideFromAltTab(this);
             Win32Helper.DisableControlBox(this);
         }
@@ -371,7 +371,7 @@
         {
             try
             {
                 _hwndSource.RemoveHook(WndProc);
             }
             catch (Exception)
             {
@@ -474,7 +474,7 @@
                             && QueryTextBox.CaretIndex == QueryTextBox.Text.Length)
                         {
                             var queryWithoutActionKeyword =
-                                QueryBuilder.Build(QueryTextBox.Text.Trim(), PluginManager.NonGlobalPlugins)?.Search;
+                                QueryBuilder.Build(QueryTextBox.Text, QueryTextBox.Text.Trim(), PluginManager.NonGlobalPlugins)?.Search;
 
                             if (FilesFolders.IsLocationPathString(queryWithoutActionKeyword))
                             {
@@ -584,9 +584,9 @@
 
         #endregion
 
         #region Window WndProc
 
         private IntPtr WndProc(IntPtr hwnd, int msg, IntPtr wParam, IntPtr lParam, ref bool handled) 
         {
             switch (msg)
             {
@@ -773,7 +773,7 @@
                 Header = App.API.GetTranslation("iconTrayOpen") + " (" + _settings.Hotkey + ")",
                 Icon = openIcon
             };
             var gamemodeIcon = new FontIcon { Glyph = "\ue7fc" };
             var gamemode = new MenuItem
             {
                 Header = App.API.GetTranslation("GameMode"),
@@ -820,7 +820,7 @@
 
         public void UpdatePosition()
         {
             // Initialize call twice to work around multi-display alignment issue- https://github.com/Flow-Launcher/Flow.Launcher/issues/2910
             if (_viewModel.IsDialogJumpWindowUnderDialog())
             {
                 InitializeDialogJumpPosition();
@@ -844,7 +844,7 @@
 
         private void InitializePosition()
         {
             // Initialize call twice to work around multi-display alignment issue- https://github.com/Flow-Launcher/Flow.Launcher/issues/2910
             InitializePositionInner();
             InitializePositionInner();
             return;

Flow.Launcher/ViewModel/MainViewModel.cs

@@ -33,9 +33,10 @@ public partial class MainViewModel : BaseModel, ISavable, IDisposable
 
         private static readonly string ClassName = nameof(MainViewModel);
 
-        private bool _isQueryRunning;
         private Query _lastQuery;
         private bool _previousIsHomeQuery;
+        private Query _progressQuery; // Used for QueryResultAsync
+        private Query _updateQuery; // Used for ResultsUpdated
         private string _queryTextBeforeLeaveResults;
         private string _ignoredQueryText; // Used to ignore query text change when switching between context menu and query results
 
@@ -281,7 +282,7 @@ public void RegisterResultsUpdatedEvent()
                 var plugin = (IResultUpdated)pair.Plugin;
                 plugin.ResultsUpdated += (s, e) =>
                 {
-                    if (e.Query.RawQuery != QueryText || e.Token.IsCancellationRequested)
+                    if (_updateQuery == null || e.Query.RawQuery != _updateQuery.RawQuery || e.Token.IsCancellationRequested)
                     {
                         return;
                     }
@@ -309,7 +310,10 @@ public void RegisterResultsUpdatedEvent()
 
                     PluginManager.UpdatePluginMetadata(resultsCopy, pair.Metadata, e.Query);
 
-                    if (token.IsCancellationRequested) return;
+                    if (_updateQuery == null || e.Query.RawQuery != _updateQuery.RawQuery || token.IsCancellationRequested)
+                    {
+                        return;
+                    }
 
                     App.API.LogDebug(ClassName, $"Update results for plugin <{pair.Metadata.Name}>");
 
@@ -439,7 +443,7 @@ private void LoadContextMenu()
         [RelayCommand]
         private void Backspace(object index)
         {
-            var query = QueryBuilder.Build(QueryText.Trim(), PluginManager.NonGlobalPlugins);
+            var query = QueryBuilder.Build(QueryText, QueryText.Trim(), PluginManager.NonGlobalPlugins);
 
             // GetPreviousExistingDirectory does not require trailing '\', otherwise will return empty string
             var path = FilesFolders.GetPreviousExistingDirectory((_) => true, query.Search.TrimEnd('\\'));
@@ -1328,7 +1332,11 @@ private static List<Result> GetHistoryItems(IEnumerable<HistoryItem> historyItem
 
         private async Task QueryResultsAsync(bool searchDelay, bool isReQuery = false, bool reSelect = true)
         {
-            _updateSource?.Cancel();
+            if (_updateSource != null)
+            {
+                await _updateSource.CancelAsync();
+            }
+            _progressQuery = null;
 
             App.API.LogDebug(ClassName, $"Start query with text: <{QueryText}>");
 
@@ -1340,8 +1348,6 @@ private async Task QueryResultsAsync(bool searchDelay, bool isReQuery = false, b
                 return;
             }
 
-            App.API.LogDebug(ClassName, $"Start query with ActionKeyword <{query.ActionKeyword}> and RawQuery <{query.RawQuery}>");
-
             var currentIsHomeQuery = query.IsHomeQuery;
             var currentIsDialogJump = _isDialogJump;
 
@@ -1352,69 +1358,78 @@ private async Task QueryResultsAsync(bool searchDelay, bool isReQuery = false, b
                 return;
             }
 
-            _updateSource?.Dispose();
+            try
+            {
+                // Check if the input text matches the query text
+                if (query.Input != QueryText) return;
 
-            var currentUpdateSource = new CancellationTokenSource();
-            _updateSource = currentUpdateSource;
-            var currentCancellationToken = _updateSource.Token;
-            _updateToken = currentCancellationToken;
+                App.API.LogDebug(ClassName, $"Start query with ActionKeyword <{query.ActionKeyword}> and RawQuery <{query.RawQuery}>");
 
-            ProgressBarVisibility = Visibility.Hidden;
-            _isQueryRunning = true;
+                _updateSource?.Dispose();
 
-            // Switch to ThreadPool thread
-            await TaskScheduler.Default;
+                var currentUpdateSource = new CancellationTokenSource();
+                _updateSource = currentUpdateSource;
+                var currentCancellationToken = _updateSource.Token;
+                _updateToken = currentCancellationToken;
 
-            if (currentCancellationToken.IsCancellationRequested) return;
+                ProgressBarVisibility = Visibility.Hidden;
 
-            // Update the query's IsReQuery property to true if this is a re-query
-            query.IsReQuery = isReQuery;
+                _progressQuery = query;
+                _updateQuery = query;
 
-            ICollection<PluginPair> plugins = Array.Empty<PluginPair>();
-            if (currentIsHomeQuery)
-            {
-                if (Settings.ShowHomePage)
-                {
-                    plugins = PluginManager.ValidPluginsForHomeQuery();
-                }
+                // Switch to ThreadPool thread
+                await TaskScheduler.Default;
 
-                PluginIconPath = null;
-                PluginIconSource = null;
-                SearchIconVisibility = Visibility.Visible;
-            }
-            else
-            {
-                plugins = PluginManager.ValidPluginsForQuery(query, currentIsDialogJump);
+                if (currentCancellationToken.IsCancellationRequested) return;
 
-                if (plugins.Count == 1)
-                {
-                    PluginIconPath = plugins.Single().Metadata.IcoPath;
-                    PluginIconSource = await App.API.LoadImageAsync(PluginIconPath);
-                    SearchIconVisibility = Visibility.Hidden;
-                }
-                else
+                // Update the query's IsReQuery property to true if this is a re-query
+                query.IsReQuery = isReQuery;
+
+                ICollection<PluginPair> plugins = Array.Empty<PluginPair>();
+                if (currentIsHomeQuery)
                 {
+                    if (Settings.ShowHomePage)
+                    {
+                        plugins = PluginManager.ValidPluginsForHomeQuery();
+                    }
+
                     PluginIconPath = null;
                     PluginIconSource = null;
                     SearchIconVisibility = Visibility.Visible;
                 }
-            }
+                else
+                {
+                    plugins = PluginManager.ValidPluginsForQuery(query, currentIsDialogJump);
+
+                    if (plugins.Count == 1)
+                    {
+                        PluginIconPath = plugins.Single().Metadata.IcoPath;
+                        PluginIconSource = await App.API.LoadImageAsync(PluginIconPath);
+                        SearchIconVisibility = Visibility.Hidden;
+                    }
+                    else
+                    {
+                        PluginIconPath = null;
+                        PluginIconSource = null;
+                        SearchIconVisibility = Visibility.Visible;
+                    }
+                }
 
-            App.API.LogDebug(ClassName, $"Valid <{plugins.Count}> plugins: {string.Join(" ", plugins.Select(x => $"<{x.Metadata.Name}>"))}");
+                App.API.LogDebug(ClassName, $"Valid <{plugins.Count}> plugins: {string.Join(" ", plugins.Select(x => $"<{x.Metadata.Name}>"))}");
 
-            // Do not wait for performance improvement
-            /*if (string.IsNullOrEmpty(query.ActionKeyword))
-            {
-                // Wait 15 millisecond for query change in global query
-                // if query changes, return so that it won't be calculated
-                await Task.Delay(15, currentCancellationToken);
-                if (currentCancellationToken.IsCancellationRequested) return;
-            }*/
+                // Do not wait for performance improvement
+                /*if (string.IsNullOrEmpty(query.ActionKeyword))
+                {
+                    // Wait 15 millisecond for query change in global query
+                    // if query changes, return so that it won't be calculated
+                    await Task.Delay(15, currentCancellationToken);
+                    if (currentCancellationToken.IsCancellationRequested) return;
+                }*/
 
-            _ = Task.Delay(200, currentCancellationToken).ContinueWith(_ =>
+                _ = Task.Delay(200, currentCancellationToken).ContinueWith(_ =>
                 {
                     // start the progress bar if query takes more than 200 ms and this is the current running query and it didn't finish yet
-                    if (_isQueryRunning)
+                    if (_progressQuery != null && _progressQuery == query)
                     {
                         ProgressBarVisibility = Visibility.Visible;
                     }
@@ -1423,58 +1438,65 @@ private async Task QueryResultsAsync(bool searchDelay, bool isReQuery = false, b
                 TaskContinuationOptions.NotOnCanceled,
                 TaskScheduler.Default);
 
-            // plugins are ICollection, meaning LINQ will get the Count and preallocate Array
+                // plugins are ICollection, meaning LINQ will get the Count and preallocate Array
 
-            Task[] tasks;
-            if (currentIsHomeQuery)
-            {
-                if (ShouldClearExistingResultsForNonQuery(plugins))
+                Task[] tasks;
+                if (currentIsHomeQuery)
                 {
-                    Results.Clear();
-                    App.API.LogDebug(ClassName, $"Existing results are cleared for non-query");
-                }
+                    if (ShouldClearExistingResultsForNonQuery(plugins))
+                    {
+                        // No update tasks and just return
+                        ClearResults();
+                        return;
+                    }
 
-                tasks = plugins.Select(plugin => plugin.Metadata.HomeDisabled switch
+                    tasks = plugins.Select(plugin => plugin.Metadata.HomeDisabled switch
+                    {
+                        false => QueryTaskAsync(plugin, currentCancellationToken),
+                        true => Task.CompletedTask
+                    }).ToArray();
+
+                    // Query history results for home page firstly so it will be put on top of the results
+                    if (Settings.ShowHistoryResultsForHomePage)
+                    {
+                        QueryHistoryTask(currentCancellationToken);
+                    }
+                }
+                else
                 {
-                    false => QueryTaskAsync(plugin, currentCancellationToken),
-                    true => Task.CompletedTask
-                }).ToArray();
+                    tasks = plugins.Select(plugin => plugin.Metadata.Disabled switch
+                    {
+                        false => QueryTaskAsync(plugin, currentCancellationToken),
+                        true => Task.CompletedTask
+                    }).ToArray();
+                }
 
-                // Query history results for home page firstly so it will be put on top of the results
-                if (Settings.ShowHistoryResultsForHomePage)
+                try
                 {
-                    QueryHistoryTask(currentCancellationToken);
+                    // Check the code, WhenAll will translate all type of IEnumerable or Collection to Array, so make an array at first
+                    await Task.WhenAll(tasks);
                 }
-            }
-            else
-            {
-                tasks = plugins.Select(plugin => plugin.Metadata.Disabled switch
+                catch (OperationCanceledException)
                 {
-                    false => QueryTaskAsync(plugin, currentCancellationToken),
-                    true => Task.CompletedTask
-                }).ToArray();
-            }
-
-            try
-            {
-                // Check the code, WhenAll will translate all type of IEnumerable or Collection to Array, so make an array at first
-                await Task.WhenAll(tasks);
-            }
-            catch (OperationCanceledException)
-            {
-                // nothing to do here
-            }
+                    // nothing to do here
+                }
 
-            if (currentCancellationToken.IsCancellationRequested) return;
+                if (currentCancellationToken.IsCancellationRequested) return;
 
-            // this should happen once after all queries are done so progress bar should continue
-            // until the end of all querying
-            _isQueryRunning = false;
+                // this should happen once after all queries are done so progress bar should continue
+                // until the end of all querying
+                _progressQuery = null;
 
-            if (!currentCancellationToken.IsCancellationRequested)
+                if (!currentCancellationToken.IsCancellationRequested)
+                {
+                    // update to hidden if this is still the current query
+                    ProgressBarVisibility = Visibility.Hidden;
+                }
+            }
+            finally
             {
-                // update to hidden if this is still the current query
-                ProgressBarVisibility = Visibility.Hidden;
+                // this make sures running query is null even if the query is canceled
+                _progressQuery = null;
             }
 
             // Local function
@@ -1574,7 +1596,7 @@ private async Task<Query> ConstructQueryAsync(string queryText, IEnumerable<Cust
         {
             if (string.IsNullOrWhiteSpace(queryText))
             {
-                return QueryBuilder.Build(string.Empty, PluginManager.NonGlobalPlugins);
+                return QueryBuilder.Build(string.Empty, string.Empty, PluginManager.NonGlobalPlugins);
             }
 
             var queryBuilder = new StringBuilder(queryText);
@@ -1594,7 +1616,7 @@ private async Task<Query> ConstructQueryAsync(string queryText, IEnumerable<Cust
             // Applying builtin shortcuts
             await BuildQueryAsync(builtInShortcuts, queryBuilder, queryBuilderTmp);
 
-            return QueryBuilder.Build(queryBuilder.ToString().Trim(), PluginManager.NonGlobalPlugins);
+            return QueryBuilder.Build(QueryText, queryBuilder.ToString().Trim(), PluginManager.NonGlobalPlugins);
         }
 
         private async Task BuildQueryAsync(IEnumerable<BaseBuiltinShortcutModel> builtInShortcuts,
@@ -1907,7 +1929,10 @@ public async Task SetupDialogJumpAsync(nint handle)
             if (DialogJump.DialogJumpWindowPosition == DialogJumpWindowPositions.UnderDialog)
             {
                 // Cancel the previous Dialog Jump task
-                _dialogJumpSource?.Cancel();
+                if (_dialogJumpSource != null)
+                {
+                    await _dialogJumpSource.CancelAsync();
+                }
 
                 // Create a new cancellation token source
                 _dialogJumpSource = new CancellationTokenSource();