Extract logic to create middleware pipe into private method

Author: asgrim

src/Exception/MiddlewareNotCallableException.php

@@ -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 $this->middlewareName ?? '';
+    }
+}

src/MiddlewareListener.php

@@ -9,10 +9,13 @@
 
 namespace Zend\Mvc;
 
+use Interop\Container\ContainerInterface;
 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;
@@ -52,31 +55,22 @@ public function onDispatch(MvcEvent $event)
         $serviceManager = $application->getServiceManager();
 
         $psr7ResponsePrototype = Psr7Response::fromZend($response);
-        $pipe = new MiddlewarePipe();
-        $pipe->setResponsePrototype($psr7ResponsePrototype);
-
-        $middlewaresToBePiped = !is_array($middleware) ? [$middleware] : $middleware;
-
-        $middlewareName = 'noMiddlewarePiped';
-        $middlewareToBePiped = null;
-        foreach ($middlewaresToBePiped as $middlewareToBePiped) {
-            $middlewareName = is_string($middlewareToBePiped) ? $middlewareToBePiped : get_class($middlewareToBePiped);
-
-            if (is_string($middlewareToBePiped) && $serviceManager->has($middlewareToBePiped)) {
-                $middlewareToBePiped = $serviceManager->get($middlewareToBePiped);
-            }
-            if (! is_callable($middlewareToBePiped)) {
-                $return = $this->marshalMiddlewareNotCallable(
-                    $application::ERROR_MIDDLEWARE_CANNOT_DISPATCH,
-                    $middlewareName,
-                    $event,
-                    $application
-                );
-                $event->setResult($return);
-                return $return;
-            }
 
-            $pipe->pipe($middlewareToBePiped);
+        try {
+            $pipe = $this->createPipeFromSpec(
+                $serviceManager,
+                $psr7ResponsePrototype,
+                is_array($middleware) ? $middleware : [$middleware]
+            );
+        } catch (MiddlewareNotCallableException $middlewareNotCallableException) {
+            $return = $this->marshalMiddlewareNotCallable(
+                $application::ERROR_MIDDLEWARE_CANNOT_DISPATCH,
+                $middlewareNotCallableException->toMiddlewareName(),
+                $event,
+                $application
+            );
+            $event->setResult($return);
+            return $return;
         }
 
         $caughtException = null;
@@ -103,10 +97,6 @@ function (PsrServerRequestInterface $request, PsrResponseInterface $response) {
         if ($caughtException !== null) {
             $event->setName(MvcEvent::EVENT_DISPATCH_ERROR);
             $event->setError($application::ERROR_EXCEPTION);
-            $event->setController($middlewareName);
-            if (null !== $middlewareToBePiped) {
-                $event->setControllerClass(get_class($middlewareToBePiped));
-            }
             $event->setParam('exception', $caughtException);
 
             $events  = $application->getEventManager();
@@ -126,6 +116,37 @@ function (PsrServerRequestInterface $request, PsrResponseInterface $response) {
         return $response;
     }
 
+    /**
+     * Create a middleware pipe from the array spec given.
+     *
+     * @param ContainerInterface $serviceLocator
+     * @param ResponseInterface $responsePrototype
+     * @param array $middlewaresToBePiped
+     * @return MiddlewarePipe
+     * @throws \Zend\Mvc\Exception\MiddlewareNotCallableException
+     */
+    private function createPipeFromSpec(
+        ContainerInterface $serviceLocator,
+        ResponseInterface $responsePrototype,
+        array $middlewaresToBePiped
+    ) {
+        $pipe = new MiddlewarePipe();
+        $pipe->setResponsePrototype($responsePrototype);
+        foreach ($middlewaresToBePiped as $middlewareToBePiped) {
+            $middlewareName = is_string($middlewareToBePiped) ? $middlewareToBePiped : get_class($middlewareToBePiped);
+
+            if (is_string($middlewareToBePiped) && $serviceLocator->has($middlewareToBePiped)) {
+                $middlewareToBePiped = $serviceLocator->get($middlewareToBePiped);
+            }
+            if (! is_callable($middlewareToBePiped)) {
+                throw MiddlewareNotCallableException::fromMiddlewareName($middlewareName);
+            }
+
+            $pipe->pipe($middlewareToBePiped);
+        }
+        return $pipe;
+    }
+
     /**
      * Marshal a middleware not callable exception event
      *

test/Exception/MiddlewareNotCallableExceptionTest.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-2015 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 as TestCase;
+use Zend\Mvc\Exception\MiddlewareNotCallableException;
+
+final class MiddlewareNotCallableExceptionTest extends TestCase
+{
+    public function testFromMiddlewareName()
+    {
+        $middlewareName = uniqid('middlewareName', true);
+        $exception = MiddlewareNotCallableException::fromMiddlewareName($middlewareName);
+
+        self::assertInstanceOf(MiddlewareNotCallableException::class, $exception);
+        self::assertSame('Cannot dispatch middleware ' . $middlewareName, $exception->getMessage());
+        self::assertSame($middlewareName, $exception->toMiddlewareName());
+    }
+
+    public function testToMiddlewareNameWhenNotSet()
+    {
+        $exception = new MiddlewareNotCallableException();
+        self::assertSame('', $exception->toMiddlewareName());
+    }
+}