Skip to content

Commit d73a757

Browse files
committed
feat: graceful SSE drain on session manager shutdown
Terminate all active transports before cancelling the task group during StreamableHTTPSessionManager shutdown. This closes their in-memory streams, allowing EventSourceResponse to send a final `more_body=False` chunk — a clean HTTP close instead of a connection reset. Without this, reverse proxies like nginx see "upstream prematurely closed connection" and return 502 to clients during rolling deploys. Changes: - Track in-flight stateless transports in `_stateless_transports` set - In `run()` finally block, call `terminate()` on all stateful and stateless transports before `tg.cancel_scope.cancel()` - Add E2E tests for both stateless and stateful modes that verify the SSE stream closes cleanly when the manager shuts down while a tool call is in-flight
1 parent 7ba41dc commit d73a757

2 files changed

Lines changed: 231 additions & 4 deletions

File tree

src/mcp/server/streamable_http_manager.py

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ def __init__(
9090
self._session_creation_lock = anyio.Lock()
9191
self._server_instances: dict[str, StreamableHTTPServerTransport] = {}
9292

93+
# Track in-flight stateless transports for graceful shutdown
94+
self._stateless_transports: set[StreamableHTTPServerTransport] = set()
95+
9396
# The task group will be set during lifespan
9497
self._task_group = None
9598
# Thread-safe tracking of run() calls
@@ -130,11 +133,28 @@ async def lifespan(app: Starlette) -> AsyncIterator[None]:
130133
yield # Let the application run
131134
finally:
132135
logger.info("StreamableHTTP session manager shutting down")
136+
137+
# Terminate all active transports before cancelling the task
138+
# group. This closes their in-memory streams, which lets
139+
# EventSourceResponse send a final ``more_body=False`` chunk
140+
# — a clean HTTP close instead of a connection reset.
141+
for transport in list(self._server_instances.values()):
142+
try:
143+
await transport.terminate()
144+
except Exception: # pragma: no cover
145+
logger.debug("Error terminating transport during shutdown", exc_info=True)
146+
for transport in list(self._stateless_transports):
147+
try:
148+
await transport.terminate()
149+
except Exception: # pragma: no cover
150+
logger.debug("Error terminating stateless transport during shutdown", exc_info=True)
151+
133152
# Cancel task group to stop all spawned tasks
134153
tg.cancel_scope.cancel()
135154
self._task_group = None
136155
# Clear any remaining server instances
137156
self._server_instances.clear()
157+
self._stateless_transports.clear()
138158

139159
async def handle_request(self, scope: Scope, receive: Receive, send: Send) -> None:
140160
"""Process ASGI request with proper session handling and transport setup.
@@ -161,6 +181,9 @@ async def _handle_stateless_request(self, scope: Scope, receive: Receive, send:
161181
security_settings=self.security_settings,
162182
)
163183

184+
# Track for graceful shutdown
185+
self._stateless_transports.add(http_transport)
186+
164187
# Start server in a new task
165188
async def run_stateless_server(*, task_status: TaskStatus[None] = anyio.TASK_STATUS_IGNORED):
166189
async with http_transport.connect() as streams:
@@ -181,8 +204,11 @@ async def run_stateless_server(*, task_status: TaskStatus[None] = anyio.TASK_STA
181204
# Start the server task
182205
await self._task_group.start(run_stateless_server)
183206

184-
# Handle the HTTP request and return the response
185-
await http_transport.handle_request(scope, receive, send)
207+
try:
208+
# Handle the HTTP request and return the response
209+
await http_transport.handle_request(scope, receive, send)
210+
finally:
211+
self._stateless_transports.discard(http_transport)
186212

187213
# Terminate the transport after the request is handled
188214
await http_transport.terminate()

tests/server/test_streamable_http_manager.py

Lines changed: 203 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
import pytest
1111
from starlette.types import Message
1212

13-
from mcp import Client
13+
from mcp import Client, types
1414
from mcp.client.streamable_http import streamable_http_client
1515
from mcp.server import Server, ServerRequestContext, streamable_http_manager
1616
from mcp.server.streamable_http import MCP_SESSION_ID_HEADER, StreamableHTTPServerTransport
17-
from mcp.server.streamable_http_manager import StreamableHTTPSessionManager
17+
from mcp.server.streamable_http_manager import StreamableHTTPASGIApp, StreamableHTTPSessionManager
1818
from mcp.types import INVALID_REQUEST, ListToolsResult, PaginatedRequestParams
1919

2020

@@ -413,3 +413,204 @@ def test_session_idle_timeout_rejects_non_positive():
413413
def test_session_idle_timeout_rejects_stateless():
414414
with pytest.raises(RuntimeError, match="not supported in stateless"):
415415
StreamableHTTPSessionManager(app=Server("test"), session_idle_timeout=30, stateless=True)
416+
417+
418+
MCP_HEADERS = {
419+
"Accept": "application/json, text/event-stream",
420+
"Content-Type": "application/json",
421+
}
422+
423+
_INITIALIZE_REQUEST = {
424+
"jsonrpc": "2.0",
425+
"id": 1,
426+
"method": "initialize",
427+
"params": {
428+
"protocolVersion": "2025-03-26",
429+
"capabilities": {},
430+
"clientInfo": {"name": "test", "version": "0.1"},
431+
},
432+
}
433+
434+
_INITIALIZED_NOTIFICATION = {
435+
"jsonrpc": "2.0",
436+
"method": "notifications/initialized",
437+
}
438+
439+
_TOOL_CALL_REQUEST = {
440+
"jsonrpc": "2.0",
441+
"id": 2,
442+
"method": "tools/call",
443+
"params": {"name": "slow_tool", "arguments": {"message": "hello"}},
444+
}
445+
446+
447+
def _make_slow_tool_server() -> tuple[Server, anyio.Event]:
448+
"""Create an MCP server with a tool that blocks forever, returning
449+
the server and an event that fires when the tool starts executing."""
450+
tool_started = anyio.Event()
451+
452+
async def handle_call_tool(ctx: ServerRequestContext, params: types.CallToolRequestParams) -> types.CallToolResult:
453+
tool_started.set()
454+
await anyio.sleep_forever()
455+
return types.CallToolResult( # pragma: no cover
456+
content=[types.TextContent(type="text", text="never reached")]
457+
)
458+
459+
async def handle_list_tools(
460+
ctx: ServerRequestContext, params: PaginatedRequestParams | None
461+
) -> ListToolsResult: # pragma: no cover
462+
return ListToolsResult(
463+
tools=[
464+
types.Tool(
465+
name="slow_tool",
466+
description="A tool that blocks forever",
467+
input_schema={"type": "object", "properties": {"message": {"type": "string"}}},
468+
)
469+
]
470+
)
471+
472+
app = Server("test-graceful-shutdown", on_call_tool=handle_call_tool, on_list_tools=handle_list_tools)
473+
return app, tool_started
474+
475+
476+
@pytest.mark.anyio
477+
async def test_graceful_shutdown_terminates_active_stateless_transports():
478+
"""Verify that shutting down the session manager terminates in-flight
479+
stateless transports so SSE streams close cleanly (``more_body=False``)
480+
instead of being abruptly cancelled.
481+
482+
This prevents "upstream prematurely closed connection" errors at reverse
483+
proxies like nginx.
484+
"""
485+
app, tool_started = _make_slow_tool_server()
486+
manager = StreamableHTTPSessionManager(app=app, stateless=True)
487+
488+
mcp_app = StreamableHTTPASGIApp(manager)
489+
490+
manager_ready = anyio.Event()
491+
shutdown_event = anyio.Event()
492+
stream_outcome: str | None = None
493+
494+
async with anyio.create_task_group() as tg:
495+
496+
async def run_lifespan_and_shutdown():
497+
async with manager.run():
498+
manager_ready.set()
499+
with anyio.fail_after(5):
500+
await tool_started.wait()
501+
shutdown_event.set()
502+
503+
async def make_requests():
504+
nonlocal stream_outcome
505+
with anyio.fail_after(5):
506+
await manager_ready.wait()
507+
async with (
508+
httpx.ASGITransport(mcp_app) as transport,
509+
httpx.AsyncClient(transport=transport, base_url="http://testserver") as client,
510+
):
511+
# Initialize
512+
resp = await client.post("/mcp/", json=_INITIALIZE_REQUEST, headers=MCP_HEADERS)
513+
resp.raise_for_status()
514+
515+
# Send initialized notification
516+
resp = await client.post("/mcp/", json=_INITIALIZED_NOTIFICATION, headers=MCP_HEADERS)
517+
assert resp.status_code == 202
518+
519+
# Send slow tool call — this returns an SSE stream
520+
try:
521+
async with client.stream(
522+
"POST",
523+
"/mcp/",
524+
json=_TOOL_CALL_REQUEST,
525+
headers=MCP_HEADERS,
526+
timeout=httpx.Timeout(10, connect=5),
527+
) as stream:
528+
stream.raise_for_status()
529+
async for _chunk in stream.aiter_bytes():
530+
pass # pragma: no cover
531+
stream_outcome = "clean"
532+
except httpx.RemoteProtocolError: # pragma: no cover
533+
stream_outcome = "reset"
534+
535+
tg.start_soon(run_lifespan_and_shutdown)
536+
tg.start_soon(make_requests)
537+
538+
with anyio.fail_after(10):
539+
await shutdown_event.wait()
540+
541+
tg.cancel_scope.cancel()
542+
543+
assert stream_outcome == "clean", f"Expected clean HTTP close, got {stream_outcome}"
544+
545+
546+
@pytest.mark.anyio
547+
async def test_graceful_shutdown_terminates_active_stateful_transports():
548+
"""Verify that shutting down the session manager terminates in-flight
549+
stateful transports so SSE streams close cleanly."""
550+
app, tool_started = _make_slow_tool_server()
551+
manager = StreamableHTTPSessionManager(app=app, stateless=False)
552+
553+
mcp_app = StreamableHTTPASGIApp(manager)
554+
555+
manager_ready = anyio.Event()
556+
shutdown_event = anyio.Event()
557+
stream_outcome: str | None = None
558+
559+
async with anyio.create_task_group() as tg:
560+
561+
async def run_lifespan_and_shutdown():
562+
async with manager.run():
563+
manager_ready.set()
564+
with anyio.fail_after(5):
565+
await tool_started.wait()
566+
shutdown_event.set()
567+
568+
async def make_requests():
569+
nonlocal stream_outcome
570+
with anyio.fail_after(5):
571+
await manager_ready.wait()
572+
async with (
573+
httpx.ASGITransport(mcp_app) as transport,
574+
httpx.AsyncClient(transport=transport, base_url="http://testserver") as client,
575+
):
576+
# Initialize (creates a session)
577+
resp = await client.post("/mcp/", json=_INITIALIZE_REQUEST, headers=MCP_HEADERS)
578+
resp.raise_for_status()
579+
session_id = resp.headers.get(MCP_SESSION_ID_HEADER)
580+
assert session_id is not None
581+
582+
session_headers = {
583+
**MCP_HEADERS,
584+
MCP_SESSION_ID_HEADER: session_id,
585+
"mcp-protocol-version": "2025-03-26",
586+
}
587+
588+
# Send initialized notification
589+
resp = await client.post("/mcp/", json=_INITIALIZED_NOTIFICATION, headers=session_headers)
590+
assert resp.status_code == 202
591+
592+
# Send slow tool call
593+
try:
594+
async with client.stream(
595+
"POST",
596+
"/mcp/",
597+
json=_TOOL_CALL_REQUEST,
598+
headers=session_headers,
599+
timeout=httpx.Timeout(10, connect=5),
600+
) as stream:
601+
stream.raise_for_status()
602+
async for _chunk in stream.aiter_bytes():
603+
pass # pragma: no cover
604+
stream_outcome = "clean"
605+
except httpx.RemoteProtocolError: # pragma: no cover
606+
stream_outcome = "reset"
607+
608+
tg.start_soon(run_lifespan_and_shutdown)
609+
tg.start_soon(make_requests)
610+
611+
with anyio.fail_after(10):
612+
await shutdown_event.wait()
613+
614+
tg.cancel_scope.cancel()
615+
616+
assert stream_outcome == "clean", f"Expected clean HTTP close, got {stream_outcome}"

0 commit comments

Comments
 (0)