Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Batch FAR window update messages to lower refresh overhead. #73534

Merged
merged 3 commits into from
May 18, 2024
Merged

Batch FAR window update messages to lower refresh overhead. #73534

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac128b5
Update window more slowly
CyrusNajmabadi May 17, 2024
caf6c9a
Apply suggestions from code review
CyrusNajmabadi May 17, 2024
e48436f
Merge branch 'main' into slowFar
CyrusNajmabadi May 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion ...VisualStudio/Core/Def/FindReferences/Contexts/AbstractTableDataSourceFindUsagesContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ private abstract class AbstractTableDataSourceFindUsagesContext :
protected readonly IWpfTableControl2 TableControl;

private readonly AsyncBatchingWorkQueue<(int current, int maximum)> _progressQueue;
private readonly AsyncBatchingWorkQueue _notifyQueue;

protected readonly object Gate = new();

Expand Down Expand Up @@ -163,6 +164,18 @@ protected AbstractTableDataSourceFindUsagesContext(
this.UpdateTableProgressAsync,
presenter._asyncListener,
CancellationTokenSource.Token);

// Similarly, updating the actual FAR window can be quite expensive (especially when there are thousands of
// results). To limit the amount of work we do, we'll only update the window every 500ms.
_notifyQueue = new AsyncBatchingWorkQueue(
DelayTimeSpan.Medium,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DelayTimeSpan.Medium

I kind of feel like I wish the ABWQ had an option where it would customize the delay as the work expanded.

Something like:
For the first 1 second, it updates on NearImmediate cadence.
Between 1 - 5 seconds, it updates on short cadence
After 5 seconds, it updates on medium cadence

It just feels like adding a 500 ms delay on really quick FAR requests might be perceptible.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I def didn't notice anything feeling off here. I could make it 250ms if you feel better about that. We'll still likely get the majority of the benefit.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like that. 250 ms is a lot less noticeable than 500 ms.

cancellationToken =>
{
_tableDataSink.FactorySnapshotChanged(this);
return ValueTaskFactory.CompletedTask;
},
presenter._asyncListener,
CancellationTokenSource.Token);
}

protected abstract Task OnCompletedAsyncWorkerAsync(CancellationToken cancellationToken);
Expand Down Expand Up @@ -203,7 +216,7 @@ private static ImmutableArray<string> SelectCustomColumnsToInclude(ImmutableArra
}

protected void NotifyChange()
=> _tableDataSink.FactorySnapshotChanged(this);
=> _notifyQueue.AddWork();

private void OnFindReferencesWindowClosed(object sender, EventArgs e)
{
Expand Down
Loading