Fix #61: Add support callable middlewares (#69)

rustamwin · web-flow · commit aa5379fd9f9a · 2022-12-23T23:55:19.000+05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 - Chg #68: Remove wrapper factory (@rustamwin)
 - New #68: Add `ParametersResolverInterface` to resolve parameters of middleware that are provided as callable (@rustamwin)
+- Enh #69: Add support for callable middlewares (@rustamwin)
+- Enh #69: Add debug info to callable wrapper (@rustamwin)
 
 ## 4.0.0 November 10, 2022
 
diff --git a/src/MiddlewareFactory.php b/src/MiddlewareFactory.php
@@ -44,6 +44,7 @@ public function __construct(
      * - A callable with
      *   `function(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface`
      *   signature.
+     * - Any callable.
      * - A controller handler action in format `[TestController::class, 'index']`. `TestController` instance will
      *   be created and `index()` method will be executed.
      * - A function returning a middleware. The middleware returned will be executed.
@@ -87,11 +88,11 @@ private function isMiddlewareClassDefinition(array|callable|string $definition):
     }
 
     /**
-     * @psalm-assert-if-true array{0:class-string, 1:non-empty-string}|Closure $definition
+     * @psalm-assert-if-true array{0:class-string, 1:non-empty-string}|callable $definition
      */
     private function isCallableDefinition(array|callable|string $definition): bool
     {
-        if ($definition instanceof Closure) {
+        if (is_callable($definition)) {
             return true;
         }
 
@@ -125,15 +126,15 @@ private function isArrayDefinition(array|callable|string $definition): bool
     }
 
     /**
-     * @param array{0:class-string, 1:non-empty-string}|Closure $callable
+     * @param array{0:class-string, 1:non-empty-string}|callable $callable
      */
-    private function wrapCallable(array|Closure $callable): MiddlewareInterface
+    private function wrapCallable(array|callable $callable): MiddlewareInterface
     {
-        if (is_array($callable)) {
-            return $this->createActionWrapper($callable[0], $callable[1]);
+        if (is_callable($callable)) {
+            return $this->createCallableWrapper($callable);
         }
 
-        return $this->createCallableWrapper($callable);
+        return $this->createActionWrapper($callable[0], $callable[1]);
     }
 
     private function createCallableWrapper(callable $callback): MiddlewareInterface
@@ -171,6 +172,11 @@ public function process(
                 throw new InvalidMiddlewareDefinitionException($this->callback);
             }
 
+            public function __debugInfo(): array
+            {
+                return ['callback' => $this->callback];
+            }
+
             /**
              * @return \ReflectionParameter[]
              */
diff --git a/tests/MiddlewareFactoryTest.php b/tests/MiddlewareFactoryTest.php
@@ -15,6 +15,7 @@
 use Yiisoft\Middleware\Dispatcher\InvalidMiddlewareDefinitionException;
 use Yiisoft\Middleware\Dispatcher\MiddlewareFactory;
 use Yiisoft\Middleware\Dispatcher\ParametersResolverInterface;
+use Yiisoft\Middleware\Dispatcher\Tests\Support\InvokeableAction;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\SimpleParametersResolver;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\UseParamsController;
 use Yiisoft\Middleware\Dispatcher\Tests\Support\UseParamsMiddleware;
@@ -110,6 +111,45 @@ public function testCreateFromClosureWithResolver(): void
         );
     }
 
+    public function testCreateCallableFromArrayWithInstance(): void
+    {
+        $container = $this->getContainer();
+        $controller = new TestController();
+        $middleware = $this
+            ->getMiddlewareFactory($container)
+            ->create([$controller, 'index']);
+        self::assertSame(
+            'yii',
+            $middleware
+                ->process(
+                    $this->createMock(ServerRequestInterface::class),
+                    $this->createMock(RequestHandlerInterface::class)
+                )
+                ->getHeaderLine('test')
+        );
+        self::assertSame(
+            [$controller, 'index'],
+            $middleware->__debugInfo()['callback']
+        );
+    }
+
+    public function testCreateCallableObject(): void
+    {
+        $container = $this->getContainer();
+        $middleware = $this
+            ->getMiddlewareFactory($container)
+            ->create(new InvokeableAction());
+        self::assertSame(
+            'yii',
+            $middleware
+                ->process(
+                    $this->createMock(ServerRequestInterface::class),
+                    $this->createMock(RequestHandlerInterface::class)
+                )
+                ->getHeaderLine('test')
+        );
+    }
+
     public function testCreateFromClosureMiddleware(): void
     {
         $container = $this->getContainer([TestController::class => new TestController()]);
@@ -259,14 +299,6 @@ public function testInvalidMiddlewareWithWrongArrayType(): void
             ->create(['class' => TestController::class, 'index']);
     }
 
-    public function testInvalidMiddlewareWithWrongArrayWithInstance(): void
-    {
-        $this->expectException(InvalidMiddlewareDefinitionException::class);
-        $this
-            ->getMiddlewareFactory()
-            ->create([new TestController(), 'index']);
-    }
-
     public function testInvalidMiddlewareWithWrongArrayWithIntItems(): void
     {
         $this->expectException(InvalidMiddlewareDefinitionException::class);
diff --git a/tests/Support/InvokeableAction.php b/tests/Support/InvokeableAction.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Middleware\Dispatcher\Tests\Support;
+
+use Nyholm\Psr7\Response;
+use Psr\Http\Message\ResponseInterface;
+
+final class InvokeableAction
+{
+    public function __invoke(): ResponseInterface
+    {
+        return new Response(200, ['test' => 'yii']);
+    }
+}
