Merge pull request #69 from gsteel/v4/method-not-allowed-response-fac…

…tory

Drop compatibility with callable response factories on `MethodNotAllowedMiddleware` and `ImplicitOptionsMiddleware`

psalm-baseline.xml

@@ -5,9 +5,4 @@
       <code><![CDATA[$this->services[$id]]]></code>
     </MixedReturnStatement>
   </file>
-  <file src="test/Response/CallableResponseFactoryDecoratorTest.php">
-    <InternalMethod>
-      <code><![CDATA[new CallableResponseFactoryDecorator(fn (): ResponseInterface => $this->response)]]></code>
-    </InternalMethod>
-  </file>
 </files>

src/Middleware/ImplicitOptionsMiddleware.php

@@ -5,7 +5,6 @@
 namespace Mezzio\Router\Middleware;
 
 use Fig\Http\Message\RequestMethodInterface as RequestMethod;
-use Mezzio\Router\Response\CallableResponseFactoryDecorator;
 use Mezzio\Router\RouteResult;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -16,7 +15,6 @@
 use function assert;
 use function implode;
 use function is_array;
-use function is_callable;
 
 /**
  * Handle implicit OPTIONS requests.
@@ -43,25 +41,8 @@
  */
 final class ImplicitOptionsMiddleware implements MiddlewareInterface
 {
-    private ResponseFactoryInterface $responseFactory;
-
-    /**
-     * @param (callable():ResponseInterface)|ResponseFactoryInterface $responseFactory A factory capable of returning an
-     *     empty ResponseInterface instance to return for implicit OPTIONS
-     *     requests.
-     */
-    public function __construct(callable|ResponseFactoryInterface $responseFactory)
+    public function __construct(private readonly ResponseFactoryInterface $responseFactory)
     {
-        if (is_callable($responseFactory)) {
-            // Factories are wrapped in a closure in order to enforce return type safety.
-            $responseFactory = new CallableResponseFactoryDecorator(
-                static function () use ($responseFactory): ResponseInterface {
-                    return $responseFactory();
-                }
-            );
-        }
-
-        $this->responseFactory = $responseFactory;
     }
 
     /**

src/Middleware/ImplicitOptionsMiddlewareFactory.php

@@ -6,27 +6,31 @@
 
 use Mezzio\Router\Exception\MissingDependencyException;
 use Psr\Container\ContainerInterface;
+use Psr\Http\Message\ResponseFactoryInterface;
 
 /**
  * Create and return an ImplicitOptionsMiddleware instance.
  *
  * This factory depends on one other service:
  *
- * - Psr\Http\Message\ResponseInterface, which should resolve to a callable
- *   that will produce an empty Psr\Http\Message\ResponseInterface instance.
+ * - Psr\Http\Message\ResponseFactoryInterface, which should resolve to an instance of that interface.
  */
 final class ImplicitOptionsMiddlewareFactory
 {
-    use Psr17ResponseFactoryTrait;
-
     /**
-     * @throws MissingDependencyException If the Psr\Http\Message\ResponseInterface
-     *     service is missing.
+     * @throws MissingDependencyException If the Psr\Http\Message\ResponseFactoryInterface service is missing.
      */
     public function __invoke(ContainerInterface $container): ImplicitOptionsMiddleware
     {
+        if (! $container->has(ResponseFactoryInterface::class)) {
+            throw MissingDependencyException::dependencyForService(
+                ResponseFactoryInterface::class,
+                ImplicitOptionsMiddleware::class,
+            );
+        }
+
         return new ImplicitOptionsMiddleware(
-            $this->detectResponseFactory($container)
+            $container->get(ResponseFactoryInterface::class),
         );
     }
 }

src/Middleware/MethodNotAllowedMiddleware.php

@@ -5,7 +5,6 @@
 namespace Mezzio\Router\Middleware;
 
 use Fig\Http\Message\StatusCodeInterface as StatusCode;
-use Mezzio\Router\Response\CallableResponseFactoryDecorator;
 use Mezzio\Router\RouteResult;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -16,7 +15,6 @@
 use function assert;
 use function implode;
 use function is_array;
-use function is_callable;
 
 /**
  * Emit a 405 Method Not Allowed response
@@ -31,23 +29,8 @@
  */
 final class MethodNotAllowedMiddleware implements MiddlewareInterface
 {
-    private ResponseFactoryInterface $responseFactory;
-
-    /**
-     * @param (callable():ResponseInterface)|ResponseFactoryInterface $responseFactory
-     */
-    public function __construct(callable|ResponseFactoryInterface $responseFactory)
+    public function __construct(private readonly ResponseFactoryInterface $responseFactory)
     {
-        if (is_callable($responseFactory)) {
-            // Factories are wrapped in a closure in order to enforce return type safety.
-            $responseFactory = new CallableResponseFactoryDecorator(
-                function () use ($responseFactory): ResponseInterface {
-                    return $responseFactory();
-                }
-            );
-        }
-
-        $this->responseFactory = $responseFactory;
     }
 
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
@@ -63,12 +46,4 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         return $this->responseFactory->createResponse(StatusCode::STATUS_METHOD_NOT_ALLOWED)
             ->withHeader('Allow', implode(',', $allowedMethods));
     }
-
-    /**
-     * @internal This method is only available for unit tests.
-     */
-    public function getResponseFactory(): ResponseFactoryInterface
-    {
-        return $this->responseFactory;
-    }
 }

src/Middleware/MethodNotAllowedMiddlewareFactory.php

@@ -6,27 +6,31 @@
 
 use Mezzio\Router\Exception\MissingDependencyException;
 use Psr\Container\ContainerInterface;
+use Psr\Http\Message\ResponseFactoryInterface;
 
 /**
  * Create and return a MethodNotAllowedMiddleware instance.
  *
  * This factory depends on one other service:
  *
- * - Psr\Http\Message\ResponseInterface, which should resolve to a callable
- *   that will produce an empty Psr\Http\Message\ResponseInterface instance.
+ * - Psr\Http\Message\ResponseFactoryInterface, which should resolve to an instance of that interface.
  */
 final class MethodNotAllowedMiddlewareFactory
 {
-    use Psr17ResponseFactoryTrait;
-
     /**
-     * @throws MissingDependencyException If the Psr\Http\Message\ResponseInterface
-     *     service is missing.
+     * @throws MissingDependencyException If the Psr\Http\Message\ResponseFactoryInterface service is missing.
      */
     public function __invoke(ContainerInterface $container): MethodNotAllowedMiddleware
     {
+        if (! $container->has(ResponseFactoryInterface::class)) {
+            throw MissingDependencyException::dependencyForService(
+                ResponseFactoryInterface::class,
+                MethodNotAllowedMiddleware::class,
+            );
+        }
+
         return new MethodNotAllowedMiddleware(
-            $this->detectResponseFactory($container)
+            $container->get(ResponseFactoryInterface::class),
         );
     }
 }

src/Test/AbstractImplicitMethodsIntegrationTest.php

@@ -19,9 +19,11 @@
 use Mezzio\Router\Route;
 use Mezzio\Router\RouteResult;
 use Mezzio\Router\RouterInterface;
+use MezzioTest\Router\Asset\FixedResponseFactory;
 use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\MiddlewareInterface;
@@ -46,9 +48,9 @@ abstract public function getRouter(): RouterInterface;
     public function getImplicitOptionsMiddleware(?ResponseInterface $response = null): ImplicitOptionsMiddleware
     {
         return new ImplicitOptionsMiddleware(
-            function () use ($response): ResponseInterface {
-                return $response ?? new Response();
-            }
+            new FixedResponseFactory(
+                $response ?? new Response(),
+            ),
         );
     }
 
@@ -60,13 +62,13 @@ public function getImplicitHeadMiddleware(RouterInterface $router): ImplicitHead
         );
     }
 
-    /**
-     * @return callable(): never
-     */
-    public function createInvalidResponseFactory(): callable
+    public function createInvalidResponseFactory(): ResponseFactoryInterface
     {
-        return static function (): ResponseInterface {
-            self::fail('Response generated when it should not have been');
+        return new class implements ResponseFactoryInterface {
+            public function createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface
+            {
+                TestCase::fail('Response generated when it should not have been');
+            }
         };
     }
 
@@ -236,9 +238,9 @@ public function testWithoutImplicitMiddleware(string $requestMethod, array $allo
 
         $pipeline = new MiddlewarePipe();
         $pipeline->pipe(new RouteMiddleware($router));
-        $pipeline->pipe(new MethodNotAllowedMiddleware(static function () use ($finalResponse): ResponseInterface {
-            return $finalResponse;
-        }));
+        $pipeline->pipe(new MethodNotAllowedMiddleware(
+            new FixedResponseFactory($finalResponse),
+        ));
 
         $finalHandler = $this->createMock(RequestHandlerInterface::class);
         $finalHandler

test/Asset/FixedResponseFactory.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MezzioTest\Router\Asset;
+
+use Psr\Http\Message\ResponseFactoryInterface;
+use Psr\Http\Message\ResponseInterface;
+
+final class FixedResponseFactory implements ResponseFactoryInterface
+{
+    public function __construct(public readonly ResponseInterface $response)
+    {
+    }
+
+    public function createResponse(int $code = 200, string $reasonPhrase = ''): ResponseInterface
+    {
+        return $this->response->withStatus($code);
+    }
+}