Obsolete error page middleware

Author: John Luo

src/Middleware/Diagnostics.EntityFrameworkCore/src/DatabaseErrorPageExtensions.cs

@@ -11,6 +11,7 @@ namespace Microsoft.AspNetCore.Builder
     /// <summary>
     /// <see cref="IApplicationBuilder"/> extension methods for the <see cref="DatabaseErrorPageMiddleware"/>.
     /// </summary>
+    [Obsolete("This is obsolete and will be removed in a future version. Use DatabaseExceptionHandler instead.")]
     public static class DatabaseErrorPageExtensions
     {
         /// <summary>
@@ -19,6 +20,7 @@ public static class DatabaseErrorPageExtensions
         /// </summary>
         /// <param name="app">The <see cref="IApplicationBuilder"/> to register the middleware with.</param>
         /// <returns>The same <see cref="IApplicationBuilder"/> instance so that multiple calls can be chained.</returns>
+        [Obsolete("This is obsolete and will be removed in a future version. Use DatabaseExceptionHandler instead.")]
         public static IApplicationBuilder UseDatabaseErrorPage(this IApplicationBuilder app)
         {
             if (app == null)
@@ -36,6 +38,7 @@ public static IApplicationBuilder UseDatabaseErrorPage(this IApplicationBuilder
         /// <param name="app">The <see cref="IApplicationBuilder"/> to register the middleware with.</param>
         /// <param name="options">A <see cref="DatabaseErrorPageOptions"/> that specifies options for the middleware.</param>
         /// <returns>The same <see cref="IApplicationBuilder"/> instance so that multiple calls can be chained.</returns>
+        [Obsolete("This is obsolete and will be removed in a future version. Use DatabaseExceptionHandler instead.")]
         public static IApplicationBuilder UseDatabaseErrorPage(
             this IApplicationBuilder app, DatabaseErrorPageOptions options)
         {
@@ -59,4 +62,4 @@ public static IApplicationBuilder UseDatabaseErrorPage(
             return app;
         }
     }
-}
+}

src/Middleware/Diagnostics.EntityFrameworkCore/src/DatabaseErrorPageMiddleware.cs

@@ -56,6 +56,7 @@ public void Hold(Exception exception, Type contextType)
         ///     consumes them to detect database related exception.
         /// </param>
         /// <param name="options">The options to control what information is displayed on the error page.</param>
+        [Obsolete("This is obsolete and will be removed in a future version. Use DatabaseExceptionHandler instead.")]
         public DatabaseErrorPageMiddleware(
             RequestDelegate next,
             ILoggerFactory loggerFactory,

src/Middleware/Diagnostics.EntityFrameworkCore/src/DiagnosticsEntityFrameworkCoreLoggerExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -14,11 +14,6 @@ internal static class DiagnosticsEntityFrameworkCoreLoggerExtensions
             new EventId(1, "NoContextType"),
             "No context type was specified. Ensure the form data from the request includes a 'context' value, specifying the context type name to apply migrations for.");
 
-        private static readonly Action<ILogger, string, Exception> _invalidContextType = LoggerMessage.Define<string>(
-            LogLevel.Error,
-            new EventId(2, "InvalidContextType"),
-            "The context type '{ContextTypeName}' could not be loaded. Ensure this is the correct type name for the context you are trying to apply migrations for.");
-
         private static readonly Action<ILogger, string, Exception> _contextNotRegistered = LoggerMessage.Define<string>(
             LogLevel.Error,
             new EventId(3, "ContextNotRegistered"),
@@ -85,11 +80,6 @@ public static void NoContextType(this ILogger logger)
             _noContextType(logger, null);
         }
 
-        public static void InvalidContextType(this ILogger logger, string contextTypeName)
-        {
-            _invalidContextType(logger, contextTypeName, null);
-        }
-
         public static void ContextNotRegistered(this ILogger logger, string contextTypeName)
         {
             _contextNotRegistered(logger, contextTypeName, null);

src/Middleware/Diagnostics.EntityFrameworkCore/src/MigrationsEndPointMiddleware.cs

@@ -11,7 +11,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
-using Microsoft.Extensions.Primitives;
 
 namespace Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore
 {
@@ -111,12 +110,7 @@ private static async Task<DbContext> GetDbContext(HttpContext context, ILogger l
             var form = await context.Request.ReadFormAsync();
             var contextTypeName = form["context"];
 
-            // TODO: Decouple
-            // Look for DbContext classes registered in the service provider
-            var registeredContexts = context.RequestServices.GetServices<DbContextOptions>()
-                .Select(o => o.ContextType);
-
-            if (string.IsNullOrWhiteSpace(contextTypeName) || !registeredContexts.Any(c => string.Equals(contextTypeName, c.AssemblyQualifiedName)))
+            if (string.IsNullOrWhiteSpace(contextTypeName))
             {
                 logger.NoContextType();
 
@@ -125,33 +119,27 @@ private static async Task<DbContext> GetDbContext(HttpContext context, ILogger l
                 return null;
             }
 
-            var contextType = Type.GetType(contextTypeName);
+            // TODO: Decouple
+            // Look for DbContext classes registered in the service provider
+            var registeredContexts = context.RequestServices.GetServices<DbContextOptions>()
+                .Select(o => o.ContextType);
 
-            if (contextType == null)
+            if (!registeredContexts.Any(c => string.Equals(contextTypeName, c.AssemblyQualifiedName)))
             {
-                var message = Strings.FormatMigrationsEndPointMiddleware_InvalidContextType(contextTypeName);
+                var message = Strings.FormatMigrationsEndPointMiddleware_ContextNotRegistered(contextTypeName);
 
-                logger.InvalidContextType(contextTypeName);
+                logger.ContextNotRegistered(contextTypeName);
 
                 await WriteErrorToResponse(context.Response, message);
 
                 return null;
             }
 
+            var contextType = Type.GetType(contextTypeName);
+
             // TODO: Decouple
             var db = (DbContext)context.RequestServices.GetService(contextType);
 
-            if (db == null)
-            {
-                var message = Strings.FormatMigrationsEndPointMiddleware_ContextNotRegistered(contextType.FullName);
-
-                logger.ContextNotRegistered(contextType.FullName);
-
-                await WriteErrorToResponse(context.Response, message);
-
-                return null;
-            }
-
             return db;
         }
 

src/Middleware/Diagnostics.EntityFrameworkCore/src/Strings.resx

@@ -166,14 +166,11 @@
     <value>&gt; dotnet ef database update</value>
   </data>
   <data name="MigrationsEndPointMiddleware_ContextNotRegistered" xml:space="preserve">
-    <value>The context type '{0}' was not found in services. This usually means the context was not registered in services during startup. You probably want to call AddScoped&lt;{0}&gt;() inside the UseServices(...) call in your application startup code.</value>
+    <value>The context type '{0}' was not found in services. This usually means either the context is invalid or it was not registered in services during startup. You probably want to call AddDBContext&lt;&gt;() inside the ConfigureServices(...) call in your application startup code.</value>
   </data>
   <data name="MigrationsEndPointMiddleware_Exception" xml:space="preserve">
     <value>An error occurred while applying the migrations for '{0}'. See InnerException for details.</value>
   </data>
-  <data name="MigrationsEndPointMiddleware_InvalidContextType" xml:space="preserve">
-    <value>The context type '{0}' could not be loaded. Ensure this is the correct type name for the context you are trying to apply migrations for.</value>
-  </data>
   <data name="MigrationsEndPointMiddleware_NoContextType" xml:space="preserve">
     <value>No context type was specified. Ensure the form data from the request includes a 'context' value, specifying the context type name to apply migrations for.</value>
   </data>

src/Middleware/Diagnostics.EntityFrameworkCore/src/Views/DatabaseErrorPage.Designer.cs

@@ -1,4 +1,4 @@
-@using System
+@using System
 @using System.Linq
 @using Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore
 @using Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.Views
@@ -69,7 +69,7 @@
             </div>
         }
 
-        var contextWithPendingMigrations = Model.ContextDetails.Where(c => c.PendingMigrations.Any());
+        var contextWithPendingMigrations = Model.ContextDetails.Where(c => c.PendingMigrations.Any()).Except(contextWithNoDBOrMigrations);
         if (contextWithPendingMigrations.Any())
         {
             <div>
@@ -135,7 +135,7 @@
             </div>
         }
 
-        var contextWithPendingModelChanges = Model.ContextDetails.Where(c => c.PendingModelChanges);
+        var contextWithPendingModelChanges = Model.ContextDetails.Where(c => c.PendingModelChanges).Except(contextWithNoDBOrMigrations).Except(contextWithPendingMigrations);
         if (contextWithPendingModelChanges.Any())
         {
             <div>

src/Middleware/Diagnostics.EntityFrameworkCore/src/Views/DatabaseErrorPage.cshtml

@@ -27,8 +27,10 @@ public class DatabaseErrorPageMiddlewareTest
         [Fact]
         public async Task Successful_requests_pass_thru()
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var builder = new WebHostBuilder().Configure(app => app
                 .UseDatabaseErrorPage()
+#pragma warning restore CS0618 // Type or member is obsolete
                 .UseMiddleware<SuccessMiddleware>());
             var server = new TestServer(builder);
 
@@ -53,8 +55,10 @@ public virtual async Task Invoke(HttpContext context)
         [Fact]
         public async Task Non_database_exceptions_pass_thru()
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var builder = new WebHostBuilder().Configure(app => app
                 .UseDatabaseErrorPage()
+#pragma warning restore CS0618 // Type or member is obsolete
                 .UseMiddleware<ExceptionMiddleware>());
             var server = new TestServer(builder);
 
@@ -119,7 +123,9 @@ public async Task Error_page_displayed_no_migrations()
 
                 Assert.Equal(HttpStatusCode.InternalServerError, response.StatusCode);
                 var content = await response.Content.ReadAsStringAsync();
-                Assert.Contains(StringsHelpers.GetResourceString("FormatDatabaseErrorPage_NoDbOrMigrationsTitle", typeof(BloggingContext).Name), content);
+                Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_NoDbOrMigrationsTitle"), content);
+                Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_NoDbOrMigrationsInfo"), content);
+                Assert.Contains(typeof(BloggingContext).Name, content);
                 Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_AddMigrationCommandPMC").Replace(">", "&gt;"), content);
                 Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_ApplyMigrationsCommandPMC").Replace(">", "&gt;"), content);
             }
@@ -178,7 +184,9 @@ public async Task Error_page_displayed_pending_migrations()
                 Assert.Equal(HttpStatusCode.InternalServerError, response.StatusCode);
 
                 var content = await response.Content.ReadAsStringAsync();
-                Assert.Contains(StringsHelpers.GetResourceString("FormatDatabaseErrorPage_PendingMigrationsTitle", typeof(BloggingContextWithMigrations).Name), content);
+                Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_PendingMigrationsTitle"), content);
+                Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_PendingMigrationsInfo"), content);
+                Assert.Contains(typeof(BloggingContextWithMigrations).Name, content);
                 Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_ApplyMigrationsCommandPMC").Replace(">", "&gt;"), content);
                 Assert.Contains("<li>111111111111111_MigrationOne</li>", content);
                 Assert.Contains("<li>222222222222222_MigrationTwo</li>", content);
@@ -214,7 +222,9 @@ public async Task Error_page_displayed_pending_model_changes()
                 Assert.Equal(HttpStatusCode.InternalServerError, response.StatusCode);
 
                 var content = await response.Content.ReadAsStringAsync();
-                Assert.Contains(StringsHelpers.GetResourceString("FormatDatabaseErrorPage_PendingChangesTitle", typeof(BloggingContextWithPendingModelChanges).Name), content);
+                Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_PendingChangesTitle"), content);
+                Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_PendingChangesInfo"), content);
+                Assert.Contains(typeof(BloggingContextWithPendingModelChanges).Name, content);
                 Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_AddMigrationCommandCLI").Replace(">", "&gt;"), content);
                 Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_AddMigrationCommandPMC").Replace(">", "&gt;"), content);
                 Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_ApplyMigrationsCommandCLI").Replace(">", "&gt;"), content);
@@ -259,7 +269,7 @@ public async Task Error_page_then_apply_migrations()
                 // Ensure the url we're going to test is what the page is using in it's JavaScript
                 var javaScriptEncoder = JavaScriptEncoder.Default;
                 Assert.Contains("req.open(\"POST\", \"" + JavaScriptEncode(expectedMigrationsEndpoint) + "\", true);", content);
-                Assert.Contains("var formBody = \"context=" + JavaScriptEncode(UrlEncode(expectedContextType)) + "\";", content);
+                Assert.Contains("data-assemblyname=\"" + JavaScriptEncode(expectedContextType) + "\"", content);
 
                 // Step Two: Request to migrations endpoint
                 var formData = new FormUrlEncodedContent(new List<KeyValuePair<string, string>>
@@ -305,10 +315,12 @@ public async Task Customize_migrations_end_point()
                 var builder = new WebHostBuilder()
                     .Configure(app =>
                     {
+#pragma warning disable CS0618 // Type or member is obsolete
                         app.UseDatabaseErrorPage(new DatabaseErrorPageOptions
                         {
                             MigrationsEndPointPath = new PathString(migrationsEndpoint)
                         });
+#pragma warning restore CS0618 // Type or member is obsolete
 
                         app.UseMiddleware<PendingMigrationsMiddleware>();
                     })
@@ -338,7 +350,9 @@ public async Task Pass_thru_when_context_not_in_services()
             var builder = new WebHostBuilder()
                 .Configure(app =>
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     app.UseDatabaseErrorPage();
+#pragma warning restore CS0618 // Type or member is obsolete
                     app.UseMiddleware<ContextNotRegisteredInServicesMiddleware>();
 #pragma warning disable CS0618 // Type or member is obsolete
                     app.ApplicationServices.GetService<ILoggerFactory>().AddProvider(logProvider);
@@ -436,7 +450,9 @@ public async Task Error_page_displayed_when_exception_wrapped()
                 Assert.Equal(HttpStatusCode.InternalServerError, response.StatusCode);
                 var content = await response.Content.ReadAsStringAsync();
                 Assert.Contains("I wrapped your exception", content);
-                Assert.Contains(StringsHelpers.GetResourceString("FormatDatabaseErrorPage_NoDbOrMigrationsTitle", typeof(BloggingContext).Name), content);
+                Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_NoDbOrMigrationsTitle"), content);
+                Assert.Contains(StringsHelpers.GetResourceString("DatabaseErrorPage_NoDbOrMigrationsInfo"), content);
+                Assert.Contains(typeof(BloggingContext).Name, content);
             }
         }
 
@@ -467,7 +483,9 @@ private static TestServer SetupTestServer<TContext, TMiddleware>(SqlTestStore da
             var builder = new WebHostBuilder()
                 .Configure(app =>
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     app.UseDatabaseErrorPage();
+#pragma warning restore CS0618 // Type or member is obsolete
 
                     app.UseMiddleware<TMiddleware>();
 

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

@@ -165,7 +165,7 @@ public async Task Invalid_context_type_specified()
             var content = await response.Content.ReadAsStringAsync();
 
             Assert.Equal(HttpStatusCode.BadRequest, response.StatusCode);
-            Assert.StartsWith(StringsHelpers.GetResourceString("FormatMigrationsEndPointMiddleware_InvalidContextType", typeName), content);
+            Assert.StartsWith(StringsHelpers.GetResourceString("FormatMigrationsEndPointMiddleware_ContextNotRegistered", typeName), content);
             Assert.True(content.Length > 512);
         }
 
@@ -186,7 +186,7 @@ public async Task Context_not_registered_in_services()
             var content = await response.Content.ReadAsStringAsync();
 
             Assert.Equal(HttpStatusCode.BadRequest, response.StatusCode);
-            Assert.StartsWith(StringsHelpers.GetResourceString("FormatMigrationsEndPointMiddleware_ContextNotRegistered", typeof(BloggingContext)), content);
+            Assert.StartsWith(StringsHelpers.GetResourceString("FormatMigrationsEndPointMiddleware_ContextNotRegistered", typeof(BloggingContext).AssemblyQualifiedName), content);
             Assert.True(content.Length > 512);
         }