Client.withBatch leaves per-request tasks pending when transport.send throws

未关闭
  • 哪里不对？
#324 2 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

@bbdu3 已经在做这个了。

开始于 2026年11月9日。

  • #328 来自 @bbdu3 —— 未关闭

评估

难度
4/5
预计耗时
3-5 天
新手友好度
55/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
swift
领域
api, backend

调研方向

Start with Client.withBatch(), Batch.addRequest(), and the single request Client.send() failure path described in the issue; use the existing MockTransport to reproduce the send failure with two Ping requests. Trace how pending request registration and continuation resumption are coordinated, including exactly-once cleanup. Done when each affected task receives the send error, its pending entry is removed, and unrelated requests remain unaffected.

由索引模型根据 Issue 内容生成。

描述

Client.withBatch() propagates a transport send error to its caller, but does not propagate that failure to the tasks previously returned by Batch.addRequest().

How to found

After successfully connecting a client:

  1. Configure the transport to throw from send() before delivering the batch, while keeping the receive stream open.
  2. Add two requests inside withBatch() and retain their returned task handles.
  3. Catch the error thrown by withBatch().
  4. Await the retained tasks without disconnecting or explicitly cancelling their requests.

The batch was not delivered, so no responses will arrive. However, the per-request tasks have no send-failure path that completes them.

This can be exercised using the existing MockTransport: complete initialization successfully, call setFailSend(true), then submit a batch of Ping requests.

Expected behavior

When sending the batch fails, its outstanding per-request tasks should complete with the send error, and their pending request entries should be removed.

Current code path

Batch.addRequest() returns an independent task that waits on a CheckedContinuation. Registration in pendingRequests happens through another asynchronous task:

Task {
    await client.addPendingRequest(
        id: request.id,
        continuation: continuation,
        type: M.Result.self
    )
}

withBatch() subsequently sends the collected requests:

let data = try encoder.encode(requests)
try await connection.send(data)

There is no failure handler here to remove those pending requests or resume their continuations. Throwing from withBatch() does not automatically complete the separately created tasks.

By comparison, the single-request Client.send() path explicitly removes its pending request and resumes its continuation when sending fails.

Impact

Code awaiting the retained batch task results can remain suspended after the outer batch call has already failed. Registered pending requests also remain retained until another path handles them, such as explicit request cancellation or client disconnection.

This report concerns local transport send failure with no response received. It does not concern a successfully delivered batch containing JSON-RPC error responses, which already has response-handling logic.

my suggestion

I think withBatch() should propagate a send failure to all still-pending requests belonging to that batch, without affecting unrelated requests.

The fix also needs to account for asynchronous registration in Batch.addRequest(): simply removing currently registered IDs in a catch block may miss a continuation registered after cleanup. Registration and failure handling should be coordinated, while preserving exactly-once continuation resumption.

Related work

  • #113 provides relevant exactly-once cleanup behavior for individual requests and response handling, but does not add batch send-failure cleanup.
  • #210 and #213 change withBatch() to return the closure’s result; their diffs leave the transport send-failure path without cleanup.
  • #314 adds rejection of batching for its modern protocol mode, rather than repairing failure handling in the existing batching path.

I did not find an existing issue or PR specifically addressing this failure path in the searches performed. If this issue and repair directions are correct, I am willing to open a PR.

主要语言
Swift
星标
1.6k
派生
270
平均合并
2 天 7 小时
30 天内合并 PR
15

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

modelcontextprotocol/swift-sdk 的其他 Issue

查看 modelcontextprotocol/swift-sdk 的全部 Issue

相似的 Issue

更多 Swift Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。