bug #45261 [HttpClient] Fix Content-Length header when possible (nicolas-grekas)

fancyweb · fancyweb · commit 582f572f5975 · 2022-02-01T10:47:20.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [HttpClient] Fix Content-Length header when possible | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #45260 | License | MIT | Doc PR | - When userland fails to compute the correct Content-Length header and we can fix it, as is the case in the linked issue. Commits ------- f5c2e6e [HttpClient] Fix Content-Length header when possible
diff --git a/src/Symfony/Component/HttpClient/HttpClientTrait.php b/src/Symfony/Component/HttpClient/HttpClientTrait.php
@@ -86,6 +86,14 @@ private static function prepareRequest(?string $method, ?string $url, array $opt
 
         if (isset($options['body'])) {
             $options['body'] = self::normalizeBody($options['body']);
+
+            if (\is_string($options['body'])
+                && (string) \strlen($options['body']) !== substr($h = $options['normalized_headers']['content-length'][0] ?? '', 16)
+                && ('' !== $h || ('' !== $options['body'] && !isset($options['normalized_headers']['transfer-encoding'])))
+            ) {
+                $options['normalized_headers']['content-length'] = [substr_replace($h ?: 'Content-Length: ', \strlen($options['body']), 16)];
+                $options['headers'] = array_merge(...array_values($options['normalized_headers']));
+            }
         }
 
         if (isset($options['peer_fingerprint'])) {
diff --git a/src/Symfony/Component/HttpClient/Tests/HttpClientTestCase.php b/src/Symfony/Component/HttpClient/Tests/HttpClientTestCase.php
@@ -180,6 +180,20 @@ public function testDebugInfoOnDestruct()
         $this->assertNotEmpty($traceInfo['debug']);
     }
 
+    public function testFixContentLength()
+    {
+        $client = $this->getHttpClient(__FUNCTION__);
+
+        $response = $client->request('POST', 'http://localhost:8057/post', [
+            'body' => 'abc=def',
+            'headers' => ['Content-Length: 4'],
+        ]);
+
+        $body = $response->toArray();
+
+        $this->assertSame(['abc' => 'def', 'REQUEST_METHOD' => 'POST'], $body);
+    }
+
     public function testNegativeTimeout()
     {
         $client = $this->getHttpClient(__FUNCTION__);
diff --git a/src/Symfony/Component/HttpClient/Tests/MockHttpClientTest.php b/src/Symfony/Component/HttpClient/Tests/MockHttpClientTest.php
@@ -73,6 +73,43 @@ public function testZeroStatusCode()
         $this->assertSame(0, $response->getStatusCode());
     }
 
+    public function testFixContentLength()
+    {
+        $client = new MockHttpClient();
+
+        $response = $client->request('POST', 'http://localhost:8057/post', [
+            'body' => 'abc=def',
+            'headers' => ['Content-Length: 4'],
+        ]);
+
+        $requestOptions = $response->getRequestOptions();
+        $this->assertSame('Content-Length: 7', $requestOptions['headers'][0]);
+        $this->assertSame(['Content-Length: 7'], $requestOptions['normalized_headers']['content-length']);
+
+        $response = $client->request('POST', 'http://localhost:8057/post', [
+            'body' => 'abc=def',
+        ]);
+
+        $requestOptions = $response->getRequestOptions();
+        $this->assertSame('Content-Length: 7', $requestOptions['headers'][1]);
+        $this->assertSame(['Content-Length: 7'], $requestOptions['normalized_headers']['content-length']);
+
+        $response = $client->request('POST', 'http://localhost:8057/post', [
+            'body' => 'abc=def',
+            'headers' => ['Transfer-Encoding: chunked'],
+        ]);
+
+        $requestOptions = $response->getRequestOptions();
+        $this->assertFalse(isset($requestOptions['normalized_headers']['content-length']));
+
+        $response = $client->request('POST', 'http://localhost:8057/post', [
+            'body' => '',
+        ]);
+
+        $requestOptions = $response->getRequestOptions();
+        $this->assertFalse(isset($requestOptions['normalized_headers']['content-length']));
+    }
+
     public function testThrowExceptionInBodyGenerator()
     {
         $mockHttpClient = new MockHttpClient([
