Consider renaming `ConfigureHostApplicationBuilder` to `ConfigureWebApplicationBuilder`

[Youssef1313]

Background and Motivation

We recently (in .NET 11 Preview 6) added ConfigureHostApplicationBuilder as a new API in Mmvc.Testing library. PR #66527. There is an about question still about the API name, if it should be ConfigureHostApplicationBuilder or ConfigureWebApplicationBuilder

Proposed API

namespace Microsoft.AspNetCore.Mvc.Testing;

public class WebApplicationFactory<TEntryPoint> : IDisposable, IAsyncDisposable where TEntryPoint : class
{
-    protected virtual void ConfigureHostApplicationBuilder(IHostApplicationBuilder hostApplicationBuilder);
+    protected virtual void ConfigureWebApplicationBuilder(IHostApplicationBuilder hostApplicationBuilder);
}

Usage Examples

Same as today. This is just a rename. See original proposal for info. #66574

Alternative Designs

Risks

We discussed already the parameter type and agreed it should be IHostApplicationBuilder. So it might sound a bit strange that the method name and parameter name are mismatched. We need to also decide about the exact instance being passed. If it's an internal wrapper, or the real WebApplicationBuilder.

[dotnet-policy-service]

Thank you for submitting this for API review. This will be reviewed by @dotnet/aspnet-api-review at the next meeting of the ASP.NET Core API Review group. Please ensure you take a look at the API review process documentation and ensure that:

• The PR contains changes to the reference-assembly that describe the API change. Or, you have included a snippet of reference-assembly-style code that illustrates the API change.
• The PR describes the impact to users, both positive (useful new APIs) and negative (breaking changes).
• Someone is assigned to "champion" this change in the meeting, and they understand the impact and design of the change.

[github-actions]

Triage Summary

Area: area-mvc / area-minimal (proposal spans MVC testing and minimal API testing infrastructure; both area labels already applied)
Type: Feature (proposes renaming the ConfigureHostApplicationBuilder API to ConfigureWebApplicationBuilder as a follow-up to an approved API addition)

Potential Duplicates

• None found

Generated by Triage Comment Reviewer for dotnet/aspnetcore for issue #67393 · 26.7 AIC · ⌖ 25.3 AIC · ⊞ 24.6K · ◷

[Youssef1313]

If we made a change, we should update the docs that's added in dotnet/AspNetCore.Docs#37291

[halter73]

API Review Notes:

• We don't want to confuse people who might think this applies to Host.CreateApplicationBuilder or Host.CreateDefaultBuilder, so using WebApplicationBuilder in the name makes more sense than HostApplicationBuilder.

API Approved!

namespace Microsoft.AspNetCore.Mvc.Testing;

public class WebApplicationFactory<TEntryPoint> : IDisposable, IAsyncDisposable where TEntryPoint : class
{
-    protected virtual void ConfigureHostApplicationBuilder(IHostApplicationBuilder hostApplicationBuilder);
+    protected virtual void ConfigureWebApplicationBuilder(IHostApplicationBuilder hostApplicationBuilder);
}