refactor: use System.Threading.CancellationToken instead of SourceGit.Commands.Command.CancelToken to cancel fetching information of selected commit

Signed-off-by: leo <[email protected]>

Author: love-linger

src/Commands/Command.cs

@@ -3,18 +3,14 @@
 using System.Diagnostics;
 using System.Text;
 using System.Text.RegularExpressions;
+using System.Threading;
 
 using Avalonia.Threading;
 
 namespace SourceGit.Commands
 {
     public partial class Command
     {
-        public class CancelToken
-        {
-            public bool Requested { get; set; } = false;
-        }
-
         public class ReadToEndResult
         {
             public bool IsSuccess { get; set; } = false;
@@ -30,7 +26,7 @@ public enum EditorType
         }
 
         public string Context { get; set; } = string.Empty;
-        public CancelToken Cancel { get; set; } = null;
+        public CancellationToken CancellationToken { get; set; } = CancellationToken.None;
         public string WorkingDirectory { get; set; } = null;
         public EditorType Editor { get; set; } = EditorType.CoreEditor; // Only used in Exec() mode
         public string SSHKey { get; set; } = string.Empty;
@@ -43,36 +39,15 @@ public bool Exec()
             var start = CreateGitStartInfo();
             var errs = new List<string>();
             var proc = new Process() { StartInfo = start };
-            var isCancelled = false;
 
             proc.OutputDataReceived += (_, e) =>
             {
-                if (Cancel != null && Cancel.Requested)
-                {
-                    isCancelled = true;
-                    proc.CancelErrorRead();
-                    proc.CancelOutputRead();
-                    if (!proc.HasExited)
-                        proc.Kill(true);
-                    return;
-                }
-
                 if (e.Data != null)
                     OnReadline(e.Data);
             };
 
             proc.ErrorDataReceived += (_, e) =>
             {
-                if (Cancel != null && Cancel.Requested)
-                {
-                    isCancelled = true;
-                    proc.CancelErrorRead();
-                    proc.CancelOutputRead();
-                    if (!proc.HasExited)
-                        proc.Kill(true);
-                    return;
-                }
-
                 if (string.IsNullOrEmpty(e.Data))
                 {
                     errs.Add(string.Empty);
@@ -97,9 +72,25 @@ public bool Exec()
                 errs.Add(e.Data);
             };
 
+            var dummy = null as Process;
             try
             {
                 proc.Start();
+
+                // It not safe, please only use `CancellationToken` in readonly commands.
+                if (CancellationToken.CanBeCanceled)
+                {
+                    dummy = proc;
+                    CancellationToken.Register(() =>
+                    {
+                        if (dummy is { HasExited: false })
+                        {
+                            dummy.CancelErrorRead();
+                            dummy.CancelOutputRead();
+                            dummy.Kill();
+                        }
+                    });
+                }
             }
             catch (Exception e)
             {
@@ -113,10 +104,11 @@ public bool Exec()
             proc.BeginErrorReadLine();
             proc.WaitForExit();
 
+            dummy = null;
             int exitCode = proc.ExitCode;
             proc.Close();
 
-            if (!isCancelled && exitCode != 0)
+            if (!CancellationToken.IsCancellationRequested && exitCode != 0)
             {
                 if (RaiseError)
                 {

src/ViewModels/CommitDetail.cs

@@ -3,6 +3,7 @@
 using System.Globalization;
 using System.IO;
 using System.Text.RegularExpressions;
+using System.Threading;
 using System.Threading.Tasks;
 
 using Avalonia.Controls;
@@ -171,7 +172,7 @@ public void Cleanup()
             _searchChangeFilter = null;
             _diffContext = null;
             _viewRevisionFileContent = null;
-            _cancelToken = null;
+            _cancellationSource = null;
             WebLinks.Clear();
             _revisionFiles = null;
             _revisionFileSearchSuggestion = null;
@@ -589,41 +590,45 @@ private void Refresh()
             if (_commit == null)
                 return;
 
+            if (_cancellationSource is { IsCancellationRequested: false })
+                _cancellationSource.Cancel();
+
+            _cancellationSource = new CancellationTokenSource();
+            var token = _cancellationSource.Token;
+
             Task.Run(() =>
             {
                 var message = new Commands.QueryCommitFullMessage(_repo.FullPath, _commit.SHA).Result();
                 var links = ParseLinksInMessage(message);
-                Dispatcher.UIThread.Invoke(() => FullMessage = new Models.CommitFullMessage { Message = message, Links = links });
+
+                if (!token.IsCancellationRequested)
+                    Dispatcher.UIThread.Invoke(() => FullMessage = new Models.CommitFullMessage { Message = message, Links = links });
             });
 
             Task.Run(() =>
             {
                 var signInfo = new Commands.QueryCommitSignInfo(_repo.FullPath, _commit.SHA, !_repo.HasAllowedSignersFile).Result();
-                Dispatcher.UIThread.Invoke(() => SignInfo = signInfo);
+                if (!token.IsCancellationRequested)
+                    Dispatcher.UIThread.Invoke(() => SignInfo = signInfo);
             });
 
-            if (_cancelToken != null)
-                _cancelToken.Requested = true;
-
-            _cancelToken = new Commands.Command.CancelToken();
-
             if (Preferences.Instance.ShowChildren)
             {
                 Task.Run(() =>
                 {
                     var max = Preferences.Instance.MaxHistoryCommits;
-                    var cmdChildren = new Commands.QueryCommitChildren(_repo.FullPath, _commit.SHA, max) { Cancel = _cancelToken };
-                    var children = cmdChildren.Result();
-                    if (!cmdChildren.Cancel.Requested)
+                    var cmd = new Commands.QueryCommitChildren(_repo.FullPath, _commit.SHA, max) { CancellationToken = token };
+                    var children = cmd.Result();
+                    if (!token.IsCancellationRequested)
                         Dispatcher.UIThread.Post(() => Children = children);
                 });
             }
 
             Task.Run(() =>
             {
                 var parent = _commit.Parents.Count == 0 ? "4b825dc642cb6eb9a060e54bf8d69288fbee4904" : _commit.Parents[0];
-                var cmdChanges = new Commands.CompareRevisions(_repo.FullPath, parent, _commit.SHA) { Cancel = _cancelToken };
-                var changes = cmdChanges.Result();
+                var cmd = new Commands.CompareRevisions(_repo.FullPath, parent, _commit.SHA) { CancellationToken = token };
+                var changes = cmd.Result();
                 var visible = changes;
                 if (!string.IsNullOrWhiteSpace(_searchChangeFilter))
                 {
@@ -635,7 +640,7 @@ private void Refresh()
                     }
                 }
 
-                if (!cmdChanges.Cancel.Requested)
+                if (!token.IsCancellationRequested)
                 {
                     Dispatcher.UIThread.Post(() =>
                     {
@@ -873,7 +878,7 @@ private void CalcRevisionFileSearchSuggestion()
         private string _searchChangeFilter = string.Empty;
         private DiffContext _diffContext = null;
         private object _viewRevisionFileContent = null;
-        private Commands.Command.CancelToken _cancelToken = null;
+        private CancellationTokenSource _cancellationSource = null;
         private List<string> _revisionFiles = null;
         private string _revisionFileSearchFilter = string.Empty;
         private List<string> _revisionFileSearchSuggestion = null;