php-sdk/tests/Unit/Server/ProtocolTest.php
Valeriu Gutu 1961414432
[Schema][Server] Preserve request id in JSON-RPC error responses instead of fabricating id:"" (#379)
* Preserve request id in JSON-RPC error responses instead of fabricating id:""

When the server received input it could not turn into a valid message, the
error response carried a fabricated empty-string id that was never in the
request, breaking JSON-RPC client correlation.

The id default for the error factories was '' and that default reached the
wire unchanged: unrecoverable parse errors emitted id:"", and for invalid-
but-parseable messages MessageFactory discarded the decoded id so it also
fell back to "".

Now unrecoverable parse errors (-32700) return id: null per JSON-RPC 2.0,
and invalid-but-parseable requests (-32600) preserve the original request
id. Error::$id / getId() and the $id parameter of forParseError() /
forInvalidRequest() are widened to string|int|null, and the recoverable id
is threaded through InvalidInputMessageException.

Fixes #333

* Preserve nullable request id consistently across Error factories and fromArray

- Widen the remaining for*() factories (forMethodNotFound, forInvalidParams,
  forInternalError, forServerError, forResourceNotFound) to string|int|null
  defaulting to null, so no error path can fabricate id:"" again. The only
  defaulting call site (ProtocolVersionMiddleware) now emits id:null instead
  of id:"" for a pre-parse rejection, which is the spec-correct value.
- Accept a null id in Error::fromArray(): require the id key to be present
  (JSON-RPC responses must carry it) but allow its value to be null, so a
  spec-compliant id:null error response round-trips and incoming error
  responses with id:null are accepted instead of rejected.
- Widen the @phpstan-type ErrorData id to string|int|null to match the ctor,
  getId(), and jsonSerialize() shape.

* Document intentional id recovery guard in MessageFactory

* Cover id: 0 and string ids in recoverable-id preservation test

* Fixed client handling of null-id error responses
2026-08-18 15:47:27 +02:00

1592 lines
60 KiB
PHP

<?php
/*
* This file is part of the official PHP MCP SDK.
*
* A collaboration between Symfony and the PHP Foundation.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Mcp\Tests\Unit\Server;
use Mcp\Event\ErrorEvent;
use Mcp\Event\NotificationEvent;
use Mcp\Event\RequestEvent;
use Mcp\Event\ResponseEvent;
use Mcp\JsonRpc\MessageFactory;
use Mcp\Schema\Enum\LoggingLevel;
use Mcp\Schema\JsonRpc\Error;
use Mcp\Schema\JsonRpc\Response;
use Mcp\Schema\Notification\LoggingMessageNotification;
use Mcp\Schema\Request\CallToolRequest;
use Mcp\Schema\Request\PingRequest;
use Mcp\Server\Handler\Notification\NotificationHandlerInterface;
use Mcp\Server\Handler\Request\RequestHandlerInterface;
use Mcp\Server\Protocol;
use Mcp\Server\Session\SessionInterface;
use Mcp\Server\Session\SessionManagerInterface;
use Mcp\Server\Transport\TransportInterface;
use Mcp\Tests\Unit\Fixtures\ThrowingRequest;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\TestDox;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use Psr\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Uid\Uuid;
final class ProtocolTest extends TestCase
{
private MockObject&SessionManagerInterface $sessionManager;
/** @var MockObject&TransportInterface<mixed> */
private MockObject&TransportInterface $transport;
protected function setUp(): void
{
$this->sessionManager = $this->createMock(SessionManagerInterface::class);
$this->transport = $this->createMock(TransportInterface::class);
}
#[TestDox('A single notification can be handled by multiple handlers')]
public function testNotificationHandledByMultipleHandlers(): void
{
$handlerA = $this->createMock(NotificationHandlerInterface::class);
$handlerA->method('supports')->willReturn(true);
$handlerA->expects($this->once())->method('handle');
$handlerB = $this->createMock(NotificationHandlerInterface::class);
$handlerB->method('supports')->willReturn(false);
$handlerB->expects($this->never())->method('handle');
$handlerC = $this->createMock(NotificationHandlerInterface::class);
$handlerC->method('supports')->willReturn(true);
$handlerC->expects($this->once())->method('handle');
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [$handlerA, $handlerB, $handlerC],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "notifications/initialized"}',
$sessionId
);
}
#[TestDox('An id-less error response from the client is logged and ignored, not stored under a collapsed session key')]
public function testIdLessErrorResponseIsIgnored(): void
{
$session = $this->createMock(SessionInterface::class);
$session->expects($this->never())->method('set');
$this->sessionManager->method('exists')->willReturn(true);
$this->sessionManager->method('createWithId')->willReturn($session);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "error": {"code": -32700, "message": "Parse error"}}',
$sessionId
);
}
#[TestDox('A single request is handled only by the first matching handler')]
public function testRequestHandledByFirstMatchingHandler(): void
{
$handlerA = $this->createMock(RequestHandlerInterface::class);
$handlerA->method('supports')->willReturn(true);
$handlerA->expects($this->once())->method('handle')->willReturn(new Response(1, ['result' => 'success']));
$handlerB = $this->createMock(RequestHandlerInterface::class);
$handlerB->method('supports')->willReturn(false);
$handlerB->expects($this->never())->method('handle');
$handlerC = $this->createMock(RequestHandlerInterface::class);
$handlerC->method('supports')->willReturn(true);
$handlerC->expects($this->never())->method('handle');
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$session->method('getId')->willReturn(Uuid::v4());
// Configure session mock for queue operations
$queue = [];
$session->method('get')->willReturnCallback(static function ($key, $default = null) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
return $queue;
}
return $default;
});
$session->method('set')->willReturnCallback(static function ($key, $value) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
$queue = $value;
}
});
// The protocol now queues responses instead of sending them directly
// save() is called once during processInput and once during consumeOutgoingMessages
$session->expects($this->exactly(2))
->method('save');
$protocol = new Protocol(
requestHandlers: [$handlerA, $handlerB, $handlerC],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}',
$sessionId
);
// Check that the response was queued in the session
$outgoing = $protocol->consumeOutgoingMessages($sessionId);
$this->assertCount(1, $outgoing);
$message = json_decode($outgoing[0]['message'], true);
$this->assertArrayHasKey('result', $message);
}
#[TestDox('Initialize request must not have a session ID')]
public function testInitializeRequestWithSessionIdReturnsError(): void
{
$this->transport->expects($this->once())
->method('send')
->with(
$this->callback(static function ($data) {
$decoded = json_decode($data, true);
return isset($decoded['error'])
&& str_contains($decoded['error']['message'], 'session ID MUST NOT be sent');
}),
$this->anything()
);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": {"name": "test", "version": "1.0"}}}',
$sessionId
);
}
#[TestDox('Initialize request must not be part of a batch')]
public function testInitializeRequestInBatchReturnsError(): void
{
$this->transport->expects($this->once())
->method('send')
->with(
$this->callback(static function ($data) {
$decoded = json_decode($data, true);
return isset($decoded['error'])
&& str_contains($decoded['error']['message'], 'MUST NOT be part of a batch');
}),
$this->anything()
);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$protocol->processInput(
$this->transport,
'[{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": {"name": "test", "version": "1.0"}}}, {"jsonrpc": "2.0", "method": "ping", "id": 2}]',
null
);
}
#[TestDox('Non-initialize requests require a session ID')]
public function testNonInitializeRequestWithoutSessionIdReturnsError(): void
{
$this->transport->expects($this->once())
->method('send')
->with(
$this->callback(static function ($data) {
$decoded = json_decode($data, true);
return isset($decoded['error'])
&& str_contains($decoded['error']['message'], 'session id is REQUIRED');
}),
$this->callback(static function ($context) {
return isset($context['status_code']) && 400 === $context['status_code'];
})
);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}',
null
);
}
#[TestDox('Non-existent session ID returns error')]
public function testNonExistentSessionIdReturnsError(): void
{
$this->sessionManager->method('exists')->willReturn(false);
$this->transport->expects($this->once())
->method('send')
->with(
$this->callback(static function ($data) {
$decoded = json_decode($data, true);
return isset($decoded['error'])
&& str_contains($decoded['error']['message'], 'Session not found or has expired');
}),
$this->callback(static function ($context) {
return isset($context['status_code']) && 404 === $context['status_code'];
})
);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}',
$sessionId
);
}
#[TestDox('Invalid JSON returns parse error')]
public function testInvalidJsonReturnsParseError(): void
{
$this->transport->expects($this->once())
->method('send')
->with(
$this->callback(static function ($data) {
$decoded = json_decode($data, true);
return isset($decoded['error'])
&& Error::PARSE_ERROR === $decoded['error']['code'];
}),
$this->anything()
);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$protocol->processInput(
$this->transport,
'invalid json',
null
);
}
#[TestDox('Unrecoverable parse error does not fabricate an empty-string id')]
public function testParseErrorDoesNotFabricateEmptyStringId(): void
{
$sentPayload = null;
$this->transport->expects($this->once())
->method('send')
->willReturnCallback(static function ($data) use (&$sentPayload) {
$sentPayload = $data;
});
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
// Well-formed JSON nested past PHP's json_decode() depth limit (512), mirroring
// issue #333: json_decode() throws "Maximum stack depth exceeded" so the request
// carries a real numeric id (900512) that cannot be recovered once decoding fails.
$deeplyNested = str_repeat('[', 600).str_repeat(']', 600);
$input = '{"jsonrpc":"2.0","id":900512,"method":"initialize","params":'.$deeplyNested.'}';
$protocol->processInput($this->transport, $input, null);
$this->assertNotNull($sentPayload);
$decoded = json_decode($sentPayload, true);
$this->assertSame(Error::PARSE_ERROR, $decoded['error']['code']);
// The original id is genuinely unrecoverable after a parse failure: it must never be
// fabricated as an empty string, and — per the MCP `RequestId` schema, which never
// allows `null` — the key must be omitted rather than sent as `id: null`.
$this->assertArrayNotHasKey('id', $decoded, 'Unrecoverable parse error must omit id, not fabricate one');
}
#[TestDox('Invalid message structure returns error')]
public function testInvalidMessageStructureReturnsError(): void
{
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
// Configure session mock for queue operations
$queue = [];
$session->method('get')->willReturnCallback(static function ($key, $default = null) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
return $queue;
}
return $default;
});
$session->method('set')->willReturnCallback(static function ($key, $value) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
$queue = $value;
}
});
// The protocol now queues responses instead of sending them directly
// save() is called once during processInput and once during consumeOutgoingMessages
$session->expects($this->exactly(2))
->method('save');
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "params": {}}',
$sessionId
);
// Check that the error was queued in the session
$outgoing = $protocol->consumeOutgoingMessages($sessionId);
$this->assertCount(1, $outgoing);
$message = json_decode($outgoing[0]['message'], true);
$this->assertArrayHasKey('error', $message);
$this->assertEquals(Error::INVALID_REQUEST, $message['error']['code']);
}
#[TestDox('An unexpected throwable while creating a message returns an internal error under its id')]
public function testUnexpectedThrowableWhileCreatingMessagesReturnsInternalError(): void
{
$sent = null;
$this->transport->expects($this->once())
->method('send')
->willReturnCallback(static function ($data) use (&$sent) {
$sent = $data;
});
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: new MessageFactory([ThrowingRequest::class]),
sessionManager: $this->sessionManager,
);
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "id": 1, "method": "test/throwing"}',
Uuid::v4()
);
$decoded = json_decode((string) $sent, true);
$this->assertSame(Error::INTERNAL_ERROR, $decoded['error']['code']);
$this->assertSame(1, $decoded['id'], 'The peer must be able to correlate the failure with its request.');
$this->assertStringNotContainsString('must not leak', $decoded['error']['message']);
}
#[TestDox('A batch that fails to hydrate is answered once, under the empty id')]
public function testBatchThatFailsToHydrateIsAnsweredOnce(): void
{
$sent = [];
$this->transport->method('send')->willReturnCallback(static function ($data) use (&$sent) {
$sent[] = $data;
});
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: new MessageFactory([PingRequest::class, ThrowingRequest::class]),
sessionManager: $this->sessionManager,
);
$protocol->processInput(
$this->transport,
'[{"jsonrpc": "2.0", "id": 1, "method": "ping"}, {"jsonrpc": "2.0", "id": 2, "method": "test/throwing"}]',
Uuid::v4()
);
$this->assertCount(1, $sent);
$decoded = json_decode($sent[0], true);
$this->assertSame(Error::INTERNAL_ERROR, $decoded['error']['code']);
$this->assertSame('', $decoded['id'], 'The failure cannot be attributed to one request of the batch.');
}
#[TestDox('A batch holding only notifications is not answered when processing fails')]
public function testBatchOfNotificationsIsNotAnsweredWhenProcessingFails(): void
{
$session = $this->createMock(SessionInterface::class);
$session->method('save')->willThrowException(new \RuntimeException('storage is gone'));
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$this->transport->expects($this->never())->method('send');
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$protocol->processInput(
$this->transport,
'[{"jsonrpc": "2.0", "method": "notifications/initialized"}]',
Uuid::v4()
);
}
#[TestDox('An unexpected throwable while saving the session does not answer a notification')]
public function testUnexpectedThrowableWhileSavingSessionDoesNotEscape(): void
{
$session = $this->createMock(SessionInterface::class);
$session->method('save')->willThrowException(new \RuntimeException('storage is gone'));
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
// JSON-RPC forbids answering a notification, so the failure is only logged.
$this->transport->expects($this->never())->method('send');
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "notifications/initialized"}',
Uuid::v4()
);
}
#[TestDox('A failing notification event listener does not produce a response')]
public function testFailingNotificationListenerDoesNotProduceResponse(): void
{
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$queue = [];
$session->method('get')->willReturnCallback(static function ($key, $default = null) use (&$queue) {
return '_mcp.outgoing_queue' === $key ? $queue : $default;
});
$session->method('set')->willReturnCallback(static function ($key, $value) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
$queue = $value;
}
});
$dispatcher = $this->createMock(EventDispatcherInterface::class);
$dispatcher->method('dispatch')->willReturnCallback(static function ($event) {
if ($event instanceof NotificationEvent) {
throw new \RuntimeException('listener blew up');
}
return $event;
});
$this->transport->expects($this->never())->method('send');
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $dispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "notifications/initialized"}',
$sessionId
);
$this->assertSame([], $protocol->consumeOutgoingMessages($sessionId));
}
/**
* @return iterable<string, array{string, string|int}>
*/
public static function recoverableIdProvider(): iterable
{
yield 'positive int' => ['{"jsonrpc": "2.0", "id": 42, "params": {}}', 42];
yield 'zero int (truthiness trap)' => ['{"jsonrpc": "2.0", "id": 0, "params": {}}', 0];
yield 'string id' => ['{"jsonrpc": "2.0", "id": "req-1", "params": {}}', 'req-1'];
}
#[DataProvider('recoverableIdProvider')]
#[TestDox('Invalid but parseable message preserves its recoverable id')]
public function testInvalidMessagePreservesRecoverableId(string $input, string|int $expectedId): void
{
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
// Configure session mock for queue operations (mirrors testInvalidMessageStructureReturnsError).
$queue = [];
$session->method('get')->willReturnCallback(static function ($key, $default = null) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
return $queue;
}
return $default;
});
$session->method('set')->willReturnCallback(static function ($key, $value) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
$queue = $value;
}
});
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
// Valid JSON carrying a real id but missing method/result/error: the message is
// structurally invalid, yet its id IS recoverable from the decoded payload.
$protocol->processInput(
$this->transport,
$input,
$sessionId
);
$outgoing = $protocol->consumeOutgoingMessages($sessionId);
$this->assertCount(1, $outgoing);
$message = json_decode($outgoing[0]['message'], true);
$this->assertArrayHasKey('error', $message);
$this->assertEquals(Error::INVALID_REQUEST, $message['error']['code']);
$this->assertSame($expectedId, $message['id'], 'Invalid-but-parseable message must preserve its recoverable id, not return ""');
}
#[TestDox('Request without handler returns method not found error')]
public function testRequestWithoutHandlerReturnsMethodNotFoundError(): void
{
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
// Configure session mock for queue operations
$queue = [];
$session->method('get')->willReturnCallback(static function ($key, $default = null) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
return $queue;
}
return $default;
});
$session->method('set')->willReturnCallback(static function ($key, $value) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
$queue = $value;
}
});
// The protocol now queues responses instead of sending them directly
// save() is called once during processInput and once during consumeOutgoingMessages
$session->expects($this->exactly(2))
->method('save');
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "id": 1, "method": "ping"}',
$sessionId
);
// Check that the error was queued in the session
$outgoing = $protocol->consumeOutgoingMessages($sessionId);
$this->assertCount(1, $outgoing);
$message = json_decode($outgoing[0]['message'], true);
$this->assertArrayHasKey('error', $message);
$this->assertEquals(Error::METHOD_NOT_FOUND, $message['error']['code']);
$this->assertStringContainsString('No handler found', $message['error']['message']);
}
#[TestDox('Handler throwing InvalidArgumentException returns invalid params error')]
public function testHandlerInvalidArgumentReturnsInvalidParamsError(): void
{
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willThrowException(new \InvalidArgumentException('Invalid parameter'));
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
// Configure session mock for queue operations
$queue = [];
$session->method('get')->willReturnCallback(static function ($key, $default = null) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
return $queue;
}
return $default;
});
$session->method('set')->willReturnCallback(static function ($key, $value) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
$queue = $value;
}
});
// The protocol now queues responses instead of sending them directly
// save() is called once during processInput and once during consumeOutgoingMessages
$session->expects($this->exactly(2))
->method('save');
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "test"}}',
$sessionId
);
// Check that the error was queued in the session
$outgoing = $protocol->consumeOutgoingMessages($sessionId);
$this->assertCount(1, $outgoing);
$message = json_decode($outgoing[0]['message'], true);
$this->assertArrayHasKey('error', $message);
$this->assertEquals(Error::INVALID_PARAMS, $message['error']['code']);
$this->assertStringContainsString('Invalid parameter', $message['error']['message']);
}
#[TestDox('Handler throwing unexpected exception returns internal error')]
public function testHandlerUnexpectedExceptionReturnsInternalError(): void
{
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willThrowException(new \RuntimeException('Unexpected error'));
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
// Configure session mock for queue operations
$queue = [];
$session->method('get')->willReturnCallback(static function ($key, $default = null) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
return $queue;
}
return $default;
});
$session->method('set')->willReturnCallback(static function ($key, $value) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
$queue = $value;
}
});
// The protocol now queues responses instead of sending them directly
// save() is called once during processInput and once during consumeOutgoingMessages
$session->expects($this->exactly(2))
->method('save');
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "test"}}',
$sessionId
);
// Check that the error was queued in the session
$outgoing = $protocol->consumeOutgoingMessages($sessionId);
$this->assertCount(1, $outgoing);
$message = json_decode($outgoing[0]['message'], true);
$this->assertArrayHasKey('error', $message);
$this->assertEquals(Error::INTERNAL_ERROR, $message['error']['code']);
$this->assertSame('Internal server error.', $message['error']['message']);
$this->assertStringNotContainsString('Unexpected error', $message['error']['message']);
}
#[TestDox('Notification handler exceptions are caught and logged')]
public function testNotificationHandlerExceptionsAreCaught(): void
{
$handler = $this->createMock(NotificationHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willThrowException(new \RuntimeException('Handler error'));
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [$handler],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "notifications/initialized"}',
$sessionId
);
$this->expectNotToPerformAssertions();
}
#[TestDox('Successful request returns response with session ID')]
public function testSuccessfulRequestReturnsResponseWithSessionId(): void
{
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willReturn(new Response(1, ['status' => 'ok']));
$sessionId = Uuid::v4();
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn($sessionId);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
// Configure session mock for queue operations
$queue = [];
$session->method('get')->willReturnCallback(static function ($key, $default = null) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
return $queue;
}
return $default;
});
$session->method('set')->willReturnCallback(static function ($key, $value) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
$queue = $value;
}
});
// The protocol now queues responses instead of sending them directly
// save() is called once during processInput and once during consumeOutgoingMessages
$session->expects($this->exactly(2))
->method('save');
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}',
$sessionId
);
// Check that the response was queued in the session
$outgoing = $protocol->consumeOutgoingMessages($sessionId);
$this->assertCount(1, $outgoing);
$message = json_decode($outgoing[0]['message'], true);
$this->assertArrayHasKey('result', $message);
$this->assertEquals(['status' => 'ok'], $message['result']);
}
#[TestDox('Batch requests are processed and send multiple responses')]
public function testBatchRequestsAreProcessed(): void
{
$handlerA = $this->createMock(RequestHandlerInterface::class);
$handlerA->method('supports')->willReturn(true);
$handlerA->method('handle')->willReturnCallback(static function ($request) {
return Response::fromArray([
'jsonrpc' => '2.0',
'id' => $request->getId(),
'result' => ['method' => $request::getMethod()],
]);
});
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
// Configure session mock for queue operations
$queue = [];
$session->method('get')->willReturnCallback(static function ($key, $default = null) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
return $queue;
}
return $default;
});
$session->method('set')->willReturnCallback(static function ($key, $value) use (&$queue) {
if ('_mcp.outgoing_queue' === $key) {
$queue = $value;
}
});
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
// The protocol now queues responses instead of sending them directly
$session->expects($this->exactly(2))
->method('save');
$protocol = new Protocol(
requestHandlers: [$handlerA],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'[{"jsonrpc": "2.0", "method": "tools/list", "id": 1}, {"jsonrpc": "2.0", "method": "prompts/list", "id": 2}]',
$sessionId
);
// Check that both responses were queued in the session
$outgoing = $protocol->consumeOutgoingMessages($sessionId);
$this->assertCount(2, $outgoing);
foreach ($outgoing as $outgoingMessage) {
$message = json_decode($outgoingMessage['message'], true);
$this->assertArrayHasKey('result', $message);
}
}
#[TestDox('Session is saved after processing')]
public function testSessionIsSavedAfterProcessing(): void
{
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$session->expects($this->once())->method('save');
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "notifications/initialized"}',
$sessionId
);
}
#[TestDox('Destroy session removes session from store')]
public function testDestroySessionRemovesSession(): void
{
$sessionId = Uuid::v4();
$this->sessionManager->expects($this->once())
->method('destroy')
->with($sessionId);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
);
$protocol->destroySession($sessionId);
}
#[TestDox('RequestEvent is dispatched when a request is received')]
public function testRequestEventIsDispatched(): void
{
$capturedEvents = [];
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->method('dispatch')
->willReturnCallback(static function ($event) use (&$capturedEvents) {
$capturedEvents[] = $event;
return $event;
});
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willReturn(new Response(1, ['result' => 'success']));
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
$session->method('get')->willReturn([]);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "ping", "id": 1}',
$sessionId
);
// Should have RequestEvent (and ResponseEvent)
$this->assertGreaterThanOrEqual(1, \count($capturedEvents));
$this->assertInstanceOf(RequestEvent::class, $capturedEvents[0]);
$this->assertSame($session, $capturedEvents[0]->getSession());
$this->assertSame('ping', $capturedEvents[0]->getMethod());
}
#[TestDox('RequestEvent modification is used by handler')]
public function testRequestEventModificationIsUsed(): void
{
$handlerReceivedRequest = null;
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->method('dispatch')
->willReturnCallback(static function ($event) {
if ($event instanceof RequestEvent) {
// Simulate a listener modifying the request
$originalRequest = $event->getRequest();
// Create a modified CallToolRequest with different name but same ID
$modifiedRequest = CallToolRequest::fromArray([
'jsonrpc' => '2.0',
'id' => $originalRequest->getId(),
'method' => 'tools/call',
'params' => [
'name' => 'modified_tool',
'arguments' => ['modified' => true],
],
]);
$event->setRequest($modifiedRequest);
}
return $event;
});
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler
->method('handle')
->willReturnCallback(static function ($request) use (&$handlerReceivedRequest) {
$handlerReceivedRequest = $request;
return new Response(1, ['result' => 'success']);
});
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
$session->method('get')->willReturn([]);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "tools/call", "id": 1, "params": {"name": "original_tool", "arguments": {}}}',
$sessionId
);
// Verify the handler received the modified request
$this->assertInstanceOf(CallToolRequest::class, $handlerReceivedRequest);
$this->assertSame('modified_tool', $handlerReceivedRequest->name);
$this->assertSame(['modified' => true], $handlerReceivedRequest->arguments);
}
#[TestDox('RequestEvent works with null EventDispatcher')]
public function testRequestEventWithNullDispatcher(): void
{
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willReturn(new Response(1, ['result' => 'success']));
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
$session->method('get')->willReturn([]);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: null,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "ping", "id": 1}',
$sessionId
);
// Should not crash - success
$this->expectNotToPerformAssertions();
}
#[TestDox('ResponseEvent is dispatched when handler returns Response')]
public function testResponseEventIsDispatched(): void
{
$capturedEvents = [];
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->method('dispatch')
->willReturnCallback(static function ($event) use (&$capturedEvents) {
$capturedEvents[] = $event;
return $event;
});
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willReturn(new Response(1, ['result' => 'success']));
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
$session->method('get')->willReturn([]);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "ping", "id": 1}',
$sessionId
);
// Should have RequestEvent and ResponseEvent
$this->assertCount(2, $capturedEvents);
$this->assertInstanceOf(RequestEvent::class, $capturedEvents[0]);
$this->assertInstanceOf(ResponseEvent::class, $capturedEvents[1]);
/** @var ResponseEvent $responseEvent */
$responseEvent = $capturedEvents[1];
$this->assertSame($session, $responseEvent->getSession());
$this->assertSame('ping', $responseEvent->getMethod());
$this->assertInstanceOf(Response::class, $responseEvent->getResponse());
}
#[TestDox('ResponseEvent modification is used when sending')]
public function testResponseEventModificationIsUsed(): void
{
$outgoingQueue = [];
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->method('dispatch')
->willReturnCallback(static function ($event) {
if ($event instanceof ResponseEvent) {
// Simulate a listener modifying the response
$modifiedResponse = new Response(
$event->getResponse()->getId(),
['result' => 'modified', 'original' => false]
);
$event->setResponse($modifiedResponse);
}
return $event;
});
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willReturn(new Response(1, ['result' => 'original']));
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
$session->method('get')->willReturn([]);
$session
->method('set')
->willReturnCallback(static function ($key, $value) use (&$outgoingQueue) {
if ('_mcp.outgoing_queue' === $key) {
$outgoingQueue = $value;
}
});
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "ping", "id": 1}',
$sessionId
);
// Verify the MODIFIED response was queued
$this->assertNotEmpty($outgoingQueue);
$lastQueued = end($outgoingQueue);
$this->assertIsArray($lastQueued);
$this->assertArrayHasKey('message', $lastQueued);
$decoded = json_decode($lastQueued['message'], true);
$this->assertSame('modified', $decoded['result']['result']);
$this->assertFalse($decoded['result']['original']);
}
#[TestDox('ErrorEvent is dispatched when handler returns Error')]
public function testErrorEventIsDispatchedForErrorResult(): void
{
$capturedEvents = [];
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->method('dispatch')
->willReturnCallback(static function ($event) use (&$capturedEvents) {
$capturedEvents[] = $event;
return $event;
});
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willReturn(Error::forInternalError('test error', 1));
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
$session->method('get')->willReturn([]);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "ping", "id": 1}',
$sessionId
);
// Should have RequestEvent and ErrorEvent
$this->assertCount(2, $capturedEvents);
$this->assertInstanceOf(RequestEvent::class, $capturedEvents[0]);
$this->assertInstanceOf(ErrorEvent::class, $capturedEvents[1]);
/** @var ErrorEvent $errorEvent */
$errorEvent = $capturedEvents[1];
$this->assertSame($session, $errorEvent->getSession());
$this->assertNull($errorEvent->getThrowable());
$this->assertInstanceOf(Error::class, $errorEvent->getError());
}
#[TestDox('ErrorEvent is dispatched on InvalidArgumentException')]
public function testErrorEventIsDispatchedForInvalidArgument(): void
{
$capturedEvents = [];
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->method('dispatch')
->willReturnCallback(static function ($event) use (&$capturedEvents) {
$capturedEvents[] = $event;
return $event;
});
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willThrowException(new \InvalidArgumentException('Invalid param'));
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
$session->method('get')->willReturn([]);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "ping", "id": 1}',
$sessionId
);
// Should have RequestEvent and ErrorEvent
$this->assertCount(2, $capturedEvents);
$this->assertInstanceOf(RequestEvent::class, $capturedEvents[0]);
$this->assertInstanceOf(ErrorEvent::class, $capturedEvents[1]);
/** @var ErrorEvent $errorEvent */
$errorEvent = $capturedEvents[1];
$this->assertInstanceOf(\InvalidArgumentException::class, $errorEvent->getThrowable());
$this->assertSame('Invalid param', $errorEvent->getThrowable()->getMessage());
}
#[TestDox('ErrorEvent is dispatched on generic Throwable')]
public function testErrorEventIsDispatchedForGenericException(): void
{
$capturedEvents = [];
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->method('dispatch')
->willReturnCallback(static function ($event) use (&$capturedEvents) {
$capturedEvents[] = $event;
return $event;
});
$handler = $this->createMock(RequestHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->method('handle')->willThrowException(new \RuntimeException('Runtime error'));
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
$session->method('get')->willReturn([]);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [$handler],
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "ping", "id": 1}',
$sessionId
);
// Should have RequestEvent and ErrorEvent
$this->assertCount(2, $capturedEvents);
$this->assertInstanceOf(RequestEvent::class, $capturedEvents[0]);
$this->assertInstanceOf(ErrorEvent::class, $capturedEvents[1]);
/** @var ErrorEvent $errorEvent */
$errorEvent = $capturedEvents[1];
$this->assertInstanceOf(\RuntimeException::class, $errorEvent->getThrowable());
$this->assertSame('Runtime error', $errorEvent->getThrowable()->getMessage());
}
#[TestDox('ErrorEvent is dispatched when no handler found')]
public function testErrorEventIsDispatchedForMethodNotFound(): void
{
$capturedEvents = [];
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->method('dispatch')
->willReturnCallback(static function ($event) use (&$capturedEvents) {
$capturedEvents[] = $event;
return $event;
});
$session = $this->createMock(SessionInterface::class);
$session->method('getId')->willReturn(Uuid::v4());
$session->method('get')->willReturn([]);
$session->expects($this->once())->method('save');
$session->expects($this->atLeastOnce())->method('set');
$this->sessionManager->method('create')->willReturn($session); // create() for initialize
$this->sessionManager->method('exists')->willReturn(false); // No existing session
$protocol = new Protocol(
requestHandlers: [], // No handlers
notificationHandlers: [],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "initialize", "id": 1, "params": {"protocolVersion": "2024-11-05", "capabilities": {}, "clientInfo": {"name": "test", "version": "1.0"}}}',
null // Initialize must not have sessionId
);
// Should have RequestEvent and ErrorEvent
$this->assertCount(2, $capturedEvents);
$this->assertInstanceOf(RequestEvent::class, $capturedEvents[0]);
$this->assertInstanceOf(ErrorEvent::class, $capturedEvents[1]);
/** @var ErrorEvent $errorEvent */
$errorEvent = $capturedEvents[1];
$this->assertNull($errorEvent->getThrowable());
$this->assertInstanceOf(Error::class, $errorEvent->getError());
}
#[TestDox('NotificationEvent is dispatched when notification received')]
public function testNotificationEventIsDispatched(): void
{
$capturedEvent = null;
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->expects($this->once())
->method('dispatch')
->with($this->callback(static function ($event) use (&$capturedEvent) {
$capturedEvent = $event;
return $event instanceof NotificationEvent;
}))
->willReturnArgument(0);
$handler = $this->createMock(NotificationHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->expects($this->once())->method('handle');
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [$handler],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "notifications/initialized"}',
$sessionId
);
$this->assertNotNull($capturedEvent);
$this->assertInstanceOf(NotificationEvent::class, $capturedEvent);
$this->assertSame($session, $capturedEvent->getSession());
$this->assertSame('notifications/initialized', $capturedEvent->getMethod());
}
#[TestDox('NotificationEvent modification is used by handlers')]
public function testNotificationEventModificationIsUsed(): void
{
$handlerReceivedNotification = null;
$eventDispatcher = $this->createMock(EventDispatcherInterface::class);
$eventDispatcher
->method('dispatch')
->willReturnCallback(static function ($event) {
if ($event instanceof NotificationEvent) {
// Simulate a listener modifying the notification
$modifiedNotification = LoggingMessageNotification::fromArray([
'jsonrpc' => '2.0',
'method' => 'notifications/message',
'params' => [
'level' => 'error',
'data' => 'modified message',
'logger' => 'modified_logger',
],
]);
$event->setNotification($modifiedNotification);
}
return $event;
});
$handler = $this->createMock(NotificationHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler
->method('handle')
->willReturnCallback(static function ($notification) use (&$handlerReceivedNotification) {
$handlerReceivedNotification = $notification;
});
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [$handler],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: $eventDispatcher,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "notifications/message", "params": {"level": "info", "data": "original message"}}',
$sessionId
);
// Verify the handler received the MODIFIED notification
$this->assertInstanceOf(LoggingMessageNotification::class, $handlerReceivedNotification);
$this->assertSame(LoggingLevel::Error, $handlerReceivedNotification->level);
$this->assertSame('modified message', $handlerReceivedNotification->data);
$this->assertSame('modified_logger', $handlerReceivedNotification->logger);
}
#[TestDox('NotificationEvent works with null EventDispatcher')]
public function testNotificationEventWithNullDispatcher(): void
{
$handler = $this->createMock(NotificationHandlerInterface::class);
$handler->method('supports')->willReturn(true);
$handler->expects($this->once())->method('handle');
$session = $this->createMock(SessionInterface::class);
$this->sessionManager->method('createWithId')->willReturn($session);
$this->sessionManager->method('exists')->willReturn(true);
$protocol = new Protocol(
requestHandlers: [],
notificationHandlers: [$handler],
messageFactory: MessageFactory::make(),
sessionManager: $this->sessionManager,
eventDispatcher: null,
);
$sessionId = Uuid::v4();
$protocol->processInput(
$this->transport,
'{"jsonrpc": "2.0", "method": "notifications/initialized"}',
$sessionId
);
}
}