是否可以测试方法在由任务启动时是否使用捕获的 SynchronizationContext 运行？

Question

我可能在某个地方遗漏了答案，或者这是一些微不足道的问题，但我还没有找到。

这实际上是我试图在代码中实现的目标：

public static async Task CapturesContext()
{
    await Task.Run(() => DoWhatever());
}

public static async Task DoesNotCaptureContext()
{
    await Task.Run(() => DoWhatever()).ConfigureAwait(false);
}

public static void DoWhatever()
{
    //Any way to test here that it was run with/without a captured SynchronizationContext?
}

上面是一个非常简单的例子，但表达了我想要完成的事情。

我们的目标是在非常大的代码库中清除 ConfigureAwait 的不当用法。

给定使用Task 运行的任何方法，是否可以通过Assert 或单元测试之类的代码检查给定方法是否使用捕获的SynchronizationContext 运行？

如果没有，是否有其他方法可以实现我的目标？

Answer 1

目标是在一个非常大的代码库中清除不正确的 ConfigureAwait 用法。

一些团队为此选择使用代码分析工具。有几种可用。我见过的最常见的方法是要求为每个await 提供一个ConfigureAwait，并明确指定true 或false。这可以确保每个await 都经过审查并且上下文流是明确的。其他团队应用“始终使用ConfigureAwait(false)”的项目特定规则，并且只依赖于对无法遵循该规则的项目进行代码审查。

您的示例代码的问题在于，DoWhatever不可能知道它是否被间接调用，因为 Task.Run。如果你重写这些方法，这就变得很清楚了：

public static async Task CapturesContext()
{
  var task = Task.Run(() => DoWhatever());
  await task;
}

public static async Task DoesNotCaptureContext()
{
  var task = Task.Run(() => DoWhatever());
  var configuredTask = task.ConfigureAwait(false);
  await configuredTask;
}

重写方法的第一行应该清楚地表明DoWhatever 不知道CapturesContext 或DoesNotCaptureContext 是否会捕获上下文。注意“will”（将来时）——DoWhatever 完全有可能在 ConfigureAwait(false) 被调用之前运行并完成执行。

现在，您可以在任务中检查它是否正在现在上下文中运行。但在这种情况下，对于这两个示例方法，DoWhatever 将不会看到上下文，因为Task.Run。所以这并不能帮助您检测到CapturesContext 确实捕获了上下文的事实； DoWhatever 看不到上下文，因此无法检测到它。

自定义SynchronizationContext 是单元测试的一个很好的解决方案，但是在运行时使用它会很尴尬，因为你确实有一些需要上下文的方法。出于这个原因，大多数团队选择依赖代码审查和/或代码分析工具。

Answer 2

创建一个SynchronizationContext，它在Post 和Send 的实现中引发异常。或者，让它设置一个布尔值，指示是否调用了 Send 或 Post，以便您稍后检查该布尔值（如果您这样做，您可能希望运行提供的委托，否则您可能会面临死锁的风险）。

每当测试一个永远不应使用当前同步上下文的方法时，在测试开始时将该自定义同步上下文的一个实例设置为当前同步上下文。