sunrise-php / http-router

src/Router.php

<?php

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Nekhay <afenric@gmail.com>
 * @copyright Copyright (c) 2018, Anatoly Nekhay
 * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-router
 */

declare(strict_types=1);

namespace Sunrise\Http\Router;

use InvalidArgumentException;
use LogicException;
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Sunrise\Http\Router\Dictionary\HeaderName;
use Sunrise\Http\Router\Dictionary\PlaceholderCode;
use Sunrise\Http\Router\Event\RoutePostRunEvent;
use Sunrise\Http\Router\Event\RoutePreRunEvent;
use Sunrise\Http\Router\Exception\HttpException;
use Sunrise\Http\Router\Exception\HttpExceptionFactory;
use Sunrise\Http\Router\Helper\RouteBuilder;
use Sunrise\Http\Router\Helper\RouteCompiler;
use Sunrise\Http\Router\Helper\RouteMatcher;
use Sunrise\Http\Router\Loader\LoaderInterface;
use Sunrise\Http\Router\RequestHandler\CallableRequestHandler;
use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler;
use UnexpectedValueException;

use function array_flip;
use function array_keys;
use function array_merge;
use function rawurldecode;
use function sprintf;

final class Router implements RouterInterface
{
    /** @var array<string, RouteInterface> */
    private array $routes = [];

    /** @var array<string, non-empty-string> */

The doc comment array<string, non-empty-string> at position 4 could not be parsed: Unknown type name 'non-empty-string' at position 4 in array<string, non-empty-string>.

    private array $routePatterns = [];

    /** @var array<string, RequestHandlerInterface> */
    private array $routeRequestHandlers = [];

    private ?RequestHandlerInterface $requestHandler = null;

    private bool $isLoaded = false;

    /**
     * @since 3.0.0
     */
    public function __construct(
        private readonly ReferenceResolverInterface $referenceResolver,
        /** @var array<array-key, LoaderInterface> */
        private readonly array $loaders,
        /** @var array<array-key, mixed> */
        private readonly array $middlewares = [],
        /** @var array<array-key, mixed> */
        private readonly array $routeMiddlewares = [],
        private readonly ?EventDispatcherInterface $eventDispatcher = null,
    ) {
    }

    /**
     * @inheritDoc
     *
     * @throws InvalidArgumentException
     */
    public function getRoutes(): array
    {
        $this->isLoaded or $this->load();

        return $this->routes;
    }

    /**
     * @inheritDoc
     *
     * @throws InvalidArgumentException
     */
    public function getRoute(string $name): RouteInterface
    {
        $routes = $this->getRoutes();

        if (!isset($routes[$name])) {
            throw new InvalidArgumentException(sprintf('The route "%s" does not exist.', $name));
        }

        return $routes[$name];
    }

    /**
     * @inheritDoc
     *
     * @throws InvalidArgumentException
     */
    public function hasRoute(string $name): bool
    {
        $routes = $this->getRoutes();

        return isset($routes[$name]);
    }

    /**
     * @inheritDoc
     *
     * @throws HttpException
     * @throws InvalidArgumentException
     * @throws LogicException
     */
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        return $this->getRequestHandler()->handle($request);
    }

    /**
     * @inheritDoc
     *
     * @throws HttpException
     * @throws InvalidArgumentException
     * @throws LogicException
     */
    public function match(ServerRequestInterface $request): RouteInterface
    {
        $routes = $this->getRoutes();

        if ($routes === []) {
            throw new LogicException('The router does not contain any routes.');
        }

        $requestPath = rawurldecode($request->getUri()->getPath());
        $requestMethod = $request->getMethod();
        $allowedMethods = [];

        foreach ($routes as $route) {
            try {
                if (!RouteMatcher::matchRoute($this->compileRoute($route), $requestPath, $matches)) {
                    continue;
                }
            } catch (UnexpectedValueException $e) {
                throw HttpExceptionFactory::malformedUri(previous: $e);
            }

            $routeMethods = array_flip($route->getMethods());
            if (!isset($routeMethods[$requestMethod])) {
                $allowedMethods += $routeMethods;
                continue;
            }

            return $matches === [] ? $route : $route->withAddedAttributes($matches);
        }

        if ($allowedMethods !== []) {
            throw HttpExceptionFactory::methodNotAllowed()
                ->addMessagePlaceholder(PlaceholderCode::REQUEST_METHOD, $requestMethod)
                ->addHeaderField(HeaderName::ALLOW, ...array_keys($allowedMethods));
        }

        throw HttpExceptionFactory::resourceNotFound()
            ->addMessagePlaceholder(PlaceholderCode::REQUEST_URI, $requestPath);
    }

    /**
     * @inheritDoc
     *
     * @throws InvalidArgumentException
     */
    public function runRoute(RouteInterface $route, ServerRequestInterface $request): ResponseInterface
    {
        foreach ($route->getAttributes() as $name => $value) {
            $request = $request->withAttribute($name, $value);
        }

        $request = $request->withAttribute(RouteInterface::class, $route);

        if ($this->eventDispatcher !== null) {
            $event = new RoutePreRunEvent($route, $request);
            $this->eventDispatcher->dispatch($event);
            $request = $event->request;
        }

        $response = $this->getRouteRequestHandler($route)->handle($request);

        if ($this->eventDispatcher !== null) {
            $event = new RoutePostRunEvent($route, $request, $response);
            $this->eventDispatcher->dispatch($event);
            $response = $event->response;
        }

        return $response;
    }

    /**
     * @inheritDoc
     *
     * @throws InvalidArgumentException
     */
    public function buildRoute(RouteInterface $route, array $values = [], bool $strictly = false): string
    {
        $result = RouteBuilder::buildRoute($route->getPath(), $values + $route->getAttributes());

        if ($strictly && !RouteMatcher::matchRoute($this->compileRoute($route), $result)) {
            throw new InvalidArgumentException(sprintf(
                'The route "%s" could not be built because one of the values does not match its pattern.',
                $route->getName(),
            ));
        }

        return $result;
    }

    /**
     * @throws InvalidArgumentException
     *
     * @return non-empty-string

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    private function compileRoute(RouteInterface $route): string
    {
        return $this->routePatterns[$route->getName()] ??= $route->getPattern()
            ?? RouteCompiler::compileRoute($route->getPath(), $route->getPatterns());
    }

    /**
     * @internal
     *
     * @throws InvalidArgumentException
     */
    public function getRouteRequestHandler(RouteInterface $route): RequestHandlerInterface
    {
        $name = $route->getName();
        if (isset($this->routeRequestHandlers[$name])) {
            return $this->routeRequestHandlers[$name];
        }

        $this->routeRequestHandlers[$name] = $this->referenceResolver
            ->resolveRequestHandler($route->getRequestHandler());

        $middlewares = array_merge($this->routeMiddlewares, $route->getMiddlewares());
        if ($middlewares !== []) {
            $this->routeRequestHandlers[$name] = new QueueableRequestHandler($this->routeRequestHandlers[$name]);
            foreach ($middlewares as $middleware) {
                $this->routeRequestHandlers[$name]->enqueue($this->referenceResolver->resolveMiddleware($middleware));
            }
        }

        return $this->routeRequestHandlers[$name];
    }

    /**
     * @internal
     *
     * @throws InvalidArgumentException
     */
    public function getRequestHandler(): RequestHandlerInterface
    {
        if ($this->requestHandler !== null) {
            return $this->requestHandler;
        }

        $this->requestHandler = new CallableRequestHandler(
            fn(ServerRequestInterface $request): ResponseInterface =>
                $this->runRoute($this->match($request), $request),
        );

        if ($this->middlewares !== []) {
            $this->requestHandler = new QueueableRequestHandler($this->requestHandler);

$this->requestHandler of type null is incompatible with the type Psr\Http\Server\RequestHandlerInterface expected by parameter $endpoint of Sunrise\Http\Router\RequestHandler\QueueableRequestHandler::__construct().

            foreach ($this->middlewares as $middleware) {
                $this->requestHandler->enqueue($this->referenceResolver->resolveMiddleware($middleware));
            }
        }

        return $this->requestHandler;
    }

    /**
     * @throws InvalidArgumentException
     */
    private function load(): void
    {
        foreach ($this->loaders as $loader) {
            foreach ($loader->load() as $route) {
                $name = $route->getName();

                if (isset($this->routes[$name])) {
                    throw new InvalidArgumentException(sprintf('The route "%s" already exists.', $name));
                }

                $this->routes[$name] = $route;
            }
        }

        $this->isLoaded = true;
    }
}