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.

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

Fix the ability to expand the list of analyzers in a reference #49574

Merged
1 commit merged into from
Nov 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#nullable disable

using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
Expand All @@ -14,10 +12,13 @@ internal class TestAnalyzerReferenceByLanguage : AnalyzerReference
{
private readonly IReadOnlyDictionary<string, ImmutableArray<DiagnosticAnalyzer>> _analyzersMap;

public TestAnalyzerReferenceByLanguage(IReadOnlyDictionary<string, ImmutableArray<DiagnosticAnalyzer>> analyzersMap)
=> _analyzersMap = analyzersMap;
public TestAnalyzerReferenceByLanguage(IReadOnlyDictionary<string, ImmutableArray<DiagnosticAnalyzer>> analyzersMap, string? fullPath = null)
{
_analyzersMap = analyzersMap;
FullPath = fullPath;
}

public override string FullPath => null;
public override string? FullPath { get; }
public override string Display => nameof(TestAnalyzerReferenceByLanguage);
public override object Id => Display;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,7 @@ public IEnumerable Items
_specificDiagnosticOptions = project.CompilationOptions!.SpecificDiagnosticOptions;
_analyzerConfigOptions = project.GetAnalyzerConfigOptions();

_diagnosticItems = new BulkObservableCollection<BaseDiagnosticItem>();
_diagnosticItems.AddRange(GetDiagnosticItems(project.Language, project.CompilationOptions, _analyzerConfigOptions));
_diagnosticItems = CreateDiagnosticItems(project.Language, project.CompilationOptions, _analyzerConfigOptions);

Workspace.WorkspaceChanged += OnWorkspaceChangedLookForOptionsChanges;
}
Expand All @@ -97,7 +96,7 @@ public IEnumerable Items
}
}

private IEnumerable<BaseDiagnosticItem> GetDiagnosticItems(string language, CompilationOptions options, AnalyzerConfigOptionsResult? analyzerConfigOptions)
private BulkObservableCollection<BaseDiagnosticItem> CreateDiagnosticItems(string language, CompilationOptions options, AnalyzerConfigOptionsResult? analyzerConfigOptions)
{
// Within an analyzer assembly, an individual analyzer may report multiple different diagnostics
// with the same ID. Or, multiple analyzers may report diagnostics with the same ID. Or a
Expand All @@ -110,7 +109,9 @@ private IEnumerable<BaseDiagnosticItem> GetDiagnosticItems(string language, Comp

Contract.ThrowIfFalse(HasItems);
Copy link
Member Author

Choose a reason for hiding this comment

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

This was the problematic assert: conceptually the idea was "we shouldn't be trying to create items if we know we don't have any to show", but in the code prior to this new change we would assign the field before calling GetDiagnosticItems, so HasItems would instead return false because we had realized the list prematurely.


return AnalyzerReference.GetAnalyzers(language)
var collection = new BulkObservableCollection<BaseDiagnosticItem>();
collection.AddRange(
AnalyzerReference.GetAnalyzers(language)
.SelectMany(a => _diagnosticAnalyzerService.AnalyzerInfoCache.GetDiagnosticDescriptors(a))
.GroupBy(d => d.Id)
.OrderBy(g => g.Key, StringComparer.CurrentCulture)
Expand All @@ -119,7 +120,9 @@ private IEnumerable<BaseDiagnosticItem> GetDiagnosticItems(string language, Comp
var selectedDiagnostic = g.OrderBy(d => d, s_comparer).First();
var effectiveSeverity = selectedDiagnostic.GetEffectiveSeverity(options, analyzerConfigOptions);
return CreateItem(selectedDiagnostic, effectiveSeverity, language);
});
}));

return collection;
}

private void OnWorkspaceChangedLookForOptionsChanges(object sender, WorkspaceChangeEventArgs e)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
' Licensed to the .NET Foundation under one or more agreements.
' The .NET Foundation licenses this file to you under the MIT license.
' See the LICENSE file in the project root for more information.

Imports System.Collections.Immutable
Imports Microsoft.CodeAnalysis
Imports Microsoft.CodeAnalysis.Diagnostics
Imports Microsoft.CodeAnalysis.Editor.UnitTests.Workspaces
Imports Microsoft.CodeAnalysis.Test.Utilities
Imports Microsoft.Internal.VisualStudio.PlatformUI
Imports Microsoft.VisualStudio.LanguageServices.Implementation.SolutionExplorer
Imports Microsoft.VisualStudio.LanguageServices.UnitTests.ProjectSystemShim.Framework
Imports Microsoft.VisualStudio.Shell

Namespace Microsoft.VisualStudio.LanguageServices.UnitTests.SolutionExplorer
<UseExportProvider>
Public Class CpsDiagnosticItemSourceTests
<Fact, Trait(Traits.Feature, Traits.Features.Diagnostics)>
Public Sub AnalyzerHasDiagnostics()
Dim workspaceXml =
<Workspace>
<Project Language="Visual Basic" CommonReferences="true">
</Project>
</Workspace>

Using workspace = TestWorkspace.Create(workspaceXml)
Dim project = workspace.Projects.Single()

Dim analyzers = New Dictionary(Of String, ImmutableArray(Of DiagnosticAnalyzer))

' The choice here of this analyzer to test with is arbitray -- there's nothing special about this
' analyzer versus any other one.
analyzers.Add(LanguageNames.VisualBasic, ImmutableArray.Create(Of DiagnosticAnalyzer)(New Microsoft.CodeAnalysis.VisualBasic.UseAutoProperty.VisualBasicUseAutoPropertyAnalyzer()))

Const analyzerPath = "C:\Analyzer.dll"
workspace.OnAnalyzerReferenceAdded(project.Id, New TestAnalyzerReferenceByLanguage(analyzers, analyzerPath))

Dim source As IAttachedCollectionSource = New CpsDiagnosticItemSource(
workspace,
project.FilePath,
project.Id,
New MockHierarchyItem() With {.CanonicalName = "\net472\analyzerdependency\" + analyzerPath},
New FakeAnalyzersCommandHandler, workspace.GetService(Of IDiagnosticAnalyzerService))

Assert.True(source.HasItems)
Dim diagnostic = Assert.IsAssignableFrom(Of ITreeDisplayItem)(Assert.Single(source.Items))
Assert.Contains(IDEDiagnosticIds.UseAutoPropertyDiagnosticId, diagnostic.Text)
End Using
End Sub
End Class
End Namespace