BlameControl: cancellation token for git-blame (#9816)

git-blame may require considerable time, the git executable must be cancelable. Clear the blame viewer when processing a new file. Make the async Clear in FileViewer public. Cancellation token for LoadBlame Missing for RevFileTree (and FileHistory), existing for RevDiff Return the async Task for the Blame.
gitextensions · Jan 27, 2022 · 3f7d2b3 · 3f7d2b3
1 parent 1dc9bba
commit 3f7d2b3
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 44 deletions.
diff --git a/GitCommands/Git/GitModule.cs b/GitCommands/Git/GitModule.cs
@@ -3260,7 +3260,7 @@ public IEnumerable<INamedGitItem> GetTree(ObjectId? commitId, bool full)
             return _gitTreeParser.Parse(tree);
         }
 
-        public GitBlame Blame(string? fileName, string from, Encoding encoding, string? lines = null)
+        public GitBlame Blame(string? fileName, string from, Encoding encoding, string? lines = null, CancellationToken cancellationToken = default)
         {
             GitArgumentBuilder args = new("blame")
             {
@@ -3275,7 +3275,13 @@ public GitBlame Blame(string? fileName, string from, Encoding encoding, string?
                 fileName.ToPosixPath().Quote()
             };
 
-            var output = _gitExecutable.GetOutput(args, cache: GitCommandCache, outputEncoding: LosslessEncoding);
+            ExecutionResult result = _gitExecutable.Execute(
+                args,
+                cache: GitCommandCache,
+                outputEncoding: LosslessEncoding,
+                cancellationToken: cancellationToken);
+
+            var output = result.StandardOutput;
 
             try
             {

diff --git a/GitUI/CommandsDialogs/FormBlame.cs b/GitUI/CommandsDialogs/FormBlame.cs
@@ -34,7 +34,7 @@ public FormBlame(GitUICommands commands, string fileName, GitRevision? revision,
 
             FileName = fileName;
 
-            blameControl1.LoadBlame(revision ?? Module.GetRevision(), null, fileName, null, null, Module.FilesEncoding, initialLine);
+            _ = blameControl1.LoadBlameAsync(revision ?? Module.GetRevision(), null, fileName, null, null, Module.FilesEncoding, initialLine);
             blameControl1.ConfigureRepositoryHostPlugin(PluginRegistry.TryGetGitHosterForModule(Module));
         }
 

diff --git a/GitUI/CommandsDialogs/FormFileHistory.cs b/GitUI/CommandsDialogs/FormFileHistory.cs
@@ -340,7 +340,7 @@ private void UpdateSelectedFileViewers(bool force = false)
 
             if (tabControl1.SelectedTab == BlameTab)
             {
-                Blame.LoadBlame(revision, children, fileName, RevisionGrid, BlameTab, Diff.Encoding, force: force);
+                _ = Blame.LoadBlameAsync(revision, children, fileName, RevisionGrid, BlameTab, Diff.Encoding, force: force, cancellationToken: _viewChangesSequence.Next());
             }
             else if (tabControl1.SelectedTab == ViewTab)
             {

diff --git a/GitUI/CommandsDialogs/RevisionDiffControl.cs b/GitUI/CommandsDialogs/RevisionDiffControl.cs
@@ -476,14 +476,15 @@ private void ResetSelectedItemsTo(bool actsAsChild)
             RequestRefresh();
         }
 
-        private void BlameSelectedFileDiff(int? line = null)
+        private async Task ShowSelectedFileBlameAsync(int? line = null)
         {
             BlameControl.Visible = true;
             DiffText.Visible = false;
             GitRevision rev = DiffFiles.SelectedItem.SecondRevision.IsArtificial
                 ? _revisionGrid.GetActualRevision(_revisionGrid.CurrentCheckout)
                 : DiffFiles.SelectedItem.SecondRevision;
-            BlameControl.LoadBlame(rev, children: null, DiffFiles.SelectedItem.Item.Name, _revisionGrid, controlToMask: null, DiffText.Encoding, line, cancellationToken: _viewChangesSequence.Next());
+            await BlameControl.LoadBlameAsync(rev, children: null, DiffFiles.SelectedItem.Item.Name, _revisionGrid,
+                controlToMask: null, DiffText.Encoding, line, cancellationToken: _viewChangesSequence.Next());
         }
 
         private async Task ShowSelectedFileDiffAsync()
@@ -495,12 +496,16 @@ await DiffText.ViewChangesAsync(DiffFiles.SelectedItem,
                 cancellationToken: _viewChangesSequence.Next());
         }
 
+        /// <summary>
+        /// Show selected item as diff or blame
+        /// </summary>
+        private void ShowSelectedFile(int? line = null) =>
+            ThreadHelper.JoinableTaskFactory.RunAsync(async () =>
+            await (DiffText.Visible ? ShowSelectedFileDiffAsync() : ShowSelectedFileBlameAsync(line))).FileAndForget();
+
         private void DiffFiles_SelectedIndexChanged(object sender, EventArgs e)
         {
-            ThreadHelper.JoinableTaskFactory.RunAsync(async () =>
-            {
-                await ShowSelectedFileDiffAsync();
-            }).FileAndForget();
+            ThreadHelper.JoinableTaskFactory.RunAsync(ShowSelectedFileDiffAsync).FileAndForget();
         }
 
         private void DiffFiles_DoubleClick(object sender, EventArgs e)
@@ -513,11 +518,7 @@ private void DiffFiles_DoubleClick(object sender, EventArgs e)
 
             if (AppSettings.OpenSubmoduleDiffInSeparateWindow && item.Item.IsSubmodule)
             {
-                ThreadHelper.JoinableTaskFactory.RunAsync(
-                    async () =>
-                    {
-                        await DiffFiles.OpenSubmoduleAsync();
-                    });
+                ThreadHelper.JoinableTaskFactory.RunAsync(DiffFiles.OpenSubmoduleAsync);
             }
             else
             {
@@ -535,10 +536,7 @@ private void DiffFiles_DataSourceChanged(object sender, EventArgs e)
 
         private void DiffText_ExtraDiffArgumentsChanged(object sender, EventArgs e)
         {
-            ThreadHelper.JoinableTaskFactory.RunAsync(async () =>
-            {
-                await ShowSelectedFileDiffAsync();
-            }).FileAndForget();
+            ThreadHelper.JoinableTaskFactory.RunAsync(ShowSelectedFileDiffAsync).FileAndForget();
         }
 
         private void DiffText_PatchApplied(object sender, EventArgs e)
@@ -637,7 +635,9 @@ private void blameToolStripMenuItem_Click(object sender, EventArgs e)
             {
                 int? line = DiffText.Visible ? DiffText.CurrentFileLine : null;
                 blameToolStripMenuItem.Checked = !blameToolStripMenuItem.Checked;
-                BlameSelectedFileDiff(line);
+                BlameControl.Visible = blameToolStripMenuItem.Checked;
+                DiffText.Visible = !blameToolStripMenuItem.Checked;
+                ShowSelectedFile(line);
                 return;
             }
 

diff --git a/GitUI/CommandsDialogs/RevisionFileTreeControl.Designer.cs b/GitUI/CommandsDialogs/RevisionFileTreeControl.Designer.cs
diff --git a/GitUI/CommandsDialogs/RevisionFileTreeControl.cs b/GitUI/CommandsDialogs/RevisionFileTreeControl.cs
@@ -57,6 +57,7 @@ private readonly RememberFileContextMenuController _rememberFileContextMenuContr
             = RememberFileContextMenuController.Default;
         private Action? _refreshGitStatus;
         private RevisionGridControl? _revisionGrid;
+        private readonly CancellationTokenSequence _viewBlameSequence = new();
 
         public RevisionFileTreeControl()
         {
@@ -290,6 +291,21 @@ private string GetShortcutKeyDisplayString(Command cmd)
 
         #endregion
 
+        /// <summary>
+        /// Clean up any resources being used.
+        /// </summary>
+        /// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
+        protected override void Dispose(bool disposing)
+        {
+            if (disposing)
+            {
+                _viewBlameSequence.Dispose();
+                components?.Dispose();
+            }
+
+            base.Dispose(disposing);
+        }
+
         protected override void OnRuntimeLoad()
         {
             tvGitTree.ImageList = new ImageList(components)
@@ -391,8 +407,7 @@ private Task ShowGitItemAsync(GitItem gitItem)
                         int? line = FileText.Visible ? FileText.CurrentFileLine : null;
                         BlameControl.Visible = true;
                         FileText.Visible = false;
-                        BlameControl.LoadBlame(_revision, children: null, gitItem.FileName, _revisionGrid, controlToMask: null, FileText.Encoding, line);
-                        return Task.CompletedTask;
+                        return BlameControl.LoadBlameAsync(_revision, children: null, gitItem.FileName, _revisionGrid, controlToMask: null, FileText.Encoding, line, cancellationToken: _viewBlameSequence.Next());
                     }
 
                 case GitObjectType.Commit:
@@ -423,7 +438,7 @@ private Task ClearOutputAsync()
         {
             BlameControl.Visible = false;
             FileText.Visible = true;
-            return FileText.ViewTextAsync("", "");
+            return FileText.ClearAsync();
         }
 
         private void tvGitTree_BeforeExpand(object sender, TreeViewCancelEventArgs e)

diff --git a/GitUI/Editor/FileViewer.cs b/GitUI/Editor/FileViewer.cs
@@ -328,6 +328,11 @@ public void SetGitBlameGutter(IEnumerable<GitBlameEntry> gitBlameEntries)
             }
         }
 
+        public void ClearBlameGutter()
+        {
+            internalFileViewer.ShowGutterAvatars = false;
+        }
+
         public void ReloadHotkeys()
         {
             Hotkeys = HotkeySettingsManager.LoadHotkeys(HotkeySettingsName);
@@ -649,9 +654,11 @@ string GetFileText()
             }
         }
 
+        public Task ClearAsync() => ViewTextAsync("", "");
+
         public void Clear()
         {
-            ThreadHelper.JoinableTaskFactory.Run(() => ViewTextAsync("", ""));
+            ThreadHelper.JoinableTaskFactory.Run(() => ClearAsync());
         }
 
         /// <summary>
@@ -863,24 +870,25 @@ long GetFileLength()
             }
         }
 
-        private Task ShowOrDeferAsync(long contentLength, Func<Task> showFunc)
+        private async Task ShowOrDeferAsync(long contentLength, Func<Task> showFunc)
         {
             const long maxLength = 5 * 1024 * 1024;
 
             if (contentLength > maxLength)
             {
-                Clear();
+                await ClearAsync();
                 Refresh();
                 _NO_TRANSLATE_lblShowPreview.Text = string.Format(_largeFileSizeWarning.Text, contentLength / (1024d * 1024));
                 _NO_TRANSLATE_lblShowPreview.Show();
                 _deferShowFunc = showFunc;
-                return Task.CompletedTask;
+                return;
             }
             else
             {
                 _NO_TRANSLATE_lblShowPreview.Hide();
                 _deferShowFunc = null;
-                return showFunc();
+                await showFunc();
+                return;
             }
         }
 

diff --git a/GitUI/GitUIExtensions.cs b/GitUI/GitUIExtensions.cs
@@ -48,7 +48,7 @@ public static async Task ViewChangesAsync(this FileViewer fileViewer,
                     return;
                 }
 
-                fileViewer.Clear();
+                await fileViewer.ClearAsync();
                 return;
             }
 

diff --git a/GitUI/UserControls/BlameControl.cs b/GitUI/UserControls/BlameControl.cs
@@ -6,6 +6,7 @@
 using System.Linq;
 using System.Text;
 using System.Threading;
+using System.Threading.Tasks;
 using System.Windows.Forms;
 using GitCommands;
 using GitExtUtils;
@@ -96,7 +97,7 @@ public void HideCommitInfo()
             CommitInfo.CommandClicked -= commitInfo_CommandClicked;
         }
 
-        public void LoadBlame(GitRevision revision, IReadOnlyList<ObjectId>? children, string? fileName, RevisionGridControl? revGrid, Control? controlToMask, Encoding encoding, int? initialLine = null, bool force = false, CancellationToken cancellationToken = default)
+        public async Task LoadBlameAsync(GitRevision revision, IReadOnlyList<ObjectId>? children, string? fileName, RevisionGridControl? revGrid, Control? controlToMask, Encoding encoding, int? initialLine = null, bool force = false, CancellationToken cancellationToken = default)
         {
             ObjectId objectId = revision.ObjectId;
 
@@ -121,7 +122,12 @@ public void LoadBlame(GitRevision revision, IReadOnlyList<ObjectId>? children, s
                 ? _clickedBlameLine.OriginLineNumber
                 : initialLine ?? 0;
 
-            _blameLoader.LoadAsync(() => _blame = Module.Blame(fileName, objectId.ToString(), encoding),
+            // Clear the contents of the viewer while loading
+            BlameAuthor.ClearBlameGutter();
+            await BlameAuthor.ClearAsync();
+            await BlameFile.ClearAsync();
+
+            await _blameLoader.LoadAsync(cancellationToken => _blame = Module.Blame(fileName, objectId.ToString(), encoding, cancellationToken: cancellationToken),
                 () => ProcessBlame(fileName, revision, children, controlToMask, line, scrollPos, cancellationToken));
         }