Enable nullable on Diagnostics.EntityFrameworkCore (#28814)

* Enable nullable on Diagnostics.EntityFrameworkCore

Author: JamesNK

src/Middleware/Diagnostics.EntityFrameworkCore/src/DatabaseDeveloperPageExceptionFilter.cs

@@ -13,7 +13,6 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 
-#nullable enable
 namespace Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore
 {
     /// <summary>

src/Middleware/Diagnostics.EntityFrameworkCore/src/DatabaseDeveloperPageExceptionFilterServiceExtensions.cs

@@ -6,7 +6,6 @@
 using Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 
-#nullable enable
 namespace Microsoft.Extensions.DependencyInjection
 {
     /// <summary>

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

@@ -21,7 +21,7 @@ namespace Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore
     ///     Captures synchronous and asynchronous database related exceptions from the pipeline that may be resolved using Entity Framework
     ///     migrations. When these exceptions occur an HTML response with details of possible actions to resolve the issue is generated.
     /// </summary>
-    public class DatabaseErrorPageMiddleware : IObserver<DiagnosticListener>, IObserver<KeyValuePair<string, object>>
+    public class DatabaseErrorPageMiddleware : IObserver<DiagnosticListener>, IObserver<KeyValuePair<string, object?>>
     {
         private static readonly AsyncLocal<DiagnosticHolder> _localDiagnostic = new AsyncLocal<DiagnosticHolder>();
 
@@ -33,8 +33,8 @@ public void Hold(Exception exception, Type contextType)
                 ContextType = contextType;
             }
 
-            public Exception Exception { get; private set; }
-            public Type ContextType { get; private set; }
+            public Exception? Exception { get; private set; }
+            public Type? ContextType { get; private set; }
         }
 
         private readonly RequestDelegate _next;
@@ -110,8 +110,8 @@ public virtual async Task Invoke(HttpContext httpContext)
                 {
                     if (ShouldDisplayErrorPage(exception))
                     {
-                        var contextType = _localDiagnostic.Value.ContextType;
-                        var details = await httpContext.GetContextDetailsAsync(contextType, _logger);
+                        var contextType = _localDiagnostic.Value!.ContextType;
+                        var details = await httpContext.GetContextDetailsAsync(contextType!, _logger);
 
                         if (details != null && (details.PendingModelChanges || details.PendingMigrations.Count() > 0))
                         {
@@ -139,7 +139,7 @@ private bool ShouldDisplayErrorPage(Exception exception)
         {
             _logger.AttemptingToMatchException(exception.GetType());
 
-            var lastRecordedException = _localDiagnostic.Value.Exception;
+            var lastRecordedException = _localDiagnostic.Value!.Exception;
 
             if (lastRecordedException == null)
             {
@@ -175,7 +175,7 @@ void IObserver<DiagnosticListener>.OnNext(DiagnosticListener diagnosticListener)
             }
         }
 
-        void IObserver<KeyValuePair<string, object>>.OnNext(KeyValuePair<string, object> keyValuePair)
+        void IObserver<KeyValuePair<string, object?>>.OnNext(KeyValuePair<string, object?> keyValuePair)
         {
             switch (keyValuePair.Value)
             {
@@ -204,11 +204,11 @@ void IObserver<DiagnosticListener>.OnError(Exception error)
         {
         }
 
-        void IObserver<KeyValuePair<string, object>>.OnCompleted()
+        void IObserver<KeyValuePair<string, object?>>.OnCompleted()
         {
         }
 
-        void IObserver<KeyValuePair<string, object>>.OnError(Exception error)
+        void IObserver<KeyValuePair<string, object?>>.OnError(Exception error)
         {
         }
     }

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

@@ -9,27 +9,27 @@ namespace Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore
     internal static class DiagnosticsEntityFrameworkCoreLoggerExtensions
     {
         // MigrationsEndPointMiddleware
-        private static readonly Action<ILogger, Exception> _noContextType = LoggerMessage.Define(
+        private static readonly Action<ILogger, Exception?> _noContextType = LoggerMessage.Define(
             LogLevel.Error,
             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> _contextNotRegistered = LoggerMessage.Define<string>(
+        private static readonly Action<ILogger, string, Exception?> _contextNotRegistered = LoggerMessage.Define<string>(
             LogLevel.Error,
             new EventId(3, "ContextNotRegistered"),
             "The context type '{ContextTypeName}' was not found in services. This usually means the context was not registered in services during startup. You probably want to call AddScoped<>() inside the UseServices(...) call in your application startup code.");
 
-        private static readonly Action<ILogger, string, Exception> _requestPathMatched = LoggerMessage.Define<string>(
+        private static readonly Action<ILogger, string, Exception?> _requestPathMatched = LoggerMessage.Define<string>(
             LogLevel.Debug,
             new EventId(4, "RequestPathMatched"),
             "Request path matched the path configured for this migrations endpoint({RequestPath}). Attempting to process the migrations request.");
 
-        private static readonly Action<ILogger, string, Exception> _applyingMigrations = LoggerMessage.Define<string>(
+        private static readonly Action<ILogger, string, Exception?> _applyingMigrations = LoggerMessage.Define<string>(
             LogLevel.Debug,
             new EventId(5, "ApplyingMigrations"),
             "Request is valid, applying migrations for context '{ContextTypeName}'");
 
-        private static readonly Action<ILogger, string, Exception> _migrationsApplied = LoggerMessage.Define<string>(
+        private static readonly Action<ILogger, string, Exception?> _migrationsApplied = LoggerMessage.Define<string>(
             LogLevel.Debug,
             new EventId(6, "MigrationsApplied"),
             "Migrations successfully applied for context '{ContextTypeName}'.");
@@ -40,32 +40,32 @@ internal static class DiagnosticsEntityFrameworkCoreLoggerExtensions
             "An error occurred while applying the migrations for '{ContextTypeName}'. See InnerException for details:");
 
         // DatabaseErrorPageMiddleware
-        private static readonly Action<ILogger, Type, Exception> _attemptingToMatchException = LoggerMessage.Define<Type>(
+        private static readonly Action<ILogger, Type, Exception?> _attemptingToMatchException = LoggerMessage.Define<Type>(
             LogLevel.Debug,
             new EventId(1, "AttemptingToMatchException"),
             "{ExceptionType} occurred, checking if Entity Framework recorded this exception as resulting from a failed database operation.");
 
-        private static readonly Action<ILogger, Exception> _noRecordedException = LoggerMessage.Define(
+        private static readonly Action<ILogger, Exception?> _noRecordedException = LoggerMessage.Define(
             LogLevel.Debug,
             new EventId(2, "NoRecordedException"),
             "Entity Framework did not record any exceptions due to failed database operations. This means the current exception is not a failed Entity Framework database operation, or the current exception occurred from a DbContext that was not obtained from request services.");
 
-        private static readonly Action<ILogger, Exception> _noMatch = LoggerMessage.Define(
+        private static readonly Action<ILogger, Exception?> _noMatch = LoggerMessage.Define(
             LogLevel.Debug,
             new EventId(3, "NoMatchFound"),
             "The current exception (and its inner exceptions) do not match the last exception Entity Framework recorded due to a failed database operation. This means the database operation exception was handled and another exception occurred later in the request.");
 
-        private static readonly Action<ILogger, Exception> _matched = LoggerMessage.Define(
+        private static readonly Action<ILogger, Exception?> _matched = LoggerMessage.Define(
             LogLevel.Debug,
             new EventId(4, "MatchFound"),
             "Entity Framework recorded that the current exception was due to a failed database operation. Attempting to show database error page.");
 
-        private static readonly Action<ILogger, string, Exception> _contextNotRegisteredDatabaseErrorPageMiddleware = LoggerMessage.Define<string>(
+        private static readonly Action<ILogger, string, Exception?> _contextNotRegisteredDatabaseErrorPageMiddleware = LoggerMessage.Define<string>(
             LogLevel.Error,
             new EventId(5, "ContextNotRegistered"),
             "The context type '{ContextTypeName}' was not found in services. This usually means the context was not registered in services during startup. You probably want to call AddScoped<>() inside the UseServices(...) call in your application startup code. Skipping display of the database error page.");
 
-        private static readonly Action<ILogger, Exception> _notRelationalDatabase = LoggerMessage.Define(
+        private static readonly Action<ILogger, Exception?> _notRelationalDatabase = LoggerMessage.Define(
             LogLevel.Debug,
             new EventId(6, "NotRelationalDatabase"),
             "The target data store is not a relational database. Skipping the database error page.");

src/Middleware/Diagnostics.EntityFrameworkCore/src/HttpContextDatabaseContextDetailsExtensions.cs

@@ -15,7 +15,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
-#nullable enable
 namespace Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore
 {
     internal static class HttpContextDatabaseContextDetailsExtensions
@@ -26,7 +25,7 @@ internal static class HttpContextDatabaseContextDetailsExtensions
 
             if (context == null)
             {
-                logger.ContextNotRegisteredDatabaseErrorPageMiddleware(dbcontextType.FullName);
+                logger.ContextNotRegisteredDatabaseErrorPageMiddleware(dbcontextType.FullName!);
                 return null;
             }
 

src/Middleware/Diagnostics.EntityFrameworkCore/src/Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.csproj

@@ -5,6 +5,7 @@
     <TargetFrameworks>$(DefaultNetCoreTargetFramework)</TargetFrameworks>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageTags>aspnetcore;diagnostics;entityframeworkcore</PackageTags>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>

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

@@ -74,7 +74,7 @@ public virtual async Task Invoke(HttpContext context)
 
                 if (db != null)
                 {
-                    var dbName = db.GetType().FullName;
+                    var dbName = db.GetType().FullName!;
                     try
                     {
                         _logger.ApplyingMigrations(dbName);
@@ -103,7 +103,7 @@ public virtual async Task Invoke(HttpContext context)
             }
         }
 
-        private static async Task<DbContext> GetDbContext(HttpContext context, ILogger logger)
+        private static async Task<DbContext?> GetDbContext(HttpContext context, ILogger logger)
         {
             var form = await context.Request.ReadFormAsync();
             var contextTypeName = form["context"];
@@ -132,9 +132,9 @@ private static async Task<DbContext> GetDbContext(HttpContext context, ILogger l
                 return null;
             }
 
-            var contextType = Type.GetType(contextTypeName);
+            var contextType = Type.GetType(contextTypeName)!;
 
-            var db = (DbContext)context.RequestServices.GetService(contextType);
+            var db = (DbContext?)context.RequestServices.GetService(contextType);
 
             return db;
         }

src/Middleware/Diagnostics.EntityFrameworkCore/src/PublicAPI.Shipped.txt

@@ -17,11 +17,11 @@ virtual Microsoft.AspNetCore.Builder.DatabaseErrorPageOptions.MigrationsEndPoint
 virtual Microsoft.AspNetCore.Builder.MigrationsEndPointOptions.Path.get -> Microsoft.AspNetCore.Http.PathString
 virtual Microsoft.AspNetCore.Builder.MigrationsEndPointOptions.Path.set -> void
 ~Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseDeveloperPageExceptionFilter.DatabaseDeveloperPageExceptionFilter(Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseDeveloperPageExceptionFilter!>! logger, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.DatabaseErrorPageOptions!>! options) -> void
-~Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseErrorPageMiddleware.DatabaseErrorPageMiddleware(Microsoft.AspNetCore.Http.RequestDelegate next, Microsoft.Extensions.Logging.ILoggerFactory loggerFactory, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.DatabaseErrorPageOptions> options) -> void
-~Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.MigrationsEndPointMiddleware.MigrationsEndPointMiddleware(Microsoft.AspNetCore.Http.RequestDelegate next, Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.MigrationsEndPointMiddleware> logger, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.MigrationsEndPointOptions> options) -> void
-~static Microsoft.AspNetCore.Builder.DatabaseErrorPageExtensions.UseDatabaseErrorPage(this Microsoft.AspNetCore.Builder.IApplicationBuilder app) -> Microsoft.AspNetCore.Builder.IApplicationBuilder
-~static Microsoft.AspNetCore.Builder.DatabaseErrorPageExtensions.UseDatabaseErrorPage(this Microsoft.AspNetCore.Builder.IApplicationBuilder app, Microsoft.AspNetCore.Builder.DatabaseErrorPageOptions options) -> Microsoft.AspNetCore.Builder.IApplicationBuilder
-~static Microsoft.AspNetCore.Builder.MigrationsEndPointExtensions.UseMigrationsEndPoint(this Microsoft.AspNetCore.Builder.IApplicationBuilder app) -> Microsoft.AspNetCore.Builder.IApplicationBuilder
-~static Microsoft.AspNetCore.Builder.MigrationsEndPointExtensions.UseMigrationsEndPoint(this Microsoft.AspNetCore.Builder.IApplicationBuilder app, Microsoft.AspNetCore.Builder.MigrationsEndPointOptions options) -> Microsoft.AspNetCore.Builder.IApplicationBuilder
-~virtual Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseErrorPageMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext httpContext) -> System.Threading.Tasks.Task
-~virtual Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.MigrationsEndPointMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext context) -> System.Threading.Tasks.Task
+~Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseErrorPageMiddleware.DatabaseErrorPageMiddleware(Microsoft.AspNetCore.Http.RequestDelegate! next, Microsoft.Extensions.Logging.ILoggerFactory! loggerFactory, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.DatabaseErrorPageOptions!>! options) -> void
+~Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.MigrationsEndPointMiddleware.MigrationsEndPointMiddleware(Microsoft.AspNetCore.Http.RequestDelegate! next, Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.MigrationsEndPointMiddleware!>! logger, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.MigrationsEndPointOptions!>! options) -> void
+static Microsoft.AspNetCore.Builder.DatabaseErrorPageExtensions.UseDatabaseErrorPage(this Microsoft.AspNetCore.Builder.IApplicationBuilder! app) -> Microsoft.AspNetCore.Builder.IApplicationBuilder!
+static Microsoft.AspNetCore.Builder.DatabaseErrorPageExtensions.UseDatabaseErrorPage(this Microsoft.AspNetCore.Builder.IApplicationBuilder! app, Microsoft.AspNetCore.Builder.DatabaseErrorPageOptions! options) -> Microsoft.AspNetCore.Builder.IApplicationBuilder!
+static Microsoft.AspNetCore.Builder.MigrationsEndPointExtensions.UseMigrationsEndPoint(this Microsoft.AspNetCore.Builder.IApplicationBuilder! app) -> Microsoft.AspNetCore.Builder.IApplicationBuilder!
+static Microsoft.AspNetCore.Builder.MigrationsEndPointExtensions.UseMigrationsEndPoint(this Microsoft.AspNetCore.Builder.IApplicationBuilder! app, Microsoft.AspNetCore.Builder.MigrationsEndPointOptions! options) -> Microsoft.AspNetCore.Builder.IApplicationBuilder!
+virtual Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.DatabaseErrorPageMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext! httpContext) -> System.Threading.Tasks.Task!
+virtual Microsoft.AspNetCore.Diagnostics.EntityFrameworkCore.MigrationsEndPointMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext! context) -> System.Threading.Tasks.Task!

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

@@ -9,7 +9,7 @@
 }
 @functions
 {
-    public DatabaseErrorPageModel Model { get; set; }
+    public DatabaseErrorPageModel Model { get; set; } = default!;
 
     public string UrlEncode(string content)
     {
@@ -34,7 +34,7 @@
 <body>
     <h1>@Strings.DatabaseErrorPage_Title</h1>
     <p>
-        @for (Exception ex = Model.Exception; ex != null; ex = ex.InnerException)
+        @for (Exception? ex = Model.Exception; ex != null; ex = ex.InnerException)
         {
             <span>@ex.GetType().Name: @ex.Message</span>
             <br />
@@ -87,7 +87,7 @@
                     </ul>
 
                     <p>
-                        <button id="applyMigrations" onclick="ApplyMigrations()" data-assemblyname="@JavaScriptEncode(context.Type.AssemblyQualifiedName)">@Strings.DatabaseErrorPage_ApplyMigrationsButton</button>
+                        <button id="applyMigrations" onclick="ApplyMigrations()" data-assemblyname="@JavaScriptEncode(context.Type.AssemblyQualifiedName!)">@Strings.DatabaseErrorPage_ApplyMigrationsButton</button>
                         <span id="applyMigrationsError" class="error"></span>
                         <span id="applyMigrationsSuccess"></span>
                     </p>
@@ -115,7 +115,7 @@
                     };
 
                     var formBody = "context=" + encodeURIComponent(document.getElementById('applyMigrations').getAttribute('data-assemblyname'));
-                    req.open("POST", "@JavaScriptEncode(Model.PathBase.Add(Model.Options.MigrationsEndPointPath).Value)", true);
+                    req.open("POST", "@JavaScriptEncode(Model.PathBase.Add(Model.Options.MigrationsEndPointPath).Value!)", true);
                     req.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
                     req.send(formBody);
                 }