BlameControl: cancellation token for git-blame #9816
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
assigned
This was referenced Jan 14, 2022
mstv
reviewed
Jan 17, 2022
| @@ -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()); | |||
There was a problem hiding this comment.
❔ _ =
Why do you explicitly discard the Task result sometimes and sometimes not?
There was a problem hiding this comment.
This was required in #8914
Will add to FormBlame
There was a problem hiding this comment.
Why not JTF.RunAsync(() => Blame.LoadBlameAsync(...)).FileAndForget(); or JTF.Run(() => Blame.LoadBlameAsync(...))?
There was a problem hiding this comment.
I just realized that GitUIExtensions.ViewChangesAsync is async Task changing this too (it should work the same).
The same handling should be used, should ViewChangesAsync be changed too?
RussKie
reviewed
Jan 18, 2022
| @@ -638,7 +638,7 @@ private void blameToolStripMenuItem_Click(object sender, EventArgs e) | |||
| } | |||
|
|
|||
| blameToolStripMenuItem.Checked = !blameToolStripMenuItem.Checked; | |||
| BlameSelectedFileDiff(); | |||
| ShowSelectedFileBlameAsync(); | |||
|
LGTM |
gerhardol
force-pushed
the
feature/i9796-blame-cancellation
branch
from
0173b53
to
fb14952
Compare
|
squashed and rebased, added one change to clear the file viewer async. Would like to merge this in two days or so. |
mstv
reviewed
Jan 21, 2022
gerhardol
force-pushed
the
feature/i9796-blame-cancellation
branch
from
18f8c00
to
bef1283
Compare
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.
gerhardol
force-pushed
the
feature/i9796-blame-cancellation
branch
from
bef1283
to
4d21470
Compare
mstv
approved these changes
Jan 26, 2022
|
Squash merging tomorrow. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
git-blame may require considerable time, the git executable
must be cancelable.
For instance git-blame of "GitUI/Translation/en_pseudo.xlf" takes about a minute for me.
Clear the blame viewer when processing a new file.
Before the contents of the previous file was not cleared, which was confusing.
(This was not a problem when a separate FileHistory had to be opened for Blame, but is now when Blame can be viewed in FileTree and RevDidd).
Note that cancelling the Git command will not kill the Git process. So clicking around in the file tree can start several long running processes.
Before, they always ran to completion in GitModule, now they are aborted (no exit status and short runtime in command log).
So in some sense cancelling is worse as the command still runs but command cache is not updated if the file is viewed again...
process.Kill() could be used when cancellation is done.
Screenshots
Before
(You can see that the second time English-plugins.xlf is clicked that it is quickly displayed as git-blame ran to completion before the executable was cancelled).
After
Test methodology
Manual
Merge strategy
I agree that the maintainer squash merge this PR (if the commit message is clear).
✒️ I contribute this code under The Developer Certificate of Origin.