Merge pull request #217 from asgrim/modify-middleware-listener-to-use-stratigility-pipe

Modify middleware listener to use stratigility pipe

Author: weierophinney

composer.json

@@ -27,7 +27,8 @@
         "phpunit/phpunit": "^6.0.7 || ^5.7.14",
         "zendframework/zend-coding-standard": "~1.0.0",
         "zendframework/zend-json": "^2.6.1 || ^3.0",
-        "zendframework/zend-psr7bridge": "^0.2"
+        "zendframework/zend-psr7bridge": "^0.2",
+        "zendframework/zend-stratigility": "^2.0.1"
     },
     "suggest": {
         "zendframework/zend-json": "(^2.6.1 || ^3.0) To auto-deserialize JSON body content in AbstractRestfulController extensions, when json_decode is unavailable",
@@ -40,7 +41,8 @@
         "zendframework/zend-mvc-plugin-prg": "To provide Post/Redirect/Get functionality within controllers",
         "zendframework/zend-paginator": "^2.7 To provide pagination functionality via PaginatorPluginManager",
         "zendframework/zend-psr7bridge": "(^0.2) To consume PSR-7 middleware within the MVC workflow",
-        "zendframework/zend-servicemanager-di": "zend-servicemanager-di provides utilities for integrating zend-di and zend-servicemanager in your zend-mvc application"
+        "zendframework/zend-servicemanager-di": "zend-servicemanager-di provides utilities for integrating zend-di and zend-servicemanager in your zend-mvc application",
+        "zendframework/zend-stratigility": "zend-stratigility is required to use middleware pipes in the MiddlewareListener"
     },
     "config": {
         "sort-packages": true

composer.lock

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Mvc\Exception;
+
+final class MiddlewareNotCallableException extends RuntimeException
+{
+    /**
+     * @var string
+     */
+    private $middlewareName;
+
+    /**
+     * @param string $middlewareName
+     * @return self
+     */
+    public static function fromMiddlewareName($middlewareName)
+    {
+        $middlewareName = (string)$middlewareName;
+        $instance = new self(sprintf('Cannot dispatch middleware %s', $middlewareName));
+        $instance->middlewareName = $middlewareName;
+        return $instance;
+    }
+
+    /**
+     * @return string
+     */
+    public function toMiddlewareName()
+    {
+        return null !== $this->middlewareName ? $this->middlewareName : '';
+    }
+}

src/Exception/MiddlewareNotCallableException.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Mvc\Exception;
+
+class ReachedFinalHandlerException extends RuntimeException
+{
+    /**
+     * @return self
+     */
+    public static function create()
+    {
+        return new self('Reached the final handler for middleware pipe - check the pipe configuration');
+    }
+}

src/Exception/ReachedFinalHandlerException.php

@@ -9,12 +9,19 @@
 
 namespace Zend\Mvc;
 
+use Interop\Container\ContainerInterface;
+use Interop\Http\ServerMiddleware\MiddlewareInterface;
 use Psr\Http\Message\ResponseInterface as PsrResponseInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface as PsrServerRequestInterface;
 use Zend\EventManager\AbstractListenerAggregate;
 use Zend\EventManager\EventManagerInterface;
+use Zend\Mvc\Exception\MiddlewareNotCallableException;
+use Zend\Mvc\Exception\ReachedFinalHandlerException;
 use Zend\Psr7Bridge\Psr7ServerRequest as Psr7Request;
 use Zend\Psr7Bridge\Psr7Response;
 use Zend\Router\RouteMatch;
+use Zend\Stratigility\MiddlewarePipe;
 
 class MiddlewareListener extends AbstractListenerAggregate
 {
@@ -47,15 +54,19 @@ public function onDispatch(MvcEvent $event)
         $application    = $event->getApplication();
         $response       = $application->getResponse();
         $serviceManager = $application->getServiceManager();
-        $middlewareName = is_string($middleware) ? $middleware : get_class($middleware);
 
-        if (is_string($middleware) && $serviceManager->has($middleware)) {
-            $middleware = $serviceManager->get($middleware);
-        }
-        if (! is_callable($middleware)) {
+        $psr7ResponsePrototype = Psr7Response::fromZend($response);
+
+        try {
+            $pipe = $this->createPipeFromSpec(
+                $serviceManager,
+                $psr7ResponsePrototype,
+                is_array($middleware) ? $middleware : [$middleware]
+            );
+        } catch (MiddlewareNotCallableException $middlewareNotCallableException) {
             $return = $this->marshalMiddlewareNotCallable(
                 $application::ERROR_MIDDLEWARE_CANNOT_DISPATCH,
-                $middlewareName,
+                $middlewareNotCallableException->toMiddlewareName(),
                 $event,
                 $application
             );
@@ -69,7 +80,13 @@ public function onDispatch(MvcEvent $event)
             foreach ($routeMatch->getParams() as $key => $value) {
                 $psr7Request = $psr7Request->withAttribute($key, $value);
             }
-            $return = $middleware($psr7Request, Psr7Response::fromZend($response));
+            $return = $pipe(
+                $psr7Request,
+                $psr7ResponsePrototype,
+                function (PsrServerRequestInterface $request, PsrResponseInterface $response) {
+                    throw ReachedFinalHandlerException::create();
+                }
+            );
         } catch (\Throwable $ex) {
             $caughtException = $ex;
         } catch (\Exception $ex) {  // @TODO clean up once PHP 7 requirement is enforced
@@ -79,8 +96,6 @@ public function onDispatch(MvcEvent $event)
         if ($caughtException !== null) {
             $event->setName(MvcEvent::EVENT_DISPATCH_ERROR);
             $event->setError($application::ERROR_EXCEPTION);
-            $event->setController($middlewareName);
-            $event->setControllerClass(get_class($middleware));
             $event->setParam('exception', $caughtException);
 
             $events  = $application->getEventManager();
@@ -100,6 +115,42 @@ public function onDispatch(MvcEvent $event)
         return $response;
     }
 
+    /**
+     * Create a middleware pipe from the array spec given.
+     *
+     * @param ContainerInterface $serviceLocator
+     * @param ResponseInterface $responsePrototype
+     * @param array $middlewaresToBePiped
+     * @return MiddlewarePipe
+     * @throws \InvalidArgumentException
+     * @throws \Zend\Mvc\Exception\MiddlewareNotCallableException
+     */
+    private function createPipeFromSpec(
+        ContainerInterface $serviceLocator,
+        ResponseInterface $responsePrototype,
+        array $middlewaresToBePiped
+    ) {
+        $pipe = new MiddlewarePipe();
+        $pipe->setResponsePrototype($responsePrototype);
+        foreach ($middlewaresToBePiped as $middlewareToBePiped) {
+            if (null === $middlewareToBePiped) {
+                throw new \InvalidArgumentException('Middleware name cannot be null');
+            }
+
+            $middlewareName = is_string($middlewareToBePiped) ? $middlewareToBePiped : get_class($middlewareToBePiped);
+
+            if (is_string($middlewareToBePiped) && $serviceLocator->has($middlewareToBePiped)) {
+                $middlewareToBePiped = $serviceLocator->get($middlewareToBePiped);
+            }
+            if (! $middlewareToBePiped instanceof MiddlewareInterface && ! is_callable($middlewareToBePiped)) {
+                throw MiddlewareNotCallableException::fromMiddlewareName($middlewareName);
+            }
+
+            $pipe->pipe($middlewareToBePiped);
+        }
+        return $pipe;
+    }
+
     /**
      * Marshal a middleware not callable exception event
      *

src/MiddlewareListener.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\Mvc;
+
+use PHPUnit\Framework\TestCase;
+use Zend\Mvc\Exception\MiddlewareNotCallableException;
+
+final class MiddlewareNotCallableExceptionTest extends TestCase
+{
+    public function testFromMiddlewareName()
+    {
+        $middlewareName = uniqid('middlewareName', true);
+        $exception = MiddlewareNotCallableException::fromMiddlewareName($middlewareName);
+
+        $this->assertInstanceOf(MiddlewareNotCallableException::class, $exception);
+        $this->assertSame('Cannot dispatch middleware ' . $middlewareName, $exception->getMessage());
+        $this->assertSame($middlewareName, $exception->toMiddlewareName());
+    }
+
+    public function testToMiddlewareNameWhenNotSet()
+    {
+        $exception = new MiddlewareNotCallableException();
+        $this->assertSame('', $exception->toMiddlewareName());
+    }
+}

test/Exception/MiddlewareNotCallableExceptionTest.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\Mvc;
+
+use PHPUnit\Framework\TestCase;
+use Zend\Mvc\Exception\ReachedFinalHandlerException;
+
+final class ReachedFinalHandlerExceptionTest extends TestCase
+{
+    public function testFromNothing()
+    {
+        $exception = ReachedFinalHandlerException::create();
+
+        $this->assertInstanceOf(ReachedFinalHandlerException::class, $exception);
+        $this->assertSame(
+            'Reached the final handler for middleware pipe - check the pipe configuration',
+            $exception->getMessage()
+        );
+    }
+}