Remove disabling shared ResponseInterface

geerteltink · geerteltink · commit 23a3b0c2d486 · 2018-02-07T10:26:11.000+01:00
This feature is not in the PSR-11 spec so we can't relay on it.
This provides another solution by requiring different ResponseInterfaces
where needed.
diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php
@@ -9,7 +9,8 @@
 
 namespace Zend\Expressive;
 
-use Psr\Http\Message\ResponseInterface;
+use Zend\Expressive\Response\NotFoundResponseInterface;
+use Zend\Expressive\Response\RouterResponseInterface;
 use Zend\HttpHandlerRunner\Emitter\EmitterInterface;
 use Zend\HttpHandlerRunner\RequestHandlerRunner;
 use Zend\Stratigility\Middleware\ErrorHandler;
@@ -45,20 +46,17 @@ public function getDependencies() : array
                 ErrorHandler::class                        => Container\ErrorHandlerFactory::class,
                 // Change the following in development to the WhoopsErrorResponseGeneratorFactory:
                 ErrorResponseGenerator::class              => Container\ErrorResponseGeneratorFactory::class,
+                Middleware\NotFoundMiddleware::class       => Container\NotFoundMiddlewareFactory::class,
                 MiddlewareContainer::class                 => Container\MiddlewareContainerFactory::class,
                 MiddlewareFactory::class                   => Container\MiddlewareFactoryFactory::class,
-                Middleware\NotFoundMiddleware::class       => Container\NotFoundMiddlewareFactory::class,
+                NotFoundResponseInterface::class           => Container\ResponseFactory::class,
                 RequestHandlerRunner::class                => Container\RequestHandlerRunnerFactory::class,
-                ResponseInterface::class                   => Container\ResponseFactory::class,
                 Router\DispatchMiddleware::class           => Container\DispatchMiddlewareFactory::class,
                 Router\PathBasedRoutingMiddleware::class   => Container\RouteMiddlewareFactory::class,
+                RouterResponseInterface::class             => Container\ResponseFactory::class,
                 ServerRequestErrorResponseGenerator::class => Container\ServerRequestErrorResponseGeneratorFactory::class,
                 ServerRequestFactory::class                => Container\ServerRequestFactoryFactory::class,
             ],
-            'shared' => [
-                // Do not share response instances
-                ResponseInterface::class => false,
-            ],
         ];
         // @codingStandardsIgnoreEnd
     }
diff --git a/src/Container/NotFoundMiddlewareFactory.php b/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
diff --git a/src/Container/RouteMiddlewareFactory.php b/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)
         );
     }
 }
diff --git a/src/Response/NotFoundResponseInterface.php b/src/Response/NotFoundResponseInterface.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-expressive for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-expressive/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace Zend\Expressive\Response;
+
+use Psr\Http\Message\ResponseInterface;
+
+interface NotFoundResponseInterface extends ResponseInterface
+{
+}
diff --git a/src/Response/RouterResponseInterface.php b/src/Response/RouterResponseInterface.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-expressive for the canonical source repository
+ * @copyright Copyright (c) 2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-expressive/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace Zend\Expressive\Response;
+
+use Psr\Http\Message\ResponseInterface;
+
+interface RouterResponseInterface extends ResponseInterface
+{
+}
diff --git a/test/ConfigProviderTest.php b/test/ConfigProviderTest.php
@@ -18,6 +18,8 @@
 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;
@@ -50,36 +52,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(ErrorResponseGenerator::class, $factories);
+        $this->assertArrayHasKey(Middleware\NotFoundMiddleware::class, $factories);
         $this->assertArrayHasKey(MiddlewareContainer::class, $factories);
         $this->assertArrayHasKey(MiddlewareFactory::class, $factories);
-        $this->assertArrayHasKey(DispatchMiddleware::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']);
     }
 }
diff --git a/test/Container/NotFoundMiddlewareFactoryTest.php b/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()
diff --git a/test/Container/RouteMiddlewareFactoryTest.php b/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();
 

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`namespace Zend\Expressive\Container;`
`11`	`11`
`12`	`12`	`use Psr\Container\ContainerInterface;`
`13`		`-use Psr\Http\Message\ResponseInterface;`
	`13`	`+use Zend\Expressive\Response\RouterResponseInterface;`
`14`	`14`	`use Zend\Expressive\Router\PathBasedRoutingMiddleware;`
`15`	`15`	`use Zend\Expressive\Router\RouterInterface;`
`16`	`16`
`@@ -20,7 +20,7 @@ public function __invoke(ContainerInterface $container) : PathBasedRoutingMiddle`
`20`	`20`	`{`
`21`	`21`	`return new PathBasedRoutingMiddleware(`
`22`	`22`	`$container->get(RouterInterface::class),`
`23`		`- $container->get(ResponseInterface::class)`
	`23`	`+ $container->get(RouterResponseInterface::class)`
`24`	`24`	`);`
`25`	`25`	`}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`use Psr\Http\Message\ResponseInterface;`
`16`	`16`	`use Zend\Expressive\Container\NotFoundMiddlewareFactory;`
`17`	`17`	`use Zend\Expressive\Middleware\NotFoundMiddleware;`
	`18`	`+use Zend\Expressive\Response\NotFoundResponseInterface;`
`18`	`19`	`use Zend\Expressive\Template\TemplateRendererInterface;`
`19`	`20`
`20`	`21`	`class NotFoundMiddlewareFactoryTest extends TestCase`
`@@ -29,7 +30,7 @@ protected function setUp()`
`29`	`30`	`{`
`30`	`31`	`$this->response = $this->prophesize(ResponseInterface::class)->reveal();`
`31`	`32`	`$this->container = $this->prophesize(ContainerInterface::class);`
`32`		`- $this->container->get(ResponseInterface::class)->willReturn($this->response);`
	`33`	`+ $this->container->get(NotFoundResponseInterface::class)->willReturn($this->response);`
`33`	`34`	`}`
`34`	`35`
`35`	`36`	`public function testFactoryCreatesInstanceWithoutRendererIfRendererServiceIsMissing()`