modelcontextprotocol/ruby-sdk
Watch
1
0
Fork
You've already forked ruby-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #296 from koic/rename_session_stream_key

Browse source 
Rename `session[:stream]` to `session[:get_sse_stream]`
This commit is contained in:
Koichi ITO 2026-04-06 03:30:22 +09:00 • committed by GitHub
commit ba79d53c97
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

30
lib/mcp/server/transports/streamable_http_transport.rb
View file

@ -15,7 +15,7 @@ module MCP
def initialize(server, stateless: false, session_idle_timeout: nil) def initialize(server, stateless: false, session_idle_timeout: nil)
super(server) super(server)
# Maps `session_id` to `{ stream: stream_object, server_session: ServerSession, last_active_at: float_from_monotonic_clock }`. # Maps `session_id` to `{ get_sse_stream: stream_object, server_session: ServerSession, last_active_at: float_from_monotonic_clock }`.
@sessions = {} @sessions = {}
@mutex = Mutex.new @mutex = Mutex.new
@ -61,7 +61,7 @@ module MCP
end end
removed_sessions.each do |session| removed_sessions.each do |session|
close_stream_safely(session[:stream]) close_stream_safely(session[:get_sse_stream])
close_post_request_streams(session) close_post_request_streams(session)
end end
end end
@ -113,7 +113,7 @@ module MCP
failed_sessions = [] failed_sessions = []
@sessions.each do |sid, session| @sessions.each do |sid, session|
next unless (stream = session[:stream]) next unless (stream = session[:get_sse_stream])
if session_expired?(session) if session_expired?(session)
failed_sessions << sid failed_sessions << sid
@ -247,7 +247,7 @@ module MCP
end end
removed_sessions.each do |session| removed_sessions.each do |session|
close_stream_safely(session[:stream]) close_stream_safely(session[:get_sse_stream])
close_post_request_streams(session) close_post_request_streams(session)
end end
end end
@ -334,7 +334,7 @@ module MCP
end end
if session if session
close_stream_safely(session[:stream]) close_stream_safely(session[:get_sse_stream])
close_post_request_streams(session) close_post_request_streams(session)
end end
end end
@ -358,7 +358,7 @@ module MCP
def cleanup_and_collect_stream(session_id, streams_to_close) def cleanup_and_collect_stream(session_id, streams_to_close)
return unless (removed = cleanup_session_unsafe(session_id)) return unless (removed = cleanup_session_unsafe(session_id))
streams_to_close << removed[:stream] streams_to_close << removed[:get_sse_stream]
removed[:post_request_streams]&.each_value { |stream| streams_to_close << stream } removed[:post_request_streams]&.each_value { |stream| streams_to_close << stream }
end end
@ -449,7 +449,7 @@ module MCP
@mutex.synchronize do @mutex.synchronize do
@sessions[session_id] = { @sessions[session_id] = {
stream: nil, get_sse_stream: nil,
server_session: server_session, server_session: server_session,
last_active_at: Process.clock_gettime(Process::CLOCK_MONOTONIC), last_active_at: Process.clock_gettime(Process::CLOCK_MONOTONIC),
} }
@ -543,7 +543,7 @@ module MCP
if related_request_id if related_request_id
session.dig(:post_request_streams, related_request_id) session.dig(:post_request_streams, related_request_id)
else else
session[:stream] session[:get_sse_stream]
end end
end end
@ -572,7 +572,7 @@ module MCP
end end
if removed if removed
close_stream_safely(removed[:stream]) close_stream_safely(removed[:get_sse_stream])
removed[:post_request_streams]&.each_value do |stream| removed[:post_request_streams]&.each_value do |stream|
close_stream_safely(stream) close_stream_safely(stream)
@ -583,7 +583,7 @@ module MCP
end end
def get_session_stream(session_id) def get_session_stream(session_id)
@mutex.synchronize { @sessions[session_id]&.fetch(:stream, nil) } @mutex.synchronize { @sessions[session_id]&.fetch(:get_sse_stream, nil) }
end end
def session_exists?(session_id) def session_exists?(session_id)
@ -626,8 +626,8 @@ module MCP
def store_stream_for_session(session_id, stream) def store_stream_for_session(session_id, stream)
@mutex.synchronize do @mutex.synchronize do
session = @sessions[session_id] session = @sessions[session_id]
if session && !session[:stream] if session && !session[:get_sse_stream]
session[:stream] = stream session[:get_sse_stream] = stream
else else
# Either session was removed, or another request already established a stream. # Either session was removed, or another request already established a stream.
stream.close stream.close
@ -652,13 +652,13 @@ module MCP
end end
def session_active_with_stream?(session_id) def session_active_with_stream?(session_id)
@mutex.synchronize { @sessions.key?(session_id) && @sessions[session_id][:stream] } @mutex.synchronize { @sessions.key?(session_id) && @sessions[session_id][:get_sse_stream] }
end end
def send_keepalive_ping(session_id) def send_keepalive_ping(session_id)
@mutex.synchronize do @mutex.synchronize do
if @sessions[session_id] && @sessions[session_id][:stream] if @sessions[session_id] && @sessions[session_id][:get_sse_stream]
send_ping_to_stream(@sessions[session_id][:stream]) send_ping_to_stream(@sessions[session_id][:get_sse_stream])
end end
end end
rescue *STREAM_WRITE_ERRORS => e rescue *STREAM_WRITE_ERRORS => e

14
test/mcp/server/transports/streamable_http_transport_test.rb
View file

@ -346,7 +346,7 @@ module MCP
# Simulate an active SSE stream by storing a stream object in the session # Simulate an active SSE stream by storing a stream object in the session
mock_stream = StringIO.new mock_stream = StringIO.new
@transport.instance_variable_get(:@sessions)[session_id][:stream] = mock_stream @transport.instance_variable_get(:@sessions)[session_id][:get_sse_stream] = mock_stream
# Attempt a second GET request for the same session # Attempt a second GET request for the same session
get_request = create_rack_request( get_request = create_rack_request(
@ -377,14 +377,14 @@ module MCP
# Establish stream A # Establish stream A
stream_a = StringIO.new stream_a = StringIO.new
@transport.send(:store_stream_for_session, session_id, stream_a) @transport.send(:store_stream_for_session, session_id, stream_a)
assert_equal stream_a, @transport.instance_variable_get(:@sessions)[session_id][:stream] assert_equal stream_a, @transport.instance_variable_get(:@sessions)[session_id][:get_sse_stream]
# Attempt to store stream B (simulating a racing request) # Attempt to store stream B (simulating a racing request)
stream_b = StringIO.new stream_b = StringIO.new
@transport.send(:store_stream_for_session, session_id, stream_b) @transport.send(:store_stream_for_session, session_id, stream_b)
# Stream A should still be the active stream # Stream A should still be the active stream
assert_equal stream_a, @transport.instance_variable_get(:@sessions)[session_id][:stream] assert_equal stream_a, @transport.instance_variable_get(:@sessions)[session_id][:get_sse_stream]
# Stream B should have been closed # Stream B should have been closed
assert stream_b.closed? assert stream_b.closed?
@ -928,7 +928,7 @@ module MCP
end end
end end
@transport.instance_variable_get(:@sessions)[session_id][:stream] = mock_stream @transport.instance_variable_get(:@sessions)[session_id][:get_sse_stream] = mock_stream
result = @transport.send_notification("test", { message: "test" }, session_id: session_id) result = @transport.send_notification("test", { message: "test" }, session_id: session_id)
@ -973,7 +973,7 @@ module MCP
# The broken request_stream should be removed. # The broken request_stream should be removed.
refute @transport.instance_variable_get(:@sessions)[session_id][:post_request_streams].key?(related_id) refute @transport.instance_variable_get(:@sessions)[session_id][:post_request_streams].key?(related_id)
# GET SSE stream should still be intact. # GET SSE stream should still be intact.
assert @transport.instance_variable_get(:@sessions)[session_id][:stream] assert @transport.instance_variable_get(:@sessions)[session_id][:get_sse_stream]
end end
test "active_stream does not fall back to GET SSE when related_request_id is given but request_stream is missing" do test "active_stream does not fall back to GET SSE when related_request_id is given but request_stream is missing" do
@ -2378,7 +2378,7 @@ module MCP
mutex.unlock mutex.unlock
end end
end end
transport.instance_variable_get(:@sessions)[session_id][:stream] = mock_stream transport.instance_variable_get(:@sessions)[session_id][:get_sse_stream] = mock_stream
sleep(0.02) # Wait for session to expire. sleep(0.02) # Wait for session to expire.
@ -2495,7 +2495,7 @@ module MCP
# Attach a mock stream to the session # Attach a mock stream to the session
stream = StringIO.new stream = StringIO.new
transport.instance_variable_get(:@sessions)[session_id][:stream] = stream transport.instance_variable_get(:@sessions)[session_id][:get_sse_stream] = stream
# Wait for the session to exceed the idle timeout (0.01s) # Wait for the session to exceed the idle timeout (0.01s)
sleep(0.02) sleep(0.02)