RouterTest.php

<?php

namespace Utopia\Http;

use PHPUnit\Framework\TestCase;

final class RouterTest extends TestCase
{
    public function tearDown(): void
    {
        Router::reset();
    }

    public function testCanMatchUrl(): void
    {
        $routeIndex = new Route(Http::REQUEST_METHOD_GET, '/');
        $routeAbout = new Route(Http::REQUEST_METHOD_GET, '/about');
        $routeAboutMe = new Route(Http::REQUEST_METHOD_GET, '/about/me');

        Router::addRoute($routeIndex);
        Router::addRoute($routeAbout);
        Router::addRoute($routeAboutMe);

        $this->assertEquals($routeIndex, Router::match(Http::REQUEST_METHOD_GET, '/'));
        $this->assertEquals($routeAbout, Router::match(Http::REQUEST_METHOD_GET, '/about'));
        $this->assertEquals($routeAboutMe, Router::match(Http::REQUEST_METHOD_GET, '/about/me'));
    }

    public function testCanMatchUrlWithPlaceholder(): void
    {
        $routeBlog = new Route(Http::REQUEST_METHOD_GET, '/blog');
        $routeBlogAuthors = new Route(Http::REQUEST_METHOD_GET, '/blog/authors');
        $routeBlogAuthorsComments = new Route(Http::REQUEST_METHOD_GET, '/blog/authors/comments');
        $routeBlogPost = new Route(Http::REQUEST_METHOD_GET, '/blog/:post');
        $routeBlogPostComments = new Route(Http::REQUEST_METHOD_GET, '/blog/:post/comments');
        $routeBlogPostCommentsSingle = new Route(Http::REQUEST_METHOD_GET, '/blog/:post/comments/:comment');

        Router::addRoute($routeBlog);
        Router::addRoute($routeBlogAuthors);
        Router::addRoute($routeBlogAuthorsComments);
        Router::addRoute($routeBlogPost);
        Router::addRoute($routeBlogPostComments);
        Router::addRoute($routeBlogPostCommentsSingle);

        $this->assertEquals($routeBlog, Router::match(Http::REQUEST_METHOD_GET, '/blog'));
        $this->assertEquals($routeBlogAuthors, Router::match(Http::REQUEST_METHOD_GET, '/blog/authors'));
        $this->assertEquals($routeBlogAuthorsComments, Router::match(Http::REQUEST_METHOD_GET, '/blog/authors/comments'));
        $this->assertEquals($routeBlogPost, Router::match(Http::REQUEST_METHOD_GET, '/blog/test'));
        $this->assertEquals($routeBlogPostComments, Router::match(Http::REQUEST_METHOD_GET, '/blog/test/comments'));
        $this->assertEquals($routeBlogPostCommentsSingle, Router::match(Http::REQUEST_METHOD_GET, '/blog/test/comments/:comment'));
    }

    public function testCanMatchUrlWithWildcard(): void
    {
        $routeIndex = new Route('GET', '/');
        $routeAbout = new Route('GET', '/about');
        $routeAboutWildcard = new Route('GET', '/about/*');

        Router::addRoute($routeIndex);
        Router::addRoute($routeAbout);
        Router::addRoute($routeAboutWildcard);

        $this->assertEquals($routeIndex, Router::match('GET', '/'));
        $this->assertEquals($routeAbout, Router::match('GET', '/about'));
        $this->assertEquals($routeAboutWildcard, Router::match('GET', '/about/me'));
        $this->assertEquals($routeAboutWildcard, Router::match('GET', '/about/you'));
        $this->assertEquals($routeAboutWildcard, Router::match('GET', '/about/me/myself/i'));
    }

    public function testCanMatchHttpMethod(): void
    {
        $routeGET = new Route(Http::REQUEST_METHOD_GET, '/');
        $routePOST = new Route(Http::REQUEST_METHOD_POST, '/');

        Router::addRoute($routeGET);
        Router::addRoute($routePOST);

        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/'));
        $this->assertEquals($routePOST, Router::match(Http::REQUEST_METHOD_POST, '/'));

        $this->assertNotEquals($routeGET, Router::match(Http::REQUEST_METHOD_POST, '/'));
        $this->assertNotEquals($routePOST, Router::match(Http::REQUEST_METHOD_GET, '/'));
    }

    public function testCanMatchAlias(): void
    {
        $routeGET = new Route(Http::REQUEST_METHOD_GET, '/target');
        $routeGET
            ->alias('/alias')
            ->alias('/alias2');

        Router::addRoute($routeGET);

        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/target'));
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/alias'));
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/alias2'));
    }

    public function testCanMatchMix(): void
    {
        $routeGET = new Route(Http::REQUEST_METHOD_GET, '/');
        $routeGET
            ->alias('/console/*')
            ->alias('/auth/*')
            ->alias('/invite')
            ->alias('/login')
            ->alias('/recover')
            ->alias('/register/*');

        Router::addRoute($routeGET);

        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/'));
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/console'));
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/invite'));
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/login'));
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/recover'));
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/console/lorem/ipsum/dolor'));
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/auth/lorem/ipsum'));
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/register/lorem/ipsum'));
    }

    public function testCanMatchFilename(): void
    {
        $routeGET = new Route(Http::REQUEST_METHOD_GET, '/robots.txt');

        Router::addRoute($routeGET);
        $this->assertEquals($routeGET, Router::match(Http::REQUEST_METHOD_GET, '/robots.txt'));
    }

    public function testCannotFindUnknownRouteByPath(): void
    {
        $this->assertNull(Router::match(Http::REQUEST_METHOD_GET, '/404'));
    }

    public function testCannotFindUnknownRouteByMethod(): void
    {
        $route = new Route(Http::REQUEST_METHOD_GET, '/404');

        Router::addRoute($route);

        $this->assertEquals($route, Router::match(Http::REQUEST_METHOD_GET, '/404'));

        $this->assertNull(Router::match(Http::REQUEST_METHOD_POST, '/404'));
    }
    
    public function testCanMatchAnyMethod(): void
    {
        $route = new Route(Http::REQUEST_METHOD_ANY, '/any-route');
        
        Router::addRoute($route);
        
        // Should match any HTTP method for the specific path
        $this->assertEquals($route, Router::match(Http::REQUEST_METHOD_GET, '/any-route'));
        $this->assertEquals($route, Router::match(Http::REQUEST_METHOD_POST, '/any-route'));
        $this->assertEquals($route, Router::match(Http::REQUEST_METHOD_PUT, '/any-route'));
        $this->assertEquals($route, Router::match(Http::REQUEST_METHOD_PATCH, '/any-route'));
        $this->assertEquals($route, Router::match(Http::REQUEST_METHOD_DELETE, '/any-route'));
        
        // But should not match other paths
        $this->assertNull(Router::match(Http::REQUEST_METHOD_GET, '/different-path'));
    }
    
    public function testMethodSpecificHasPrecedenceOverAny(): void
    {
        $anyRoute = new Route(Http::REQUEST_METHOD_ANY, '/test-route');
        $getRoute = new Route(Http::REQUEST_METHOD_GET, '/test-route');
        
        Router::addRoute($anyRoute);
        Router::addRoute($getRoute);
        
        // GET request should match the GET-specific route
        $this->assertEquals($getRoute, Router::match(Http::REQUEST_METHOD_GET, '/test-route'));
        
        // Other methods should match the "any" route
        $this->assertEquals($anyRoute, Router::match(Http::REQUEST_METHOD_POST, '/test-route'));
        $this->assertEquals($anyRoute, Router::match(Http::REQUEST_METHOD_PUT, '/test-route'));
    }
}