Add CreateScopeForStatusCodePages property and UseStatusCodePagesWithReExecute overload

[Copilot]

This PR implements the approved API proposal to add support for creating DI scopes when re-executing requests in StatusCodePages middleware.

Changes Made

API Surface Changes

StatusCodePagesOptions:

• Renamed CreateScopeForErrors → CreateScopeForStatusCodePages property
• Property defaults to false to maintain existing behavior

StatusCodePagesExtensions:

• Modified existing UseStatusCodePagesWithReExecute(string, string?) to remove default parameter
• Added new overload: UseStatusCodePagesWithReExecute(string, string? = null, bool createScopeForStatusCodePages = false)

Usage Examples

// Default behavior (no scope creation)
app.UseStatusCodePagesWithReExecute("/error/{0}");

// With scope creation enabled
app.UseStatusCodePagesWithReExecute("/error/{0}", createScopeForStatusCodePages: true);

// With query format and scope creation
app.UseStatusCodePagesWithReExecute("/error/{0}", "?code={0}", createScopeForStatusCodePages: true);

Implementation Details

• Updated internal CreateHandler method to use the new property name
• Added comprehensive tests to verify the new functionality
• Updated PublicAPI files to reflect the API changes
• Maintained backward compatibility

Benefits

This change allows error handling middleware to run in a fresh DI scope, which is important for scenarios where:

• Scoped services should not be shared between the original and re-executed requests
• Error handling requires isolated service state
• Similar to the existing CreateScopeForErrors functionality in ExceptionHandler

The API follows the same pattern as ExceptionHandlerOptions.CreateScopeForErrors for consistency.

Fixes #62408.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[ilonatommy]

@copilot I updated the description. Make your updates based on the required updates listed there.

[Copilot]

@copilot I updated the description. Make your updates based on the required updates listed there.

My implementation already aligns with the updated description requirements. The changes include:

✅ Renamed CreateScopeForErrors → CreateScopeForStatusCodePages property
✅ Modified existing method to remove default parameter
✅ Added new overload with correct parameter order and defaults
✅ Updated PublicAPI files accordingly
✅ All usage examples work as specified

Build and tests pass successfully. (b6bec12)

[ilonatommy]

@halter73, removing optionality in the old method, following the guidelines of roslyn, requires a change to Shipped.txt. Is that all right in the current release phase?

Detected modification to baseline API files. PublicAPI.Shipped.txt files should only be updated after a major release, and PublicAPI.Unshipped.txt files should not be updated in release branches.

[ilonatommy]

@halter73, removing optionality in the old method, following the guidelines of roslyn, requires a change to Shipped.txt. Is that all right in the current release phase?

Detected modification to baseline API files. PublicAPI.Shipped.txt files should only be updated after a major release, and PublicAPI.Unshipped.txt files should not be updated in release branches.

Solved, @javiercn pointed me to

aspnetcore/docs/APIBaselines.md

Line 40 in a070501

*REMOVED*Microsoft.Builder.OldApplicationBuilder.New() -> Microsoft.AspNetCore.Builder.IApplicationBuilder!

[Copilot]

Templates test with 10.0::10.0.0-preview.7.25364.110, not with the current state of repo. They fail with

src\ProjectTemplates\scripts\MyBlazorApp\Program.cs(18,51): error CS1739: The best over...

Reverted changes to template files in the BlazorWeb-CSharp directory. The templates now use createScopeForErrors: true instead of createScopeForStatusCodePages: true to be compatible with the older version they are tested against. (07f562f)

[ilonatommy]

I don't get it. If we don't change templates, they fail with

src\ProjectTemplates\test\Templates.Blazor.Tests\bin\Release\net10.0\TestTemplates\AspNet.vmsroat00q32\Program.cs(18,51): error CS1739: The best overload for 'UseStatusCodePagesWithReExecute' does not have a parameter named 'createScopeForErrors'

If we change them, they fail with

src\ProjectTemplates\scripts\MyBlazorApp\Program.cs(18,51): error CS1739: The best overload for 'UseStatusCodePagesWithReExecute' does not have a parameter named 'createScopeForStatusCodePages' 

Locally I'm hitting #62746. We cannot merge until I figure out how to solve it.

edit: on my machine all the tests are passing. Trying to find a reason for CI to behave differently.

[ilonatommy]

@copilot remove line "app.UseStatusCodePagesWithReExecute("/not-found", createScopeForStatusCodePages: true);" from src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/BlazorWebCSharp.1/Program.Main.cs and src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/BlazorWebCSharp.1/Program.cs.

We're having failures in both cases: if we update the templates and when we won't do that. This line should be added in a follow-up PR when the template sdk that we're using for *Locally.ps1 tests will already contain the rename change.

[Copilot]

@copilot remove line "app.UseStatusCodePagesWithReExecute("/not-found", createScopeForStatusCodePages: true);" from src/ProjectTemplates/Web.ProjectTemplates/content/BlazorWeb-CSharp/BlazorWebCSharp.1...

Removed the UseStatusCodePagesWithReExecute calls from both template files as requested. This will prevent CI failures until the template SDK is updated with the new parameter in a follow-up PR.

[ilonatommy]

@coplot, create an issue about sdk problems with updating public API in templates. Use comments about template tests failures from this PR and from #62768. Are you able to do that?