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

Switch to a producer/consumer queue to search for computing refactorings #73322

Merged
merged 6 commits into from
May 3, 2024
Merged

Switch to a producer/consumer queue to search for computing refactorings #73322

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cd72b2b
Switch to a producer/consumer queue to search for computing refactori…
CyrusNajmabadi May 3, 2024
cbcc2b8
Merge branch 'main' into producerConsumerRefactoring
CyrusNajmabadi May 3, 2024
4ee2a3b
Simplify
CyrusNajmabadi May 3, 2024
4679baa
Fix ordering
CyrusNajmabadi May 3, 2024
99b4ae1
Simplify
CyrusNajmabadi May 3, 2024
2129891
cleanup
CyrusNajmabadi May 3, 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
81 changes: 46 additions & 35 deletions src/Features/Core/Portable/CodeRefactorings/CodeRefactoringService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,44 +119,55 @@ public async Task<ImmutableArray<CodeRefactoring>> GetRefactoringsAsync(
using (TelemetryLogging.LogBlockTimeAggregated(FunctionId.CodeRefactoring_Summary, $"Pri{priority.GetPriorityInt()}"))
using (Logger.LogBlock(FunctionId.Refactoring_CodeRefactoringService_GetRefactoringsAsync, cancellationToken))
{
var extensionManager = document.Project.Solution.Services.GetRequiredService<IExtensionManager>();
using var _ = ArrayBuilder<Task<CodeRefactoring?>>.GetInstance(out var tasks);

foreach (var provider in GetProviders(document))
{
if (priority != null && priority != provider.RequestPriority)
continue;

tasks.Add(Task.Run(async () =>
using var _ = ArrayBuilder<CodeRefactoring>.GetInstance(out var codeRefactorings);

var providers = GetProviders(document).Where(p => priority == null || p.RequestPriority == priority);

await ProducerConsumer<CodeRefactoring>.RunAsync(
ProducerConsumerOptions.SingleReaderOptions,
produceItems: static (callback, args) =>
// Run all providers in parallel to get the set of refactorings for this document.
RoslynParallel.ForEachAsync(
args.providers,
args.cancellationToken,
async (provider, cancellationToken) =>
{
// Log an individual telemetry event for slow code refactoring computations to
// allow targeted trace notifications for further investigation. 500 ms seemed like
// a good value so as to not be too noisy, but if fired, indicates a potential
// area requiring investigation.
const int CodeRefactoringTelemetryDelay = 500;

var providerName = provider.GetType().Name;
args.@this.RefactoringToMetadataMap.TryGetValue(provider, out var providerMetadata);

var logMessage = KeyValueLogMessage.Create(m =>
{
m[TelemetryLogging.KeyName] = providerName;
m[TelemetryLogging.KeyLanguageName] = args.document.Project.Language;
});

using (args.addOperationScope(providerName))
using (RoslynEventSource.LogInformationalBlock(FunctionId.Refactoring_CodeRefactoringService_GetRefactoringsAsync, providerName, cancellationToken))
using (TelemetryLogging.LogBlockTime(FunctionId.CodeRefactoring_Delay, logMessage, CodeRefactoringTelemetryDelay))
{
var extensionManager = args.document.Project.Solution.Services.GetRequiredService<IExtensionManager>();
Copy link
Contributor

Choose a reason for hiding this comment

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

var extensionManager

out of curiosity, why was this moved inside the producer code? Couldn't it have been passed in like it was before?

Copy link
Member Author

Choose a reason for hiding this comment

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

very true. it was more annoyance around passing the args along :)


var refactoring = await args.@this.GetRefactoringFromProviderAsync(
args.document, args.state, provider, providerMetadata, extensionManager, args.options, cancellationToken).ConfigureAwait(false);
if (refactoring != null)
callback(refactoring);
}
}),
consumeItems: static async (reader, args) =>
{
// Log an individual telemetry event for slow code refactoring computations to
// allow targeted trace notifications for further investigation. 500 ms seemed like
// a good value so as to not be too noisy, but if fired, indicates a potential
// area requiring investigation.
const int CodeRefactoringTelemetryDelay = 500;

var providerName = provider.GetType().Name;
RefactoringToMetadataMap.TryGetValue(provider, out var providerMetadata);

var logMessage = KeyValueLogMessage.Create(m =>
{
m[TelemetryLogging.KeyName] = providerName;
m[TelemetryLogging.KeyLanguageName] = document.Project.Language;
});

using (addOperationScope(providerName))
using (RoslynEventSource.LogInformationalBlock(FunctionId.Refactoring_CodeRefactoringService_GetRefactoringsAsync, providerName, cancellationToken))
using (TelemetryLogging.LogBlockTime(FunctionId.CodeRefactoring_Delay, logMessage, CodeRefactoringTelemetryDelay))
{
return await GetRefactoringFromProviderAsync(document, state, provider, providerMetadata,
extensionManager, options, cancellationToken).ConfigureAwait(false);
}
await foreach (var refactoring in reader)
args.codeRefactorings.Add(refactoring);
},
cancellationToken));
}
args: (@this: this, document, state, providers, options, addOperationScope, codeRefactorings, cancellationToken),
cancellationToken).ConfigureAwait(false);

var results = await Task.WhenAll(tasks).ConfigureAwait(false);
return results.WhereNotNull().ToImmutableArray();
return codeRefactorings.ToImmutableAndClear();
}
}

Expand Down
Loading