Merge branch 'hotfix/547-shared-services' into release-3.0.0

Close #547

Author: weierophinney

CHANGELOG.md

@@ -2,6 +2,40 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 3.0.0alpha5 - 2018-02-07
+
+### Added
+
+- Nothing.
+
+### Changed
+
+- [#547](https://github.com/zendframework/zend-expressive/pull/547) modifies the
+  `ConfigProvider`, the `NotFoundMiddlewareFactory`, and the
+  `RouteMiddlewareFactory` to remove the concept of the _unshared_
+  `ResponseInterface` service, as service sharing is not always configurable in
+  container implementations. To resolve the ability to provide discrete
+  instances, the `ConfigProvider` defines two new virtual services that each
+  resolve to the `Zend\Expressive\Container\ResponseFactory`:
+
+  - `Zend\Expressive\Response\NotFoundResponseInterface`
+  - `Zend\Expressive\Response\RouterResponseInterface`
+
+  The related factories now consume these services in order to receive a
+  response prototype for the services they produce.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 3.0.0alpha4 - 2018-02-07
 
 ### Added

src/ConfigProvider.php

@@ -9,7 +9,6 @@
 
 namespace Zend\Expressive;
 
-use Psr\Http\Message\ResponseInterface;
 use Zend\HttpHandlerRunner\Emitter\EmitterInterface;
 use Zend\HttpHandlerRunner\RequestHandlerRunner;
 use Zend\Stratigility\Middleware\ErrorHandler;
@@ -48,16 +47,13 @@ public function getDependencies() : array
                 Middleware\ErrorResponseGenerator::class   => Container\ErrorResponseGeneratorFactory::class,
                 Middleware\NotFoundMiddleware::class       => Container\NotFoundMiddlewareFactory::class,
                 RequestHandlerRunner::class                => Container\RequestHandlerRunnerFactory::class,
-                ResponseInterface::class                   => Container\ResponseFactory::class,
+                Response\NotFoundResponseInterface::class  => Container\ResponseFactory::class,
+                Response\RouterResponseInterface::class    => Container\ResponseFactory::class,
                 Router\DispatchMiddleware::class           => Container\DispatchMiddlewareFactory::class,
                 Router\PathBasedRoutingMiddleware::class   => Container\RouteMiddlewareFactory::class,
                 ServerRequestErrorResponseGenerator::class => Container\ServerRequestErrorResponseGeneratorFactory::class,
                 ServerRequestFactory::class                => Container\ServerRequestFactoryFactory::class,
             ],
-            'shared' => [
-                // Do not share response instances
-                ResponseInterface::class => false,
-            ],
         ];
         // @codingStandardsIgnoreEnd
     }

src/Container/NotFoundMiddlewareFactory.php

@@ -10,8 +10,8 @@
 namespace Zend\Expressive\Container;
 
 use Psr\Container\ContainerInterface;
-use Psr\Http\Message\ResponseInterface;
 use Zend\Expressive\Middleware\NotFoundMiddleware;
+use Zend\Expressive\Response\NotFoundResponseInterface;
 use Zend\Expressive\Template\TemplateRendererInterface;
 
 class NotFoundMiddlewareFactory
@@ -23,12 +23,12 @@ public function __invoke(ContainerInterface $container) : NotFoundMiddleware
             ? $container->get(TemplateRendererInterface::class)
             : null;
         $template = $config['zend-expressive']['error_handler']['template_404']
-            ?? NotFoundMiddleware::TEMPLATE_DEFAULT;
-        $layout = $config['zend-expressive']['error_handler']['layout']
-            ?? NotFoundMiddleware::LAYOUT_DEFAULT;
+                    ?? NotFoundMiddleware::TEMPLATE_DEFAULT;
+        $layout   = $config['zend-expressive']['error_handler']['layout']
+                    ?? NotFoundMiddleware::LAYOUT_DEFAULT;
 
         return new NotFoundMiddleware(
-            $container->get(ResponseInterface::class),
+            $container->get(NotFoundResponseInterface::class),
             $renderer,
             $template,
             $layout

src/Container/RouteMiddlewareFactory.php

@@ -10,7 +10,7 @@
 namespace Zend\Expressive\Container;
 
 use Psr\Container\ContainerInterface;
-use Psr\Http\Message\ResponseInterface;
+use Zend\Expressive\Response\RouterResponseInterface;
 use Zend\Expressive\Router\PathBasedRoutingMiddleware;
 use Zend\Expressive\Router\RouterInterface;
 
@@ -20,7 +20,7 @@ public function __invoke(ContainerInterface $container) : PathBasedRoutingMiddle
     {
         return new PathBasedRoutingMiddleware(
             $container->get(RouterInterface::class),
-            $container->get(ResponseInterface::class)
+            $container->get(RouterResponseInterface::class)
         );
     }
 }

test/ConfigProviderTest.php

@@ -10,14 +10,15 @@
 namespace ZendTest\Expressive;
 
 use PHPUnit\Framework\TestCase;
-use Psr\Http\Message\ResponseInterface;
 use Zend\Expressive\Application;
 use Zend\Expressive\ApplicationPipeline;
 use Zend\Expressive\ConfigProvider;
 use Zend\Expressive\Delegate\DefaultDelegate;
 use Zend\Expressive\Middleware;
 use Zend\Expressive\MiddlewareContainer;
 use Zend\Expressive\MiddlewareFactory;
+use Zend\Expressive\Response\NotFoundResponseInterface;
+use Zend\Expressive\Response\RouterResponseInterface;
 use Zend\Expressive\Router\DispatchMiddleware;
 use Zend\Expressive\Router\PathBasedRoutingMiddleware;
 use Zend\Expressive\ServerRequestErrorResponseGenerator;
@@ -49,36 +50,27 @@ public function testProviderDefinesExpectedFactoryServices()
 
         $this->assertArrayHasKey(Application::class, $factories);
         $this->assertArrayHasKey(ApplicationPipeline::class, $factories);
+        $this->assertArrayHasKey(DispatchMiddleware::class, $factories);
         $this->assertArrayHasKey(EmitterInterface::class, $factories);
         $this->assertArrayHasKey(ErrorHandler::class, $factories);
         $this->assertArrayHasKey(MiddlewareContainer::class, $factories);
         $this->assertArrayHasKey(MiddlewareFactory::class, $factories);
-        $this->assertArrayHasKey(DispatchMiddleware::class, $factories);
         $this->assertArrayHasKey(Middleware\ErrorResponseGenerator::class, $factories);
         $this->assertArrayHasKey(Middleware\NotFoundMiddleware::class, $factories);
+        $this->assertArrayHasKey(NotFoundResponseInterface::class, $factories);
         $this->assertArrayHasKey(PathBasedRoutingMiddleware::class, $factories);
         $this->assertArrayHasKey(RequestHandlerRunner::class, $factories);
-        $this->assertArrayHasKey(ResponseInterface::class, $factories);
+        $this->assertArrayHasKey(RouterResponseInterface::class, $factories);
         $this->assertArrayHasKey(ServerRequestErrorResponseGenerator::class, $factories);
         $this->assertArrayHasKey(ServerRequestFactory::class, $factories);
     }
 
-    public function testResponseIsMarkedAsUnshared()
-    {
-        $config = $this->provider->getDependencies();
-        $shared = $config['shared'];
-
-        $this->assertArrayHasKey(ResponseInterface::class, $shared);
-        $this->assertFalse($shared[ResponseInterface::class]);
-    }
-
     public function testInvocationReturnsArrayWithDependencies()
     {
         $config = ($this->provider)();
         $this->assertInternalType('array', $config);
         $this->assertArrayHasKey('dependencies', $config);
         $this->assertArrayHasKey('aliases', $config['dependencies']);
         $this->assertArrayHasKey('factories', $config['dependencies']);
-        $this->assertArrayHasKey('shared', $config['dependencies']);
     }
 }

test/Container/NotFoundMiddlewareFactoryTest.php

@@ -15,6 +15,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Zend\Expressive\Container\NotFoundMiddlewareFactory;
 use Zend\Expressive\Middleware\NotFoundMiddleware;
+use Zend\Expressive\Response\NotFoundResponseInterface;
 use Zend\Expressive\Template\TemplateRendererInterface;
 
 class NotFoundMiddlewareFactoryTest extends TestCase
@@ -29,7 +30,7 @@ protected function setUp()
     {
         $this->response = $this->prophesize(ResponseInterface::class)->reveal();
         $this->container = $this->prophesize(ContainerInterface::class);
-        $this->container->get(ResponseInterface::class)->willReturn($this->response);
+        $this->container->get(NotFoundResponseInterface::class)->willReturn($this->response);
     }
 
     public function testFactoryCreatesInstanceWithoutRendererIfRendererServiceIsMissing()

test/Container/RouteMiddlewareFactoryTest.php

@@ -13,6 +13,7 @@
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
 use Zend\Expressive\Container\RouteMiddlewareFactory;
+use Zend\Expressive\Response\RouterResponseInterface;
 use Zend\Expressive\Router\PathBasedRoutingMiddleware;
 use Zend\Expressive\Router\RouterInterface;
 
@@ -24,7 +25,7 @@ public function testFactoryProducesPathBasedRoutingMiddleware()
         $response = $this->prophesize(ResponseInterface::class)->reveal();
         $container = $this->prophesize(ContainerInterface::class);
         $container->get(RouterInterface::class)->willReturn($router);
-        $container->get(ResponseInterface::class)->willReturn($response);
+        $container->get(RouterResponseInterface::class)->willReturn($response);
 
         $factory = new RouteMiddlewareFactory();