Add is_alive liveness-probe API across SDKs (decouple liveness from typed ping deserialization)
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 48/100
- issue の種類
- 機能追加
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
調査の方向性
rust/src/lib.rs:1676、nodejs/src/client.ts:1032、go/client.go:1317、dotnet/src/Client.cs:874 に記載されている Client の ping エントリポイントと、同等の Python クライアントから始め、その後 @github/copilot/schemas/api.schema.json を調査します。SDK のテストを実行し、ping body の厳密なデシリアライゼーションに失敗する有効な JSON-RPC レスポンスのカバレッジを追加します。完了の条件は、各 Client に言語に適した liveness メソッドがあり、既存の型付き ping API が変更されず、各 SDK がこの区別をドキュメント化していることです。
索引モデルが issue の本文から書いたものです。
説明
Summary
The Copilot CLI host (github/github-app) had to work around a deserialization failure in our SDK's typed ping() API on the session-resume / warm-CLI-pool / liveness-probe paths. See github/github-app#5461 for the workaround.
Their fix introduces a ping_cli_compat(&client) helper that drops to the raw client.call("ping", json!({})) so the result body is never deserialized — they only care whether the JSON-RPC round trip succeeded.
We should give them (and everyone doing liveness checks) a first-class primitive instead of forcing them to bypass our typed API.
Root cause
Across all five SDKs, ping() deserializes the response into a typed body:
- Rust:
Client::ping(&self) -> Result<PingResponse, Error>(rust/src/lib.rs:1676) - Node:
client.ping()returning{message, timestamp, protocolVersion?}(nodejs/src/client.ts:1032) - Go:
client.Ping(ctx, msg) (*PingResponse, error)(go/client.go:1317) - .NET:
client.PingAsync(...) : Task<PingResponse>(dotnet/src/Client.cs:874) - Python: equivalent typed return
The authoritative PingResult schema (@github/copilot/schemas/api.schema.json) requires message, timestamp (date-time string), and protocolVersion (integer > 0). The Rust hand-written PingResponse softens this with #[serde(default)] and Option<u32>, but that only helps for missing fields — wrong types (e.g. null timestamp, integer-shape drift) still fail. Same brittleness exists across the other SDKs.
ping is used by hosts as a liveness check (warm-pool reuse, resumed-session aliveness, retrier "is the cached client still alive" probes). These paths straddle CLI version boundaries — a resumed older CLI process can answer with a slightly different ping body shape, and the entire liveness check fails even though the RPC itself succeeded.
This is exactly the wrong failure mode for a health check: the consumer asked "is the CLI reachable?" and we answered "no" because of a body-shape mismatch.
Proposed fix
Add a dedicated liveness-probe API to every SDK Client:
- Sends the
pingJSON-RPC call. - Returns success based solely on JSON-RPC success — never deserializes the result body.
- Composable with caller-supplied timeouts — no baked-in timeout, so each host (startup probe, warm-pool, resume probe, background keepalive) sets its own budget.
ping()and generatedrpc.ping()stay strict and schema-faithful. Callers who actually want the typed data keep getting it; schema drift continues to surface there as a real error.
Per-language names:
| SDK | API |
|---|---|
| Rust | Client::is_alive(&self) -> bool |
| Node | client.isAlive(): Promise<boolean> |
| Python | client.is_alive() -> bool |
| Go | client.IsAlive(ctx context.Context) bool |
| .NET | client.IsAliveAsync(ct) : Task<bool> |
After this lands, the github/github-app workaround helper goes away and call sites become e.g. existing.is_alive().await.
Rejected alternatives
- Loosen
ping()itself. Considered and rejected.ping()is a typed schema-backed API; if it silently swallows malformed bodies, the contract becomes ambiguous (did the caller want liveness, or the ping data?). It also masks real CLI/schema drift in the API most likely to catch it. - Loosen the generated
rpc.ping(PingRequest). Same reasoning, more so — generated APIs must remain schema-faithful.is_aliveis the explicit escape hatch. - "Fix it only in the CLI." The CLI should still honor the schema, and we should investigate any drift. But liveness checks fundamentally straddle version boundaries, so the SDK needs a body-agnostic primitive regardless.
Acceptance criteria
- New
is_alive/IsAlive/isAlivemethod on the Rust, Node, Python, Go, and .NETClienttypes. - Method calls the
pingJSON-RPC method and returns success purely on RPC success, ignoring the response body. - Existing
ping()/rpc.ping()typed APIs unchanged. - Docs in each SDK clearly distinguish "use
is_alivefor liveness/warm-pool/resume checks" from "useping()when you want the typed response." - Tests cover the case where the CLI returns a
pingbody that fails strict deserialization but is otherwise a valid JSON-RPC success —is_alivereturnstrue,ping()returns an error. - Once shipped, the workaround in github/github-app#5461 is removed.
Design review
Reviewed and agreed with GPT-5.5; consensus on:
- Separate
is_aliveAPI (not looseningping). - Keep generated
rpc.pingstrict. - No baked-in timeout; caller composes timeouts.
- Name
is_aliveclearly communicates intent ("RPC round trip succeeded") and beatsping_raw/ping_check.
- 主要言語
- Java
- スター
- 10.5k
- フォーク
- 1.5k
- 平均マージ
- 1日 9時間
- マージ済み PR(30日)
- 130
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/copilot-sdk のほかの issue
-
agentic-workflows
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
github/copilot-sdk#2760 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
github/copilot-sdk#2759 ·
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
github/copilot-sdk#2758 ·
-
agentic-workflows
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/copilot-sdk#2709 · コメント 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
github/copilot-sdk#2673 ·
github/copilot-sdk の issue をすべて見る
似ている issue
-
area/plugin
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
kestra-io/plugin-kestra#190 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
google-ai-edge/LiteRT-LM#3739 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
integra-team-red/meet-map#249 ·
-
[Studio][Bug] Cancelled create-user dialog keeps the password and admin switch for the next attempt オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
apache/rocketmq-dashboard#5064 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
wso2/dpdp-accelerator#287 ·