sunrise-php / http-router

src/ResponseResolverChain.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\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use ReflectionAttribute;
use ReflectionMethod;
use Sunrise\Http\Router\Annotation\ResponseHeader;
use Sunrise\Http\Router\Annotation\ResponseStatus;

use function sprintf;
use function usort;

/**
 * @since 3.0.0
 */
final class ResponseResolverChain implements ResponseResolverChainInterface
{
    private bool $isSorted = false;

    public function __construct(
        /** @var array<array-key, ResponseResolverInterface> */
        private array $resolvers = [],
    ) {
    }

    /**
     * @inheritDoc
     *
     * @throws InvalidArgumentException
     * @throws LogicException
     */
    public function resolveResponse(
        mixed $response,
        ReflectionMethod $responder,
        ServerRequestInterface $request,
    ): ResponseInterface {
        if ($response instanceof ResponseInterface) {
            return $response;
        }

        $this->isSorted or $this->sortResolvers();
        foreach ($this->resolvers as $resolver) {
            $result = $resolver->resolveResponse($response, $responder, $request);
            if ($result instanceof ResponseInterface) {
                return self::completeResponse($result, $responder);
            }
        }

        throw new LogicException(sprintf(
            'The responder "%s" returned an unsupported response that cannot be resolved.',
            self::stringifyResponder($responder),
        ));
    }

    private static function completeResponse(
        ResponseInterface $response,
        ReflectionMethod $responder,
    ): ResponseInterface {
        /** @var list<ReflectionAttribute<ResponseStatus>> $annotations */
        $annotations = $responder->getAttributes(ResponseStatus::class);
        if (isset($annotations[0])) {
            $status = $annotations[0]->newInstance();
            $response = $response->withStatus($status->code, $status->phrase);
        }

        /** @var list<ReflectionAttribute<ResponseHeader>> $annotations */
        $annotations = $responder->getAttributes(ResponseHeader::class);
        foreach ($annotations as $annotation) {
            $header = $annotation->newInstance();
            $response = $response->withHeader($header->name, $header->value);
        }

        return $response;

The expression return $response could return the type Psr\Http\Message\MessageInterface which includes types incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding an additional type-check to rule them out.

    }

    private function sortResolvers(): void
    {
        $this->isSorted = usort($this->resolvers, static fn(
            ResponseResolverInterface $a,
            ResponseResolverInterface $b,
        ): int => $b->getWeight() <=> $a->getWeight());
    }

    public static function stringifyResponder(ReflectionMethod $responder): string
    {
        return sprintf('%s::%s()', $responder->class, $responder->name);
    }
}