Add support for pagination on list requests (#55)
10 - Added the list resources handler with test class 10 - Update the ListPromptsHandler to use annotations 10 - Add the list resource handler, and it's test as well 10 - Added the registry logic 10 - Added the list tools handler logic 10 - Fix all php-cs-fixer related issues 10 - Resolved phpstan issues for ListPromptsHandlerTest 10 - Resolved phpstan issues for ListToolsHandlerTest 10 - Resolved phpstan issues for ListResourcesHandlerTest 10 - Resolved phpstan issues in registry class 10 - Resolved phpstan issues for the handler class 10 - Resolved php cs fixer issues 10 - Resolved all phpstan issues by generating the baseline again 10 - Remove the two loop operation and use foreach for optimization 10 - Removed unused code and resolved namespace 10 - Add signatures to interface and registry 10 - Add updated phpstan rule set 10 - Arranged according to property type 10 - Introduce reference page DTO, fix all failing test 10 - Resolve cs-fixer issues 10 - Resolve phpstan issues 10 - Resolve php cs fixer issues 10 - Created a reference directory for the Page DTO 10 - Remove manual loop for clean code readability Co-authored-by: larry.sulebalogun <larry.sulebalogun@tillo.io>
This commit is contained in:
Sule-Balogun Olanrewaju
GitHub
parent
4db831778b
commit
325b4aaf9c
1 changed files with 1016 additions and 131 deletions
274
tests/Server/RequestHandler/ListToolsHandlerTest.php
Normal file
274
tests/Server/RequestHandler/ListToolsHandlerTest.php
Normal file
|
|
@ -0,0 +1,274 @@
|
|||
<?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\Server\RequestHandler;
|
||||
|
||||
use Mcp\Capability\Registry;
|
||||
use Mcp\Exception\InvalidCursorException;
|
||||
use Mcp\Schema\Request\ListToolsRequest;
|
||||
use Mcp\Schema\Result\ListToolsResult;
|
||||
use Mcp\Schema\Tool;
|
||||
use Mcp\Server\RequestHandler\ListToolsHandler;
|
||||
use Mcp\Server\Session\InMemorySessionStore;
|
||||
use Mcp\Server\Session\Session;
|
||||
use Mcp\Server\Session\SessionInterface;
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class ListToolsHandlerTest extends TestCase
|
||||
{
|
||||
private Registry $registry;
|
||||
private ListToolsHandler $handler;
|
||||
private SessionInterface $session;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
$this->registry = new Registry();
|
||||
$this->handler = new ListToolsHandler($this->registry, pageSize: 3); // Use small page size for testing
|
||||
$this->session = new Session(new InMemorySessionStore());
|
||||
}
|
||||
|
||||
#[TestDox('Returns first page when no cursor provided')]
|
||||
public function testReturnsFirstPageWhenNoCursorProvided(): void
|
||||
{
|
||||
// Arrange
|
||||
$this->addToolsToRegistry(5);
|
||||
$request = $this->createListToolsRequest();
|
||||
|
||||
// Act
|
||||
$response = $this->handler->handle($request, $this->session);
|
||||
|
||||
// Assert
|
||||
/** @var ListToolsResult $result */
|
||||
$result = $response->result;
|
||||
$this->assertInstanceOf(ListToolsResult::class, $result);
|
||||
$this->assertCount(3, $result->tools);
|
||||
$this->assertNotNull($result->nextCursor);
|
||||
|
||||
$this->assertEquals('tool_0', $result->tools[0]->name);
|
||||
$this->assertEquals('tool_1', $result->tools[1]->name);
|
||||
$this->assertEquals('tool_2', $result->tools[2]->name);
|
||||
}
|
||||
|
||||
#[TestDox('Returns paginated tools with cursor')]
|
||||
public function testReturnsPaginatedToolsWithCursor(): void
|
||||
{
|
||||
// Arrange
|
||||
$this->addToolsToRegistry(10);
|
||||
$request = $this->createListToolsRequest(cursor: null);
|
||||
|
||||
// Act
|
||||
$response = $this->handler->handle($request, $this->session);
|
||||
|
||||
// Assert
|
||||
/** @var ListToolsResult $result */
|
||||
$result = $response->result;
|
||||
$this->assertInstanceOf(ListToolsResult::class, $result);
|
||||
$this->assertCount(3, $result->tools);
|
||||
$this->assertNotNull($result->nextCursor);
|
||||
|
||||
$this->assertEquals('tool_0', $result->tools[0]->name);
|
||||
$this->assertEquals('tool_1', $result->tools[1]->name);
|
||||
$this->assertEquals('tool_2', $result->tools[2]->name);
|
||||
}
|
||||
|
||||
#[TestDox('Returns second page with cursor')]
|
||||
public function testReturnsSecondPageWithCursor(): void
|
||||
{
|
||||
// Arrange
|
||||
$this->addToolsToRegistry(10);
|
||||
$firstPageRequest = $this->createListToolsRequest();
|
||||
$firstPageResponse = $this->handler->handle($firstPageRequest, $this->session);
|
||||
|
||||
/** @var ListToolsResult $firstPageResult */
|
||||
$firstPageResult = $firstPageResponse->result;
|
||||
$secondPageRequest = $this->createListToolsRequest(cursor: $firstPageResult->nextCursor);
|
||||
|
||||
// Act
|
||||
$response = $this->handler->handle($secondPageRequest, $this->session);
|
||||
|
||||
// Assert
|
||||
/** @var ListToolsResult $result */
|
||||
$result = $response->result;
|
||||
$this->assertInstanceOf(ListToolsResult::class, $result);
|
||||
$this->assertCount(3, $result->tools);
|
||||
$this->assertNotNull($result->nextCursor);
|
||||
|
||||
$this->assertEquals('tool_3', $result->tools[0]->name);
|
||||
$this->assertEquals('tool_4', $result->tools[1]->name);
|
||||
$this->assertEquals('tool_5', $result->tools[2]->name);
|
||||
}
|
||||
|
||||
#[TestDox('Returns last page with null cursor')]
|
||||
public function testReturnsLastPageWithNullCursor(): void
|
||||
{
|
||||
// Arrange
|
||||
$this->addToolsToRegistry(5);
|
||||
$firstPageRequest = $this->createListToolsRequest();
|
||||
$firstPageResponse = $this->handler->handle($firstPageRequest, $this->session);
|
||||
|
||||
/** @var ListToolsResult $firstPageResult */
|
||||
$firstPageResult = $firstPageResponse->result;
|
||||
$secondPageRequest = $this->createListToolsRequest(cursor: $firstPageResult->nextCursor);
|
||||
|
||||
// Act
|
||||
$response = $this->handler->handle($secondPageRequest, $this->session);
|
||||
|
||||
// Assert
|
||||
/** @var ListToolsResult $result */
|
||||
$result = $response->result;
|
||||
$this->assertInstanceOf(ListToolsResult::class, $result);
|
||||
$this->assertCount(2, $result->tools);
|
||||
$this->assertNull($result->nextCursor);
|
||||
|
||||
$this->assertEquals('tool_3', $result->tools[0]->name);
|
||||
$this->assertEquals('tool_4', $result->tools[1]->name);
|
||||
}
|
||||
|
||||
#[TestDox('Returns all tools when count is less than page size')]
|
||||
public function testReturnsAllToolsWhenCountIsLessThanPageSize(): void
|
||||
{
|
||||
// Arrange
|
||||
$this->addToolsToRegistry(2); // Less than page size (3)
|
||||
$request = $this->createListToolsRequest();
|
||||
|
||||
// Act
|
||||
$response = $this->handler->handle($request, $this->session);
|
||||
|
||||
// Assert
|
||||
/** @var ListToolsResult $result */
|
||||
$result = $response->result;
|
||||
$this->assertInstanceOf(ListToolsResult::class, $result);
|
||||
$this->assertCount(2, $result->tools);
|
||||
$this->assertNull($result->nextCursor);
|
||||
|
||||
$this->assertEquals('tool_0', $result->tools[0]->name);
|
||||
$this->assertEquals('tool_1', $result->tools[1]->name);
|
||||
}
|
||||
|
||||
#[TestDox('Handles empty registry')]
|
||||
public function testHandlesEmptyRegistry(): void
|
||||
{
|
||||
// Arrange
|
||||
$request = $this->createListToolsRequest();
|
||||
|
||||
// Act
|
||||
$response = $this->handler->handle($request, $this->session);
|
||||
|
||||
// Assert
|
||||
/** @var ListToolsResult $result */
|
||||
$result = $response->result;
|
||||
$this->assertInstanceOf(ListToolsResult::class, $result);
|
||||
$this->assertCount(0, $result->tools);
|
||||
$this->assertNull($result->nextCursor);
|
||||
}
|
||||
|
||||
#[TestDox('Throws exception for invalid cursor')]
|
||||
public function testThrowsExceptionForInvalidCursor(): void
|
||||
{
|
||||
// Arrange
|
||||
$this->addToolsToRegistry(5);
|
||||
$request = $this->createListToolsRequest(cursor: 'invalid-cursor');
|
||||
|
||||
// Assert
|
||||
$this->expectException(InvalidCursorException::class);
|
||||
|
||||
// Act
|
||||
$this->handler->handle($request, $this->session);
|
||||
}
|
||||
|
||||
#[TestDox('Throws exception for cursor beyond bounds')]
|
||||
public function testThrowsExceptionForCursorBeyondBounds(): void
|
||||
{
|
||||
// Arrange
|
||||
$this->addToolsToRegistry(5);
|
||||
$outOfBoundsCursor = base64_encode('100');
|
||||
$request = $this->createListToolsRequest(cursor: $outOfBoundsCursor);
|
||||
|
||||
// Assert
|
||||
$this->expectException(InvalidCursorException::class);
|
||||
|
||||
// Act
|
||||
$this->handler->handle($request, $this->session);
|
||||
}
|
||||
|
||||
#[TestDox('Handles cursor at exact boundary')]
|
||||
public function testHandlesCursorAtExactBoundary(): void
|
||||
{
|
||||
// Arrange
|
||||
$this->addToolsToRegistry(6);
|
||||
$exactBoundaryCursor = base64_encode('6');
|
||||
$request = $this->createListToolsRequest(cursor: $exactBoundaryCursor);
|
||||
|
||||
// Act
|
||||
$response = $this->handler->handle($request, $this->session);
|
||||
|
||||
// Assert
|
||||
/** @var ListToolsResult $result */
|
||||
$result = $response->result;
|
||||
$this->assertInstanceOf(ListToolsResult::class, $result);
|
||||
$this->assertCount(0, $result->tools);
|
||||
$this->assertNull($result->nextCursor);
|
||||
}
|
||||
|
||||
#[TestDox('Maintains stable cursors across calls')]
|
||||
public function testMaintainsStableCursorsAcrossCalls(): void
|
||||
{
|
||||
// Arrange
|
||||
$this->addToolsToRegistry(10);
|
||||
|
||||
// Act
|
||||
$request = $this->createListToolsRequest();
|
||||
$response1 = $this->handler->handle($request, $this->session);
|
||||
$response2 = $this->handler->handle($request, $this->session);
|
||||
|
||||
// Assert
|
||||
/** @var ListToolsResult $result1 */
|
||||
$result1 = $response1->result;
|
||||
/** @var ListToolsResult $result2 */
|
||||
$result2 = $response2->result;
|
||||
$this->assertEquals($result1->nextCursor, $result2->nextCursor);
|
||||
$this->assertEquals($result1->tools, $result2->tools);
|
||||
}
|
||||
|
||||
private function addToolsToRegistry(int $count): void
|
||||
{
|
||||
for ($i = 0; $i < $count; ++$i) {
|
||||
$tool = new Tool(
|
||||
name: "tool_$i",
|
||||
inputSchema: [
|
||||
'type' => 'object',
|
||||
'properties' => [],
|
||||
'required' => [],
|
||||
],
|
||||
description: "Test tool $i",
|
||||
annotations: null
|
||||
);
|
||||
|
||||
$this->registry->registerTool($tool, fn () => null);
|
||||
}
|
||||
}
|
||||
|
||||
private function createListToolsRequest(?string $cursor = null): ListToolsRequest
|
||||
{
|
||||
$data = [
|
||||
'jsonrpc' => '2.0',
|
||||
'id' => 'test-request-id',
|
||||
'method' => 'tools/list',
|
||||
];
|
||||
|
||||
if (null !== $cursor) {
|
||||
$data['params'] = ['cursor' => $cursor];
|
||||
}
|
||||
|
||||
return ListToolsRequest::fromArray($data);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue