Add support for invokable class name & request handler (#89)

rustamwin · vjik · web-flow · commit ab811589581e · 2023-09-19T09:59:27.000+03:00
Co-authored-by: Sergei Predvoditelev &lt;sergei@predvoditelev.ru&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,8 @@
 # Yii Middleware Dispatcher Change Log
 
-## 5.1.1 under development
+## 5.2.0 under development
 
-- no changes in this release.
+- Enh #89: Add support for invokable class names & classes that implements `Psr\Http\Server\RequestHandlerInterface` (@rustamwin)
 
 ## 5.1.0 May 11, 2023
 
diff --git a/README.md b/README.md
@@ -64,6 +64,9 @@ In the above we have used a callback. Overall the following options are availabl
 - A controller handler action in format `[TestController::class, 'index']`. `TestController` instance will be created and
   `index()` method will be executed.
 - A name of PSR-15 middleware class. The middleware instance will be obtained from container.
+- A name of PSR-15 request handler class. The request handler instance will be obtained from container and executed.
+- A name or instance of invokable class. If the name of invokable class is provided, the instance will be 
+  obtained from container and executed.
 - A function returning a middleware such as
   ```php
   static function (): MiddlewareInterface {
diff --git a/src/MiddlewareFactory.php b/src/MiddlewareFactory.php
@@ -42,6 +42,8 @@ public function __construct(
      * @param array|callable|string $middlewareDefinition Middleware definition in one of the following formats:
      *
      * - A name of PSR-15 middleware class. The middleware instance will be obtained from container and executed.
+     * - A name of PSR-15 request handler class. The request handler instance will be obtained from container and executed.
+     * - A name of invokable class. The invokable class instance will be obtained from container and executed.
      * - A callable with
      *   `function(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface`
      *   signature.
@@ -64,6 +66,14 @@ public function create(array|callable|string $middlewareDefinition): MiddlewareI
             return $this->container->get($middlewareDefinition);
         }
 
+        if ($this->isRequestHandlerClassDefinition($middlewareDefinition)) {
+            return $this->wrapCallable([$middlewareDefinition, 'handle']);
+        }
+
+        if ($this->isInvokableClassDefinition($middlewareDefinition)) {
+            return $this->wrapCallable([$middlewareDefinition, '__invoke']);
+        }
+
         if ($this->isCallableDefinition($middlewareDefinition)) {
             return $this->wrapCallable($middlewareDefinition);
         }
@@ -89,6 +99,27 @@ private function isMiddlewareClassDefinition(array|callable|string $definition):
             && is_subclass_of($definition, MiddlewareInterface::class);
     }
 
+    /**
+     * @psalm-assert-if-true class-string<RequestHandlerInterface> $definition
+     */
+    private function isRequestHandlerClassDefinition(array|callable|string $definition): bool
+    {
+        return is_string($definition)
+            && is_subclass_of($definition, RequestHandlerInterface::class);
+    }
+
+    /**
+     * @psalm-assert-if-true class-string|object $definition
+     */
+    private function isInvokableClassDefinition(array|callable|string $definition): bool
+    {
+        /**
+         * @psalm-suppress ArgumentTypeCoercion `method_exists()` allow use any string as first argument and returns
+         * false if it not class name.
+         */
+        return is_string($definition) && method_exists($definition, '__invoke');
+    }
+
     /**
      * @psalm-assert-if-true array{0:class-string, 1:non-empty-string}|callable $definition
      */
@@ -124,7 +155,7 @@ private function isArrayDefinition(array|callable|string $definition): bool
             return false;
         }
 
-        return is_subclass_of((string)($definition['class'] ?? ''), MiddlewareInterface::class);
+        return is_subclass_of((string) ($definition['class'] ?? ''), MiddlewareInterface::class);
     }
 
     /**
diff --git a/tests/MiddlewareDispatcherTest.php b/tests/MiddlewareDispatcherTest.php
@@ -17,6 +17,8 @@
 use Yiisoft\Middleware\Dispatcher\MiddlewareDispatcher;
 use Yiisoft\Middleware\Dispatcher\MiddlewareFactory;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\FailMiddleware;
+use Yiisoft\Middleware\Dispatcher\Tests\Support\InvokeableAction;
+use Yiisoft\Middleware\Dispatcher\Tests\Support\SimpleRequestHandler;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\TestController;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\TestMiddleware;
 use Yiisoft\Test\Support\Container\SimpleContainer;
@@ -31,14 +33,48 @@ public function testCallableMiddlewareCalled(): void
         $dispatcher = $this
             ->createDispatcher()
             ->withMiddlewares([
-                static fn (): ResponseInterface => new Response(418),
+                static fn(): ResponseInterface => new Response(418),
             ]);
 
         $response = $dispatcher->dispatch($request, $this->getRequestHandler());
         $this->assertSame(418, $response->getStatusCode());
     }
 
-    public function testArrayMiddlewareCall(): void
+    public function testInvokableMiddlewareCalled(): void
+    {
+        $request = new ServerRequest('GET', '/');
+        $container = $this->createContainer([InvokeableAction::class => new InvokeableAction()]);
+
+        $dispatcher = $this
+            ->createDispatcher($container)
+            ->withMiddlewares([
+                InvokeableAction::class,
+            ]);
+
+        $response = $dispatcher->dispatch($request, $this->getRequestHandler());
+        $this->assertSame(200, $response->getStatusCode());
+    }
+
+    public function testRequestHandlerCalled(): void
+    {
+        $request = new ServerRequest('GET', '/');
+        $container = $this->createContainer(
+            [
+                SimpleRequestHandler::class => new SimpleRequestHandler(),
+            ]
+        );
+
+        $dispatcher = $this
+            ->createDispatcher($container)
+            ->withMiddlewares([
+                SimpleRequestHandler::class,
+            ]);
+
+        $response = $dispatcher->dispatch($request, $this->getRequestHandler());
+        $this->assertSame(200, $response->getStatusCode());
+    }
+
+    public function testArrayMiddlewareCalled(): void
     {
         $request = new ServerRequest('GET', '/');
         $container = $this->createContainer([
@@ -60,7 +96,13 @@ public function testMiddlewareFullStackCalled(): void
             $request = $request->withAttribute('middleware', 'middleware1');
             return $handler->handle($request);
         };
-        $middleware2 = static fn (ServerRequestInterface $request) => new Response(200, [], null, '1.1', implode($request->getAttributes()));
+        $middleware2 = static fn(ServerRequestInterface $request) => new Response(
+            200,
+            [],
+            null,
+            '1.1',
+            implode($request->getAttributes())
+        );
 
         $dispatcher = $this
             ->createDispatcher()
@@ -75,8 +117,8 @@ public function testMiddlewareStackInterrupted(): void
     {
         $request = new ServerRequest('GET', '/');
 
-        $middleware1 = static fn () => new Response(403);
-        $middleware2 = static fn () => new Response(200);
+        $middleware1 = static fn() => new Response(403);
+        $middleware2 = static fn() => new Response(200);
 
         $dispatcher = $this
             ->createDispatcher()
@@ -92,8 +134,10 @@ public function testEventsAreDispatched(): void
 
         $request = new ServerRequest('GET', '/');
 
-        $middleware1 = static fn (ServerRequestInterface $request, RequestHandlerInterface $handler) => $handler->handle($request);
-        $middleware2 = static fn () => new Response();
+        $middleware1 = static fn(ServerRequestInterface $request, RequestHandlerInterface $handler) => $handler->handle(
+            $request
+        );
+        $middleware2 = static fn() => new Response();
 
         $dispatcher = $this
             ->createDispatcher(null, $eventDispatcher)
@@ -118,7 +162,7 @@ public function testEventsAreDispatchedWhenMiddlewareFailedWithException(): void
 
         $request = new ServerRequest('GET', '/');
         $eventDispatcher = new SimpleEventDispatcher();
-        $middleware = fn () => new FailMiddleware();
+        $middleware = fn() => new FailMiddleware();
         $dispatcher = $this
             ->createDispatcher(null, $eventDispatcher)
             ->withMiddlewares([$middleware]);
@@ -151,10 +195,7 @@ public function testHasMiddlewares(array $definitions, bool $expected): void
     {
         self::assertSame(
             $expected,
-            $this
-                ->createDispatcher()
-                ->withMiddlewares($definitions)
-                ->hasMiddlewares()
+            $this->createDispatcher()->withMiddlewares($definitions)->hasMiddlewares()
         );
     }
 
@@ -194,8 +235,10 @@ public function handle(ServerRequestInterface $request): ResponseInterface
         };
     }
 
-    private function createDispatcher(ContainerInterface $container = null, ?EventDispatcherInterface $eventDispatcher = null): MiddlewareDispatcher
-    {
+    private function createDispatcher(
+        ContainerInterface $container = null,
+        ?EventDispatcherInterface $eventDispatcher = null
+    ): MiddlewareDispatcher {
         if ($container === null) {
             $container = $this->createContainer();
         }
diff --git a/tests/MiddlewareFactoryTest.php b/tests/MiddlewareFactoryTest.php
@@ -15,26 +15,42 @@
 use Yiisoft\Middleware\Dispatcher\InvalidMiddlewareDefinitionException;
 use Yiisoft\Middleware\Dispatcher\MiddlewareFactory;
 use Yiisoft\Middleware\Dispatcher\ParametersResolverInterface;
+use Yiisoft\Middleware\Dispatcher\Tests\Support\InvalidController;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\InvokeableAction;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\ParametersResolver\SimpleParametersResolver;
-use Yiisoft\Middleware\Dispatcher\Tests\Support\UseParamsController;
-use Yiisoft\Middleware\Dispatcher\Tests\Support\UseParamsMiddleware;
-use Yiisoft\Middleware\Dispatcher\Tests\Support\InvalidController;
+use Yiisoft\Middleware\Dispatcher\Tests\Support\SimpleRequestHandler;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\TestController;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\TestMiddleware;
+use Yiisoft\Middleware\Dispatcher\Tests\Support\UseParamsController;
+use Yiisoft\Middleware\Dispatcher\Tests\Support\UseParamsMiddleware;
 use Yiisoft\Test\Support\Container\SimpleContainer;
 
 final class MiddlewareFactoryTest extends TestCase
 {
     public function testCreateFromString(): void
     {
         $container = $this->getContainer([TestMiddleware::class => new TestMiddleware()]);
-        $middleware = $this
-            ->getMiddlewareFactory($container)
-            ->create(TestMiddleware::class);
+        $middleware = $this->getMiddlewareFactory($container)->create(TestMiddleware::class);
+
         self::assertInstanceOf(TestMiddleware::class, $middleware);
     }
 
+    public function testCreateFromInvokable(): void
+    {
+        $container = $this->getContainer([InvokeableAction::class => new InvokeableAction()]);
+        $middleware = $this->getMiddlewareFactory($container)->create(InvokeableAction::class);
+
+        self::assertInstanceOf(MiddlewareInterface::class, $middleware);
+    }
+
+    public function testCreateFromRequestHandler(): void
+    {
+        $container = $this->getContainer([SimpleRequestHandler::class => new SimpleRequestHandler()]);
+        $middleware = $this->getMiddlewareFactory($container)->create(SimpleRequestHandler::class);
+
+        self::assertInstanceOf(MiddlewareInterface::class, $middleware);
+    }
+
     public function testCreateFromArray(): void
     {
         $container = $this->getContainer([TestController::class => new TestController()]);
@@ -79,7 +95,7 @@ public function testCreateFromClosureResponse(): void
         $middleware = $this
             ->getMiddlewareFactory($container)
             ->create(
-                static fn (): ResponseInterface => (new Response())->withStatus(418)
+                static fn(): ResponseInterface => (new Response())->withStatus(418)
             );
         self::assertSame(
             418,
@@ -98,7 +114,7 @@ public function testCreateFromClosureWithResolver(): void
         $middleware = $this
             ->getMiddlewareFactory($container, new SimpleParametersResolver())
             ->create(
-                static fn (string $test = ''): ResponseInterface => (new Response())->withStatus(418, $test)
+                static fn(string $test = ''): ResponseInterface => (new Response())->withStatus(418, $test)
             );
         self::assertSame(
             'yii',
@@ -156,7 +172,7 @@ public function testCreateFromClosureMiddleware(): void
         $middleware = $this
             ->getMiddlewareFactory($container)
             ->create(
-                static fn (): MiddlewareInterface => new TestMiddleware()
+                static fn(): MiddlewareInterface => new TestMiddleware()
             );
         self::assertSame(
             '42',
@@ -234,7 +250,7 @@ public function testInvalidMiddlewareWithWrongCallable(): void
         $middleware = $this
             ->getMiddlewareFactory($container)
             ->create(
-                static fn () => 42
+                static fn() => 42
             );
 
         $this->expectException(InvalidMiddlewareDefinitionException::class);
@@ -307,8 +323,10 @@ public function testInvalidMiddlewareWithWrongArrayWithIntItems(): void
             ->create([7, 42]);
     }
 
-    private function getMiddlewareFactory(ContainerInterface $container = null, ParametersResolverInterface $parametersResolver = null): MiddlewareFactory
-    {
+    private function getMiddlewareFactory(
+        ContainerInterface $container = null,
+        ParametersResolverInterface $parametersResolver = null
+    ): MiddlewareFactory {
         if ($container !== null) {
             return new MiddlewareFactory($container, $parametersResolver);
         }
diff --git a/tests/Support/SimpleRequestHandler.php b/tests/Support/SimpleRequestHandler.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Middleware\Dispatcher\Tests\Support;
+
+use Nyholm\Psr7\Response;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+
+class SimpleRequestHandler implements RequestHandlerInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function handle(ServerRequestInterface $request): ResponseInterface
+    {
+        return new Response(200);
+    }
+}
