fixup! PerformRefreshRevisions: Cancel and restart reload

Review comments + exception safety
gitextensions · Oct 19, 2023 · e414384 · e414384
1 parent f6486e8
commit e414384
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 38 deletions.
diff --git a/GitUI/CommandsDialogs/FormBrowse.cs b/GitUI/CommandsDialogs/FormBrowse.cs
@@ -1659,40 +1659,46 @@ private void SetGitModule(object sender, GitModuleEventArgs e)
  if (Module.IsValidGitWorkingDir())
  {
  RevisionGrid.SuspendRefreshRevisions();
- string path = Module.WorkingDir;
- ThreadHelper.JoinableTaskFactory.Run(() => RepositoryHistoryManager.Locals.AddAsMostRecentAsync(path));
- AppSettings.RecentWorkingDir = path;
+ try
+ {
+ string path = Module.WorkingDir;
+ ThreadHelper.JoinableTaskFactory.Run(() => RepositoryHistoryManager.Locals.AddAsMostRecentAsync(path));
+ AppSettings.RecentWorkingDir = path;
 
- HideDashboard();
+  HideDashboard();
 
- if (!string.Equals(originalWorkingDir, Module.WorkingDir, StringComparison.Ordinal))
- {
- ChangeTerminalActiveFolder(Module.WorkingDir);
+  if (!string.Equals(originalWorkingDir, Module.WorkingDir, StringComparison.Ordinal))
+  {
+  ChangeTerminalActiveFolder(Module.WorkingDir);
 
 #if DEBUG
- // Current encodings
- Debug.WriteLine($"Encodings for {Module.WorkingDir}");
- Debug.WriteLine($"Files content encoding: {Module.FilesEncoding.EncodingName}");
- Debug.WriteLine($"Commit encoding: {Module.CommitEncoding.EncodingName}");
- if (Module.LogOutputEncoding.CodePage != Module.CommitEncoding.CodePage)
- {
- Debug.WriteLine($"Log output encoding: {Module.LogOutputEncoding.EncodingName}");
- }
+  // Current encodings
+  Debug.WriteLine($"Encodings for {Module.WorkingDir}");
+  Debug.WriteLine($"Files content encoding: {Module.FilesEncoding.EncodingName}");
+  Debug.WriteLine($"Commit encoding: {Module.CommitEncoding.EncodingName}");
+  if (Module.LogOutputEncoding.CodePage != Module.CommitEncoding.CodePage)
+  {
+  Debug.WriteLine($"Log output encoding: {Module.LogOutputEncoding.EncodingName}");
+  }
 #endif
 
- // Reset the filter when switching repos
+  // Reset the filter when switching repos
 
- // If we're applying custom branch or revision filters - reset them
- RevisionGrid.ResetAllFilters();
- ToolStripFilters.ClearQuickFilters();
- AppSettings.BranchFilterEnabled = AppSettings.BranchFilterEnabled;
- revisionDiff.RepositoryChanged();
- }
+  // If we're applying custom branch or revision filters - reset them
+  RevisionGrid.ResetAllFilters();
+  ToolStripFilters.ClearQuickFilters();
+  AppSettings.BranchFilterEnabled = AppSettings.BranchFilterEnabled;
+  revisionDiff.RepositoryChanged();
+  }
 
- RevisionInfo.SetRevisionWithChildren(revision: null, children: Array.Empty<ObjectId>());
- RevisionGrid.ResumeRefreshRevisions();
+ RevisionInfo.SetRevisionWithChildren(revision: null, children: Array.Empty<ObjectId>());
+ }
+ finally
+ {
+ RevisionGrid.ResumeRefreshRevisions();
 
- RefreshRevisions();
+ RefreshRevisions();
+ }
  }
  else
  {

diff --git a/GitUI/UserControls/RevisionGrid/RevisionGridControl.cs b/GitUI/UserControls/RevisionGrid/RevisionGridControl.cs
@@ -113,7 +113,7 @@ public sealed partial class RevisionGridControl : GitModuleControl, IScriptHostC
  /// </summary>
  private Lazy<IReadOnlyCollection<string>>? _ambiguousRefs;
 
- private int _updatingFilters;
+ private int _suspendRefreshCounter;
 
  private IDisposable? _revisionSubscription;
  private GitRevision? _baseCommitToCompare;
@@ -472,15 +472,15 @@ public void DisableContextMenu()
  /// Prevents revisions refreshes and stops <see cref="PerformRefreshRevisions"/> from executing
  /// until <see cref="ResumeRefreshRevisions"/> is called.
  /// </summary>
- internal void SuspendRefreshRevisions() => _updatingFilters++;
+ internal void SuspendRefreshRevisions() => ++_suspendRefreshCounter;
 
  /// <summary>
  /// Resume revisions refreshes.
  /// </summary>
  internal void ResumeRefreshRevisions()
  {
- --_updatingFilters;
- DebugHelpers.Assert(_updatingFilters >= 0, $"{nameof(ResumeRefreshRevisions)} was called without matching {nameof(SuspendRefreshRevisions)}!");
+ --_suspendRefreshCounter;
+ DebugHelpers.Assert(_suspendRefreshCounter >= 0, $"{nameof(ResumeRefreshRevisions)} was called without matching {nameof(SuspendRefreshRevisions)}!");
  }
 
  public void SetAndApplyBranchFilter(string filter)
@@ -856,7 +856,7 @@ private void ShowLoading(bool showSpinner = true)
  /// i.e. it is not in a middle of reconfiguration process guarded by <see cref="SuspendRefreshRevisions"/>
  /// and <see cref="ResumeRefreshRevisions"/>.
  /// </summary>
- private bool CanRefresh => _updatingFilters == 0;
+ private bool CanRefresh => _suspendRefreshCounter == 0;
 
  #region PerformRefreshRevisions
 
@@ -865,8 +865,7 @@ private void ShowLoading(bool showSpinner = true)
  /// </summary>
  /// <exception cref="Exception"></exception>
  /// <param name="forceRefreshRefs">Refresh may be required as references may be changed.</param>
- /// <param name="skipIfAlreadyRefreshing">If true and grid is already / yet being refreshed, do not cancel and restart.</param>
- public void PerformRefreshRevisions(Func<RefsFilter, IReadOnlyList<IGitRef>> getRefs = null, bool forceRefreshRefs = false, bool skipIfAlreadyRefreshing = false)
+ public void PerformRefreshRevisions(Func<RefsFilter, IReadOnlyList<IGitRef>> getRefs = null, bool forceRefreshRefs = false)
  {
  ThreadHelper.AssertOnUIThread();
 
@@ -878,12 +877,6 @@ public void PerformRefreshRevisions(Func<RefsFilter, IReadOnlyList<IGitRef>> get
 
  if (_isRefreshingRevisions)
  {
- if (skipIfAlreadyRefreshing)
- {
- Trace.WriteLine("Ignoring refresh as RefreshRevisions() is already running.");
- return;
- }
-
  Trace.WriteLine("Forcing refresh, cancel already running RefreshRevisions().");
  if (!_gridView.IsDataLoadComplete)
  {