解决microsoft/sample-app-aoai-chatGPT中的异步客户端会话未关闭问题

在基于Azure OpenAI构建的聊天应用microsoft/sample-app-aoai-chatGPT中，开发团队遇到了一个典型的异步编程问题——未关闭的客户端会话。这个问题虽然不会立即导致应用崩溃，但长期运行后可能引发内存泄漏和性能下降。

问题现象

应用在启用聊天历史功能并处理多个并发请求时，日志中会出现"Unclosed client session"警告信息。这表明应用程序创建的异步客户端会话没有被正确关闭，导致资源未被释放。

根本原因分析

经过深入排查，发现问题出在CosmosDB客户端的初始化逻辑上。当应用使用DefaultAzureCredential进行身份验证时，创建的是一个异步版本的凭据对象(aio)，但这个异步会话没有被正确管理生命周期。

具体来看，在app.py文件的init_cosmosdb_client()函数中，当AZURE_COSMOSDB_ACCOUNT_KEY未设置时，代码会使用DefaultAzureCredential()创建凭据。问题在于这个异步凭据对象没有被显式关闭。

解决方案

针对这个问题，社区提出了两种有效的解决方案：

方案一：使用上下文管理器管理异步凭据

最简单的修复方法是使用Python的async with语法来管理DefaultAzureCredential的生命周期：

async def init_cosmosdb_client():
    if not AZURE_COSMOSDB_ACCOUNT_KEY:
        async with DefaultAzureCredential() as credential:
            # 使用credential初始化Cosmos客户端
    else:
        credential = AZURE_COSMOSDB_ACCOUNT_KEY

这种方法确保凭据对象在使用完毕后会被自动关闭，解决了资源泄漏问题。

方案二：全局单例模式优化

考虑到CosmosClient的初始化是一个重量级操作，官方文档建议在整个应用生命周期中保持单例实例。更完善的解决方案是：

1. 在应用启动时初始化CosmosDB客户端
2. 将客户端实例存储在应用上下文中
3. 使用事件机制确保路由处理前客户端已就绪

实现代码示例：

cosmos_db_ready = asyncio.Event()

def create_app():
    app = Quart(__name__)
    
    @app.before_serving
    async def init():
        try:
            app.cosmos_conversation_client = await init_cosmosdb_client()
            cosmos_db_ready.set()
        except Exception as e:
            logging.exception("初始化CosmosDB客户端失败")
            app.cosmos_conversation_client = None
            raise e
    
    return app

在路由处理函数中，首先等待数据库就绪：

async def add_conversation():
    await cosmos_db_ready.wait()
    # 使用current_app.cosmos_conversation_client操作数据库

最佳实践建议

1. 资源管理：对于所有实现了异步上下文管理协议的对象，都应使用async with语法确保资源释放

2. 客户端生命周期：重量级客户端应考虑应用级单例模式，避免重复初始化开销

3. 错误处理：数据库连接初始化应放在应用启动阶段，失败时尽早暴露问题

4. 就绪检查：使用事件机制确保依赖服务就绪后再处理请求

这种设计不仅解决了原始问题，还提高了应用的健壮性和性能表现。对于生产环境中的Python异步应用开发，这些模式都值得借鉴。