divineniiquaye / flight-routing

src/Traits/ResolverTrait.php

<?php declare(strict_types=1);

/*
 * This file is part of Flight Routing.
 *
 * PHP version 8.0 and above required
 *
 * @author    Divine Niiquaye Ibok <divineibok@gmail.com>
 * @copyright 2019 Divine Niiquaye Ibok (https://divinenii.com/)
 * @license   https://opensource.org/licenses/BSD-3-Clause License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Flight\Routing\Traits;

use Flight\Routing\Exceptions\{MethodNotAllowedException, UriHandlerException};
use Psr\Http\Message\UriInterface;

/**
 * The default implementation for route match.
 *
 * @author Divine Niiquaye Ibok <divineibok@gmail.com>
 */
trait ResolverTrait
{
    /** @var array<int|string,mixed> */
    private array $optimized = [];

    /**
     * @param array<string,mixed>                  $route
     * @param array<int,array<string,bool|string>> $errors
     */
    protected function assertRoute(string $method, UriInterface $uri, array &$route, array &$errors): bool
    {
        $matched = true;

        if (!\array_key_exists($method, $route['methods'] ?? [])) {
            $errors[0] += $route['methods'] ?? [];
            $matched = false;
        } elseif (isset($route['hosts']) && !\array_key_exists($errors[2] ??= \rtrim($uri->getHost().':'.$uri->getPort(), ':'), $route['hosts'])) {

It seems like AssignCoalesceNode can also be of type array<string,boolean|string>; however, parameter $key of array_key_exists() does only seem to accept integer|string, maybe add an additional type check?

            $hosts = \array_keys($route['hosts'], true, true);
            [$hostsRegex, $hostVar] = $this->compiler->compile(\implode('|', $hosts), $route['placeholders'] ?? []);

            if ($matched = 1 === \preg_match($hostsRegex.'i', $errors[2], $matches, \PREG_UNMATCHED_AS_NULL)) {

It seems like $errors[2] can also be of type array<string,boolean|string>; however, parameter $subject of preg_match() does only seem to accept string, maybe add an additional type check?

                foreach ($hostVar as $key => $value) {
                    $route['arguments'][$key] = $matches[$key] ?: $route['defaults'][$key] ?? $value;
                }
            }
        } elseif (isset($route['schemes']) && !\array_key_exists($uri->getScheme(), $route['schemes'])) {
            $errors[1] += $route['schemes'] ?? [];
            $matched = false;
        }

        return $matched;
    }

    /**
     * @return null|array<string,mixed>
     */
    protected function resolveRoute(string $path, string $method, UriInterface $uri): ?array
    {
        $errors = [[], []];

        foreach ($this->getCollection()->getRoutes() as $i => $r) {

It seems like getCollection() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            if (isset($r['prefix']) && !\str_starts_with($path, '/'.\ltrim($r['prefix'], '/'))) {
                continue;
            }
            [$p, $v] = $this->optimized[$i] ??= $this->compiler->compile('/'.\ltrim($r['path'], '/'), $r['placeholders'] ?? []);

            if (!\preg_match($p, $path, $m, \PREG_UNMATCHED_AS_NULL) || !$this->assertRoute($method, $uri, $r, $errors)) {
                continue;
            }

            foreach ($v as $key => $value) {
                $r['arguments'][$key] = $m[$key] ?? $r['defaults'][$key] ?? $value;
            }

            return $r;
        }

        return $this->resolveError($errors, $method, $uri);

Are you sure the usage of $this->resolveError($errors, $method, $uri) targeting Flight\Routing\Traits\ResolverTrait::resolveError() seems to always return null.

    }

    /**
     * @return null|array<string,mixed>
     */
    protected function resolveCache(string $path, string $method, UriInterface $uri): ?array
    {
        $errors = [[], []];
        $routes = $this->optimized[2] ?? $this->doCache();

It seems like doCache() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if (!$matched = $this->optimized[0][$path] ?? $this->optimized[1][0]($path)) {
            return null;
        }

        foreach ($matched as $match) {
            $r = $routes[$o = \intval($match['MARK'] ?? $match)] ?? $routes->getRoutes()[$o];

            if (!$this->assertRoute($method, $uri, $r, $errors)) {
                continue;
            }

            if (isset($match['MARK'])) {
                $i = 0;

                foreach ($this->optimized[1][1][$o] ?? [] as $key => $value) {
                    $r['arguments'][$key] = $match[++$i] ?: $r['defaults'][$key] ?? $value;
                }
            }

            return $r;
        }

        return $this->resolveError($errors, $method, $uri);

Are you sure the usage of $this->resolveError($errors, $method, $uri) targeting Flight\Routing\Traits\ResolverTrait::resolveError() seems to always return null.

    }

    /**
     * @param array<int,array<string,bool|string>> $errors
     */
    protected function resolveError(array $errors, string $method, UriInterface $uri)
    {
        if (!empty($errors[0])) {
            throw new MethodNotAllowedException(\array_keys($errors[0]), $uri->getPath(), $method);
        }

        if (!empty($errors[1])) {
            throw new UriHandlerException(
                \sprintf(
                    'Route with "%s" path requires request scheme(s) [%s], "%s" is invalid.',
                    $uri->getPath(),
                    \implode(', ', \array_keys($errors[1])),
                    $uri->getScheme(),
                ),
                400
            );
        }

        return null;
    }
}