Allow HostFactoryResolver to listen on arbitrary events by Youssef1313 · Pull Request #127743 · dotnet/runtime

Youssef1313 · 2026-05-04T11:55:57Z

I needed this to prototype the change in dotnet/aspnetcore#66527.

Whether or not we will need to use that in aspnet is to be decided when dotnet/aspnetcore#66574 is reviewed.

The change here is in internal class which is consumed via an internal source-only package (that package isn't shipped to nuget.org). The PR doesn't introduce any behavior changes to runtime. It will only allow aspnetcore to hook additional delegates, which will allow us to fire HostApplicationBuilderCreated event when the user calls WebApplication.CreateBuilder, and gives us the opportunity in the testing library to add early configuration sources that users expect to be available before Build() is called.

dotnet-policy-service · 2026-05-04T11:57:17Z

Tagging subscribers to this area: @dotnet/area-extensions-hosting
See info in area-owners.md if you want to be subscribed.

Copilot

Pull request overview

This PR extends HostFactoryResolver.ResolveHostFactory to allow callers to attach callbacks for additional DiagnosticSource event names emitted by Microsoft.Extensions.Hosting, enabling tooling scenarios that need to observe more than just the existing HostBuilding / HostBuilt flow.

Changes:

Adds an optional arbitraryActions map to ResolveHostFactory and threads it into HostingListener.
Invokes a registered callback when an observed hosting DiagnosticSource event key matches an entry in arbitraryActions.
Adds a new using Microsoft.Extensions.Configuration; directive (currently unused).

+                                                                 Dictionary<string, Action<object?>>? arbitraryActions = null,
                                                                 Action<Exception?>? entrypointCompleted = null)


                                                                 TimeSpan? waitTimeout = null,
                                                                 bool stopApplication = true,
                                                                 Action<object>? configureHostBuilder = null,
+                                                                 Dictionary<string, Action<object?>>? arbitraryActions = null,
                                                                 Action<Exception?>? entrypointCompleted = null)


+                else if (_arbitraryActions?.TryGetValue(value.Key, out var arbitraryAction) == true)
+                {
+                    arbitraryAction.Invoke(value.Value);
+                }


Youssef1313 · 2026-05-15T12:46:38Z

                if (value.Key == "HostBuilding")
                {
                    _configure?.Invoke(value.Value!);
                }
-
-                if (value.Key == "HostBuilt")
+                else if (value.Key == "HostBuilt")
                {
                    _hostTcs.TrySetResult(value.Value!);

                    if (_stopApplication)
                    {
                        // Stop the host from running further
                        ThrowHostAborted();
                    }
                }
+                else if (_arbitraryActions?.TryGetValue(value.Key, out var arbitraryAction) == true)
+                {
+                    arbitraryAction.Invoke(value.Value);
+                }


I don't think it's worth making _arbitraryActions apply to HostBuilding/HostBuilt. There is no need and this is all internal stuff, so it's easy to change in future if needed.

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

            private readonly TaskCompletionSource<object> _hostTcs = new();
            private IDisposable? _disposable;
            private readonly Action<object>? _configure;
+            private readonly Dictionary<string, Action<object?>>? _arbitraryActions;
            private readonly Action<Exception?>? _entrypointCompleted;
            private static readonly AsyncLocal<HostingListener> _currentListener = new();

-            public HostingListener(string[] args, MethodInfo entryPoint, TimeSpan waitTimeout, bool stopApplication, Action<object>? configure, Action<Exception?>? entrypointCompleted)
+            public HostingListener(string[] args, MethodInfo entryPoint, TimeSpan waitTimeout, bool stopApplication, Action<object>? configure, Dictionary<string, Action<object?>>? arbitraryActions, Action<Exception?>? entrypointCompleted)
            {
                _args = args;
                _entryPoint = entryPoint;
                _waitTimeout = waitTimeout;
                _stopApplication = stopApplication;
                _configure = configure;
+                _arbitraryActions = arbitraryActions;


                }
+                else if (_arbitraryActions?.TryGetValue(value.Key, out var arbitraryAction) == true)
+                {
+                    arbitraryAction.Invoke(value.Value);


Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Youssef1313 · 2026-05-15T12:48:51Z

        public static Func<string[], object>? ResolveHostFactory(Assembly assembly,
                                                                 TimeSpan? waitTimeout = null,
                                                                 bool stopApplication = true,
                                                                 Action<object>? configureHostBuilder = null,
-                                                                 Action<Exception?>? entrypointCompleted = null)
+                                                                 Action<Exception?>? entrypointCompleted = null,
+                                                                 Dictionary<string, Action<object?>>? arbitraryActions = null)
        {


Not worth it. All internal stuff and we won't mutate the dictionary.

Youssef1313 · 2026-05-15T12:52:26Z

+                else if (_arbitraryActions?.TryGetValue(value.Key, out var arbitraryAction) == true)
+                {
+                    arbitraryAction.Invoke(value.Value);
+                }


@copilot apply changes based on this feedback

Implemented this in 08df3ae: added coverage for arbitraryActions with custom event callbacks (including both stopApplication modes) and a test verifying exceptions from arbitrary callbacks propagate through ResolveHostFactory.

svick · 2026-05-07T14:36:04Z

Mostly repeating what copilot said, but:

I think there should be tests for this.
You should make sure that exceptions from arbitraryActions don't escape to the thread pool. I.e. if you're using this in a test and an arbitraryAction throws, it should fail the test, not crash the test process. Maybe it alwady works that way, I don't know.

svick · 2026-05-14T12:55:36Z

@Youssef1313 If you're not planning on getting this PR merged soon, can you turn it into a draft? We don't want to have PRs that are open for a long time. Thanks.

Youssef1313 · 2026-05-15T12:49:51Z

@svick With regards to exceptions, how is the new arbitraryActions different from the existing configureHostBuilder which is just called as-is?

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

+                else if (_arbitraryActions?.TryGetValue(value.Key, out var arbitraryAction) == true)
+                {
+                    arbitraryAction.Invoke(value.Value);
+                }


github-actions · 2026-05-15T12:58:02Z

Caution

Security scanning requires review for Code Review

Details

The threat detection results could not be parsed. The workflow output should be reviewed before merging.

Review the workflow run logs for details.

🤖 Copilot Code Review — PR #127743

Holistic Assessment

Motivation: The PR adds a hook mechanism to allow consumers (ASP.NET Core) to listen on arbitrary diagnostic source events during host resolution. The use case (firing HostApplicationBuilderCreated for testing libraries) is reasonable, though the aspnetcore design is still under review.

Approach: Adding an IDictionary<string, Action<object?>> parameter to an internal API is a straightforward extension. The approach is minimal and consistent with how configureHostBuilder already works.

Summary: ⚠️ Needs Human Review. The code change is small and mechanically correct, but there are two concerns that a human reviewer should weigh: (1) missing tests, and (2) a subtle behavioral change in the if/else if restructuring.

Detailed Findings

⚠️ Missing Tests

The reviewer @svick already flagged this. This PR adds new functionality with no test coverage. Even though this is an internal source-only package, the HostFactoryResolver has existing tests (in Microsoft.Extensions.Hosting.Tests or similar). A test verifying that arbitrary actions are invoked for matching diagnostic keys would be appropriate.

Classification: Advisory — the aspnetcore consumer will implicitly test this, but in-repo tests are standard practice.

⚠️ Behavioral Change: `if` → `else if` for "HostBuilding"/"HostBuilt"

The original code had:

if (value.Key == "HostBuilding") { ... }

if (value.Key == "HostBuilt") { ... }

This was changed to if / else if / else if. Since value.Key can only be one string at a time, this is semantically equivalent for these two cases — only one branch could ever match per call. However, it's worth noting explicitly that this is safe because OnNext is called once per event, not with a key that could match both.

The else if for _arbitraryActions correctly ensures that if a consumer passes "HostBuilding" or "HostBuilt" as keys in the dictionary, they will not fire (the built-in handling takes precedence). This is reasonable but should be documented — a consumer could be surprised that these keys are silently ignored.

Classification: Advisory — the behavior is correct but the precedence rule should be called out in a doc comment or the method's XML docs.

✅ Exception Handling

The author's point in the comments is valid: arbitraryAction.Invoke(value.Value) has the same exception propagation characteristics as _configure?.Invoke(value.Value!). Both are called on the entry point thread inside a try/catch that captures exceptions into _hostTcs. Exceptions from arbitrary actions will propagate to the TrySetException path and surface to the caller, not crash the process.

💡 Naming: `arbitraryActions`

The name "arbitrary" is vague. Consider eventActions, diagnosticEventHandlers, or additionalEventListeners to better convey that these are keyed by diagnostic event names.

Generated by Copilot code review

Generated by Code Review for issue #127743 · ● 1.3M · ◷

Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/c2f33a8c-2e5f-41cc-87fb-11636c3780e9 Co-authored-by: Youssef1313 <31348972+Youssef1313@users.noreply.github.com>

Copilot · 2026-05-15T13:31:23Z

Mostly repeating what copilot said, but:

I think there should be tests for this.
...

Addressed in 08df3ae: added tests for arbitraryActions callback invocation and explicit exception propagation behavior so thrown callback exceptions fail the test path instead of escaping unchecked.

svick · 2026-05-18T16:29:22Z

With regards to exceptions, how is the new arbitraryActions different from the existing configureHostBuilder which is just called as-is?

It seems that with how it's used, an exception in arbitraryActions (or configureHostBuilder) bubbles up through the invoked Main and ends up failing the test. So I think it already behaves the way it should and you don't need to change anything.

Allow HostFactoryResolver to listen on arbitrary events

4cf8804

Copilot AI review requested due to automatic review settings May 4, 2026 11:55

Copilot started reviewing on behalf of Youssef1313 May 4, 2026 11:56 View session

github-actions Bot added the area-Extensions-Hosting label May 4, 2026

Youssef1313 mentioned this pull request May 4, 2026

Add ConfigureHostApplicationBuilder virtual method on WebApplicationFactory to allow early configuration of the host application builder dotnet/aspnetcore#66527

Draft

dotnet-policy-service Bot assigned Youssef1313 May 4, 2026

Copilot AI reviewed May 4, 2026

View reviewed changes

Update HostFactoryResolver.cs

935186b

Copilot AI review requested due to automatic review settings May 4, 2026 12:27

Copilot started reviewing on behalf of Youssef1313 May 4, 2026 12:27 View session

Copilot AI reviewed May 4, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

Update HostFactoryResolver.cs

68a5222

Copilot AI review requested due to automatic review settings May 4, 2026 14:04

Copilot started reviewing on behalf of Youssef1313 May 4, 2026 14:04 View session

Copilot AI reviewed May 4, 2026

View reviewed changes

Youssef1313 mentioned this pull request May 4, 2026

[API Proposal]: WebApplicationFactory.ConfigureHostApplicationBuilder for early test config override dotnet/aspnetcore#66574

Open

This was referenced May 5, 2026

browser-wasm linux Release LibraryTests queues timing out #117974

Open

[QUIC] Sporadic long running tests #119763

Open

rosebyte requested a review from svick May 7, 2026 12:15

Use IDictionary

989a47e

Copilot AI review requested due to automatic review settings May 15, 2026 12:52

Copilot started reviewing on behalf of Youssef1313 May 15, 2026 12:52 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

Comment thread src/libraries/Microsoft.Extensions.HostFactoryResolver/src/HostFactoryResolver.cs

Comment on lines +355 to +358

else if (_arbitraryActions?.TryGetValue(value.Key, out var arbitraryAction) == true)

{

arbitraryAction.Invoke(value.Value);

}

Copilot started work on behalf of Youssef1313 May 15, 2026 12:55 View session

Add HostFactoryResolver arbitraryActions tests

0f2154f

Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/c2f33a8c-2e5f-41cc-87fb-11636c3780e9 Co-authored-by: Youssef1313 <31348972+Youssef1313@users.noreply.github.com>

Youssef1313 marked this pull request as draft May 15, 2026 13:29

Add arbitraryActions coverage and exception propagation tests

08df3ae

Agent-Logs-Url: https://github.com/dotnet/runtime/sessions/c2f33a8c-2e5f-41cc-87fb-11636c3780e9 Co-authored-by: Youssef1313 <31348972+Youssef1313@users.noreply.github.com>

Copilot AI review requested due to automatic review settings May 15, 2026 13:31

Youssef1313 review requested due to automatic review settings May 15, 2026 13:31

Copilot finished work on behalf of Youssef1313 May 15, 2026 13:33

This was referenced May 16, 2026

Sometimes the helix SDK uses GetWorkItemsAsync when workitems aren't done processing. dotnet/dnceng#6011

Open

ExceptionHandlingExpressions.ExpressionsUnwrapeExternallyThrownRuntimeWrappedException failure #128164

Open

		Dictionary<string, Action<object?>>? arbitraryActions = null,
		Action<Exception?>? entrypointCompleted = null)

Conversation

Youssef1313 commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dotnet-policy-service Bot commented May 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Youssef1313 May 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Youssef1313 May 15, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Youssef1313 May 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 15, 2026

Choose a reason for hiding this comment

Uh oh!

svick commented May 7, 2026

Uh oh!

svick commented May 14, 2026

Uh oh!

Youssef1313 commented May 15, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

github-actions Bot commented May 15, 2026

🤖 Copilot Code Review — PR #127743

Holistic Assessment

Detailed Findings

⚠️ Missing Tests

⚠️ Behavioral Change: if → else if for "HostBuilding"/"HostBuilt"

✅ Exception Handling

💡 Naming: arbitraryActions

Uh oh!

Copilot AI commented May 15, 2026

Uh oh!

svick commented May 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Youssef1313 commented May 4, 2026 •

edited

Loading

⚠️ Behavioral Change: `if` → `else if` for "HostBuilding"/"HostBuilt"

💡 Naming: `arbitraryActions`