如何排查ASP.NET Core集成测试中CancellationToken被取消的原因？

可能导致CancellationToken随机取消的原因 #

• 测试客户端超时：集成测试使用的HttpClient默认超时较短，若测试代码未正确await异步操作，测试框架会提前终止任务触发取消；也可能是手动设置的超时时间不足以覆盖请求处理时长。
• 测试环境资源竞争：多测试并行执行时，服务器资源（线程池、数据库连接池等）耗尽，请求处理超时，ASP.NET Core框架自动触发令牌取消。
• 请求管道中间件异常：限流、超时类中间件配置不当，或自定义中间件错误调用CancellationTokenSource.Cancel()，意外触发取消。
• 请求超时机制触发：若启用了HttpRequestTimeoutMiddleware或Kestrel连接超时设置，请求处理超时会直接触发CancellationToken取消。

启用日志排查取消原因 #

1. 配置日志类别
   在appsettings.json中添加日志配置，捕获请求连接、MVC动作执行及令牌变化的详细日志：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore.Http.Connection": "Debug",
      "Microsoft.AspNetCore.Mvc.Infrastructure": "Debug",
      "System.Threading.CancellationToken": "Debug"
    }
  }
}

2. 测试项目启用日志输出
   使用WebApplicationFactory时，在测试项目中配置控制台日志输出，方便实时查看取消事件：

var factory = new WebApplicationFactory<Program>()
    .WithWebHostBuilder(builder =>
    {
        builder.ConfigureLogging(logging =>
        {
            logging.ClearProviders();
            logging.AddConsole();
        });
    });

3. 手动跟踪取消堆栈
   在动作方法中添加取消回调，输出触发取消的调用堆栈，精准定位源头：

public async Task<ActionResult<TokenResponse>> GetToken(
    [Required][FromBody] Parameters parameters,
    ApiVersion apiVersion,
    CancellationToken cancellationToken) 
{
    cancellationToken.Register(() =>
    {
        var stackTrace = new System.Diagnostics.StackTrace();
        Console.WriteLine($"CancellationToken cancelled at:\n{stackTrace}");
    });

    // 原有业务逻辑
}

解决方案 #

• 调整测试客户端超时
  显式设置HttpClient超时时间，同时确保测试方法正确await异步操作：

var client = factory.CreateClient();
client.Timeout = TimeSpan.FromMinutes(3); // 根据实际请求耗时调整

// xUnit测试示例
[Fact]
public async Task GetToken_ReturnsSuccess()
{
    var response = await client.PostAsJsonAsync("/api/v1/token", testParameters);
    response.EnsureSuccessStatusCode();
}

• 优化测试并行策略
  若为并行测试导致的资源竞争，修改测试框架配置禁用并行（以xUnit为例，在xunit.runner.json中设置）：

{
  "parallelizeTestCollections": false,
  "parallelizeAssembly": false
}

• 调整请求超时配置
  根据测试环境需求，调整或禁用请求超时中间件：

// Program.cs中根据环境判断配置
if (!app.Environment.IsTest())
{
    app.UseHttpRequestTimeout(options =>
    {
        options.Timeout = TimeSpan.FromMinutes(2);
    });
}

• 隔离下游依赖
  若下游服务响应缓慢导致超时，在测试中使用Mock替代真实依赖，排除外部因素干扰。

内容的提问来源于stack exchange，提问作者mnj