Make Content-Length addition explicit

Author: Riimu

CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.2.3] - 2018-12-18
+### Added
+- Added a method `HttpClient::enableContentLength()` to enable automatic adding of `Content-Length` header
+
+### Changed
+- The `HttpClient` will no longer automatically add the `Content-Length` header unless explicitly requested.
+
+### Fixed
+- The `HttpClient` will no longer call the `ServerApi::output()` with empty content
+
 ## [0.2.2] - 2018-10-17
 ### Changed
 - Now depends on version `^0.3.0` of the `simply/container` library

composer.json

@@ -29,7 +29,7 @@
     "zendframework/zend-diactoros": "^2.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^7.4",
+    "phpunit/phpunit": "^7.5",
     "riimu/php-cs-fixer-config": "^0.1.1",
     "riimu/sami-config": "^0.1.0"
   },

src/HttpClient.php

@@ -21,6 +21,9 @@ class HttpClient
     /** @var ServerApi The api used to actually communicate to the browser */
     private $serverApi;
 
+    /** @var bool Whether to automatically detect content length */
+    private $contentLength;
+
     /**
      * HttpClient constructor.
      */
@@ -29,6 +32,7 @@ public function __construct()
         $this->omitBody = false;
         $this->chunkSize = 8 * 1024;
         $this->serverApi = new ServerApi();
+        $this->contentLength = false;
     }
 
     /**
@@ -53,6 +57,15 @@ public function setResponseChunkSize(int $bytes): void
         $this->chunkSize = $bytes;
     }
 
+    /**
+     * Enables automatic detection of content length and adding the appropriate header.
+     * @param bool $enable True to enable, false to disable
+     */
+    public function enableContentLength(bool $enable = true): void
+    {
+        $this->contentLength = $enable;
+    }
+
     /**
      * Tells the client to omit the body from the response.
      * @param bool $omit True to omit the body, false to include it
@@ -107,6 +120,10 @@ private function hasResponseBody(ResponseInterface $response): bool
      */
     private function detectLength(ResponseInterface $response): ?int
     {
+        if (! $this->contentLength) {
+            return null;
+        }
+
         if ($response->hasHeader('Content-Length')) {
             $lengthHeader = $response->getHeader('Content-Length');
             return array_shift($lengthHeader);
@@ -154,7 +171,10 @@ private function sendBody(ResponseInterface $response, ?int $length): int
         while (!$body->eof()) {
             $read = $length === null ? $this->chunkSize : min($this->chunkSize, $length - $bytes);
             $output = $body->read($read);
-            $this->serverApi->output($output);
+
+            if ($output !== '') {
+                $this->serverApi->output($output);
+            }
 
             $bytes += \strlen($output);
 

tests/tests/ApplicationTest.php

@@ -64,6 +64,7 @@ public function testSuccessfulRouting()
 
         $this->assertSame('Correct Output', $this->sentOutput);
         $this->assertContains('Content-Type: text/plain; charset=utf-8', $this->sentHeaders);
+        $this->assertNotContains('Content-Length', implode("\n", $this->sentHeaders));
     }
 
     public function testCallingApplicationTwice()
@@ -180,6 +181,8 @@ public function testHeaderLimitedBody()
             ['GET', '/limited/', $handler],
         ]);
 
+        $this->getContainerHttpClient()->enableContentLength();
+        $this->getContainerHttpClient()->setResponseChunkSize(3);
         $this->makeRequest('GET', '/limited/');
 
         $this->assertContains('Content-Length: 4', $this->sentHeaders);
@@ -216,6 +219,7 @@ public function testSmallRewindedBody()
             ['GET', '/path/', $this->getHandler($response)],
         ]);
 
+        $this->getContainerHttpClient()->enableContentLength();
         $this->makeRequest('GET', '/path/');
 
         $this->assertContains('Content-Length: 1', $this->sentHeaders);
@@ -260,7 +264,7 @@ public function testUnmockedApplication()
     private function makeRequest(string $method, string $path)
     {
         $this->nextRequest = (new ServerRequestFactory())->createServerRequest($method, $path);
-        $this->container->get(Application::class)->run();
+        $this->getContainerApplication()->run();
     }
 
     private function buildApplication(array $routes): void
@@ -361,4 +365,14 @@ private function getResponse(string $body, array $headers = null): Response
 
         return $response;
     }
+
+    private function getContainerApplication(): Application
+    {
+        return $this->container->get(Application::class);
+    }
+
+    private function getContainerHttpClient(): HttpClient
+    {
+        return $this->container->get(HttpClient::class);
+    }
 }