Node.js: external-tool result-delivery RPC failures are silently swallowed

Offen
  • Stimmt etwas nicht?
#2,906 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

  • #2909 von @FOWEPJF255 — ohne Merge geschlossen

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
42/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
javascript, node.js
Bereich
api, backend, testing

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

In nodejs/src/session.ts:

  1. _executeToolAndRespond calls _claimExternalTool before awaiting the result-submission RPC.
  2. _claimExternalTool removes the request from pendingExternalTools.
  3. If result submission rejects, the enclosing catch calls _claimExternalTool again.
  4. The second claim returns false because the first claim removed the entry.
  5. 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.
Vorherrschende Sprache
Java
Sterne
10.7k
Forks
1.5k
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/copilot-sdk

Alle Issues in github/copilot-sdk

Ähnliche Issues

Weitere Issues zu Java

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.