MiddlewareDispatcherTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Unit\Http;
 
use PHPUnit\Framework\Attributes\Test;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use ‪TYPO3\CMS\Core\Http\MiddlewareDispatcher;
use ‪TYPO3\CMS\Core\Http\Response;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Tests\Unit\Http\Fixtures\MiddlewareFixture;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪MiddlewareDispatcherTest extends UnitTestCase
{
    #[Test]
    public function ‪executesKernelWithEmptyMiddlewareStack(): void
    {
        $kernel = new class () implements RequestHandlerInterface {
            public function handle(ServerRequestInterface $request): ResponseInterface
            {
                return (new ‪Response())->withStatus(204);
            }
        };
 
        $dispatcher = new ‪MiddlewareDispatcher($kernel);
        $response = $dispatcher->handle(new ‪ServerRequest());
 
        self::assertSame(204, $response->getStatusCode());
    }
 
    #[Test]
    public function ‪executesMiddlewaresLastInFirstOut(): void
    {
        $kernel = new class () implements RequestHandlerInterface {
            public function handle(ServerRequestInterface $request): ResponseInterface
            {
                return (new ‪Response())
                    ->withStatus(204)
                    ->withHeader('X-SEQ-PRE-REQ-HANDLER', $request->getHeader('X-SEQ-PRE-REQ-HANDLER'));
            }
        };
 
        $middleware1 = new class () implements MiddlewareInterface {
            public $id = '0';
 
            public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
            {
                $request = $request->withAddedHeader('X-SEQ-PRE-REQ-HANDLER', $this->id);
                $response = $handler->handle($request);
 
                return $response->withAddedHeader('X-SEQ-POST-REQ-HANDLER', $this->id);
            }
        };
 
        $middleware2 = clone $middleware1;
        $middleware2->id = '1';
 
        ‪MiddlewareFixture::$id = '2';
 
        $middleware4 = clone $middleware1;
        $middleware4->id = '3';
 
        $dispatcher = new ‪MiddlewareDispatcher($kernel, [$middleware1, $middleware2]);
        $dispatcher->lazy(MiddlewareFixture::class);
        $dispatcher->add($middleware4);
 
        $response = $dispatcher->handle(new ‪ServerRequest());
 
        self::assertSame(['3', '2', '1', '0'], $response->getHeader('X-SEQ-PRE-REQ-HANDLER'));
        self::assertSame(['0', '1', '2', '3'], $response->getHeader('X-SEQ-POST-REQ-HANDLER'));
        self::assertSame(204, $response->getStatusCode());
    }
 
    #[Test]
    public function ‪doesNotInstantiateLazyMiddlewareInCaseOfAnEarlyReturningOuterMiddleware(): void
    {
        $kernel = new class () implements RequestHandlerInterface {
            public function handle(ServerRequestInterface $request): ResponseInterface
            {
                return new ‪Response();
            }
        };
        $middleware = new class () implements MiddlewareInterface {
            public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
            {
                return (new ‪Response())->withStatus(404);
            }
        };
 
        ‪MiddlewareFixture::$hasBeenInstantiated = false;
        $dispatcher = new ‪MiddlewareDispatcher($kernel, [MiddlewareFixture::class, $middleware]);
        $response = $dispatcher->handle(new ‪ServerRequest());
 
        self::assertFalse(‪MiddlewareFixture::$hasBeenInstantiated);
        self::assertSame(404, $response->getStatusCode());
    }
 
    #[Test]
    public function ‪throwsExceptionForLazyNonMiddlewareInterfaceClasses(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1516821342);
 
        $kernel = new class () implements RequestHandlerInterface {
            public function handle(ServerRequestInterface $request): ResponseInterface
            {
                return new ‪Response();
            }
        };
 
        ‪MiddlewareFixture::$hasBeenInstantiated = false;
        $dispatcher = new ‪MiddlewareDispatcher($kernel);
        $dispatcher->lazy(\stdClass::class);
        $dispatcher->handle(new ‪ServerRequest());
    }
 
    #[Test]
    public function ‪canBeExecutedMultipleTimes(): void
    {
        $kernel = new class () implements RequestHandlerInterface {
            public function handle(ServerRequestInterface $request): ResponseInterface
            {
                return new ‪Response();
            }
        };
        $middleware = new class () implements MiddlewareInterface {
            public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
            {
                return (new ‪Response())->withStatus(204);
            }
        };
 
        $dispatcher = new ‪MiddlewareDispatcher($kernel);
        $dispatcher->add($middleware);
 
        $response1 = $dispatcher->handle(new ‪ServerRequest());
        $response2 = $dispatcher->handle(new ‪ServerRequest());
 
        self::assertSame(204, $response1->getStatusCode());
        self::assertSame(204, $response2->getStatusCode());
    }
 
    #[Test]
    public function ‪canBeReExecutedRecursivelyDuringDispatch(): void
    {
        $kernel = new class () implements RequestHandlerInterface {
            public function handle(ServerRequestInterface $request): ResponseInterface
            {
                return new ‪Response();
            }
        };
 
        $dispatcher = new ‪MiddlewareDispatcher($kernel);
 
        $dispatcher->add(new class ($dispatcher) implements MiddlewareInterface {
            private $dispatcher;
 
            public function __construct(RequestHandlerInterface $dispatcher)
            {
                $this->dispatcher = $dispatcher;
            }
 
            public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
            {
                if ($request->hasHeader('X-NESTED')) {
                    return (new ‪Response())->withStatus(204)->withAddedHeader('X-TRACE', 'nested');
                }
 
                $response = $this->dispatcher->handle($request->withAddedHeader('X-NESTED', '1'));
 
                return $response->withAddedHeader('X-TRACE', 'outer');
            }
        });
 
        $response = $dispatcher->handle(new ‪ServerRequest());
 
        self::assertSame(204, $response->getStatusCode());
        self::assertSame(['nested', 'outer'], $response->getHeader('X-TRACE'));
    }
 
    #[Test]
    public function ‪fetchesMiddlewareFromContainer(): void
    {
        $kernel = new class () implements RequestHandlerInterface {
            public function handle(ServerRequestInterface $request): ResponseInterface
            {
                return new ‪Response();
            }
        };
 
        $middleware = new class () implements MiddlewareInterface {
            public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
            {
                return (new ‪Response())->withStatus(404);
            }
        };
 
        $containerMock = $this->createMock(ContainerInterface::class);
        $containerMock->method('has')->with('somemiddlewarename')->willReturn(true);
        $containerMock->method('get')->with('somemiddlewarename')->willReturn($middleware);
 
        $dispatcher = new ‪MiddlewareDispatcher($kernel, ['somemiddlewarename'], $containerMock);
        $response = $dispatcher->handle(new ‪ServerRequest());
 
        self::assertSame(404, $response->getStatusCode());
    }
}