Skip to content

Remove option to disable diagnostics #80166

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

Merged
merged 4 commits into from
Sep 8, 2025
Merged

Remove option to disable diagnostics #80166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7ef952
Remove option to disable diagnostics
CyrusNajmabadi Sep 7, 2025
7e7ce0b
Remove field
CyrusNajmabadi Sep 8, 2025
4a52d4d
Delete option
CyrusNajmabadi Sep 8, 2025
fa9ed7e
REmove stale comment
CyrusNajmabadi Sep 8, 2025
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
13 changes: 3 additions & 10 deletions src/EditorFeatures/Core/SolutionEvents/HostLegacySolutionEventsWorkspaceEventListener.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ namespace Microsoft.CodeAnalysis.LegacySolutionEvents;
[ExportEventListener(WellKnownEventListeners.Workspace, WorkspaceKind.Host), Shared]
internal sealed partial class HostLegacySolutionEventsWorkspaceEventListener : IEventListener
{
private readonly IGlobalOptionService _globalOptions;
private readonly IThreadingContext _threadingContext;
private readonly AsyncBatchingWorkQueue<WorkspaceChangeEventArgs> _eventQueue;

Expand All @@ -37,11 +36,9 @@ internal sealed partial class HostLegacySolutionEventsWorkspaceEventListener : I
[ImportingConstructor]
[Obsolete(MefConstruction.ImportingConstructorMessage, error: true)]
public HostLegacySolutionEventsWorkspaceEventListener(
IGlobalOptionService globalOptions,
IThreadingContext threadingContext,
IAsynchronousOperationListenerProvider listenerProvider)
{
_globalOptions = globalOptions;
_threadingContext = threadingContext;
_eventQueue = new AsyncBatchingWorkQueue<WorkspaceChangeEventArgs>(
DelayTimeSpan.Short,
Expand All @@ -54,17 +51,13 @@ public void StartListening(Workspace workspace)
{
// We only support this option to disable crawling in internal speedometer and ddrit perf runs to lower noise.
// It is not exposed to the user.
if (_globalOptions.GetOption(SolutionCrawlerRegistrationService.EnableSolutionCrawler))
_workspaceChangedDisposer = workspace.RegisterWorkspaceChangedHandler(OnWorkspaceChanged);
_workspaceChangedDisposer = workspace.RegisterWorkspaceChangedHandler(OnWorkspaceChanged);
}

public void StopListening(Workspace workspace)
{
if (_globalOptions.GetOption(SolutionCrawlerRegistrationService.EnableSolutionCrawler))
{
_workspaceChangedDisposer?.Dispose();
_workspaceChangedDisposer = null;
}
_workspaceChangedDisposer?.Dispose();
_workspaceChangedDisposer = null;
}

private void OnWorkspaceChanged(WorkspaceChangeEventArgs e)
Expand Down
12 changes: 0 additions & 12 deletions src/Features/Core/Portable/SolutionCrawler/SolutionCrawlerService.cs
View file
Open in desktop

This file was deleted.

179 changes: 85 additions & 94 deletions src/LanguageServer/Protocol/Handler/Diagnostics/AbstractPullDiagnosticHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,117 +103,108 @@ protected virtual Task WaitForChangesAsync(string? category, RequestContext cont
// The progress object we will stream reports to.
using var progress = BufferedProgress.Create(diagnosticsParams.PartialResultToken);

// We only support this option to disable crawling in internal speedometer and ddrit perf runs to lower
// noise. It is not exposed to the user.
if (!this.GlobalOptions.GetOption(SolutionCrawlerRegistrationService.EnableSolutionCrawler))
{
context.TraceDebug($"{this.GetType()}. Skipping due to {nameof(SolutionCrawlerRegistrationService.EnableSolutionCrawler)}={false}");
}
else
{
Contract.ThrowIfNull(context.Solution);
Contract.ThrowIfNull(context.Solution);

var clientCapabilities = context.GetRequiredClientCapabilities();
var category = GetRequestDiagnosticCategory(diagnosticsParams);
var handlerName = $"{this.GetType().Name}(category: {category})";
context.TraceDebug($"{handlerName} started getting diagnostics");
var clientCapabilities = context.GetRequiredClientCapabilities();
var category = GetRequestDiagnosticCategory(diagnosticsParams);
var handlerName = $"{this.GetType().Name}(category: {category})";
context.TraceDebug($"{handlerName} started getting diagnostics");

var versionedCache = _categoryToVersionedCache.GetOrAdd(
handlerName, static (handlerName, globalOptions) => new(globalOptions, handlerName), GlobalOptions);
var versionedCache = _categoryToVersionedCache.GetOrAdd(
handlerName, static (handlerName, globalOptions) => new(globalOptions, handlerName), GlobalOptions);

// Get the set of results the request said were previously reported. We can use this to determine both
// what to skip, and what files we have to tell the client have been removed.
var previousResults = GetPreviousResults(diagnosticsParams) ?? [];
context.TraceDebug($"previousResults.Length={previousResults.Length}");
// Get the set of results the request said were previously reported. We can use this to determine both
// what to skip, and what files we have to tell the client have been removed.
var previousResults = GetPreviousResults(diagnosticsParams) ?? [];
context.TraceDebug($"previousResults.Length={previousResults.Length}");

// Create a mapping from documents to the previous results the client says it has for them. That way as we
// process documents we know if we should tell the client it should stay the same, or we can tell it what
// the updated diagnostics are.
using var _1 = PooledDictionary<ProjectOrDocumentId, PreviousPullResult>.GetInstance(out var documentIdToPreviousDiagnosticParams);
using var _2 = PooledHashSet<PreviousPullResult>.GetInstance(out var removedDocuments);
await ProcessPreviousResultsAsync(context.Solution, previousResults, documentIdToPreviousDiagnosticParams, removedDocuments, cancellationToken).ConfigureAwait(false);
// Create a mapping from documents to the previous results the client says it has for them. That way as we
// process documents we know if we should tell the client it should stay the same, or we can tell it what
// the updated diagnostics are.
using var _1 = PooledDictionary<ProjectOrDocumentId, PreviousPullResult>.GetInstance(out var documentIdToPreviousDiagnosticParams);
using var _2 = PooledHashSet<PreviousPullResult>.GetInstance(out var removedDocuments);
await ProcessPreviousResultsAsync(context.Solution, previousResults, documentIdToPreviousDiagnosticParams, removedDocuments, cancellationToken).ConfigureAwait(false);

// First, let the client know if any workspace documents have gone away. That way it can remove those for
// the user from squiggles or error-list.
HandleRemovedDocuments(context, removedDocuments, progress);
// First, let the client know if any workspace documents have gone away. That way it can remove those for
// the user from squiggles or error-list.
HandleRemovedDocuments(context, removedDocuments, progress);

// Next process each file in priority order. Determine if diagnostics are changed or unchanged since the
// last time we notified the client. Report back either to the client so they can update accordingly.
var orderedSources = await GetOrderedDiagnosticSourcesAsync(
diagnosticsParams, category, context, cancellationToken).ConfigureAwait(false);
// Next process each file in priority order. Determine if diagnostics are changed or unchanged since the
// last time we notified the client. Report back either to the client so they can update accordingly.
var orderedSources = await GetOrderedDiagnosticSourcesAsync(
diagnosticsParams, category, context, cancellationToken).ConfigureAwait(false);

context.TraceDebug($"Processing {orderedSources.Length} documents");
context.TraceDebug($"Processing {orderedSources.Length} documents");

// Keep track of what diagnostic sources we see this time around. For any we do not see this time
// around, we'll notify the client that the diagnostics for it have been removed.
using var _3 = PooledHashSet<ProjectOrDocumentId>.GetInstance(out var seenDiagnosticSourceIds);
// Keep track of what diagnostic sources we see this time around. For any we do not see this time
// around, we'll notify the client that the diagnostics for it have been removed.
using var _3 = PooledHashSet<ProjectOrDocumentId>.GetInstance(out var seenDiagnosticSourceIds);

foreach (var diagnosticSource in orderedSources)
foreach (var diagnosticSource in orderedSources)
{
seenDiagnosticSourceIds.Add(diagnosticSource.GetId());
var globalStateVersion = _diagnosticRefresher.GlobalStateVersion;

var project = diagnosticSource.GetProject();
var cacheState = new DiagnosticsRequestState(project, globalStateVersion, context, diagnosticSource);

var newResult = await versionedCache.GetOrComputeNewDataAsync(
documentIdToPreviousDiagnosticParams,
diagnosticSource.GetId(),
project,
cacheState,
cancellationToken).ConfigureAwait(false);
if (newResult != null)
{
seenDiagnosticSourceIds.Add(diagnosticSource.GetId());
var globalStateVersion = _diagnosticRefresher.GlobalStateVersion;

var project = diagnosticSource.GetProject();
var cacheState = new DiagnosticsRequestState(project, globalStateVersion, context, diagnosticSource);

var newResult = await versionedCache.GetOrComputeNewDataAsync(
documentIdToPreviousDiagnosticParams,
diagnosticSource.GetId(),
project,
cacheState,
cancellationToken).ConfigureAwait(false);
if (newResult != null)
{
ReportCurrentDiagnostics(
diagnosticSource, newResult.Value.Data, progress, newResult.Value.ResultId, clientCapabilities);
}
else
{
context.TraceDebug($"Diagnostics were unchanged for {diagnosticSource.ToDisplayString()}");

// Nothing changed between the last request and this one. Report a (null-diagnostics,
// same-result-id) response to the client as that means they should just preserve the current
// diagnostics they have for this file.
//
// Note: if this is a workspace request, we can do nothing, as that will be interpreted by the
// client as nothing having been changed for that document.
var previousParams = documentIdToPreviousDiagnosticParams[diagnosticSource.GetId()];
if (TryCreateUnchangedReport(previousParams.TextDocument, previousParams.PreviousResultId, out var report))
progress.Report(report);
}
ReportCurrentDiagnostics(
diagnosticSource, newResult.Value.Data, progress, newResult.Value.ResultId, clientCapabilities);
}
else
{
context.TraceDebug($"Diagnostics were unchanged for {diagnosticSource.ToDisplayString()}");

// Nothing changed between the last request and this one. Report a (null-diagnostics,
// same-result-id) response to the client as that means they should just preserve the current
// diagnostics they have for this file.
//
// Note: if this is a workspace request, we can do nothing, as that will be interpreted by the
// client as nothing having been changed for that document.
var previousParams = documentIdToPreviousDiagnosticParams[diagnosticSource.GetId()];
if (TryCreateUnchangedReport(previousParams.TextDocument, previousParams.PreviousResultId, out var report))
progress.Report(report);
}
}

// Now, for any diagnostics reported from a prior source that we do not see this time around, report its
// diagnostics as being removed. This allows for different sets of diagnostic-sources to be computed
// each time around, while still producing accurate diagnostic reports.
//
// Only do this if we haven't already created a removal report for that prior result above.
//
// Note: we are intentionally notifying the client that this is not a remove (vs an empty set of
// results). As far as we and the client are concerned, this document no longer exists at this point
// for the purposes of diagnostics.
foreach (var (projectOrDocumentId, previousDiagnosticParams) in documentIdToPreviousDiagnosticParams)
// Now, for any diagnostics reported from a prior source that we do not see this time around, report its
// diagnostics as being removed. This allows for different sets of diagnostic-sources to be computed
// each time around, while still producing accurate diagnostic reports.
//
// Only do this if we haven't already created a removal report for that prior result above.
//
// Note: we are intentionally notifying the client that this is not a remove (vs an empty set of
// results). As far as we and the client are concerned, this document no longer exists at this point
// for the purposes of diagnostics.
foreach (var (projectOrDocumentId, previousDiagnosticParams) in documentIdToPreviousDiagnosticParams)
{
if (!seenDiagnosticSourceIds.Contains(projectOrDocumentId) &&
!removedDocuments.Contains(previousDiagnosticParams))
{
if (!seenDiagnosticSourceIds.Contains(projectOrDocumentId) &&
!removedDocuments.Contains(previousDiagnosticParams))
{
progress.Report(CreateRemovedReport(previousDiagnosticParams.TextDocument));
}
progress.Report(CreateRemovedReport(previousDiagnosticParams.TextDocument));
}
}

// Clear out the solution context to avoid retaining memory
// https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1809058
context.ClearSolutionContext();
// Clear out the solution context to avoid retaining memory
// https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1809058
context.ClearSolutionContext();

// Some implementations of the spec will re-open requests as soon as we close them, spamming the server.
// In those cases, we wait for the implementation to indicate that changes have occurred, then we close the connection
// so that the client asks us again.
await WaitForChangesAsync(category, context, cancellationToken).ConfigureAwait(false);
// Some implementations of the spec will re-open requests as soon as we close them, spamming the server.
// In those cases, we wait for the implementation to indicate that changes have occurred, then we close the connection
// so that the client asks us again.
await WaitForChangesAsync(category, context, cancellationToken).ConfigureAwait(false);

// If we had a progress object, then we will have been reporting to that. Otherwise, take what we've been
// collecting and return that.
context.TraceDebug($"{this.GetType()} finished getting diagnostics");
}
// If we had a progress object, then we will have been reporting to that. Otherwise, take what we've been
// collecting and return that.
context.TraceDebug($"{this.GetType()} finished getting diagnostics");

return CreateReturn(progress);

Expand Down
1 change: 0 additions & 1 deletion src/VisualStudio/Core/Def/Options/VisualStudioOptionStorage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,6 @@ public bool TryFetch(LocalUserRegistryOptionPersister persister, OptionKey2 opti
{"dotnet_enable_smart_indenter", new LocalUserProfileStorage(@"Roslyn\Internal\OnOff\Features", "Smart Indenter")},
{"dotnet_enable_snippets", new LocalUserProfileStorage(@"Roslyn\Internal\OnOff\Features", "Snippets2")},
{"dotnet_enable_syntactic_colorizer", new LocalUserProfileStorage(@"Roslyn\Internal\OnOff\Features", "Syntactic Colorizer")},
{"dotnet_enable_solution_crawler", new LocalUserProfileStorage(@"Roslyn\Internal\SolutionCrawler", "Solution Crawler")},
{"dotnet_colorize_json_patterns", new RoamingProfileStorage("TextEditor.%LANGUAGE%.Specific.ColorizeJsonPatterns")},
{"dotnet_unsupported_detect_and_offer_editor_features_for_probable_json_strings", new RoamingProfileStorage("TextEditor.%LANGUAGE%.Specific.DetectAndOfferEditorFeaturesForProbableJsonStrings")},
{"dotnet_highlight_related_json_components", new RoamingProfileStorage("TextEditor.%LANGUAGE%.Specific.HighlightRelatedJsonComponentsUnderCursor")},
Expand Down
Loading