C# 任务忽略取消超时

Question

我正在尝试为任意代码编写一个包装器，该包装器将在给定的超时时间后取消（或至少停止等待）代码。

我有以下测试和实现

[Test]
public void Policy_TimeoutExpires_DoStuff_TaskShouldNotContinue()
{
    var cts = new CancellationTokenSource();
    var fakeService = new Mock<IFakeService>();
    IExecutionPolicy policy = new TimeoutPolicy(new ExecutionTimeout(20), new DefaultExecutionPolicy());
    Assert.Throws<TimeoutException>(async () => await policy.ExecuteAsync(() => DoStuff(3000, fakeService.Object), cts.Token));

    fakeService.Verify(f=>f.DoStuff(),Times.Never);
}

和“DoStuff”方法

private static async Task DoStuff(int sleepTime, IFakeService fakeService)
{

    await Task.Delay(sleepTime).ConfigureAwait(false);
    var result = await Task.FromResult("bob");
    var test = result + "test";
    fakeService.DoStuff();
}

以及IExecutionPolicy.ExecuteAsync的实现

public async Task ExecuteAsync(Action action, CancellationToken token)
{
    var cts = new CancellationTokenSource();//TODO: resolve ignoring the token we were given!

    var task = _decoratedPolicy.ExecuteAsync(action, cts.Token);
    cts.CancelAfter(_timeout);

    try
    {
        await task.ConfigureAwait(false);
    }
    catch(OperationCanceledException err)
    {
        throw new TimeoutException("The task did not complete within the TimeoutExecutionPolicy window of" + _timeout + "ms", err);
    }
}

应该发生的情况是测试方法尝试花费 >3000 毫秒并且超时应该发生在 20 毫秒，但这并没有发生。为什么我的代码没有按预期超时？

编辑：

根据要求-decoratedPolicy如下

public async Task ExecuteAsync(Action action, CancellationToken token)
{
    token.ThrowIfCancellationRequested();
    await Task.Factory.StartNew(action.Invoke, token);  
}

Answer 1

如果我理解正确，您正在尝试为不支持超时/取消的方法支持超时。

通常这是通过启动具有所需超时值的计时器来完成的。如果计时器首先触发，那么您可以抛出异常。使用 TPL，您可以使用 Task.Delay(_timeout) 代替计时器。

public async Task ExecuteAsync(Action action, CancellationToken token)
{
    var task = _decoratedPolicy.ExecuteAsync(action, token);

    var completed = await Task.WhenAny(task, Task.Delay(_timeout));
    if (completed != task)
    {
        throw new TimeoutException("The task did not complete within the TimeoutExecutionPolicy window of" + _timeout + "ms");
    }
}

注意：这不会停止 _decoratedPolicy.ExecuteAsync 方法的执行，而是会忽略它。

如果您的方法确实支持取消（但不是及时），那么最好在超时后取消任务。您可以通过创建链接令牌来做到这一点。

public async Task ExecuteAsync(Action action, CancellationToken token)
{
    using(var linkedTokenSource = CancellationTokenSource.CreateLinkedTokenSource(token))
    {
        var task = _decoratedPolicy.ExecuteAsync(action, linkedTokenSource.Token);

        var completed = await Task.WhenAny(task, Task.Delay(_timeout));
        if (completed != task)
        {
            linkedTokenSource.Cancel();//Try to cancel the method
            throw new TimeoutException("The task did not complete within the TimeoutExecutionPolicy window of" + _timeout + "ms");
        }
    }
}

Answer 2

使用CancellationToken 表示您正在进行合作取消。设置CancellationTokenSource.CancelAfter 将在指定时间后将底层令牌转换为取消状态，但如果调用异步方法未监控该令牌，则不会发生任何事情。

为了真正生成OperationCanceledException，您需要在_decoratedPolicy.ExecuteAsync 中调用cts.Token.ThrowIfCancellationRequested。

例如：

// Assuming this is _decoratedPolicy.ExecuteAsync
public async Task ExecuteAsync(Action action, CancellationToken token)
{
     // This is what creates and throws the OperationCanceledException
     token.ThrowIfCancellationRequested();

     // Simulate some work
     await Task.Delay(20);
}

编辑：

为了真正取消令牌，您需要在所有执行工作的点监视它，并且执行可能会超时。如果您无法做出该保证，请按照@SriramSakthivel 的回答，实际的Task 将被丢弃，而不是实际被取消。

Answer 3

您正在调用 Assert.Throws(Action action) 并且您的匿名异步方法被强制转换为 async void。该方法将使用 Fire&Forget 语义异步调用，不会引发异常。

但是，由于异步 void 方法中未捕获的异常，该进程可能会在不久后崩溃。

您应该同步调用 ExecuteAsync：

[Test]
public void Policy_TimeoutExpires_DoStuff_TaskShouldNotContinue()
{
    var cts = new CancellationTokenSource();
    var fakeService = new Mock<IFakeService>();
    IExecutionPolicy policy = new TimeoutPolicy(new ExecutionTimeout(20), new DefaultExecutionPolicy());
    Assert.Throws<AggregateException>(() => policy.ExecuteAsync(() => DoStuff(3000, fakeService.Object), cts.Token).Wait());

    fakeService.Verify(f=>f.DoStuff(),Times.Never);
}

或使用异步测试方法：

[Test]
public async Task Policy_TimeoutExpires_DoStuff_TaskShouldNotContinue()
{
    var cts = new CancellationTokenSource();
    var fakeService = new Mock<IFakeService>();
    IExecutionPolicy policy = new TimeoutPolicy(new ExecutionTimeout(20), new DefaultExecutionPolicy());

    try
    {
        await policy.ExecuteAsync(() => DoStuff(3000, fakeService.Object), cts.Token);
        Assert.Fail("Method did not timeout.");
    }
    catch (TimeoutException)
    { }

    fakeService.Verify(f=>f.DoStuff(),Times.Never);
}

Answer 4

我决定在这里回答我自己的问题，因为虽然列出的每个答案都解决了我需要做的事情，但它们并没有确定这个问题的根本原因。非常感谢：Scott Chamberlain、Yuval Itzchakov、Sriram Sakthivel、Jeff Cyr。感谢所有建议。

根本原因/解决方案：

await Task.Factory.StartNew(action.Invoke, token);

你在上面我的“装饰策略”中看到的返回一个 Task 并且 await 只等待外部任务。替换为

await Task.Run(async () => await action.Invoke());

得到正确的结果。

我的代码遇到了 Gotcha #4 和 Gotcha #5 的组合问题，来自 C# async gotchas

上的一篇优秀文章

整篇文章（以及对此问题的答案）确实提高了我的整体理解。