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

Jump to bottom

Don't block on clearing the output window on the UI thread when generating a file #60281

Merged
merged 3 commits into from
Mar 20, 2022
Merged

Don't block on clearing the output window on the UI thread when generating a file #60281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9b13b6
Don't block on clearing the output window on the UI thread when gener…
davidwengier Mar 20, 2022
299abce
Update PdbSourceDocumentOutputWindowLogger.cs
davidwengier Mar 20, 2022
fe8880b
Committing on a weekday might work a bit better.
davidwengier Mar 20, 2022
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
2 changes: 1 addition & 1 deletion src/Features/Core/Portable/PdbSourceDocument/IPdbSourceDocumentLogger.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace Microsoft.CodeAnalysis.PdbSourceDocument
/// </summary>
internal interface IPdbSourceDocumentLogger
{
Task ClearAsync();
void Clear();
void Log(string message);
}

Expand Down
9 changes: 2 additions & 7 deletions ...Features/Core/Portable/PdbSourceDocument/PdbSourceDocumentMetadataAsSourceFileProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,8 @@ internal sealed class PdbSourceDocumentMetadataAsSourceFileProvider : IMetadataA
var assemblyName = symbol.ContainingAssembly.Identity.Name;
var assemblyVersion = symbol.ContainingAssembly.Identity.Version.ToString();

if (_logger is not null)
{
// We block to clear the log from the previous operation, so things don't get confusing
// if the log messages are delayed
await _logger.ClearAsync().ConfigureAwait(false);
}

// Clear the log so messages from the previously generated file don't confuse the user
_logger?.Clear();
_logger?.Log(FeaturesResources.Navigating_to_symbol_0_from_1, symbol, assemblyName);

var compilation = await project.GetRequiredCompilationAsync(cancellationToken).ConfigureAwait(false);
Expand Down
18 changes: 10 additions & 8 deletions src/VisualStudio/Core/Def/PdbSourceDocument/PdbSourceDocumentOutputWindowLogger.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ internal sealed class PdbSourceDocumentOutputWindowLogger : IPdbSourceDocumentLo
private IVsOutputWindowPane? _outputPane;

private readonly IThreadingContext _threadingContext;
private readonly AsyncBatchingWorkQueue<string> _logItemsQueue;
private readonly AsyncBatchingWorkQueue<string?> _logItemsQueue;
private readonly IServiceProvider _serviceProvider;

private readonly CancellationTokenSource _cancellationTokenSource = new();
Expand All @@ -41,14 +41,14 @@ public PdbSourceDocumentOutputWindowLogger(SVsServiceProvider serviceProvider, I

var asyncListener = listenerProvider.GetListener(nameof(PdbSourceDocumentOutputWindowLogger));

_logItemsQueue = new AsyncBatchingWorkQueue<string>(
_logItemsQueue = new AsyncBatchingWorkQueue<string?>(
DelayTimeSpan.NearImmediate,
ProcessLogMessagesAsync,
asyncListener,
_cancellationTokenSource.Token);
}

private async ValueTask ProcessLogMessagesAsync(ImmutableArray<string> messages, CancellationToken cancellationToken)
private async ValueTask ProcessLogMessagesAsync(ImmutableArray<string?> messages, CancellationToken cancellationToken)
{
await _threadingContext.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);

Expand All @@ -60,7 +60,11 @@ private async ValueTask ProcessLogMessagesAsync(ImmutableArray<string> messages,
return;
}

if (pane is IVsOutputWindowPaneNoPump noPumpPane)
if (message is null)
{
pane.Clear();
}
else if (pane is IVsOutputWindowPaneNoPump noPumpPane)
{
noPumpPane.OutputStringNoPump(message + Environment.NewLine);
}
Expand All @@ -71,11 +75,9 @@ private async ValueTask ProcessLogMessagesAsync(ImmutableArray<string> messages,
}
}

public async Task ClearAsync()
public void Clear()
{
await _threadingContext.JoinableTaskFactory.SwitchToMainThreadAsync();

GetPane()?.Clear();
_logItemsQueue.AddWork((string?)null);
}

public void Log(string value)
Expand Down