Do not rely on Stratigility getOriginal*() methods

These are deprecated starting with Stratigility 1.3. This patch updates
the `TemplatedErrorHandler` and the `WhoopsErrorHandler` to instead use
the request `getOriginal*` attributes, which are injected in the
Stratigility request/response decorators, and which can be injected by
the `OriginalMessages` middleware as well.

Additionally, this updates the `Application::run()` method to ensure
that the `originalResponse` attribute is injected, as it is not in
earlier Stratigility versions.

Author: weierophinney

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

@@ -191,9 +191,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

@@ -102,11 +102,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/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);