Clear custom tool caches in sequence after updating settings

gitextensions · Aug 31, 2021 · fdadf89 · fdadf89
1 parent c02af14
commit fdadf89
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 20 deletions.
diff --git a/GitCommands/CustomDiffMergeToolCache.cs b/GitCommands/CustomDiffMergeToolCache.cs
@@ -26,23 +26,20 @@ private CustomDiffMergeToolCache(bool isDiff)
         public static CustomDiffMergeToolCache MergeToolCache { get; } = new(false);
 
         /// <summary>
-        /// Clear the existing caches
+        /// Clear the existing caches (await current calculation to finsh first)
         /// </summary>
-        public void Clear()
+        public async Task ClearAsync()
         {
-            ThreadHelper.JoinableTaskFactory.RunAsync(async () =>
-            {
-                await _mutex.WaitAsync().ConfigureAwait(false);
+            await _mutex.WaitAsync().ConfigureAwait(false);
 
-                try
-                {
-                    _tools = null;
-                }
-                finally
-                {
-                    _mutex.Release();
-                }
-            }).FileAndForget();
+            try
+            {
+                _tools = null;
+            }
+            finally
+            {
+                _mutex.Release();
+            }
         }
 
         /// <summary>

diff --git a/GitUI/CommandsDialogs/FormBrowse.cs b/GitUI/CommandsDialogs/FormBrowse.cs
@@ -1590,9 +1590,23 @@ private void OnShowSettingsClick(object sender, EventArgs e)
             RevisionGrid.ReloadTranslation();
             fileTree.ReloadHotkeys();
             revisionDiff.ReloadHotkeys();
-            new CustomDiffMergeToolProvider().Clear();
-            revisionDiff.LoadCustomDifftools();
-            RevisionGrid.LoadCustomDifftools();
+
+            // Clear the separate caches for diff/merge tools
+            ThreadHelper.JoinableTaskFactory.RunAsync(async () =>
+            {
+                await new CustomDiffMergeToolProvider().ClearAsync(isDiff: false);
+            }).FileAndForget();
+            ThreadHelper.JoinableTaskFactory.RunAsync(async () =>
+            {
+                revisionDiff.CancelLoadCustomDifftools();
+                RevisionGrid.CancelLoadCustomDifftools();
+
+                await new CustomDiffMergeToolProvider().ClearAsync(isDiff: true);
+
+                // The tool lists are created when the forms are init, must be redone after clearing the cache
+                revisionDiff.LoadCustomDifftools();
+                RevisionGrid.LoadCustomDifftools();
+            }).FileAndForget();
 
             _dashboard?.RefreshContent();
 

diff --git a/GitUI/CommandsDialogs/RevisionDiffControl.cs b/GitUI/CommandsDialogs/RevisionDiffControl.cs
@@ -190,6 +190,11 @@ public void LoadCustomDifftools()
             new CustomDiffMergeToolProvider().LoadCustomDiffMergeTools(Module, menus, components, isDiff: true);
         }
 
+        public void CancelLoadCustomDifftools()
+        {
+            _customDiffToolsSequence.CancelCurrent();
+        }
+
         private string GetShortcutKeyDisplayString(Command cmd)
         {
             return GetShortcutKeys((int)cmd).ToShortcutKeyDisplayString();

diff --git a/GitUI/CustomDiffMergeToolProvider.cs b/GitUI/CustomDiffMergeToolProvider.cs
@@ -2,6 +2,7 @@
 using System.ComponentModel;
 using System.Drawing;
 using System.Linq;
+using System.Threading.Tasks;
 using System.Windows.Forms;
 using GitCommands;
 
@@ -18,10 +19,17 @@ public class CustomDiffMergeToolProvider
         /// <summary>
         /// Clear the existing caches.
         /// </summary>
-        public void Clear()
+        /// <param name="isDiff">True if diff, false if merge.</param>
+        public async Task ClearAsync(bool isDiff)
         {
-            CustomDiffMergeToolCache.DiffToolCache.Clear();
-            CustomDiffMergeToolCache.MergeToolCache.Clear();
+            if (isDiff)
+            {
+                await CustomDiffMergeToolCache.DiffToolCache.ClearAsync();
+            }
+            else
+            {
+                await CustomDiffMergeToolCache.MergeToolCache.ClearAsync();
+            }
         }
 
         /// <summary>

diff --git a/GitUI/UserControls/RevisionGrid/RevisionGridControl.cs b/GitUI/UserControls/RevisionGrid/RevisionGridControl.cs
@@ -664,6 +664,11 @@ public void LoadCustomDifftools()
             new CustomDiffMergeToolProvider().LoadCustomDiffMergeTools(Module, menus, components, isDiff: true);
         }
 
+        public void CancelLoadCustomDifftools()
+        {
+            _customDiffToolsSequence.CancelCurrent();
+        }
+
         private void SetSelectedIndex(int index, bool toggleSelection = false)
         {
             try