ResourceSubscribeTest.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\Handler\Request;

use Mcp\Capability\Registry\ResourceReference;
use Mcp\Capability\RegistryInterface;
use Mcp\Exception\InvalidArgumentException;
use Mcp\Exception\ResourceNotFoundException;
use Mcp\Schema\JsonRpc\Error;
use Mcp\Schema\JsonRpc\Response;
use Mcp\Schema\Request\ResourceSubscribeRequest;
use Mcp\Schema\Resource;
use Mcp\Schema\Result\EmptyResult;
use Mcp\Server\Handler\Request\ResourceSubscribeHandler;
use Mcp\Server\Resource\SubscriptionManagerInterface;
use Mcp\Server\Session\SessionInterface;
use PHPUnit\Framework\Attributes\TestDox;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;

class ResourceSubscribeTest extends TestCase
{
    private ResourceSubscribeHandler $handler;
    private RegistryInterface&MockObject $registry;
    private SessionInterface&MockObject $session;
    private SubscriptionManagerInterface&MockObject $subscriptionManager;
    private LoggerInterface&MockObject $logger;

    protected function setUp(): void
    {
        $this->registry = $this->createMock(RegistryInterface::class);
        $this->subscriptionManager = $this->createMock(SubscriptionManagerInterface::class);
        $this->session = $this->createMock(SessionInterface::class);
        $this->logger = $this->createMock(LoggerInterface::class);
        $this->handler = new ResourceSubscribeHandler($this->registry, $this->subscriptionManager, $this->logger);
    }

    #[TestDox('Client can successfully subscribe to a resource')]
    public function testClientCanSuccessfulSubscribeToAResource(): void
    {
        $uri = 'file://documents/readme.txt';
        $request = $this->createResourceSubscribeRequest($uri);
        $resourceReference = $this->getMockBuilder(ResourceReference::class)
            ->setConstructorArgs([new Resource($uri, 'test', mimeType: 'text/plain'), []])
            ->getMock();

        $this->registry
            ->expects($this->once())
            ->method('getResource')
            ->with($uri)
            ->willReturn($resourceReference);

        $this->subscriptionManager->expects($this->once())
            ->method('subscribe')
            ->with($this->session, $uri);

        $response = $this->handler->handle($request, $this->session);

        $this->assertInstanceOf(Response::class, $response);
        $this->assertEquals($request->getId(), $response->id);
        $this->assertInstanceOf(EmptyResult::class, $response->result);
    }

    #[TestDox('Gracefully handle duplicate subscription to a resource')]
    public function testDuplicateSubscriptionIsGracefullyHandled(): void
    {
        $uri = 'file://documents/readme.txt';
        $request = $this->createResourceSubscribeRequest($uri);
        $resourceReference = $this->getMockBuilder(ResourceReference::class)
            ->setConstructorArgs([new Resource($uri, 'test', mimeType: 'text/plain'), []])
            ->getMock();

        $this->registry
            ->expects($this->exactly(2))
            ->method('getResource')
            ->with($uri)
            ->willReturn($resourceReference);

        $this->subscriptionManager
            ->expects($this->exactly(2))
            ->method('subscribe')
            ->with($this->session, $uri);

        $response1 = $this->handler->handle($request, $this->session);
        $response2 = $this->handler->handle($request, $this->session);

        $this->assertInstanceOf(Response::class, $response1);
        $this->assertInstanceOf(Response::class, $response2);
        $this->assertEquals($request->getId(), $response1->id);
        $this->assertEquals($request->getId(), $response2->id);
        $this->assertInstanceOf(EmptyResult::class, $response1->result);
        $this->assertInstanceOf(EmptyResult::class, $response2->result);
    }

    #[TestDox('Subscription to a resource with an empty uri throws InvalidArgumentException')]
    public function testSubscribeWithEmptyUriThrowsError(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Missing or invalid "uri" parameter for resources/subscribe.');

        $this->createResourceSubscribeRequest('');
    }

    #[TestDox('Subscription to a resource with an invalid uri throws ResourceNotException')]
    public function testHandleSubscribeResourceNotFoundException(): void
    {
        $uri = 'file://missing/file.txt';
        $request = $this->createResourceSubscribeRequest($uri);
        $exception = new ResourceNotFoundException($uri);

        $this->registry
            ->expects($this->once())
            ->method('getResource')
            ->with($uri)
            ->willThrowException($exception);

        $this->logger
            ->expects($this->once())
            ->method('error')
            ->with('Resource not found', ['uri' => $uri, 'exception' => $exception]);

        $response = $this->handler->handle($request, $this->session);

        $this->assertInstanceOf(Error::class, $response);
        $this->assertEquals(Error::RESOURCE_NOT_FOUND, $response->code);
        $this->assertEquals(\sprintf('Resource not found for uri: "%s".', $uri), $response->message);
    }

    private function createResourceSubscribeRequest(string $uri): ResourceSubscribeRequest
    {
        return ResourceSubscribeRequest::fromArray([
            'jsonrpc' => '2.0',
            'method' => ResourceSubscribeRequest::getMethod(),
            'id' => 'test-request-'.uniqid(),
            'params' => [
                'uri' => $uri,
            ],
        ]);
    }
}