Node.js: external-tool result-delivery RPC failures are silently swallowed
还没有人认领这个 Issue。
- #2909 来自 @FOWEPJF255 —— 已关闭,未合并
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 42/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- javascript, node.js
调研方向
Start with nodejs/src/session.ts, especially _executeToolAndRespond and _claimExternalTool, then trace the result-submission RPC and its error handling. Add regression coverage for a handler that succeeds while delivery fails, alongside the existing success and handler-error cases. Done means unexpected delivery failures reach the host through a documented diagnostics or error path while cancellation, races, and teardown retain their intended behavior.
由索引模型根据 Issue 内容生成。
描述
Summary
The Node.js SDK silently swallows an unexpected failure while submitting a completed external-tool result through session.tools.handlePendingToolCall.
The tool handler succeeds, but result submission rejects. _executeToolAndRespond then resolves successfully without surfacing the delivery error. The request has already been removed from the SDK's pending invocation tracking.
If the runtime remains active and has not accepted the result, it can remain waiting for a response. This report does not establish that this code path caused any particular production timeout.
Environment and verification
- OS: Windows x64.
- Node.js: reproduced on both 24.16.0 and 27.0.0-alpha.0.0.0.
- Reproduced with the Node.js SDK bundled in platform package
@github/[email protected]. - The same control flow exists in public SDK main at commit
99d90edf504f824c77dcdf0faa978f4b35848a87. This source comparison is static; the reproduction below was executed against the installed bundle. - The reproduction uses internal SDK seams to isolate result delivery. It starts no runtime or model request and requires no credentials or network access.
Minimal reproduction
Save as repro.mjs in an environment with @github/copilot-sdk installed, then run node --test repro.mjs.
import assert from 'node:assert/strict';
import test from 'node:test';
import { CopilotSession } from '@github/copilot-sdk';
test('unexpected result-delivery errors are surfaced', async () => {
const session = new CopilotSession('repro-session', {});
let handlerCalls = 0;
let responseAttempts = 0;
session._rpc = {
tools: {
handlePendingToolCall: async () => {
responseAttempts++;
throw new Error('simulated result delivery failure');
},
},
};
await assert.rejects(
session._executeToolAndRespond(
'repro-request',
'repro-tool',
'repro-call',
{},
async () => {
handlerCalls++;
return 'done';
},
),
/simulated result delivery failure/,
);
assert.equal(handlerCalls, 1);
assert.equal(responseAttempts, 1);
});
Actual behavior
The test fails with Missing expected rejection.
A separate probe confirms that the handler ran once, result submission was attempted once, and the delivery error was not surfaced. The invocation was no longer present in pendingExternalTools.
On both tested Node.js versions, two positive controls pass and the result-delivery regression fails. The controls cover a successful result submission and a handler exception successfully submitted as an error response.
Expected behavior
An unexpected result-delivery failure should reach the host through an explicit, documented diagnostics or error path rather than silently resolving. Rejecting the internal method is one possible implementation; a structured host diagnostic would also address the observability problem.
Expected cancellation, stale-response rejection, duplicate-client races, and session teardown should retain their intended behavior.
Public source analysis
_executeToolAndRespondcalls_claimExternalToolbefore awaiting the result-submission RPC._claimExternalToolremoves the request frompendingExternalTools.- If result submission rejects, the enclosing catch calls
_claimExternalToolagain. - The second claim returns false because the first claim removed the entry.
- The catch returns without surfacing the delivery failure.
The ownership claim appears intentional for cancellation and race safety, so simply removing it or rerunning the handler would not be a safe fix.
Suggested fix direction
- Separate tool-handler failures from result-delivery failures.
- Keep the single-owner claim and cancellation guarantees.
- Surface unexpected result-delivery failures explicitly instead of routing them through a second ownership claim that suppresses them.
- If result retry is supported, retry only the completed result and document its idempotency guarantees. Do not rerun a tool that may already have produced side effects.
- Add regression coverage for successful delivery, handler failure, unexpected delivery failure, completion races, teardown, and late responses.
Related reports
- #2872 concerns the 1,800-second external-tool timeout and configuration documentation. It is closed, with no public comment or linked fix explaining a supported timeout override.
- #2368 concerns an event dropped before SDK handler entry and is closed as fixed. This report instead starts with a handler that already completed.
- #2509 introduced the request ownership and cancellation behavior and is merged.
- #2425 proposed handler-dispatch diagnostics but was closed without merging.
- 主要语言
- Java
- 星标
- 10.7k
- 派生
- 1.5k
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
github/copilot-sdk 的其他 Issue
-
Rust: ElicitationRequest drops the tool call id from elicitation.requested可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
github/copilot-sdk#2900 ·
-
难度 1/5 1 小时以内 新手友好度 84/100
github/copilot-sdk#2876 · 1 条评论 · 1 个 reaction ·
-
Python ModelLimits drops max_output_tokens from model metadata可能重新可做 关联的 PR 已关闭且未合并。 未关闭bug
难度 2/5 1-3 小时 新手友好度 78/100
github/copilot-sdk#2798 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
github/copilot-sdk#2759 ·
-
docs/AGENTS.md is repo authoring guidance, but everything in docs/ gets published可能重新可做 关联的 PR 已关闭且未合并。 未关闭documentation
难度 1/5 1 小时以内 新手友好度 85/100
github/copilot-sdk#2758 ·
查看 github/copilot-sdk 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 75/100
ls1intum/thesis-management#1473 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
LunaDeerMC/Dominion#301 · 1 条评论 ·
-
[FEATURE] Expose external refresh, node-level translog and warmer stats可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭untriaged
难度 2/5 1-3 小时 新手友好度 68/100
opensearch-project/opensearch-prometheus-exporter#680 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
-
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 2 天内回复