[#566] Cover CurlAdapter gzip response parsing

Author: armanist

src/HttpClient/Adapters/CurlAdapter.php

@@ -417,29 +417,30 @@ private function parseResponse(string $rawResponse)
     {
         $response = $rawResponse;
         $contentType = $this->responseHeaders['Content-Type'] ?? null;
+        $contentEncoding = $this->responseHeaders['Content-Encoding'] ?? null;
+
+        if (is_string($contentEncoding) && strtolower($contentEncoding) === 'gzip') {
+            $decoded = gzdecode($rawResponse);
+            $response = $decoded !== false ? $decoded : $response;
+        }
 
         if (is_string($contentType) && preg_match('/\bjson\b/i', $contentType) === 1) {
-            $decoded = json_decode($rawResponse);
+            $decoded = json_decode($response);
             return json_last_error() === JSON_ERROR_NONE ? $decoded : $response;
         }
 
         if (is_string($contentType) && preg_match('/\bxml\b/i', $contentType) === 1) {
             $previousUseInternalErrors = libxml_use_internal_errors(true);
 
             try {
-                $xml = simplexml_load_string($rawResponse);
+                $xml = simplexml_load_string($response);
             } finally {
                 libxml_use_internal_errors($previousUseInternalErrors);
             }
 
             return $xml !== false ? $xml : $response;
         }
 
-        if (($this->responseHeaders['Content-Encoding'] ?? null) === 'gzip') {
-            $decoded = gzdecode($rawResponse);
-            return $decoded !== false ? $decoded : $response;
-        }
-
         return $response;
     }
 }

tests/Unit/HttpClient/Adapters/CurlAdapterTest.php

@@ -164,6 +164,19 @@ public function testCurlAdapterDecodesGzipResponse(): void
         $this->assertSame('compressed response', $response);
     }
 
+    public function testCurlAdapterParsesGzippedJsonResponse(): void
+    {
+        $adapter = new CurlAdapter();
+        $headers = $this->invokePrivateMethod($adapter, 'parseResponseHeaders', [
+            "HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Encoding: GZip\r\n\r\n",
+        ]);
+        $this->setPrivateProperty($adapter, 'responseHeaders', $headers);
+
+        $response = $this->invokePrivateMethod($adapter, 'parseResponse', [gzencode('{"ok":true}')]);
+
+        $this->assertTrue($response->ok);
+    }
+
     public function testCurlAdapterPassesZeroInfoOptionToNativeCurl(): void
     {
         $adapter = new CurlAdapter();

tests/Unit/HttpClient/HttpClientTest.php

@@ -59,6 +59,7 @@ public function testHttpClientGetSetData(): void
     public function testHttpClientIsMultiRequest(): void
     {
         $curl = Mockery::mock(Curl::class);
+        $curl->shouldReceive('setUrl')->with('https://example.com')->once();
 
         $multi = Mockery::mock(MultiCurl::class);
 
@@ -107,6 +108,8 @@ public function testHttpClientEnsureSingleRequestThrowsOnMulti(): void
     public function testHttpClientSingleRequestResponseFlow(): void
     {
         $curl = Mockery::mock(Curl::class);
+        $curl->shouldReceive('setUrl')->with('https://example.com')->once();
+        $curl->shouldReceive('setOpt')->with(CURLOPT_CUSTOMREQUEST, 'GET')->once();
         $curl->shouldReceive('exec')->once();
         $curl->shouldReceive('isError')->andReturn(false);
         $curl->shouldReceive('getId')->andReturn(0);
@@ -129,6 +132,10 @@ public function testHttpClientSingleRequestResponseFlow(): void
     public function testHttpClientPostRequestWithData(): void
     {
         $curl = Mockery::mock(Curl::class);
+        $curl->shouldReceive('setUrl')->with('https://example.com')->once();
+        $curl->shouldReceive('setOpt')->with(CURLOPT_CUSTOMREQUEST, 'POST')->once();
+        $curl->shouldReceive('buildPostData')->with(['x' => 1])->once()->andReturn('x=1');
+        $curl->shouldReceive('setOpt')->with(CURLOPT_POSTFIELDS, 'x=1')->once();
         $curl->shouldReceive('exec')->once();
         $curl->shouldReceive('isError')->andReturn(false);
         $curl->shouldReceive('getId')->andReturn(0);
@@ -148,6 +155,8 @@ public function testHttpClientPostRequestWithData(): void
     public function testHttpClientSingleRequestError(): void
     {
         $curl = Mockery::mock(Curl::class);
+        $curl->shouldReceive('setUrl')->with('https://bad.local')->once();
+        $curl->shouldReceive('setOpt')->with(CURLOPT_CUSTOMREQUEST, 'GET')->once();
         $curl->shouldReceive('exec')->once();
         $curl->shouldReceive('isError')->andReturn(true);
         $curl->shouldReceive('getId')->andReturn(0);
@@ -266,6 +275,8 @@ public function testHttpClientCreateAsyncMultiRequestRegistersCallbacks(): void
     public function testHttpClientInfoAndUrl(): void
     {
         $curl = Mockery::mock(Curl::class);
+        $curl->shouldReceive('setUrl')->with('https://example.com')->once();
+        $curl->shouldReceive('setOpt')->with(CURLOPT_CUSTOMREQUEST, 'GET')->once();
         $curl->shouldReceive('exec')->once();
         $curl->shouldReceive('isError')->andReturn(false);
         $curl->shouldReceive('getId')->andReturn(0);
@@ -288,6 +299,7 @@ public function testHttpClientInfoAndUrl(): void
     public function testHttpClientPassesZeroInfoOption(): void
     {
         $curl = Mockery::mock(Curl::class);
+        $curl->shouldReceive('setUrl')->with('https://example.com')->once();
         $curl->shouldReceive('getInfo')->with(0)->once()->andReturn('zero');
 
         $this->httpClient->createRequest('https://example.com', $curl);