From 2941e036bc864507211ed37ed9ba2ec140862daf Mon Sep 17 00:00:00 2001
From: Jeremy <jeremy24wu@gmail.com>
Date: Sat, 17 May 2025 21:08:18 +1000
Subject: [PATCH] add logging and method summaries

---
 Flow.Launcher/ViewModel/MainViewModel.cs    | 23 +++++++++++++++++----
 Flow.Launcher/ViewModel/ResultsViewModel.cs |  3 +++
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/Flow.Launcher/ViewModel/MainViewModel.cs b/Flow.Launcher/ViewModel/MainViewModel.cs
index 64fb85296..bfda18b9a 100644
--- a/Flow.Launcher/ViewModel/MainViewModel.cs
+++ b/Flow.Launcher/ViewModel/MainViewModel.cs
@@ -1341,7 +1341,11 @@ namespace Flow.Launcher.ViewModel
             if (currentIsHomeQuery)
             {
                 if (ShouldClearExistingResultsForNonQuery(plugins))
+                {
                     Results.Clear();
+                    App.API.LogDebug(ClassName, $"Existing results are cleared for non-query");
+                }
+                    
 
                 tasks = plugins.Select(plugin => plugin.Metadata.HomeDisabled switch
                 {
@@ -1548,7 +1552,9 @@ namespace Flow.Launcher.ViewModel
 
         /// <summary>
         /// Determines whether the existing search results should be cleared based on the current query and the previous query type.
-        /// This is needed because of the design that treats plugins with action keywords and global action keywords separately. Results are gathered
+        /// This is used to indicate to QueryTaskAsync or QueryHistoryTask whether to clear results. If both QueryTaskAsync and QueryHistoryTask
+        /// are not called then use ShouldClearExistingResultsForNonQuery instead.
+        /// This method needed because of the design that treats plugins with action keywords and global action keywords separately. Results are gathered
         /// either from plugins with matching action keywords or global action keyword, but not both. So when the current results are from plugins
         /// with a matching action keyword and a new result set comes from a new query with the global action keyword, the existing results need to be cleared,
         /// and vice versa. The same applies to home page query results.
@@ -1564,25 +1570,34 @@ namespace Flow.Launcher.ViewModel
             // If previous or current results are from home query, we need to clear them
             if (_previousIsHomeQuery || currentIsHomeQuery)
             {
-                App.API.LogDebug(ClassName, $"Cleared old results");
+                App.API.LogDebug(ClassName, $"Existing results should be cleared for query");
                 return true;
             }
 
             // If the last and current query are not home query type, we need to check the action keyword
             if (_lastQuery?.ActionKeyword != query?.ActionKeyword)
             {
-                App.API.LogDebug(ClassName, $"Cleared old results");
+                App.API.LogDebug(ClassName, $"Existing results should be cleared for query");
                 return true;
             }
 
             return false;
         }
 
+        /// <summary>
+        /// Determines whether existing results should be cleared for non-query calls.
+        /// A non-query call is where QueryTaskAsync and QueryHistoryTask methods are both not called.
+        /// QueryTaskAsync and QueryHistoryTask both handle result updating (clearing if required) so directly calling
+        /// Results.Clear() is not required. However when both are not called, we need to directly clear results and this
+        /// method determines on the condition when clear results should happen.
+        /// </summary>
+        /// <param name="plugins">The collection of plugins to check.</param>
+        /// <returns>True if existing results should be cleared, false otherwise.</returns>
         private bool ShouldClearExistingResultsForNonQuery(ICollection<PluginPair> plugins)
         {
             if (!Settings.ShowHistoryResultsForHomePage && (plugins.Count == 0 || plugins.All(x => x.Metadata.HomeDisabled == true)))
             {
-                App.API.LogDebug(ClassName, $"Cleared old results");
+                App.API.LogDebug(ClassName, $"Existing results should be cleared for non-query");
                 return true;
             }
 
diff --git a/Flow.Launcher/ViewModel/ResultsViewModel.cs b/Flow.Launcher/ViewModel/ResultsViewModel.cs
index cd2736afa..46a92f750 100644
--- a/Flow.Launcher/ViewModel/ResultsViewModel.cs
+++ b/Flow.Launcher/ViewModel/ResultsViewModel.cs
@@ -235,7 +235,10 @@ namespace Flow.Launcher.ViewModel
             var newResults = resultsForUpdates.SelectMany(u => u.Results, (u, r) => new ResultViewModel(r, _settings));
 
             if (resultsForUpdates.Any(x => x.shouldClearExistingResults))
+            {
+                App.API.LogDebug("NewResults", $"Existing results are cleared for query");
                 return newResults.OrderByDescending(rv => rv.Result.Score).ToList();
+            }
 
             return Results.Where(r => r?.Result != null && resultsForUpdates.All(u => u.ID != r.Result.PluginID))
                               .Concat(newResults)