Add analyzer and code fix to recommend against IHeaderDictionary.Add #44463

david-acker · 2022-10-11T01:38:04Z

Description

Adds an analyzer which identifies invocations of IHeaderDictionary.Add.
Adds two code fixes, one for replacing Add with Append and another for replacing Add with the indexer.

Questions

Is there a preferred architecture or way of organizing new analyzers and code fixes? The analyzers and codes fixes in AspNetCore.Analyzers, Mvc.Analyzers, Mvc.Api.Analyzers, and Framework/AspNetCoreAnalyzers seemed to all have slightly different styles and ways for handling the analyzers, code fixes, tests, etc. I pulled from these when creating this draft, but didn't follow the style of any one of them too rigidly. [Resolved: Moved to Framework/AspNetCoreAnalyzers and used the analyzer and code fix pattern used there.]
What's the process for picking a rule ID for the new diagnostic? I used ASP0015 as a placeholder for now as this appeared to be the next one available, based on this list of diagnostics: Code analysis in ASP.NET Core apps. [Updated to use ASP0019]

Fixes #41362

ghost · 2022-10-11T01:38:12Z

Thanks for your PR, @david-acker. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

adityamandaleeka · 2022-10-12T22:36:04Z

@david-acker Can you please put it in src/Framework/AspNetCoreAnalyzers and follow the pattern used there?

As for the ID, for now we're just incrementing the number (see https://github.com/dotnet/aspnetcore/blob/main/src/Framework/AspNetCoreAnalyzers/src/Analyzers/DiagnosticDescriptors.cs).

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs

src/Framework/AspNetCoreAnalyzers/test/Http/HeaderDictionaryAddFixerTests.cs

src/Analyzers/Analyzers/test/Microsoft.AspNetCore.Analyzers.Test.csproj

src/Framework/AspNetCoreAnalyzers/src/Analyzers/Http/HeaderDictionaryAddAnalyzer.cs

captainsafia · 2022-10-17T15:35:54Z

src/Framework/AspNetCoreAnalyzers/src/Analyzers/Resources.resx

    <value>Unused route parameter</value>
  </data>
+  <data name="Analyzer_HeaderDictionaryAdd_Message" xml:space="preserve">
+    <value>Suggest using IHeaderDictionary.Append or the indexer instead of Add</value>


Can we add a statement here about the consequences of using IDictionary.Add so the user is more informed?

I've updated the diagnostic message to the following:

Use IHeaderDictionary.Append or the indexer to append or set headers. IDictionary.Add will throw an ArgumentException when attempting to add a duplicate key.

Let me know if there are any adjustments you'd like me to make to this.

src/Framework/AspNetCoreAnalyzers/test/Http/HeaderDictionaryAddFixerTests.cs

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs

src/Framework/AspNetCoreAnalyzers/src/Analyzers/Http/HeaderDictionaryAddAnalyzer.cs

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs

Youssef1313 · 2022-10-17T20:46:22Z

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs

+
+        if (invocation is InvocationExpressionSyntax { Expression: MemberAccessExpressionSyntax { Name.Identifier: { } identifierToken } })
+        {
+            compilationUnitSyntax = compilationUnitSyntax.ReplaceToken(identifierToken, SyntaxFactory.Identifier("Append"));


I'm not sure, but could you check if SyntaxFactory.Identifier("Append").WithAdditionalAnnotations(Simplifier.AddImportsAnnotation) will avoid the need to manually add the using?

Hmm, I just tried this but it doesn't seem to add the using. Is there anything else that I would need to do here besides adding the call to WithAdditionalAnnotations(Simplifier.AddImportsAnnotation) on the identifier?

@david-acker Try getting the symbol for Microsoft.AspNetCore.Http.HeaderDictionaryExtensions and create an annotation like the following:

var annotation = new SyntaxAnnotation("SymbolId", DocumentationCommentId.CreateReferenceId(symbol));

Then use SyntaxFactory.Identifier("Append").WithAdditionalAnnotations(Simplifier.AddImportsAnnotation, annotation)

src/Framework/AspNetCoreAnalyzers/test/Http/HeaderDictionaryAddAnalyzerTests.cs

captainsafia

LGTM!

@david-acker You're welcome to handle the docs independently over on that repo.

Consider having a compilation start action when retrieves Microsoft.AspNetCore.Http.IHeaderDictionary and then do a symbol comparison here.

I don't mind doing the symbol comparison this way, but feel free to adjust if you're open to it.

@Youssef1313 Would appreciate your sign off too!

Youssef1313

Besides the comments I already added, LGTM.

david-acker · 2022-10-22T10:54:46Z

@captainsafia @Youssef1313 Sounds good! I'll address the remaining comments within the next few days.

I'll also file an issue in the docs repo and submit a PR to update the diagnostics doc page that's linked above.

adityamandaleeka · 2022-10-26T22:49:35Z

@david-acker Looks like there's some test failures.

david-acker · 2022-10-26T23:45:03Z

@adityamandaleeka Hmm, that's odd. I'm not getting those test failures locally. I'll dig into this a bit.

captainsafia · 2022-10-27T04:19:52Z

@adityamandaleeka Hmm, that's odd. I'm not getting those test failures locally. I'll dig into this a bit.

Seems to be a pesky line-ending issue. I wonder if there is a way to get the verifier to ignore these when comparing texts...

Youssef1313

These suggestions simplify the addition of using, but the end of line issue still persists

Youssef1313 · 2022-10-27T07:45:14Z

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs

+using Microsoft.CodeAnalysis.CodeActions;
+using Microsoft.CodeAnalysis.CodeFixes;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Syntax;


Suggested change

using Microsoft.CodeAnalysis.CSharp.Syntax;

using Microsoft.CodeAnalysis.CSharp.Syntax;

using Microsoft.CodeAnalysis.Simplification;

Youssef1313 · 2022-10-27T07:45:31Z

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs

+
+    private static async Task<Document> ReplaceWithAppend(Diagnostic diagnostic, Document document, InvocationExpressionSyntax invocation, CancellationToken cancellationToken)
+    {
+        var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false) as CompilationUnitSyntax;


Suggested change

var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false) as CompilationUnitSyntax;

var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false);

Youssef1313 · 2022-10-27T07:46:09Z

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs

+        return document.WithSyntaxRoot(
+            AddRequiredUsingDirectiveForAppend(root.ReplaceNode(diagnosticTarget, invocation)));


Suggested change

return document.WithSyntaxRoot(

AddRequiredUsingDirectiveForAppend(root.ReplaceNode(diagnosticTarget, invocation)));

var model = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false);

var headerDictionaryExtensionsSymbol = model.Compilation.GetTypeByMetadataName("Microsoft.AspNetCore.Http.HeaderDictionaryExtensions");

var annotation = new SyntaxAnnotation("SymbolId", DocumentationCommentId.CreateReferenceId(headerDictionaryExtensionsSymbol));

return document.WithSyntaxRoot(

root.ReplaceNode(diagnosticTarget, invocation.WithAdditionalAnnotations(Simplifier.AddImportsAnnotation, annotation)));

Youssef1313 · 2022-10-27T07:46:39Z

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs

+    private static CompilationUnitSyntax AddRequiredUsingDirectiveForAppend(CompilationUnitSyntax compilationUnitSyntax)
+    {
+        var usingDirectives = compilationUnitSyntax.Usings;
+
+        var includesRequiredUsingDirective = false;
+        var insertionIndex = 0;
+
+        for (var i = 0; i < usingDirectives.Count; i++)
+        {
+            var namespaceName = usingDirectives[i].Name.ToString();
+
+            // Always insert the new using directive after any 'System' using directives.
+            if (namespaceName.StartsWith("System", StringComparison.Ordinal))
+            {
+                insertionIndex = i + 1;
+                continue;
+            }
+
+            var result = string.Compare("Microsoft.AspNetCore.Http", namespaceName, StringComparison.Ordinal);
+
+            if (result == 0)
+            {
+                includesRequiredUsingDirective = true;
+                break;
+            }
+
+            if (result < 0)
+            {
+                insertionIndex = i;
+                break;
+            }
+        }
+
+        if (includesRequiredUsingDirective)
+        {
+            return compilationUnitSyntax;
+        }
+
+        var requiredUsingDirective =
+            SyntaxFactory.UsingDirective(
+                SyntaxFactory.QualifiedName(
+                    SyntaxFactory.QualifiedName(
+                        SyntaxFactory.IdentifierName("Microsoft"),
+                        SyntaxFactory.IdentifierName("AspNetCore")),
+                    SyntaxFactory.IdentifierName("Http")));
+
+        return compilationUnitSyntax.WithUsings(
+            usingDirectives.Insert(insertionIndex, requiredUsingDirective));
+    }
+


Suggested change

private static CompilationUnitSyntax AddRequiredUsingDirectiveForAppend(CompilationUnitSyntax compilationUnitSyntax)

{

var usingDirectives = compilationUnitSyntax.Usings;

var includesRequiredUsingDirective = false;

var insertionIndex = 0;

for (var i = 0; i < usingDirectives.Count; i++)

{

var namespaceName = usingDirectives[i].Name.ToString();

// Always insert the new using directive after any 'System' using directives.

if (namespaceName.StartsWith("System", StringComparison.Ordinal))

{

insertionIndex = i + 1;

continue;

}

var result = string.Compare("Microsoft.AspNetCore.Http", namespaceName, StringComparison.Ordinal);

if (result == 0)

{

includesRequiredUsingDirective = true;

break;

}

if (result < 0)

{

insertionIndex = i;

break;

}

}

if (includesRequiredUsingDirective)

{

return compilationUnitSyntax;

}

var requiredUsingDirective =

SyntaxFactory.UsingDirective(

SyntaxFactory.QualifiedName(

SyntaxFactory.QualifiedName(

SyntaxFactory.IdentifierName("Microsoft"),

SyntaxFactory.IdentifierName("AspNetCore")),

SyntaxFactory.IdentifierName("Http")));

return compilationUnitSyntax.WithUsings(

usingDirectives.Insert(insertionIndex, requiredUsingDirective));

}

Youssef1313 · 2022-10-27T08:00:53Z

@adityamandaleeka Hmm, that's odd. I'm not getting those test failures locally. I'll dig into this a bit.

Seems to be a pesky line-ending issue. I wonder if there is a way to get the verifier to ignore these when comparing texts...

I'm not sure if adding an editorconfig to the tests with end_of_line = crlf can fix the failure (or if it's the correct action).

cc @sharwell @CyrusNajmabadi for suggestions.

Youssef1313 · 2022-11-14T14:07:40Z

@captainsafia Could the failing test be skipped on Linux and get the PR merged?

captainsafia · 2022-11-14T16:27:57Z

@captainsafia Could the failing test be skipped on Linux and get the PR merged?

I'd like to see if trying

I'm not sure if adding an editorconfig to the tests with end_of_line = crlf can fix the failure (or if it's the correct action).

might help here.

We've had issues before where analyzer tests were not running and resulted in some unsavory unhandled exceptions. Let me see if I can tweak this PR to flow it along.

BrennanConroy · 2022-11-23T23:40:27Z

Could the failing test be skipped on Linux and get the PR merged?

@david-acker Could you try that out? Apply the OSSkipCondition to the affected tests:

aspnetcore/src/Middleware/Diagnostics.EntityFrameworkCore/test/FunctionalTests/DatabaseErrorPageMiddlewareTest.cs

Line 97 in de3019b

[OSSkipCondition(OperatingSystems.Linux)]

This reverts commit 620275d.

david-acker · 2022-11-24T01:42:03Z

I updated the failing test to be skipped on Linux and macOS. I also reverted the last commit which added the .editorconfig file.

captainsafia · 2022-11-30T03:02:01Z

@david-acker Thanks for submitting this PR! Documentation has already been handled in #45025 (comment). Feel free to submit any updates to the docs if you'd like.

david-acker added 3 commits October 10, 2022 21:04

Add IHeaderDictionary.Add analyzer and code fix

1373fbe

Change wording from "Disallow-" to "RecommendAgainst-"

aabfef9

Change diagnostic rule ID

eb91cd8

ghost added the community-contribution Indicates that the PR has been added by a community member label Oct 11, 2022

david-acker marked this pull request as draft October 11, 2022 01:38

mkArtakMSFT added the area-runtime label Oct 11, 2022

mkArtakMSFT assigned adityamandaleeka Oct 11, 2022

david-acker added 6 commits October 12, 2022 20:04

Merge branch 'main' into add-header-dictionary-analyzer

16332ba

Remove analyzer and code fix from AspNetCore.Analyzers project

2bf902d

Add analyzer to Framework/AspNetCoreAnalyzers

88625b2

Add code fix to Framework/AspNetCoreAnalyzers

dd36127

Fix nullable reference type

e6190b7

Fix diagnostics in the project caused by new analyzer

049bde0

build-analysis bot mentioned this pull request Oct 14, 2022

Tracking Nuget 429s dotnet/arcade#10885

Closed

2 tasks

Fix using directive insertion logic

1577df7

david-acker commented Oct 14, 2022

View reviewed changes

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs Outdated Show resolved Hide resolved

david-acker commented Oct 14, 2022

View reviewed changes

src/Framework/AspNetCoreAnalyzers/test/Http/HeaderDictionaryAddFixerTests.cs Outdated Show resolved Hide resolved

Fix StringComparison warning

a2331a8

david-acker marked this pull request as ready for review October 14, 2022 17:36

david-acker requested review from JamesNK and captainsafia as code owners October 14, 2022 17:36

captainsafia reviewed Oct 17, 2022

View reviewed changes

Youssef1313 reviewed Oct 17, 2022

View reviewed changes

src/Framework/AspNetCoreAnalyzers/src/Analyzers/Http/HeaderDictionaryAddAnalyzer.cs Outdated Show resolved Hide resolved

Youssef1313 reviewed Oct 17, 2022

View reviewed changes

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs Outdated Show resolved Hide resolved

Youssef1313 reviewed Oct 17, 2022

View reviewed changes

src/Framework/AspNetCoreAnalyzers/src/CodeFixes/Http/HeaderDictionaryAddFixer.cs Outdated Show resolved Hide resolved

Youssef1313 reviewed Oct 17, 2022

View reviewed changes

src/Framework/AspNetCoreAnalyzers/test/Http/HeaderDictionaryAddAnalyzerTests.cs Outdated Show resolved Hide resolved

Youssef1313 reviewed Oct 17, 2022

View reviewed changes

src/Framework/AspNetCoreAnalyzers/test/Http/HeaderDictionaryAddAnalyzerTests.cs Outdated Show resolved Hide resolved

david-acker added 2 commits October 18, 2022 21:22

Update diagnostic message

e2f0a12

Move checks before code fix registration

a216f87

captainsafia approved these changes Oct 21, 2022

View reviewed changes

Youssef1313 approved these changes Oct 22, 2022

View reviewed changes

david-acker mentioned this pull request Oct 25, 2022

ASP0019: Add documentation for new analyzers dotnet/AspNetCore.Docs#27366

Closed

david-acker added 2 commits October 25, 2022 19:37

Pass true for getInnermostNodeForTie

1bad1a3

Perform symbol comparison for IHeaderDictionary

289260a

Youssef1313 reviewed Oct 27, 2022

View reviewed changes

Add using directive via syntax annotation

bc3ef4d

Youssef1313 mentioned this pull request Oct 28, 2022

AddImportsAnnotation doesn't match existing line endings dotnet/roslyn#65081

Closed

Add editorconfig

620275d

david-acker added 2 commits November 23, 2022 20:29

Revert "Add editorconfig"

117ab9e

This reverts commit 620275d.

Skip test on Linux, macOS

a57af9b

captainsafia merged commit 522bbee into dotnet:main Nov 30, 2022

david-acker deleted the add-header-dictionary-analyzer branch December 30, 2022 01:08

Tratcher mentioned this pull request Feb 15, 2023

[dotnet-sdk-8.0.100-preview.1.23107.4] Build with Error ASP0019,ASP0023 after retargeting to .NET 8.0 for OrchardCMS app #46642

Closed

Junjun-zhao mentioned this pull request Feb 16, 2023

[dotnet-sdk-8.0.100-preview.1.23107.4] Build with Error ASP0019,ASP0023 after retargeting to .NET 8.0 for OrchardCMS app OrchardCMS/OrchardCore#13263

Closed

david-acker mentioned this pull request Apr 21, 2023

Add analyzer/codefixer to use AddAuthorizationBuilder #47428

Merged

amcasey added area-networking Includes servers, yarp, json patch, bedrock, websockets, http client factory, and http abstractions and removed area-runtime labels Aug 25, 2023

	using Microsoft.CodeAnalysis.CSharp.Syntax;
	using Microsoft.CodeAnalysis.CSharp.Syntax;
	using Microsoft.CodeAnalysis.Simplification;

	var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false) as CompilationUnitSyntax;
	var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false);

		return document.WithSyntaxRoot(
		AddRequiredUsingDirectiveForAppend(root.ReplaceNode(diagnosticTarget, invocation)));

-        return document.WithSyntaxRoot(
-            AddRequiredUsingDirectiveForAppend(root.ReplaceNode(diagnosticTarget, invocation)));
+        var model = await document.GetSemanticModelAsync(cancellationToken).ConfigureAwait(false);
+        var headerDictionaryExtensionsSymbol = model.Compilation.GetTypeByMetadataName("Microsoft.AspNetCore.Http.HeaderDictionaryExtensions");
+        var annotation = new SyntaxAnnotation("SymbolId", DocumentationCommentId.CreateReferenceId(headerDictionaryExtensionsSymbol));
+        return document.WithSyntaxRoot(
+            root.ReplaceNode(diagnosticTarget, invocation.WithAdditionalAnnotations(Simplifier.AddImportsAnnotation, annotation)));

Add analyzer and code fix to recommend against IHeaderDictionary.Add #44463

Add analyzer and code fix to recommend against IHeaderDictionary.Add #44463

Uh oh!

Conversation

david-acker commented Oct 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Questions

Uh oh!

ghost commented Oct 11, 2022

Uh oh!

adityamandaleeka commented Oct 12, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

david-acker Oct 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

captainsafia left a comment

Choose a reason for hiding this comment

Uh oh!

Youssef1313 left a comment

Choose a reason for hiding this comment

Uh oh!

david-acker commented Oct 22, 2022

Uh oh!

adityamandaleeka commented Oct 26, 2022

Uh oh!

david-acker commented Oct 26, 2022

Uh oh!

captainsafia commented Oct 27, 2022

Uh oh!

Youssef1313 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Youssef1313 commented Oct 27, 2022

Uh oh!

Youssef1313 commented Nov 14, 2022

Uh oh!

captainsafia commented Nov 14, 2022

Uh oh!

BrennanConroy commented Nov 23, 2022

Uh oh!

david-acker commented Nov 24, 2022

Uh oh!

captainsafia commented Nov 30, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

david-acker commented Oct 11, 2022 •

edited

Loading

david-acker Oct 19, 2022 •

edited

Loading