forked from dotnet/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document database error page breaking change
- Loading branch information
1 parent
b6601da
commit d5cae12
Showing
4 changed files
with
88 additions
and
2 deletions.
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
Empty file.
76 changes: 76 additions & 0 deletions
76
includes/core-changes/aspnetcore/5.0/middleware-database-error-page-obsolete.md
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,76 @@ | ||
| ### Middleware: Database error page marked as obsolete | ||
|
|
||
| The [DatabaseErrorPageMiddleware](/dotnet/api/microsoft.aspnetcore.diagnostics.entityframeworkcore.databaseerrorpagemiddleware?view=aspnetcore-3.0) and its associated extension methods were marked as obsolete in .NET 5.0. The middleware and extension methods will be removed in .NET 6.0. The functionality will instead be provided by `DatabaseDeveloperPageExceptionFilter` and its extension methods. | ||
|
|
||
| For discussion, see the GitHub issue at [dotnet/aspnetcore#24987](https://github.com/dotnet/aspnetcore/issues/24987). | ||
|
|
||
| #### Version introduced | ||
|
|
||
| 5.0 RC 1 | ||
|
|
||
| #### Old behavior | ||
|
|
||
| `DatabaseErrorPageMiddleware` and its associated extension methods weren't obsolete. | ||
|
|
||
| #### New behavior | ||
|
|
||
| `DatabaseErrorPageMiddleware` and its associated extension methods are obsolete. | ||
|
|
||
| #### Reason for change | ||
|
|
||
| `DatabaseErrorPageMiddleware` was migrated to an extensible API for the [developer exception page](/aspnet/core/fundamentals/error-handling#developer-exception-page). For more information on the extensible API, see GitHub issue [dotnet/aspnetcore#8536](https://github.com/dotnet/aspnetcore/issues/8536). | ||
|
|
||
| #### Recommended action | ||
|
|
||
| Complete the following steps: | ||
|
|
||
| 1. Stop using `DatabaseErrorPageMiddleware` in your project. For example, remove the `UseDatabaseErrorPage` method call from `Startup.Configure`: | ||
|
|
||
| ```csharp | ||
| public void Configure(IApplicationBuilder app, IWebHostEnvironment env) | ||
| { | ||
| if (env.IsDevelopment()) | ||
| { | ||
| app.UseDatabaseErrorPage(); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 1. Ensure the developer exception page is added to your project. For example, call the <xref:Microsoft.AspNetCore.Builder.DeveloperExceptionPageExtensions.UseDeveloperExceptionPage%2A> method in `Startup.Configure`: | ||
|
|
||
| ```csharp | ||
| public void Configure(IApplicationBuilder app, IWebHostEnvironment env) | ||
| { | ||
| if (env.IsDevelopment()) | ||
| { | ||
| app.UseDeveloperExceptionPage(); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 1. Add the database developer page exception filter to the services collection. For example, call the `AddDatabaseDeveloperPageExceptionFilter` method in `Startup.ConfigureServices`: | ||
|
|
||
| ```csharp | ||
| public void ConfigureServices(IServiceCollection services) | ||
| { | ||
| services.AddDatabaseDeveloperPageExceptionFilter(); | ||
| } | ||
| ``` | ||
|
|
||
| #### Category | ||
|
|
||
| ASP.NET Core | ||
|
|
||
| #### Affected APIs | ||
|
|
||
| - [Microsoft.AspNetCore.Builder.DatabaseErrorPageExtensions.UseDatabaseErrorPage](/dotnet/api/microsoft.aspnetcore.builder.databaseerrorpageextensions.usedatabaseerrorpage?view=aspnetcore-3.0) | ||
| - [Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseErrorPageMiddleware](/dotnet/api/microsoft.aspnetcore.diagnostics.entityframeworkcore.databaseerrorpagemiddleware?view=aspnetcore-3.0) | ||
|
|
||
| <!-- | ||
|
|
||
| #### Affected APIs | ||
|
|
||
| - `Overload:Microsoft.AspNetCore.Builder.DatabaseErrorPageExtensions.UseDatabaseErrorPage` | ||
| - `T:Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseErrorPageMiddleware` | ||
|
|
||
| --> |