## Motivation and Context The Ruby SDK uses a 1-Server-to-many-sessions model where session-specific state (`@client`, `@logging_message_notification`) is stored on the shared `Server` instance. This causes the last client to connect to overwrite state for all sessions, and requires `session_id` to be threaded through method signatures for session-scoped notifications. The Python SDK avoids this by creating a `ServerSession` per connection that wraps a shared `Server`. Each session holds its own state and naturally scopes notifications through its own stream. ### Changes - Added `MCP::ServerSession` class holding per-session state: client info, logging configuration, and a `transport` reference for session-scoped notification delivery. - `StreamableHTTPTransport#handle_initialization` creates a `ServerSession` per `initialize` request and stores it in the session hash. - `handle_regular_request` routes requests through the session's `ServerSession` instead of the shared `Server` directly. - `Server#handle` and `Server#handle_json` accept an optional `session:` keyword (`ServerSession` instance). - `Server#init` stores client info on the session when available. - `Server#configure_logging_level` stores logging config on the session. - `ServerContext` and `Progress` accept a `notification_target:` which can be either a `ServerSession` (session-scoped) or a `Server` (broadcast). No `session_id:` parameter needed. - `ServerContext#notify_progress` and `#notify_log_message` delegate to the `notification_target` without `session_id` threading. - `StdioTransport` creates a single `ServerSession` on `open`, making the session model transparent across both transports. ### Design Decision This follows the Python SDK's "shared `Server` + per-connection `Session`" pattern. The `Server` holds configuration (tools, prompts, resources, handlers). Each `ServerSession` holds per-connection state (client info, logging level, stream writer). Notifications from `ServerSession` go only to that session's stream. ## How Has This Been Tested? All existing tests pass. All conformance tests pass. Added tests verifying: - Session-scoped log notification is sent only to the originating session. - Session-scoped progress notification is sent only to the originating session. - Each session stores its own client info independently. - Each session stores its own logging level independently. - `StdioTransport#open` creates a `ServerSession` and stores client info on it. ## Breaking Change None for end users. The public API (`Server.new`, `define_tool`,`server_context.report_progress`, `server_context.notify_log_message`, etc.) is unchanged. The following internal API changes affect only SDK internals: - `ServerContext.new` now requires `notification_target:` instead of just`progress:`. - `Progress.new` now takes `notification_target:` instead of `server:`. - `Server#handle` and `Server#handle_json` accept an optional `session:` keyword.
197 lines
7.9 KiB
Ruby
197 lines
7.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "test_helper"
|
|
|
|
module MCP
|
|
class ServerNotificationTest < ActiveSupport::TestCase
|
|
include InstrumentationTestHelper
|
|
|
|
class MockTransport < Transport
|
|
attr_reader :notifications
|
|
|
|
def initialize(server)
|
|
super
|
|
@notifications = []
|
|
end
|
|
|
|
def send_notification(method, params = nil)
|
|
@notifications << { method: method, params: params }
|
|
true
|
|
end
|
|
|
|
def send_response(response); end
|
|
def open; end
|
|
def close; end
|
|
def handle_request(request); end
|
|
end
|
|
|
|
setup do
|
|
configuration = MCP::Configuration.new
|
|
configuration.instrumentation_callback = instrumentation_helper.callback
|
|
|
|
@server = Server.new(
|
|
name: "test_server",
|
|
version: "1.0.0",
|
|
configuration: configuration,
|
|
)
|
|
|
|
@mock_transport = MockTransport.new(@server)
|
|
@server.transport = @mock_transport
|
|
end
|
|
|
|
test "#notify_tools_list_changed sends notification through transport" do
|
|
@server.notify_tools_list_changed
|
|
|
|
assert_equal 1, @mock_transport.notifications.size
|
|
notification = @mock_transport.notifications.first
|
|
assert_equal Methods::NOTIFICATIONS_TOOLS_LIST_CHANGED, notification[:method]
|
|
assert_nil notification[:params]
|
|
end
|
|
|
|
test "#notify_prompts_list_changed sends notification through transport" do
|
|
@server.notify_prompts_list_changed
|
|
|
|
assert_equal 1, @mock_transport.notifications.size
|
|
notification = @mock_transport.notifications.first
|
|
assert_equal Methods::NOTIFICATIONS_PROMPTS_LIST_CHANGED, notification[:method]
|
|
assert_nil notification[:params]
|
|
end
|
|
|
|
test "#notify_resources_list_changed sends notification through transport" do
|
|
@server.notify_resources_list_changed
|
|
|
|
assert_equal 1, @mock_transport.notifications.size
|
|
notification = @mock_transport.notifications.first
|
|
assert_equal Methods::NOTIFICATIONS_RESOURCES_LIST_CHANGED, notification[:method]
|
|
assert_nil notification[:params]
|
|
end
|
|
|
|
test "#notify_log_message sends notification through transport" do
|
|
@server.logging_message_notification = MCP::LoggingMessageNotification.new(level: "error")
|
|
@server.notify_log_message(data: { error: "Connection Failed" }, level: "error")
|
|
|
|
assert_equal 1, @mock_transport.notifications.size
|
|
assert_equal Methods::NOTIFICATIONS_MESSAGE, @mock_transport.notifications.first[:method]
|
|
assert_equal({ "data" => { error: "Connection Failed" }, "level" => "error" }, @mock_transport.notifications.first[:params])
|
|
end
|
|
|
|
test "#notify_log_message sends notification with logger through transport" do
|
|
@server.logging_message_notification = MCP::LoggingMessageNotification.new(level: "error")
|
|
@server.notify_log_message(data: { error: "Connection Failed" }, level: "error", logger: "DatabaseLogger")
|
|
|
|
assert_equal 1, @mock_transport.notifications.size
|
|
notification = @mock_transport.notifications.first
|
|
assert_equal Methods::NOTIFICATIONS_MESSAGE, notification[:method]
|
|
assert_equal({ "data" => { error: "Connection Failed" }, "level" => "error", "logger" => "DatabaseLogger" }, notification[:params])
|
|
end
|
|
|
|
test "#notify_log_message does not send notification with invalid log level" do
|
|
@server.logging_message_notification = MCP::LoggingMessageNotification.new(level: "error")
|
|
@server.notify_log_message(data: { message: "test" }, level: "invalid")
|
|
|
|
assert_equal 0, @mock_transport.notifications.size
|
|
end
|
|
|
|
test "#notify_log_message does not send notification when level is below configured level" do
|
|
@server.logging_message_notification = MCP::LoggingMessageNotification.new(level: "error")
|
|
@server.notify_log_message(data: { message: "test" }, level: "info")
|
|
|
|
assert_equal 0, @mock_transport.notifications.size
|
|
end
|
|
|
|
test "#notify_log_message sends notification when level is above configured level through transport" do
|
|
@server.logging_message_notification = MCP::LoggingMessageNotification.new(level: "error")
|
|
@server.notify_log_message(data: { message: "test" }, level: "critical")
|
|
|
|
assert_equal 1, @mock_transport.notifications.size
|
|
assert_equal Methods::NOTIFICATIONS_MESSAGE, @mock_transport.notifications[0][:method]
|
|
assert_equal({ "data" => { message: "test" }, "level" => "critical" }, @mock_transport.notifications[0][:params])
|
|
end
|
|
|
|
test "notification methods work without transport" do
|
|
server_without_transport = Server.new(name: "test_server")
|
|
server_without_transport.logging_message_notification = MCP::LoggingMessageNotification.new(level: "error")
|
|
|
|
# Should not raise any errors
|
|
assert_nothing_raised do
|
|
server_without_transport.notify_tools_list_changed
|
|
server_without_transport.notify_prompts_list_changed
|
|
server_without_transport.notify_resources_list_changed
|
|
server_without_transport.notify_log_message(data: { error: "Connection Failed" }, level: "error")
|
|
end
|
|
end
|
|
|
|
test "notification methods handle transport errors gracefully" do
|
|
# Create a transport that raises errors
|
|
error_transport = Class.new(MockTransport) do
|
|
def send_notification(method, params = nil)
|
|
raise StandardError, "Transport error"
|
|
end
|
|
end.new(@server)
|
|
|
|
@server.transport = error_transport
|
|
@server.logging_message_notification = MCP::LoggingMessageNotification.new(level: "error")
|
|
|
|
# Mock the exception reporter
|
|
expected_contexts = [
|
|
{ notification: "tools_list_changed" },
|
|
{ notification: "prompts_list_changed" },
|
|
{ notification: "resources_list_changed" },
|
|
{ notification: "log_message" },
|
|
]
|
|
|
|
call_count = 0
|
|
@server.configuration.exception_reporter.expects(:call).times(4).with do |exception, context|
|
|
assert_kind_of StandardError, exception
|
|
assert_equal "Transport error", exception.message
|
|
assert_includes expected_contexts, context
|
|
call_count += 1
|
|
true
|
|
end
|
|
|
|
# Should not raise errors to the caller
|
|
assert_nothing_raised do
|
|
@server.notify_tools_list_changed
|
|
@server.notify_prompts_list_changed
|
|
@server.notify_resources_list_changed
|
|
@server.notify_log_message(data: { error: "Connection Failed" }, level: "error")
|
|
end
|
|
|
|
assert_equal 4, call_count
|
|
end
|
|
|
|
test "multiple notification methods can be called in sequence" do
|
|
@server.notify_tools_list_changed
|
|
@server.notify_prompts_list_changed
|
|
@server.notify_resources_list_changed
|
|
@server.logging_message_notification = MCP::LoggingMessageNotification.new(level: "error")
|
|
@server.notify_log_message(data: { error: "Connection Failed" }, level: "error")
|
|
|
|
assert_equal 4, @mock_transport.notifications.size
|
|
|
|
notifications = @mock_transport.notifications
|
|
assert_equal Methods::NOTIFICATIONS_TOOLS_LIST_CHANGED, notifications[0][:method]
|
|
assert_equal Methods::NOTIFICATIONS_PROMPTS_LIST_CHANGED, notifications[1][:method]
|
|
assert_equal Methods::NOTIFICATIONS_RESOURCES_LIST_CHANGED, notifications[2][:method]
|
|
assert_equal Methods::NOTIFICATIONS_MESSAGE, notifications[3][:method]
|
|
end
|
|
|
|
test "server.notify_log_message works after logging/setLevel via session" do
|
|
session = ServerSession.new(server: @server, transport: @mock_transport)
|
|
|
|
# Client sends logging/setLevel through session.
|
|
@server.handle(
|
|
{ jsonrpc: "2.0", id: 1, method: "logging/setLevel", params: { level: "info" } },
|
|
session: session,
|
|
)
|
|
|
|
# Server-level broadcast should still work because logging level
|
|
# is stored on both the session and the server.
|
|
@server.notify_log_message(data: "broadcast log", level: "info")
|
|
|
|
log_notifications = @mock_transport.notifications.select { |n| n[:method] == Methods::NOTIFICATIONS_MESSAGE }
|
|
assert_equal 1, log_notifications.size
|
|
assert_equal "broadcast log", log_notifications.first[:params]["data"]
|
|
end
|
|
end
|
|
end
|