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

オープン
  • 何か問題がありますか？
#324 コメント 2 件 リアクション 1 件 担当者 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時間
マージ済み PR（30日）
15

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

modelcontextprotocol/swift-sdk のほかの issue

modelcontextprotocol/swift-sdk の issue をすべて見る

似ている issue

Swift の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。