Skip to content

Add analyzer for custom IProblemDetailsWriter registration#49286

Draft
david-acker wants to merge 24 commits intodotnet:mainfrom
david-acker:custom-IProblemDetailsWriter-analyzer
Draft

Add analyzer for custom IProblemDetailsWriter registration#49286
david-acker wants to merge 24 commits intodotnet:mainfrom
david-acker:custom-IProblemDetailsWriter-analyzer

Conversation

@david-acker
Copy link
Copy Markdown
Member

@david-acker david-acker commented Jul 10, 2023 •
edited
Loading

Add analyzer for custom IProblemDetailsWriter registration

Adds an analyzer that checks that custom IProblemDetailsWriters are registered in the correct order, relative to MvcServiceCollectionExtensions method calls.

Description

If a custom IProblemDetailsWriter is registered after a MvcServiceCollectionExtensions method, the DefaultProblemDetailsWriter will be used instead of the custom IProblemDetailsWriter.

This analyzer reports a warning level diagnostic when an IProblemDetailsWriter is registered (using AddTransient, AddScoped, or AddSingleton) and appears after a call to a MvcServiceCollectionExtensions method (AddControllers, AddControllersWithViews, AddMvc, or AddRazorPages).

Diagnostic

Id: ASP0026
Title: Custom IProblemDetailsWriter is incorrectly configured
Message: The custom IProblemDetailsWriter must be registered before calling AddControllers, AddControllersWithViews, AddMvc, or AddRazorPages.
Severity: Warning

Code Examples:

Diagnostic Reported:

services.AddControllers();

// Diagnostic reported on method invocation below
services.AddTransient<IProblemDetailsWriter, SampleProblemDetailsWriter>();

No Diagnostic Reported:

services.AddTransient<IProblemDetailsWriter, SampleProblemDetailsWriter>();

services.AddControllers();

Analyzer Infrastructure Changes

  • Brings over StartupAnalyzer-related infrastructure from the legacy Microsoft.AspNetCore.Analyzers project

Fixes #48180

@ghost ghost added community-contribution Indicates that the PR has been added by a community member needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically labels Jul 10, 2023
@ghost
Copy link
Copy Markdown

ghost commented Jul 10, 2023

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

@david-acker david-acker added area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates old-area-web-frameworks-do-not-use *DEPRECATED* This label is deprecated in favor of the area-mvc and area-minimal labels and removed needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically labels Jul 10, 2023
@david-acker david-acker added the analyzer Indicates an issue which is related to analyzer experience label Oct 25, 2023
@adityamandaleeka
Copy link
Copy Markdown
Member

adityamandaleeka commented Jan 31, 2024

@david-acker, Are you still working on this one? No pressure, just asking because it's been sitting in draft state for a while.

@david-acker
Copy link
Copy Markdown
Member Author

david-acker commented Jan 31, 2024

I'm planning on working on this again fairly soon now that the API has finally approved.

@david-acker david-acker marked this pull request as ready for review February 10, 2024 04:26
@dotnet-policy-service dotnet-policy-service bot added the pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun label Feb 17, 2024
@adityamandaleeka
Copy link
Copy Markdown
Member

adityamandaleeka commented Mar 4, 2024

@captainsafia PTAL

@captainsafia
Copy link
Copy Markdown
Contributor

captainsafia commented Mar 4, 2024

/azp run

@dotnet-policy-service dotnet-policy-service bot removed the pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun label Mar 4, 2024
@azure-pipelines
Copy link
Copy Markdown

azure-pipelines bot commented Mar 4, 2024

Azure Pipelines successfully started running 3 pipeline(s).

@captainsafia
Copy link
Copy Markdown
Contributor

captainsafia commented Mar 4, 2024

@david-acker I saw you posted a question in the original issue about moving StartupAnalyzer-related infrastructure to the analyzers that get shipped in the refpack. I'm in favor of incorproating a StartupAnalyzer in that project and using source-sharing to bring in helpful dependencies like StartupFacts.

@dotnet-policy-service dotnet-policy-service bot added the pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun label Mar 12, 2024
@david-acker david-acker marked this pull request as draft March 13, 2024 05:34
This was referenced Sep 2, 2024
Open
Closed
@dotnet-policy-service
Copy link
Copy Markdown
Contributor

dotnet-policy-service bot commented Sep 10, 2024

Looks like this PR hasn't been active for some time and the codebase could have been changed in the meantime.
To make sure no conflicting changes have occurred, please rerun validation before merging. You can do this by leaving an /azp run comment here (requires commit rights), or by simply closing and reopening.

@dotnet-policy-service dotnet-policy-service bot added the pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun label Sep 10, 2024
@mkArtakMSFT mkArtakMSFT removed the area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates label Sep 16, 2024
@david-acker david-acker marked this pull request as draft October 17, 2024 23:25
@captainsafia captainsafia removed their assignment Aug 4, 2025
This was referenced Apr 4, 2026
Closed
Open
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Open
Closed
Closed
Open
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

analyzer Indicates an issue which is related to analyzer experience area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc community-contribution Indicates that the PR has been added by a community member pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Analyzer] : Warn when registering custom IProblemDetailsWriter after calling AddRazorPages, etc

4 participants

@david-acker @adityamandaleeka @captainsafia @mkArtakMSFT