PerformRefreshRevisions: Cancel and restart reload

In special cases if any, call it with "skipIfAlreadyRefreshing: true".
gitextensions · Sep 16, 2023 · 0cd07bc · 0cd07bc
1 parent e9d2885
commit 0cd07bc
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 10 deletions.
diff --git a/GitUI/CommandsDialogs/FormBrowse.cs b/GitUI/CommandsDialogs/FormBrowse.cs
@@ -651,7 +651,7 @@ private void RefreshRevisions(Func<RefsFilter, IReadOnlyList<IGitRef>> getRefs)
  return;
  }
 
- RevisionGrid.PerformRefreshRevisions(getRefs, forceRefresh: true);
+ RevisionGrid.PerformRefreshRevisions(getRefs, forceRefreshRefs: true);
 
  InternalInitialize();
  ToolStripFilters.RefreshRevisionFunction(getRefs);

diff --git a/GitUI/UserControls/RevisionGrid/RevisionGridControl.cs b/GitUI/UserControls/RevisionGrid/RevisionGridControl.cs
@@ -846,29 +846,45 @@ private void ShowLoading(bool showSpinner = true)
  }
 
  /// <summary>
- /// Indicates whether the revision grid can be refreshed, i.e. it is not currently being refreshed
- /// or it is not in a middle of reconfiguration process guarded by <see cref="SuspendRefreshRevisions"/>
+ /// Indicates whether the revision grid can be refreshed,
+ /// i.e. it is not in a middle of reconfiguration process guarded by <see cref="SuspendRefreshRevisions"/>
  /// and <see cref="ResumeRefreshRevisions"/>.
  /// </summary>
- private bool CanRefresh => !_isRefreshingRevisions && _updatingFilters == 0;
+ private bool CanRefresh => _updatingFilters == 0;
 
  #region PerformRefreshRevisions
 
  /// <summary>
  /// Queries git for the new set of revisions and refreshes the grid.
  /// </summary>
  /// <exception cref="Exception"></exception>
- /// <param name="forceRefresh">Refresh may be required as references may be changed.</param>
- public void PerformRefreshRevisions(Func<RefsFilter, IReadOnlyList<IGitRef>> getRefs = null, bool forceRefresh = false)
+ /// <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)
  {
  ThreadHelper.AssertOnUIThread();
 
  if (!CanRefresh)
  {
- Trace.WriteLine("Ignoring refresh as RefreshRevisions() is already running.");
+ Trace.WriteLine("Ignoring refresh as RefreshRevisions() is suspended.");
  return;
  }
 
+ 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)
+ {
+ _gridView.MarkAsDataLoadingComplete();
+ }
+ }
+
  GitModule capturedModule = Module;
 
  // Reset the "cache" for current branch
@@ -1073,7 +1089,7 @@ public void PerformRefreshRevisions(Func<RefsFilter, IReadOnlyList<IGitRef>> get
  });
 
  // Initiate update left panel
- RevisionsLoading?.Invoke(this, new RevisionLoadEventArgs(this, UICommands, getUnfilteredRefs, getStashRevs, forceRefresh));
+ RevisionsLoading?.Invoke(this, new RevisionLoadEventArgs(this, UICommands, getUnfilteredRefs, getStashRevs, forceRefreshRefs));
  }
  catch
  {
@@ -1357,7 +1373,7 @@ void OnRevisionReadCompleted()
  }
 
  _isRefreshingRevisions = false;
- RevisionsLoaded?.Invoke(this, new RevisionLoadEventArgs(this, UICommands, getUnfilteredRefs, getStashRevs, forceRefresh));
+ RevisionsLoaded?.Invoke(this, new RevisionLoadEventArgs(this, UICommands, getUnfilteredRefs, getStashRevs, forceRefreshRefs));
  }).FileAndForget();
  return;
  }
@@ -1422,7 +1438,7 @@ void OnRevisionReadCompleted()
 
  SetPage(_gridView);
  _isRefreshingRevisions = false;
- RevisionsLoaded?.Invoke(this, new RevisionLoadEventArgs(this, UICommands, getUnfilteredRefs, getStashRevs, forceRefresh));
+ RevisionsLoaded?.Invoke(this, new RevisionLoadEventArgs(this, UICommands, getUnfilteredRefs, getStashRevs, forceRefreshRefs));
  HighlightRevisionsByAuthor(GetSelectedRevisions());
 
  await TaskScheduler.Default;