.net - 调试失败的、未观察到的 TPL 任务

Question

我正在尝试调试通过失败的集成测试观察到的间歇性问题，但似乎进退两难。

某处某处正在创建 System.Threading.Tasks.Task，该任务随后失败并导致未观察到的任务异常。在生成的处理程序中，我可以看到任务 ID 和导致它失败的异常。我煞费苦心地分析了我的代码，甚至 followed my own advice and named all my tasks但仍未找到有问题的任务。似乎我的代码根本没有创建它。

所以我尝试在 Task 构造函数本身上设置断点。我可以使用函数断点(使用诸如“System.Threading.Tasks.Task.Task(System.Action)”之类的位置)来做到这一点。这有效，调试器中断并向我显示 Task 类的程序集。但是，我真正需要做的是将 Task 的 ID 与最终失败的 Task 的 ID 相关联。

为此，我尝试在跟踪点中输出 Task.Id 属性。但我收到一条消息，说该方法已优化，因此无法计算表达式。

所以我尝试使用源代码进行调试。我设置了我所有的符号和你有什么，但我尽我所能，但它没有用。经过多次谷歌搜索后，我发现它 isn't supported在最新的 .NET 4 上。

有人对我如何继续诊断此问题有任何想法吗？

Answer 1

好的，我已经找到这个问题了。这个错误的细节可能不如我用来找到它的方法有趣，但我将在下面的单独部分中介绍这两个部分。

问题

这是有问题的代码的一部分:

private static Task<TSuccessor> ThenImpl<TAntecedent, TSuccessor>(Task<TAntecedent> antecedent, Func<Task<TAntecedent>, Task<TSuccessor>> getSuccessor, CancellationToken cancellationToken, TaskThenOptions options)
{
    antecedent.AssertNotNull("antecedent");
    getSuccessor.AssertNotNull("getSuccessor");

    var taskCompletionSource = new TaskCompletionSource<TSuccessor>();

    antecedent.ContinueWith(
        delegate
        {
            var evenOnFaulted = options.HasFlag(TaskThenOptions.EvenOnFaulted);
            var evenOnCanceled = options.HasFlag(TaskThenOptions.EvenOnCanceled);

            if (antecedent.IsFaulted && !evenOnFaulted)
            {
                taskCompletionSource.TrySetException(antecedent.Exception.InnerExceptions));
            }
            else if ((antecedent.IsCanceled || cancellationToken.IsCancellationRequested) && !evenOnCanceled)
            {
                taskCompletionSource.TrySetCanceled();
            }
            else
            {

此方法支持我的Then 扩展方法，即I've blogged about .

除了我的博客文章中的实现之外，我最近添加了运行“then continuation”的功能，正如我所说，即使前面的任务出错:

Task.Factory.StartNew(() => { throw new InvalidOperationException(); })
    .Then(() => Console.WriteLine("Executed"), TaskThenOptions.EvenOnFaulted);

这将导致忽略初始异常并在控制台上输出“已执行”。但是，问题是我的 ThenImpl 没有观察到原始异常。为此，我更改了这一行:

if (antecedent.IsFaulted && !evenOnFaulted)

为此:

if (antecedent.Exception != null && !evenOnFaulted)

现在我不明白这个问题了。

现在，您可能想知道为什么很难追踪到这一点。问题是，我有很多促进高级场景的任务组合方法。这是一个实际的片段，可以让您了解由此产生的力量:

private Task OnConnectAsync(CancellationToken cancellationToken, object state)
{
    var firstAttempt = true;
    var retryOnFailureTask = TaskUtil
        .RetryOnFailure(
                () => TaskUtil.Delay(firstAttempt ? TimeSpan.Zero : this.reconnectDelay, cancellationToken)
                .Then(
                    x =>
                    {
                        if (!firstAttempt)
                        {
                            Interlocked.Increment(ref this.connectionAttempts);
                        }

                        firstAttempt = false;
                    })
                .Then(x => this.loggerService.Debug("Attempting to connect communications service (attempt #{0}).", this.connectionAttempts), cancellationToken)
                .Then(x => this.communicationsService.ConnectAsync(cancellationToken), cancellationToken)
                .Then(x => this.loggerService.Debug("Successfully connected communications service (attempt #{0}).", this.connectionAttempts), cancellationToken)
                .Then(x => this.communicationsService.AuthenticateAsync(cancellationToken), cancellationToken)
                .Then(x => this.loggerService.Debug("Successfully authenticated communications service (attempt #{0}).", this.connectionAttempts), cancellationToken)
                .Then(x => this.ReviveActiveStreamsAsync(cancellationToken), cancellationToken)
                .Then(x => this.loggerService.Debug("Successfully revived streams (attempt #{0}).", this.connectionAttempts), cancellationToken),
            null,
            cancellationToken);

    return retryOnFailureTask;
}

请注意自定义 RetryOnFailure、Then 和 Delay 方法。这很好地诠释了我所说的内容。

当然，这样做的缺点是在问题发生时对其进行追踪。我不禁觉得 TPL 在这方面做得很差。在我看来，每个 Task 都应该包含有关创建者的信息。至少，TPL 中应该有 Hook (例如 TaskCreated 事件)，以便开发人员可以使用自己的调试信息来补充任务。使用 .NET 4.5 后情况可能会有所改善 - 不过我使用的是 .NET 4.0。

方法

追踪问题的关键是费力地包装我用 TaskCompletionSource 创建的每个 Task，用补充消息包装任何异常。例如，这是我事先拥有的 ToBooleanTask 扩展方法:

public static Task<bool> ToBooleanTask(this Task task)
{
    var taskCompletionSource = new TaskCompletionSource<bool>();

    task.ContinueWith(
        x =>
        {
            if (x.IsFaulted)
            {
                taskCompletionSource.TrySetException(x.Exception.GetBaseException());
            }
            else if (x.IsCanceled)
            {
                taskCompletionSource.TrySetCanceled();
            }
            else
            {
                taskCompletionSource.TrySetResult(true);
            }
        });

    return taskCompletionSource.Task;
}

修改后的效果如下:

public static Task<bool> ToBooleanTask(this Task task)
{
    var taskCompletionSource = new TaskCompletionSource<bool>();

    task.ContinueWith(
        x =>
        {
            if (x.IsFaulted)
            {
                taskCompletionSource.TrySetException(new InvalidOperationException("Failure in to boolean task", x.Exception.GetBaseException()));
            }
            else if (x.IsCanceled)
            {
                taskCompletionSource.TrySetCanceled();
            }
            else
            {
                taskCompletionSource.TrySetResult(true);
            }
        });

    return taskCompletionSource.Task;
}

在本例中，我已经有了一个 TaskCompletionSource，所以很简单。在其他情况下，我必须显式创建一个 TaskCompletionSource 并将来自底层 Task 的任何故障/取消/结果转发到 TaskCompletionSource。

旁白:您可能想知道 ToBooleanTask 扩展方法的使用。如果您想实现一个方法来处理通用任务和非通用任务，这将非常有用。您可以实现通用版本，然后让您的非通用重载调用 ToBooleanTask 以创建一个通用任务，然后可以将其传递给您的通用重载。

一旦我检查了所有可能的罪魁祸首并按照上述方式对其进行了补充，我重新运行了我的测试直到它失败并注意到确实是 ToBooleanTask 创建了任务没有被观察到。因此，我将其修改为:

public static Task<bool> ToBooleanTask(this Task task)
{
    var stackTrace = new System.Diagnostics.StackTrace(true);
    var taskCompletionSource = new TaskCompletionSource<bool>();

    task.ContinueWith(
        x =>
        {
            if (x.IsFaulted)
            {
                taskCompletionSource.TrySetException(new InvalidOperationException("Failure in to boolean task with stack trace: " + stackTrace, x.Exception.GetBaseException()));
            }
            else if (x.IsCanceled)
            {
                taskCompletionSource.TrySetCanceled();
            }
            else
            {
                taskCompletionSource.TrySetResult(true);
            }
        });

    return taskCompletionSource.Task;
}

这会在发生故障时为我提供完整的堆栈跟踪。我重新运行了我的测试，直到它失败了，然后——万岁! - 获得了追踪问题所需的信息:

Failure in to boolean task with stack trace:    at XXX.Utility.Tasks.TaskExtensions.ToBooleanTask(Task task) in C:\XXX\Src\Utility\Tasks\TaskExtensions.cs:line 110
   at XXX.Utility.Tasks.TaskExtensions.Then(Task antecedent, Func`2 getSuccessor, CancellationToken cancellationToken, TaskThenOptions options) in C:\XXX\Src\Utility\Tasks\TaskExtensions.cs:line 199
   at XXX.Utility.Tasks.StateMachineTaskFactory`1.TransitionTo(T endTransitionState, CancellationToken cancellationToken, WaitForTransitionCallback`1 waitForTransitionCallback, ValidateTransitionCallback`1 validateTransitionCallback, PreTransitionCallback`1 preTransitionCallback, Object state) in C:\XXX\Src\Utility\Tasks\StateMachineTaskFactory.cs:line 312
   <snip>

所以我可以看到它是我的 Then 重载调用 ToBooleanTask 之一。然后我可以追踪到那个确切的代码，问题很快就变得很明显。

不过，这让我很好奇。为什么我用名称补充每个任务的原始方法没有产生任何结果？我尝试恢复我的修复，直接命名由 ToBooleanTask 生成的任务，然后重新运行直到失败。果然，我在调试器中看到了任务名称。很明显，我最初以某种方式错过了这个任务的命名。

呸!