Merge branch 'hotfix/165'

Close #165
Fixes zendframework/zend-expressive#606

CHANGELOG.md

@@ -26,7 +26,26 @@ details.
 
 ### Fixed
 
-- Nothing.
+- [#165](https://github.com/zendframework/zend-stratigility/pull/165) fixes an
+  issue with the `PathMiddlewareDecorator` whereby it was using the original
+  request when invoking the handler it creates, instead of prepending the
+  configured path prefix to the request URI created. With the fix, if middleware
+  alters the request path passed to the handler, the changes will now propagate
+  to later middleware. As an example:
+
+  ```php
+  new PathMiddlewareDecorator('/api', middleware(function ($request, $handler) {
+      $uri = $request->getUri();
+      if (! preg_match('#^/v\d+/#', $uri->getPath())) {
+          $request = $request->withUri($uri->withPath('/v1' . $uri->getPath()));
+      }
+      return $handler->handle($request);
+  }));
+  ```
+
+  For the request path `/api/books`, the above will now correctly result in
+  `/api/v1/books` being propagated to lower layers of the application, instead
+  of `/api/books`.
 
 ## 3.0.0 - 2018-03-15
 

src/Middleware/PathMiddlewareDecorator.php

@@ -64,7 +64,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         // layer.
         return $this->middleware->process(
             $requestToProcess,
-            $this->prepareHandlerForOriginalRequest($handler, $request)
+            $this->prepareHandlerForOriginalRequest($handler)
         );
     }
 
@@ -97,21 +97,19 @@ private function getTruncatedPath(string $segment, string $path) : string
         return substr($path, strlen($segment));
     }
 
-    private function prepareHandlerForOriginalRequest(
-        RequestHandlerInterface $handler,
-        ServerRequestInterface $originalRequest
-    ) : RequestHandlerInterface {
-        return new class ($handler, $originalRequest) implements RequestHandlerInterface {
+    private function prepareHandlerForOriginalRequest(RequestHandlerInterface $handler) : RequestHandlerInterface
+    {
+        return new class ($handler, $this->prefix) implements RequestHandlerInterface {
             /** @var RequestHandlerInterface */
             private $handler;
 
-            /** @var ServerRequestInterface */
-            private $originalRequest;
+            /** @var string */
+            private $prefix;
 
-            public function __construct(RequestHandlerInterface $handler, ServerRequestInterface $originalRequest)
+            public function __construct(RequestHandlerInterface $handler, string $prefix)
             {
                 $this->handler = $handler;
-                $this->originalRequest = $originalRequest;
+                $this->prefix = $prefix;
             }
 
             /**
@@ -126,8 +124,8 @@ public function __construct(RequestHandlerInterface $handler, ServerRequestInter
              */
             public function handle(ServerRequestInterface $request) : ResponseInterface
             {
-                $uri = $request->getUri()
-                    ->withPath($this->originalRequest->getUri()->getPath());
+                $uri = $request->getUri();
+                $uri = $uri->withPath($this->prefix . $uri->getPath());
                 return $this->handler->handle($request->withUri($uri));
             }
         };

test/Middleware/PathMiddlewareDecoratorTest.php

@@ -25,6 +25,7 @@
 
 use function sprintf;
 use function var_export;
+use function Zend\Stratigility\middleware;
 use function Zend\Stratigility\path;
 
 class PathMiddlewareDecoratorTest extends TestCase
@@ -435,4 +436,25 @@ public function testPathFunction()
         self::assertAttributeSame('/foo', 'prefix', $middleware);
         self::assertAttributeSame($toDecorate, 'middleware', $middleware);
     }
+
+    public function testUpdatesInPathInsideNestedMiddlewareAreRespected()
+    {
+        $request = new ServerRequest([], [], 'http://local.example.com/foo/bar', 'GET', 'php://memory');
+        $decoratedMiddleware = middleware(function (
+            ServerRequestInterface $request,
+            RequestHandlerInterface $handler
+        ) {
+            return $handler->handle($request->withUri(new Uri('/changed/path')));
+        });
+        $middleware = new PathMiddlewareDecorator('/foo', $decoratedMiddleware);
+
+        $handler = $this->prophesize(RequestHandlerInterface::class);
+        $handler->handle(Argument::that(function (ServerRequestInterface $received) {
+            Assert::assertEquals('/foo/changed/path', $received->getUri()->getPath());
+
+            return $received;
+        }));
+
+        $middleware->process($request, $handler->reveal());
+    }
 }