Skip to content
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.

Sign up for GitHub

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

Add the ability to stop the Host when one of its BackgroundService instances errors #50569

Merged
merged 17 commits into from
Apr 16, 2021
Merged

Add the ability to stop the Host when one of its BackgroundService instances errors #50569

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
3173bd7
Added background service exception behavior enum. Update HostOptions …
IEvangelist Mar 31, 2021
91a31ec
Added corresponding unit tests for host when ignoring or stopping.
IEvangelist Apr 1, 2021
a49fde9
Call StopAsync rather than FailFast
IEvangelist Apr 1, 2021
2e611e1
Manually update String.resx outside of VS GUI
IEvangelist Apr 1, 2021
0819a2d
Remove the RemoteExecutor, as it is no longer needed.
IEvangelist Apr 1, 2021
e985ec5
Call `IApplicationLifetime.StopApplication()` instead of `StopAsync()`.
IEvangelist Apr 5, 2021
28ccffc
Moved enum out of abstractions. Encapsulate logging logic in extensio…
IEvangelist Apr 7, 2021
c9356b8
Set the default as `StopHost`
IEvangelist Apr 7, 2021
4632446
Move ref bits from hosting.abstractions to hosting proper.
IEvangelist Apr 7, 2021
a74d694
Address feedback from peer review
IEvangelist Apr 8, 2021
4737d98
Added unit test to verify background service 1 gets started, and runs…
IEvangelist Apr 12, 2021
5cd1705
Use explicitly controlled timing for unit test and remove args: ex
IEvangelist Apr 13, 2021
bad7af5
Convert from Fact, to Theory. Test both enum values.
IEvangelist Apr 13, 2021
aeb6a56
Adjusted test case, per @eerhardt
IEvangelist Apr 13, 2021
d9c642d
Fix test hang issue
IEvangelist Apr 14, 2021
71c1f26
Separate StartAsync and ExecuteTask, let StartAsync bubble. Adjust un…
IEvangelist Apr 15, 2021
3d4c11c
Update the background service async exceptions get logged unit test
IEvangelist Apr 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/libraries/Microsoft.Extensions.Hosting/tests/UnitTests/HostBuilderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,25 @@ public void HostBuilderConfigureDefaultsInterleavesMissingConfigValues()
Assert.Equal(expectedContentRootPath, env.ContentRootPath);
}

[Fact]
public void HostBuilderCanConfigureBackgroundServiceExceptionBehavior()
{
using IHost host = new HostBuilder()
.ConfigureServices(
services =>
services.Configure<HostOptions>(
options =>
options.BackgroundServiceExceptionBehavior =
BackgroundServiceExceptionBehavior.StopHost))
.Build();

var options = host.Services.GetRequiredService<IOptions<HostOptions>>();

Assert.Equal(
BackgroundServiceExceptionBehavior.StopHost,
options.Value.BackgroundServiceExceptionBehavior);
}

private class FakeFileProvider : IFileProvider, IDisposable
{
public bool Disposed { get; private set; }
Expand Down
120 changes: 30 additions & 90 deletions src/libraries/Microsoft.Extensions.Hosting/tests/UnitTests/Internal/HostTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.DotNet.RemoteExecutor;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting.Fakes;
Expand Down Expand Up @@ -659,84 +658,34 @@ public async Task WebHostStopAsyncUsesDefaultTimeoutIfNoTokenProvided()
}

[Fact]
public void HostPropagatesExceptionsThrownWithBackgroundServiceExceptionBehaviorOfStopHost()
public async Task HostPropagatesExceptionsThrownWithBackgroundServiceExceptionBehaviorOfStopHost()
{
RemoteExecutor.Invoke(async () =>
{
using IHost host = CreateBuilder()
.ConfigureServices(
services =>
{
services.AddHostedService<AsyncThrowingService>();
services.Configure<HostOptions>(
options =>
options.BackgroundServiceExceptionBehavior =
BackgroundServiceExceptionBehavior.StopHost);
})
.Build();

await host.StartAsync();

var lifetime = host.Services.GetRequiredService<IHostApplicationLifetime>();
var wasStoppingCalled = false;
lifetime.ApplicationStopping.Register(() => wasStoppingCalled = true);
var wasStoppedCalled = false;
lifetime.ApplicationStopped.Register(() => wasStoppedCalled = true);

Assert.True(
wasStoppingCalled,
$"The {nameof(AsyncThrowingService)} should have thrown, calling Host.StopAsync, gracefully stopping the host.");
Assert.True(
wasStoppedCalled,
$"The {nameof(AsyncThrowingService)} should have thrown, calling Host.StopAsync, gracefully stopping the host.");
}).Dispose();
}

[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))]
public void HostPropagatesExceptionsThrownWithBackgroundServiceExceptionBehaviorOfStopHostAfterSometime()
{
RemoteExecutor.Invoke(async () =>
{
var backgroundDelayTaskSource = new TaskCompletionSource<bool>();

using IHost host = CreateBuilder()
.ConfigureServices(
services =>
{
services.AddHostedService(
_ => new AsyncThrowingService(backgroundDelayTaskSource.Task));

services.Configure<HostOptions>(
options =>
options.BackgroundServiceExceptionBehavior =
BackgroundServiceExceptionBehavior.StopHost);
})
.Build();
using IHost host = CreateBuilder()
.ConfigureServices(
services =>
{
services.AddHostedService<AsyncThrowingService>();
services.Configure<HostOptions>(
options =>
options.BackgroundServiceExceptionBehavior =
BackgroundServiceExceptionBehavior.StopHost);
})
.Build();

var lifetime = host.Services.GetRequiredService<IHostApplicationLifetime>();
var wasStoppingCalled = false;
lifetime.ApplicationStopping.Register(() => wasStoppingCalled = true);
var wasStoppedCalled = false;
lifetime.ApplicationStopped.Register(() => wasStoppedCalled = true);
await host.StartAsync();

await Task.WhenAll(host.StartAsync(), DelayThenSignalContinueAsync());
var lifetime = host.Services.GetRequiredService<IHostApplicationLifetime>();
var wasStoppingCalled = false;
lifetime.ApplicationStopping.Register(() => wasStoppingCalled = true);
var wasStoppedCalled = false;
lifetime.ApplicationStopped.Register(() => wasStoppedCalled = true);

async Task DelayThenSignalContinueAsync()
{
// Emulate the background service doing some work successfully
// for 5 seconds before throwing exception.
await Task.Delay(5000);

backgroundDelayTaskSource.SetResult(true);
};

Assert.True(
wasStoppingCalled,
$"The {nameof(AsyncThrowingService)} should have thrown, calling Host.StopAsync, gracefully stopping the host.");
Assert.True(
wasStoppedCalled,
$"The {nameof(AsyncThrowingService)} should have thrown, calling Host.StopAsync, gracefully stopping the host.");
}).Dispose();
Assert.True(
wasStoppingCalled,
$"The {nameof(AsyncThrowingService)} should have thrown, calling Host.StopAsync, gracefully stopping the host.");
Assert.True(
wasStoppedCalled,
$"The {nameof(AsyncThrowingService)} should have thrown, calling Host.StopAsync, gracefully stopping the host.");
}

[Fact]
Expand All @@ -761,15 +710,12 @@ public void HostHandlesExceptionsThrownWithBackgroundServiceExceptionBehaviorOfI
var lifetime = host.Services.GetRequiredService<IHostApplicationLifetime>();
var wasStoppingCalled = false;
lifetime.ApplicationStopping.Register(() => wasStoppingCalled = true);
var wasStoppedCalled = false;
lifetime.ApplicationStopped.Register(() => wasStoppedCalled = true);

host.Start();

backgroundDelayTaskSource.SetResult(true);

Assert.False(wasStoppingCalled);
Assert.False(wasStoppedCalled);
}

[Fact]
Expand Down Expand Up @@ -1490,8 +1436,6 @@ private class AsyncThrowingService : BackgroundService
{
private readonly Task? _executeDelayTask;

internal bool Disposed { get; private set; }

public AsyncThrowingService() { }

public AsyncThrowingService(Task executeDelayTask)
Expand All @@ -1501,17 +1445,13 @@ public AsyncThrowingService(Task executeDelayTask)

protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
if (_executeDelayTask is { })
await _executeDelayTask;

throw new Exception("Background Exception");
}

public override void Dispose()
{
Disposed = true;
while (true)
{
if (_executeDelayTask is { })
await _executeDelayTask;

base.Dispose();
throw new Exception("Background Exception");
}
}
}
}
Expand Down
1 change: 0 additions & 1 deletion ...crosoft.Extensions.Hosting/tests/UnitTests/Microsoft.Extensions.Hosting.Unit.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
<PropertyGroup>
<TargetFrameworks>$(NetCoreAppCurrent)-windows;$(NetCoreAppCurrent);net461</TargetFrameworks>
<EnableDefaultItems>true</EnableDefaultItems>
<IncludeRemoteExecutor>true</IncludeRemoteExecutor>
</PropertyGroup>

<ItemGroup>
Expand Down