Merge branch 'hotfix/template-reponse-deprecation'

Close #393

Author: weierophinney

CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 1.0.2 - 2016-11-11
+
+### Added
+
+- Nothing.
+
+### Changes
+
+- [#393](https://github.com/zendframework/zend-expressive/pull/393) updates
+  `Application::run()` to inject the request with an `originalResponse`
+  attribute using the provided response as the value.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- [#393](https://github.com/zendframework/zend-expressive/pull/393) fixes how
+  each of the `TemplatedErrorHandler` and `WhoopsErrorHandler` access the
+  "original" request, URI, and/or response. Previously, these used
+  Stratigility-specific methods; they now use request attributes, eliminating
+  deprecation notices emitted in Stratigility 1.3+ versions.
+
 ## 1.0.1 - 2016-11-11
 
 ### Added

src/Application.php

@@ -558,8 +558,9 @@ public function route($path, $middleware = null, array $methods = null, $name =
      */
     public function run(ServerRequestInterface $request = null, ResponseInterface $response = null)
     {
-        $request  = $request ?: ServerRequestFactory::fromGlobals();
         $response = $response ?: new Response();
+        $request  = $request ?: ServerRequestFactory::fromGlobals();
+        $request  = $request->withAttribute('originalResponse', $response);
 
         $response = $this($request, $response);
 

src/TemplatedErrorHandler.php

@@ -9,7 +9,6 @@
 
 use Psr\Http\Message\RequestInterface as Request;
 use Psr\Http\Message\ResponseInterface as Response;
-use Zend\Stratigility\Http\Response as StratigilityResponse;
 use Zend\Stratigility\Utils;
 
 /**
@@ -191,9 +190,7 @@ private function handlePotentialSuccess(Request $request, Response $response)
         }
 
         $originalResponse  = $this->originalResponse;
-        $decoratedResponse = $response instanceof StratigilityResponse
-            ? $response->getOriginalResponse()
-            : $response;
+        $decoratedResponse = $request->getAttribute('originalResponse', $response);
 
         if ($originalResponse !== $response
             && $originalResponse !== $decoratedResponse

src/WhoopsErrorHandler.php

@@ -11,7 +11,6 @@
 use Psr\Http\Message\ResponseInterface as Response;
 use Whoops\Handler\PrettyPageHandler;
 use Whoops\Run as Whoops;
-use Zend\Stratigility\Http\Request as StratigilityRequest;
 
 /**
  * Final handler with templated page capabilities plus Whoops exception reporting.
@@ -102,11 +101,9 @@ protected function handleException($exception, Request $request, Response $respo
      */
     private function prepareWhoopsHandler(Request $request, PrettyPageHandler $handler)
     {
-        if ($request instanceof StratigilityRequest) {
-            $request = $request->getOriginalRequest();
-        }
+        $uri = $request->getAttribute('originalUri', false) ?: $request->getUri();
+        $request = $request->getAttribute('originalRequest', false) ?: $request;
 
-        $uri = $request->getUri();
         $handler->addDataTable('Expressive Application Request', [
             'HTTP Method'            => $request->getMethod(),
             'URI'                    => (string) $uri,

test/IntegrationTest.php

@@ -49,14 +49,8 @@ public function testDefaultFinalHandlerCanEmitA404WhenNoMiddlewareMatches()
         $request  = new ServerRequest([], [], 'https://example.com/foo', 'GET');
         $response = new Response();
 
-        set_error_handler(function ($errno, $errstr) {
-            return false !== strstr($errstr, 'OriginalMessages');
-        }, E_USER_DEPRECATED);
-
         $app->run($request, $response);
 
-        restore_error_handler();
-
         $this->assertInstanceOf(ResponseInterface::class, $this->response);
         $this->assertEquals(404, $this->response->getStatusCode());
     }
@@ -68,14 +62,8 @@ public function testInjectedFinalHandlerCanEmitA404WhenNoMiddlewareMatches()
         $request      = new ServerRequest([], [], 'https://example.com/foo', 'GET');
         $response     = new Response();
 
-        set_error_handler(function ($errno, $errstr) {
-            return false !== strstr($errstr, 'OriginalMessages');
-        }, E_USER_DEPRECATED);
-
         $app->run($request, $response);
 
-        restore_error_handler();
-
         $this->assertInstanceOf(ResponseInterface::class, $this->response);
         $this->assertEquals(404, $this->response->getStatusCode());
     }

test/TemplatedErrorHandlerTest.php

@@ -12,7 +12,7 @@
 use Exception;
 use PHPUnit_Framework_TestCase as TestCase;
 use Prophecy\Argument;
-use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 use Zend\Expressive\Template\TemplateRendererInterface;
@@ -30,7 +30,7 @@ public function getTemplateImplementation()
 
     public function getRequest($stream)
     {
-        $request = $this->prophesize(RequestInterface::class);
+        $request = $this->prophesize(ServerRequestInterface::class);
         $request->getBody()->will(function () use ($stream) {
             return $stream->reveal();
         });
@@ -130,6 +130,9 @@ public function testInvocationWithoutErrorAndResponseSameAsOriginalReturns404Res
         $handler->setOriginalResponse($response->reveal());
 
         $request = $this->getRequest($this->getStream());
+        $request
+            ->getAttribute('originalResponse', Argument::that([$response, 'reveal']))
+            ->will([$response, 'reveal']);
 
         $result = $handler($request->reveal(), $response->reveal());
         $this->assertSame($expected->reveal(), $result);
@@ -151,6 +154,9 @@ public function testInvocationWithoutErrorAndResponseSameAsOriginalWithNewBodyCo
         $handler->setOriginalResponse($response->reveal());
 
         $request = $this->getRequest($this->getStream());
+        $request
+            ->getAttribute('originalResponse', Argument::that([$response, 'reveal']))
+            ->will([$response, 'reveal']);
 
         $result = $handler($request->reveal(), $response->reveal());
         $this->assertSame($response->reveal(), $result);
@@ -167,6 +173,9 @@ public function testInvocationWithoutErrorAndResponseDifferentThanOriginalReturn
 
         $response = $this->getResponse($this->getStream());
         $request  = $this->getRequest($this->getStream());
+        $request
+            ->getAttribute('originalResponse', Argument::that([$response, 'reveal']))
+            ->will([$response, 'reveal']);
 
         $result = $handler($request->reveal(), $response->reveal());
         $this->assertSame($response->reveal(), $result);
@@ -243,6 +252,9 @@ public function testInvocationWithoutErrorAndResponseSameAsOriginalCanReturnTemp
 
         $request = $this->getRequest($this->getStream());
         $request->getUri()->shouldBeCalled();
+        $request
+            ->getAttribute('originalResponse', Argument::that([$response, 'reveal']))
+            ->will([$response, 'reveal']);
 
         $result = $handler($request->reveal(), $response->reveal());
         $this->assertSame($expected->reveal(), $result);

test/WhoopsErrorHandlerTest.php

@@ -82,6 +82,8 @@ public function testExceptionErrorPreparesPageHandlerAndInvokesWhoops()
         $request->getAttributes()->shouldBeCalled();
         $request->getQueryParams()->shouldBeCalled();
         $request->getParsedBody()->shouldBeCalled();
+        $request->getAttribute('originalUri', false)->willReturn(false);
+        $request->getAttribute('originalRequest', false)->willReturn(false);
 
         $result = $handler($request->reveal(), $response->reveal(), $exception);
         $this->assertSame($expected->reveal(), $result);
@@ -119,7 +121,8 @@ public function testOriginalRequestIsPulledFromStratigilityRequest()
 
         $request           = new ServerRequest(['SCRIPT_NAME' => __FILE__]);
         $decoratingRequest = $this->prophesize(StratigilityRequest::class);
-        $decoratingRequest->getOriginalRequest()->willReturn($request);
+        $decoratingRequest->getAttribute('originalRequest', false)->willReturn($request);
+        $decoratingRequest->getAttribute('originalUri', false)->willReturn($request->getUri());
 
         $result = $handler($decoratingRequest->reveal(), $response->reveal(), $exception);
         $this->assertSame($expected->reveal(), $result);