-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Fix race in BackgroundService exception aggregation during Host shutdown #125590
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
danmoseley
wants to merge
3
commits into
dotnet:main
Choose a base branch
from
danmoseley:fix-bgservice-exception-race
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+93
−1
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -180,6 +180,38 @@ public async Task BackgroundServiceExceptionAndStopException_ThrowsAggregateExce | |
| Assert.IsType<InvalidOperationException>(ex)); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Regression test for a race where the fire-and-forget TryExecuteBackgroundServiceAsync | ||
| /// has not yet recorded its exception by the time Host.StopAsync reads the exception list. | ||
| /// DelayedMonitorFaultService overrides ExecuteTask so that the monitoring task sees a | ||
| /// separately-controlled task that faults 200ms after StopAsync returns, | ||
| /// reproducing the window in which the exception would be lost without the fix. | ||
| /// </summary> | ||
| [Fact] | ||
| public async Task BackgroundService_DelayedMonitoringException_ThrowsAggregateException() | ||
| { | ||
| var builder = new HostBuilder() | ||
| .ConfigureServices(services => | ||
| { | ||
| services.Configure<HostOptions>(options => | ||
| { | ||
| options.BackgroundServiceExceptionBehavior = BackgroundServiceExceptionBehavior.StopHost; | ||
| }); | ||
| services.AddHostedService<SynchronousFailureService>(); | ||
| services.AddHostedService<DelayedMonitorFaultService>(); | ||
| }); | ||
|
|
||
| var aggregateException = await Assert.ThrowsAsync<AggregateException>(async () => | ||
| { | ||
| await builder.Build().RunAsync(); | ||
| }); | ||
|
|
||
| Assert.Equal(2, aggregateException.InnerExceptions.Count); | ||
|
|
||
| Assert.All(aggregateException.InnerExceptions, ex => | ||
| Assert.IsType<InvalidOperationException>(ex)); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Tests that when a BackgroundService throws an exception with Ignore behavior, | ||
| /// the host does not throw and continues to run until stopped. | ||
|
|
@@ -294,6 +326,43 @@ private class StopFailureService : IHostedService | |
| public Task StopAsync(CancellationToken cancellationToken) => throw new InvalidOperationException("Stop failure"); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// A BackgroundService that overrides <see cref="ExecuteTask"/> to return a separately | ||
| /// controlled task. The internal _executeTask (used by BackgroundService.StopAsync) completes | ||
| /// normally on cancellation, but the overridden ExecuteTask (monitored by | ||
| /// TryExecuteBackgroundServiceAsync) faults 200ms after StopAsync, deterministically | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can you explain derministically? what if the other task/thread was not scheduled for much more than 200ms? |
||
| /// reproducing the race window. | ||
| /// </summary> | ||
| private class DelayedMonitorFaultService : BackgroundService | ||
| { | ||
| private readonly TaskCompletionSource<object?> _monitorTcs = new(TaskCreationOptions.RunContinuationsAsynchronously); | ||
|
|
||
| public override Task? ExecuteTask => _monitorTcs.Task; | ||
|
|
||
| protected override async Task ExecuteAsync(CancellationToken stoppingToken) | ||
| { | ||
| try | ||
| { | ||
| await Task.Delay(Timeout.Infinite, stoppingToken); | ||
| } | ||
| catch (OperationCanceledException) | ||
| { | ||
| } | ||
| } | ||
|
|
||
| public override async Task StopAsync(CancellationToken cancellationToken) | ||
| { | ||
| await base.StopAsync(cancellationToken); | ||
| _ = Task.Run(async () => | ||
| { | ||
| // This is testing that ExecuteTask delays stopping of the host, so it can't be triggered by a deterministic signal. | ||
| // It shouldn't cause any flakiness: incorrect ordering could cause the test to succeed when it should fail, but it shouldn't cause the test to fail when it should succeed. | ||
| await Task.Delay(200); | ||
| _monitorTcs.TrySetException(new InvalidOperationException("Delayed monitor failure")); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| private class SuccessfulService : BackgroundService | ||
| { | ||
| private readonly IHostApplicationLifetime _lifetime; | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.