Add an analyzer to detect when a duplicate razor file is provided #11498
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Collections.Immutable; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.Diagnostics; | ||
| using Microsoft.CodeAnalysis.Text; | ||
| using Microsoft.NET.Sdk.Razor.SourceGenerators; | ||
|
|
||
| namespace Microsoft.AspNetCore.Razor.SourceGenerators; | ||
|
|
||
| #pragma warning disable RS1041 // Compiler extensions should be implemented in assemblies targeting netstandard2.0 | ||
| [DiagnosticAnalyzer(LanguageNames.CSharp)] | ||
| #pragma warning restore RS1041 // Compiler extensions should be implemented in assemblies targeting netstandard2.0 | ||
| public class DuplicateRazorFileIncludedAnalyzer : DiagnosticAnalyzer | ||
|
|
||
| { | ||
| private static readonly ImmutableArray<DiagnosticDescriptor> s_supportedDiagnostics = ImmutableArray.Create(RazorDiagnostics.DuplicateRazorFileIncludedDescriptor); | ||
|
|
||
| public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => s_supportedDiagnostics; | ||
|
|
||
| public override void Initialize(AnalysisContext context) | ||
| { | ||
| context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); | ||
| context.EnableConcurrentExecution(); | ||
| context.RegisterCompilationStartAction(static compStartAction => | ||
| { | ||
| var includedFiles = new HashSet<string>(StringComparer.Ordinal); | ||
|
|
||
| compStartAction.RegisterAdditionalFileAction(additionalFilesContext => | ||
| { | ||
| var additionalFile = additionalFilesContext.AdditionalFile; | ||
|
|
||
| if (additionalFile.Path.EndsWith(".cshtml", StringComparison.Ordinal) || | ||
| additionalFile.Path.EndsWith(".razor", StringComparison.Ordinal)) | ||
| { | ||
| if (!includedFiles.Add(additionalFile.Path)) | ||
|
There was a problem hiding this comment. Can it happen that the paths are equivalent but not normalized at this point? For example: This check would not catch such duplicates. |
||
| { | ||
| var diagnostic = Diagnostic.Create( | ||
| RazorDiagnostics.DuplicateRazorFileIncludedDescriptor, | ||
| Location.Create(additionalFile.Path, new TextSpan(0, 0), new LinePositionSpan(LinePosition.Zero, LinePosition.Zero)), | ||
| additionalFile.Path); | ||
|
|
||
| additionalFilesContext.ReportDiagnostic(diagnostic); | ||
|
There was a problem hiding this comment.
The source generator will still run and report errors though, right? Wouldn't it be better if this was part of the SG pipeline then? What's the advantage of a separate analyzer anyway? There was a problem hiding this comment. There is a general feeling that we should be moving towards analyzers producing diagnostics over generators as they play better in the incremental space. There was a problem hiding this comment. Perhaps the source generator could also detect this situation and bail early to avoid producing superfluous diagnostics. There was a problem hiding this comment.
Thinking about this recommendation in general, it's hard to imagine all the diagnostics that are produced by the razor SG now would instead be produced by some analyzer, that sounds like a lot of duplicate (and hence error-prone) logic. |
||
| } | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Threading.Tasks; | ||
| using Microsoft.AspNetCore.Razor.SourceGenerators; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CSharp.Testing; | ||
| using Microsoft.CodeAnalysis.Testing; | ||
| using Xunit; | ||
|
|
||
| namespace Microsoft.NET.Sdk.Razor.SourceGenerators.Tests; | ||
|
|
||
| public class DuplicateRazorFileIncludedAnalyzerTest | ||
| { | ||
| [Theory] | ||
| [InlineData("Duplicate.cshtml")] | ||
| [InlineData("Duplicate.razor")] | ||
| public async Task Analyzer_ReportsDiagnostic_WhenDuplicateRazorFileIsIncluded(string fileName) | ||
|
There was a problem hiding this comment. Consider adding a test for the razor source generator as well to see what the errors would be. I actually cannot reproduce any issues there. I've created a project which passes duplicate AdditionalFiles to Csc but don't see any errors from the razor source generator. What is needed to hit an error? |
||
| { | ||
| // Arrange | ||
| var test = new CSharpAnalyzerTest<DuplicateRazorFileIncludedAnalyzer, DefaultVerifier> | ||
| { | ||
| TestState = | ||
| { | ||
| Sources = | ||
| { | ||
| // Need a non-empty source file to make the test helper happy | ||
| ("Test.cs", "public class Test {}"), | ||
| }, | ||
| AdditionalFiles = | ||
| { | ||
| (fileName, "<h1>Duplicate</h1>"), | ||
| (fileName, "<h1>Duplicate</h1>"), | ||
| }, | ||
| }, | ||
| ExpectedDiagnostics = | ||
| { | ||
| new DiagnosticResult(RazorDiagnostics.DuplicateRazorFileIncludedDescriptor.Id, DiagnosticSeverity.Error) | ||
| .WithLocation(fileName, 1, 1) | ||
| .WithMessageFormat(RazorDiagnostics.DuplicateRazorFileIncludedDescriptor.MessageFormat.ToString()) | ||
| .WithArguments(fileName), | ||
| }, | ||
| }; | ||
|
|
||
| // Act & Assert | ||
| await test.RunAsync(); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData("Duplicate.cshtml", "duplicate.cshtml")] | ||
| [InlineData("Duplicate.razor", "duplicate.razor")] | ||
| public async Task Analyzer_NoDiagnostic_WhenDuplicateRazorFileIsIncluded_DifferentCase(string fileName1, string fileName2) | ||
| { | ||
| // Arrange | ||
| var test = new CSharpAnalyzerTest<DuplicateRazorFileIncludedAnalyzer, DefaultVerifier> | ||
| { | ||
| TestState = | ||
| { | ||
| Sources = | ||
| { | ||
| // Need a non-empty source file to make the test helper happy | ||
| ("Test.cs", "public class Test {}"), | ||
| }, | ||
| AdditionalFiles = | ||
| { | ||
| (fileName1, "<h1>Duplicate</h1>"), | ||
| (fileName2, "<h1>Duplicate</h1>"), | ||
| }, | ||
| }, | ||
| ExpectedDiagnostics = | ||
| { | ||
| }, | ||
| }; | ||
|
|
||
| // Act & Assert | ||
| await test.RunAsync(); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData("Duplicate.cshtml")] | ||
| [InlineData("Duplicate.razor")] | ||
| public async Task Analyzer_ReportsDiagnostic_WhenThreeDuplicateRazorFilesAreIncluded(string fileName) | ||
| { | ||
| // Arrange | ||
| var test = new CSharpAnalyzerTest<DuplicateRazorFileIncludedAnalyzer, DefaultVerifier> | ||
| { | ||
| TestState = | ||
| { | ||
| Sources = | ||
| { | ||
| // Need a non-empty source file to make the test helper happy | ||
| ("Test.cs", "public class Test {}"), | ||
| }, | ||
| AdditionalFiles = | ||
| { | ||
| (fileName, "<h1>Duplicate</h1>"), | ||
| (fileName, "<h1>Duplicate</h1>"), | ||
| (fileName, "<h1>Duplicate</h1>"), | ||
| }, | ||
| }, | ||
| ExpectedDiagnostics = | ||
| { | ||
| new DiagnosticResult(RazorDiagnostics.DuplicateRazorFileIncludedDescriptor.Id, DiagnosticSeverity.Error) | ||
| .WithLocation(fileName, 1, 1) | ||
| .WithMessageFormat(RazorDiagnostics.DuplicateRazorFileIncludedDescriptor.MessageFormat.ToString()) | ||
| .WithArguments(fileName), | ||
| new DiagnosticResult(RazorDiagnostics.DuplicateRazorFileIncludedDescriptor.Id, DiagnosticSeverity.Error) | ||
| .WithLocation(fileName, 1, 1) | ||
| .WithMessageFormat(RazorDiagnostics.DuplicateRazorFileIncludedDescriptor.MessageFormat.ToString()) | ||
| .WithArguments(fileName), | ||
| }, | ||
| }; | ||
|
|
||
| // Act & Assert | ||
| await test.RunAsync(); | ||
| } | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that these specific verifiers are deprecated. See https://github.com/dotnet/roslyn-sdk/tree/main/src/Microsoft.CodeAnalysis.Testing#obsolete-packages.