Merge branch 'feature/480' into develop

Close #480

Author: weierophinney

CHANGELOG.md

@@ -6,7 +6,11 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- [#480](https://github.com/zendframework/zend-expressive/pull/480) updates the
+  `ImplicitHeadMiddleware` to add a request attribute indicating the request was
+  originally generated for a `HEAD` request before delegating the request; you
+  can now pull the attribute `Zend\Expressive\Middleware\ImplicitHeadMiddleware::FORWARDED_HTTP_METHOD_ATTRIBUTE`
+  in your own middleware in order to vary behavior in these scenarios.
 
 ### Changed
 

doc/book/features/middleware/implicit-methods-middleware.md

@@ -70,6 +70,15 @@ instance). However, if `GET` is supported, it will dispatch the next layer, but
 with a `GET` request instead of `HEAD`; additionally, it will inject the
 returned response with an empty response body before returning it.
 
+### Detecting forwarded requests
+
+- Since 2.1.0
+
+When the next layer is dispatched, the request will have an additional
+attribute, `Zend\Expressive\Middleware\ImplicitHeadMiddleware::FORWARDED_HTTP_METHOD_ATTRIBUTE`,
+with a value of `HEAD`. As such, you can check for this value in order to vary
+the headers returned if desired.
+
 ## ImplicitOptionsMiddleware
 
 `Zend\Expressive\Middleware\ImplicitOptionsMiddleware` provides support for

src/Middleware/ImplicitHeadMiddleware.php

@@ -43,6 +43,8 @@
  */
 class ImplicitHeadMiddleware implements ServerMiddlewareInterface
 {
+    const FORWARDED_HTTP_METHOD_ATTRIBUTE = 'forwarded_http_method';
+
     /**
      * @var null|ResponseInterface
      */
@@ -89,7 +91,9 @@ public function process(ServerRequestInterface $request, DelegateInterface $dele
         }
 
         $response = $delegate->process(
-            $request->withMethod(RequestMethod::METHOD_GET)
+            $request
+                ->withMethod(RequestMethod::METHOD_GET)
+                ->withAttribute(self::FORWARDED_HTTP_METHOD_ATTRIBUTE, RequestMethod::METHOD_HEAD)
         );
 
         return $response->withBody(new Stream('php://temp/', 'wb+'));

test/Middleware/ImplicitHeadMiddlewareTest.php

@@ -14,8 +14,8 @@
 use Prophecy\Argument;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
-use Psr\Http\Message\StreamInterface;
 use Zend\Diactoros\Response;
+use Zend\Diactoros\ServerRequest;
 use Zend\Expressive\Middleware\ImplicitHeadMiddleware;
 use Zend\Expressive\Router\Route;
 use Zend\Expressive\Router\RouteResult;
@@ -162,26 +162,23 @@ public function testInvokesNextWhenRouteImplicitlySupportsHeadAndSupportsGet()
         $result = $this->prophesize(RouteResult::class);
         $result->getMatchedRoute()->will([$route, 'reveal']);
 
-        $request = $this->prophesize(ServerRequestInterface::class);
-        $request->getMethod()->willReturn(RequestMethod::METHOD_HEAD);
-        $request->getAttribute(RouteResult::class, false)->will([$result, 'reveal']);
-        $request->withMethod(RequestMethod::METHOD_GET)->will([$request, 'reveal']);
+        $request = (new ServerRequest([], [], null, RequestMethod::METHOD_HEAD))
+                ->withAttribute(RouteResult::class, $result->reveal());
 
-        $response = $this->prophesize(ResponseInterface::class);
-        $response
-            ->withBody(Argument::that(function ($body) {
-                $this->assertInstanceOf(StreamInterface::class, $body);
-                $this->assertEquals('', (string) $body);
-                return true;
-            }))
-            ->will([$response, 'reveal']);
+        $response = new Response\JsonResponse(['some_data' => true], 400);
 
         $delegate = $this->prophesize(DelegateInterface::class);
-        $delegate->process($request->reveal())->will([$response, 'reveal']);
+        $delegate->process(Argument::that(function (ServerRequestInterface $request) {
+            $attr = $request->getAttribute(ImplicitHeadMiddleware::FORWARDED_HTTP_METHOD_ATTRIBUTE);
+            $this->assertSame('HEAD', $attr);
+            return true;
+        }))->willReturn($response);
 
         $middleware = new ImplicitHeadMiddleware();
-        $result = $middleware->process($request->reveal(), $delegate->reveal());
+        $result = $middleware->process($request, $delegate->reveal());
 
-        $this->assertSame($response->reveal(), $result);
+        $this->assertSame(400, $result->getStatusCode());
+        $this->assertSame('', (string) $result->getBody());
+        $this->assertSame('application/json', $result->getHeaderLine('content-type'));
     }
 }