Add CreateScopeForStatusCodePages property and UseStatusCodePagesWithReExecute overload (#62624)

* Initial plan

* Implement CreateScopeForStatusCodePages API with renamed property and new overload

Co-authored-by: ilonatommy <[email protected]>

* Address PR feedback: remove test, fix nullability, add comments

Co-authored-by: ilonatommy <[email protected]>

* Revert test file changes as requested

Co-authored-by: ilonatommy <[email protected]>

* Fix updating "Shipped.txt".

* Revert googletest changes.

* Fix template tests.

* Fix.

* Revert template changes to use createScopeForErrors instead of createScopeForStatusCodePages

Co-authored-by: ilonatommy <[email protected]>

* Remove backcompat comment from StatusCodePagesExtensions

Co-authored-by: javiercn <[email protected]>

* Revert 07f562f.

* Remove UseStatusCodePagesWithReExecute calls from template files

Co-authored-by: ilonatommy <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: ilonatommy <[email protected]>
Co-authored-by: Ilona Tomkowicz <[email protected]>
Co-authored-by: javiercn <[email protected]>

Author: 3 people

src/Components/test/testassets/Components.TestServer/RazorComponentEndpointsNoInteractivityStartup.cs

@@ -64,7 +64,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                     app.UseExceptionHandler("/Error", createScopeForErrors: true);
                 }
 
-                reexecutionApp.UseStatusCodePagesWithReExecute("/not-found-reexecute", createScopeForErrors: true);
+                reexecutionApp.UseStatusCodePagesWithReExecute("/not-found-reexecute", createScopeForStatusCodePages: true);
                 reexecutionApp.UseStaticFiles();
                 reexecutionApp.UseRouting();
                 RazorComponentEndpointsStartup<TRootComponent>.UseFakeAuthState(reexecutionApp);

src/Components/test/testassets/Components.TestServer/RazorComponentEndpointsStartup.cs

@@ -103,7 +103,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                         await context.Response.WriteAsync("Triggered a 404 status code.");
                     });
                 });
-                reexecutionApp.UseStatusCodePagesWithReExecute("/not-found-reexecute", createScopeForErrors: true);
+                reexecutionApp.UseStatusCodePagesWithReExecute("/not-found-reexecute", createScopeForStatusCodePages: true);
                 reexecutionApp.UseRouting();
 
                 reexecutionApp.UseAntiforgery();

src/Middleware/Diagnostics/src/PublicAPI.Unshipped.txt

@@ -1,8 +1,8 @@
 #nullable enable
 Microsoft.AspNetCore.Builder.ExceptionHandlerOptions.SuppressDiagnosticsCallback.get -> System.Func<Microsoft.AspNetCore.Diagnostics.ExceptionHandlerSuppressDiagnosticsContext!, bool>?
 Microsoft.AspNetCore.Builder.ExceptionHandlerOptions.SuppressDiagnosticsCallback.set -> void
-Microsoft.AspNetCore.Builder.StatusCodePagesOptions.CreateScopeForErrors.get -> bool
-Microsoft.AspNetCore.Builder.StatusCodePagesOptions.CreateScopeForErrors.set -> void
+Microsoft.AspNetCore.Builder.StatusCodePagesOptions.CreateScopeForStatusCodePages.get -> bool
+Microsoft.AspNetCore.Builder.StatusCodePagesOptions.CreateScopeForStatusCodePages.set -> void
 Microsoft.AspNetCore.Diagnostics.ExceptionHandledType
 Microsoft.AspNetCore.Diagnostics.ExceptionHandledType.ExceptionHandlerDelegate = 3 -> Microsoft.AspNetCore.Diagnostics.ExceptionHandledType
 Microsoft.AspNetCore.Diagnostics.ExceptionHandledType.ExceptionHandlerService = 1 -> Microsoft.AspNetCore.Diagnostics.ExceptionHandledType
@@ -17,4 +17,6 @@ Microsoft.AspNetCore.Diagnostics.ExceptionHandlerSuppressDiagnosticsContext.Exce
 Microsoft.AspNetCore.Diagnostics.ExceptionHandlerSuppressDiagnosticsContext.ExceptionHandlerSuppressDiagnosticsContext() -> void
 Microsoft.AspNetCore.Diagnostics.ExceptionHandlerSuppressDiagnosticsContext.HttpContext.get -> Microsoft.AspNetCore.Http.HttpContext!
 Microsoft.AspNetCore.Diagnostics.ExceptionHandlerSuppressDiagnosticsContext.HttpContext.init -> void
-static Microsoft.AspNetCore.Builder.StatusCodePagesExtensions.UseStatusCodePagesWithReExecute(this Microsoft.AspNetCore.Builder.IApplicationBuilder! app, string! pathFormat, bool createScopeForErrors, string? queryFormat = null) -> Microsoft.AspNetCore.Builder.IApplicationBuilder!
+static Microsoft.AspNetCore.Builder.StatusCodePagesExtensions.UseStatusCodePagesWithReExecute(this Microsoft.AspNetCore.Builder.IApplicationBuilder! app, string! pathFormat, string? queryFormat = null, bool createScopeForStatusCodePages = false) -> Microsoft.AspNetCore.Builder.IApplicationBuilder!
+*REMOVED*static Microsoft.AspNetCore.Builder.StatusCodePagesExtensions.UseStatusCodePagesWithReExecute(this Microsoft.AspNetCore.Builder.IApplicationBuilder! app, string! pathFormat, string? queryFormat = null) -> Microsoft.AspNetCore.Builder.IApplicationBuilder!
+static Microsoft.AspNetCore.Builder.StatusCodePagesExtensions.UseStatusCodePagesWithReExecute(this Microsoft.AspNetCore.Builder.IApplicationBuilder! app, string! pathFormat, string! queryFormat) -> Microsoft.AspNetCore.Builder.IApplicationBuilder!

src/Middleware/Diagnostics/src/StatusCodePage/StatusCodePagesExtensions.cs

@@ -144,7 +144,7 @@ public static IApplicationBuilder UseStatusCodePages(this IApplicationBuilder ap
     public static IApplicationBuilder UseStatusCodePagesWithReExecute(
         this IApplicationBuilder app,
         string pathFormat,
-        string? queryFormat = null)
+        string queryFormat)
     {
         ArgumentNullException.ThrowIfNull(app);
 
@@ -168,15 +168,15 @@ public static IApplicationBuilder UseStatusCodePagesWithReExecute(
     /// </summary>
     /// <param name="app"></param>
     /// <param name="pathFormat"></param>
-    /// <param name="createScopeForErrors">Whether or not to create a new <see cref="IServiceProvider"/> scope.</param>
     /// <param name="queryFormat"></param>
+    /// <param name="createScopeForStatusCodePages">Whether or not to create a new <see cref="IServiceProvider"/> scope.</param>
     /// <returns></returns>
     [SuppressMessage("ApiDesign", "RS0026:Do not add multiple overloads with optional parameters", Justification = "Required to maintain compatibility")]
     public static IApplicationBuilder UseStatusCodePagesWithReExecute(
         this IApplicationBuilder app,
         string pathFormat,
-        bool createScopeForErrors,
-        string? queryFormat = null)
+        string? queryFormat = null,
+        bool createScopeForStatusCodePages = false)
     {
         ArgumentNullException.ThrowIfNull(app);
 
@@ -190,7 +190,7 @@ public static IApplicationBuilder UseStatusCodePagesWithReExecute(
                     Options.Create(new StatusCodePagesOptions()
                     {
                         HandleAsync = CreateHandler(pathFormat, queryFormat, newNext),
-                        CreateScopeForErrors = createScopeForErrors,
+                        CreateScopeForStatusCodePages = createScopeForStatusCodePages,
                         PathFormat = pathFormat
                     })).Invoke;
             });
@@ -199,7 +199,7 @@ public static IApplicationBuilder UseStatusCodePagesWithReExecute(
         var options = new StatusCodePagesOptions
         {
             HandleAsync = CreateHandler(pathFormat, queryFormat),
-            CreateScopeForErrors = createScopeForErrors,
+            CreateScopeForStatusCodePages = createScopeForStatusCodePages,
             PathFormat = pathFormat
         };
         var wrappedOptions = new OptionsWrapper<StatusCodePagesOptions>(options);
@@ -222,8 +222,8 @@ private static Func<StatusCodeContext, Task> CreateHandler(string pathFormat, st
             var originalQueryString = context.HttpContext.Request.QueryString;
 
             var routeValuesFeature = context.HttpContext.Features.Get<IRouteValuesFeature>();
-            var oldScope = context.Options.CreateScopeForErrors ? context.HttpContext.RequestServices : null;
-            await using AsyncServiceScope? scope = context.Options.CreateScopeForErrors
+            var oldScope = context.Options.CreateScopeForStatusCodePages ? context.HttpContext.RequestServices : null;
+            await using AsyncServiceScope? scope = context.Options.CreateScopeForStatusCodePages
                 ? context.HttpContext.RequestServices.GetRequiredService<IServiceScopeFactory>().CreateAsyncScope()
                 : null;
 

src/Middleware/Diagnostics/src/StatusCodePage/StatusCodePagesOptions.cs

@@ -61,7 +61,7 @@ private static string BuildResponseBody(int httpStatusCode)
     /// replace it on <see cref="HttpContext.RequestServices"/> when re-executing the request.
     /// </summary>
     /// <remarks>The default value is <see langword="false"/>.</remarks>
-    public bool CreateScopeForErrors { get; set; }
+    public bool CreateScopeForStatusCodePages { get; set; }
 
     internal string? PathFormat { get; set; }
 }

src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/BlazorWebCSharp.1/Program.Main.cs

@@ -107,8 +107,6 @@ public static void Main(string[] args)
         #endif
         }
 
-        app.UseStatusCodePagesWithReExecute("/not-found", createScopeForErrors: true);
-
         #if (HasHttpsProfile)
         app.UseHttpsRedirection();
 

src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/BlazorWebCSharp.1/Program.cs

@@ -100,7 +100,6 @@
     app.UseHsts();
 #endif
 }
-app.UseStatusCodePagesWithReExecute("/not-found", createScopeForErrors: true);
 
 #if (HasHttpsProfile)
 app.UseHttpsRedirection();