访问Azure Cosmos容器时无异常直接退出的原因排查

问题描述 #

从标准C# Cosmos查询示例入手，执行到以下代码时程序直接退出，无任何提示信息：

var currentResultSet = await queryResultSetIterator.ReadNextAsync();

为验证功能有效性，编写了以下测试代码：

this.cosmosClient = new CosmosClient(EndpointUri, PrimaryKey);
this.container = cosmosClient.GetContainer(databaseId, containerId);

// 这段代码可正常运行，已在数据资源管理器验证结果
var deltest = this.cosmosClient.GetContainer(databaseId, "deleteme");
deltest.DeleteContainerAsync().Wait();  

// 这段代码会直接退出，无异常抛出
var a = await this.container.ReadContainerAsync();

执行ReadContainerAsync时，日志中出现一条关键线索：

DocDBTrace Information: 0 : Azure Environment metadata information not available. A socket operation was attempted to an unreachable network. (169.254.169.254:80)

已检查容器配置无问题，询问是否需要启用特定选项才能正常查询容器。

补充调试信息（编辑1） #

背景情况：

• 正在为.NET 6库编写单元测试，采用TDD模式
• 测试类实现了隐藏数据库细节的接口
• 类包含构造函数和一个异步方法

构造函数中的以下测试代码可正常运行：

var deltest = this.cosmosClient.GetContainer(databaseId, "deletetesttwo");
deltest.DeleteContainerAsync().Wait();

但异步方法中的同逻辑代码会立即退出单元测试的调试模式：

var deltest = this.cosmosClient.GetContainer(databaseId, "deletetesttwo");
await deltest.DeleteContainerAsync();

每次调用之间会通过数据资源管理器重新创建容器。

问题原因与解决方法 #

1. 单元测试异步方法未正确标记 #

单元测试中如果异步方法标记为async void，测试框架无法等待异步操作完成，会导致进程提前退出。必须将测试方法标记为async Task：

// 错误写法：async void 会导致测试进程提前结束
[Fact]
public async void TestCosmosOperation()
{
    // ... 测试代码
}

// 正确写法：async Task
[Fact]
public async Task TestCosmosOperation()
{
    var deltest = this.cosmosClient.GetContainer(databaseId, "deletetesttwo");
    await deltest.DeleteContainerAsync();
}

2. 禁用Azure元数据检测 #

日志中的169.254.169.254是Azure实例元数据服务地址，本地开发环境访问会失败。虽然该错误本身不致命，但可能干扰异步上下文，可通过配置禁用元数据检测：

var options = new CosmosClientOptions
{
    DisableClientTelemetry = true,
    DisableAzureMetadataLookup = true
};

this.cosmosClient = new CosmosClient(EndpointUri, PrimaryKey, options);

3. 添加异步异常捕获 #

异步操作中的未捕获异常可能导致进程崩溃，需在代码中添加异常处理逻辑，或在测试中用Assert.ThrowsAsync捕获预期异常：

try
{
    var a = await this.container.ReadContainerAsync();
}
catch (Exception ex)
{
    // 记录异常信息，排查具体问题
    Console.WriteLine($"操作异常：{ex.Message}");
    throw; // 必要时重新抛出，让测试框架捕获
}

4. 升级Cosmos Client包 #

确保使用最新稳定版的Microsoft.Azure.Cosmos NuGet包，旧版本可能存在异步处理的已知bug，升级后可解决部分问题。

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