Merge branch '2.x' into 3.x

* 2.x:
  clear parsedBody "cache" when calling withBody()

Author: bkdotcom

src/HttpMessage/ServerRequest.php

@@ -18,6 +18,7 @@
 use bdk\HttpMessage\Utility\ServerRequest as ServerRequestUtil;
 use InvalidArgumentException;
 use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UriInterface;
 
 /**
@@ -75,6 +76,9 @@ class ServerRequest extends Request implements ServerRequestInterface
     /** @var null|array|object typically $_POST */
     private $parsedBody = null;
 
+    /** @var bool */
+    private $parsedBodyExplicitlySet = false;
+
     /**
      * Query (aka $_GET) params.
      *
@@ -141,6 +145,20 @@ public static function fromGlobals(array $parseStrOpts = array())
         return ServerRequestUtil::fromGlobals($parseStrOpts);
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    #[\Override]
+    public function withBody(StreamInterface $body): static
+    {
+        $new = parent::withBody($body);
+        if ($new->parsedBodyExplicitlySet === false) {
+            // ensure that getParsedBody() will re-parse body
+            $new->parsedBody = null;
+        }
+        return $new;
+    }
+
     /**
      * Get $_SERVER values
      *
@@ -294,6 +312,7 @@ public function withParsedBody($data): static
         $this->assertParsedBody($data);
         $new = clone $this;
         $new->parsedBody = $data;
+        $new->parsedBodyExplicitlySet = $data !== null;
         return $new;
     }
 

tests/HttpMessage/ServerRequestTest.php

@@ -5,6 +5,7 @@
 use bdk\HttpMessage\Message;
 use bdk\HttpMessage\Request;
 use bdk\HttpMessage\ServerRequest;
+use bdk\HttpMessage\Utility\ContentType;
 use bdk\HttpMessage\Utility\ParseStr;
 use ReflectionObject;
 
@@ -159,6 +160,48 @@ public function testGetMethods()
         );
     }
 
+    public function testWithBodyClearsParsedBody()
+    {
+        $serverRequest = $this->createServerRequest('POST', '', array(
+            'CONTENT_TYPE' => ContentType::JSON,
+        ))->withBody(
+            $this->createStream(\json_encode(array('foo' => 'bar')))
+        );
+
+        $this->assertSame(array('foo' => 'bar'), $serverRequest->getParsedBody());
+
+        $serverRequest = $serverRequest->withBody(
+            $this->createStream(\json_encode(array('ding' => 'dong')))
+        );
+
+        $this->assertSame(array('ding' => 'dong'), $serverRequest->getParsedBody());
+    }
+
+    public function testWithBodyDoesNotClearParsedBody()
+    {
+        $serverRequest = $this->createServerRequest('POST', '', array(
+            'CONTENT_TYPE' => ContentType::JSON,
+        ))->withBody(
+            $this->createStream(\json_encode(array('foo' => 'bar')))
+        )->withParsedBody(array(
+            'snap' => 'crackle',
+        ));
+
+        // we explicitly set the parsed body - ignore the body
+        $this->assertSame(array('snap' => 'crackle'), $serverRequest->getParsedBody());
+
+        // updating the body does nothing.... use the explicit parsed body
+        $serverRequest = $serverRequest->withBody(
+            $this->createStream(\json_encode(array('ding' => 'dong')))
+        );
+        $this->assertSame(array('snap' => 'crackle'), $serverRequest->getParsedBody());
+
+        // withParsedBody(null) -> we will attempt to parsed the body
+        $serverRequest = $serverRequest->withParsedBody(null);
+        $this->assertSame(array('ding' => 'dong'), $serverRequest->getParsedBody());
+    }
+
+
     /**
      * @param string       $contentType Request content type
      * @param string       $body        Request body