Repository navigation
fix(client): close the SSE transport when its stream ends for good #3140
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
arjunprabhulal
wants to merge
1
commit into
modelcontextprotocol:main
Choose a base branch
from
arjunprabhulal:fix/sse-client-close-on-dead-stream
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@modelcontextprotocol/client': patch | ||
| --- | ||
|
|
||
| `SSEClientTransport` now closes, firing `onclose` and rejecting pending requests with `ConnectionClosed`, when its SSE stream drops after connecting and the reconnect fails for good, for example with a 404 after the server restarts. Previously the transport stayed open with no stream, so pending requests waited for their timeout and the application was never told the connection had ended. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| import { createServer } from 'node:http'; | ||
| import type { AddressInfo } from 'node:net'; | ||
|
|
||
| import { LATEST_PROTOCOL_VERSION, SdkErrorCode } from '@modelcontextprotocol/core-internal'; | ||
|
|
||
| import { Client } from '../../src/client/client'; | ||
| import { SSEClientTransport } from '../../src/client/sse'; | ||
|
|
||
| test('a pending request rejects and onclose fires when the SSE stream drops and cannot be reopened', async () => { | ||
| let gets = 0; | ||
| let write: ((data: string) => void) | undefined; | ||
| let end: (() => void) | undefined; | ||
| const server = createServer((req, res) => { | ||
| if (req.method === 'GET') { | ||
| gets++; | ||
| if (gets > 1) { | ||
| res.writeHead(404).end(); | ||
| return; | ||
| } | ||
| res.writeHead(200, { 'Content-Type': 'text/event-stream' }); | ||
| res.write('event: endpoint\ndata: /messages\n\n'); | ||
| write = data => res.write(`event: message\ndata: ${data}\n\n`); | ||
| end = () => res.end(); | ||
| return; | ||
| } | ||
| let body = ''; | ||
| req.on('data', chunk => (body += chunk)); | ||
| req.on('end', () => { | ||
| res.writeHead(202).end(); | ||
| const message = JSON.parse(body); | ||
| if (message.method === 'initialize') { | ||
| write?.( | ||
| JSON.stringify({ | ||
| jsonrpc: '2.0', | ||
| id: message.id, | ||
| result: { | ||
| protocolVersion: LATEST_PROTOCOL_VERSION, | ||
| capabilities: { tools: {} }, | ||
| serverInfo: { name: 's', version: '1' } | ||
| } | ||
| }) | ||
| ); | ||
| } else if (message.method === 'tools/list') { | ||
| end?.(); // the server goes away before answering | ||
| } | ||
| }); | ||
| }); | ||
| await new Promise<void>(resolve => server.listen(0, '127.0.0.1', () => resolve())); | ||
| try { | ||
| const url = new URL(`http://127.0.0.1:${(server.address() as AddressInfo).port}/sse`); | ||
| const client = new Client({ name: 'c', version: '1' }); | ||
| client.onerror = () => {}; | ||
| const closed = new Promise<void>(resolve => (client.onclose = resolve)); | ||
| await client.connect(new SSEClientTransport(url)); | ||
|
|
||
| const pending = client.listTools(undefined, { timeout: 30_000 }); | ||
| await expect(pending).rejects.toMatchObject({ code: SdkErrorCode.ConnectionClosed }); | ||
| await closed; | ||
| expect(gets).toBe(2); | ||
| } finally { | ||
| server.close(); | ||
| } | ||
| }, 15_000); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If an application closes the client in
onerrorand starts reconnecting inonclose, this check executes after the error callback has already calledclose(). BecauseSSEClientTransport.close()leaves_eventSourceinCLOSEDand firesoncloseunconditionally, the helper closes the old transport again and runsProtocol._onclose()twice; the second call clears_transportfor the replacement connection started by the first callback. This also happens for transient errors that becomeCLOSEDonly because the application closed them. Guard against an already-closed transport, or makeclose()idempotent.Useful? React with 👍 / 👎.