Add logger support: Introduced optional logger in the HttpClient constructor to enable request and response logging for better debugging and monitoring.

phpdevcommunity · phpdevcommunity · commit b46c3c2b5936 · 2024-10-03T13:44:25.000Z
diff --git a/src/Http/HttpStatusCode.php b/src/Http/HttpStatusCode.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace PhpDevCommunity\HttpClient;
+namespace PhpDevCommunity\HttpClient\Http;
 
 use SplEnum;
 
diff --git a/src/HttpClient.php b/src/HttpClient.php
@@ -4,6 +4,7 @@
 
 use InvalidArgumentException;
 use LogicException;
+use PhpDevCommunity\HttpClient\Http\HttpStatusCode;
 use PhpDevCommunity\HttpClient\Http\Response;
 
 final class HttpClient
@@ -21,6 +22,8 @@ final class HttpClient
      */
     private array $options;
 
+    private $logger;
+
     /**
      * HttpClient constructor.
      *
@@ -31,7 +34,7 @@ final class HttpClient
      *                      - array headers An associative array of HTTP headers to include in the request.
      *                      - string base_url The base URL to prepend to relative URLs in the request.
      */
-    public function __construct(array $options = [])
+    public function __construct(array $options = [], ?callable $logger = null)
     {
         self::validateOptions($options, ['user_agent', 'timeout', 'headers', 'base_url']);
         $this->options = array_replace([
@@ -40,6 +43,7 @@ public function __construct(array $options = [])
             'headers' => [],
             'base_url' => null,
         ], $options);
+        $this->logger = $logger;
     }
 
     /**
@@ -95,6 +99,8 @@ public function post(string $url, array $data, bool $json = false, array $header
      */
     public function fetch(string $url, array $options = []): Response
     {
+        $options['method'] = strtoupper($options['method'] ?? 'GET');
+        $options['body'] = $options['body'] ?? '';
         self::validateOptions($options, ['user_agent', 'timeout', 'headers', 'body', 'method']);
 
         $options = array_merge_recursive($this->options, $options);
@@ -110,12 +116,28 @@ public function fetch(string $url, array $options = []): Response
             throw new InvalidArgumentException(sprintf('Invalid URL: %s', $url));
         }
 
+        $info = [
+            'url' => $url,
+            'request' => [
+                'user_agent' => $options['user_agent'],
+                'method' => $options['method'],
+                'headers' => $options['headers'],
+                'body' => $options['body'],
+            ],
+            'response' => [
+                'body' => '',
+                'headers' => [],
+            ]
+        ];
+
         $response = '';
         $fp = fopen($url, 'rb', false, $context);
         $httpResponseHeaders = $http_response_header;
+        $headers = self::parseHttpResponseHeaders($httpResponseHeaders);
+        $info['response']['headers'] = $headers;
         if ($fp === false) {
-            $detail = $httpResponseHeaders[0] ?? '';
-            throw new LogicException(sprintf('Error opening request to %s: %s', $url, $detail));
+            $this->log($info);
+            throw new LogicException(sprintf('Error opening request to %s: %s', $url, $httpResponseHeaders[0] ?? ''));
         }
 
         while (!feof($fp)) {
@@ -124,9 +146,10 @@ public function fetch(string $url, array $options = []): Response
 
         fclose($fp);
 
-        $headers = self::parseHttpResponseHeaders($httpResponseHeaders);
+        $info['response']['body'] = $response;
+        $this->log($info);
 
-        return new Response($response, $headers['status_code'] ?? HttpStatusCode::HTTP_VERSION_NOT_SUPPORTED, $headers);
+        return new Response($response, $headers['status_code'], $headers);
     }
 
     /**
@@ -137,16 +160,14 @@ public function fetch(string $url, array $options = []): Response
      */
     private function createContext(array $options)
     {
-        $method = strtoupper($options['method'] ?? 'GET');
-        $body = $options['body'] ?? '';
-
-        if (in_array($method, ['POST', 'PUT']) && is_array($body)) {
+        $body = $options['body'];
+        if (in_array($options['method'], ['POST', 'PUT']) && is_array($body)) {
             $body = self::prepareRequestBody($body, $options['headers']);
         }
 
         $opts = [
             'http' => [
-                'method' => $method,
+                'method' => $options['method'],
                 'header' => self::formatHttpRequestHeaders($options['headers']),
                 'content' => $body,
                 'user_agent' => $options['user_agent'],
@@ -158,6 +179,14 @@ private function createContext(array $options)
         return stream_context_create($opts);
     }
 
+    private function log(array $info): void
+    {
+        $logger = $this->logger;
+        if (is_callable($logger)) {
+            $logger($info);
+        }
+    }
+
     /**
      * Format HTTP headers from the provided associative array.
      *
@@ -212,6 +241,10 @@ private static function parseHttpResponseHeaders(array $responseHeaders): array
                 }
             }
         }
+
+        if (!isset($headers['status_code'])) {
+            $headers['status_code'] = HttpStatusCode::HTTP_VERSION_NOT_SUPPORTED;
+        }
         return $headers;
     }
 
diff --git a/src/helpers.php b/src/helpers.php
@@ -11,9 +11,9 @@
      * @param array $options The options to configure the HttpClient
      * @return HttpClient The newly created HttpClient instance
      */
-    function http_client(array $options = []): HttpClient
+    function http_client(array $options = [], callable $logger = null): HttpClient
     {
-        return new HttpClient($options);
+        return new HttpClient($options, $logger);
     }
 }
 
@@ -28,7 +28,7 @@ function http_client(array $options = []): HttpClient
      */
     function http_post(string $url, array $data = [], array $headers = []): Response
     {
-        return http_client()->post($url, $data, false,$headers);
+        return http_client()->post($url, $data, false, $headers);
     }
 }
 
@@ -43,7 +43,7 @@ function http_post(string $url, array $data = [], array $headers = []): Response
      */
     function http_post_json(string $url, array $data = [], array $headers = []): Response
     {
-        return http_client()->post($url, $data, true ,$headers);
+        return http_client()->post($url, $data, true, $headers);
     }
 }
 
diff --git a/tests/HttpClientTest.php b/tests/HttpClientTest.php
@@ -2,6 +2,8 @@
 
 namespace PhpDevCommunity\tests;
 
+use Exception;
+use LogicException;
 use PhpDevCommunity\HttpClient\HttpClient;
 use PHPUnit\Framework\TestCase;
 
@@ -10,38 +12,46 @@ class HttpClientTest extends TestCase
     const URL = 'http://localhost:4245';
 
     protected static ?string $serverProcess = null;
+
     public static function setUpBeforeClass(): void
     {
-        $fileToRun = __DIR__.DIRECTORY_SEPARATOR.'test_server.php';
-        $command = sprintf('php -S %s %s > /dev/null 2>&1 & echo $!;',str_replace('http://', '', self::URL), $fileToRun);
+        $fileToRun = __DIR__ . DIRECTORY_SEPARATOR . 'test_server.php';
+        $command = sprintf('php -S %s %s > /dev/null 2>&1 & echo $!;', str_replace('http://', '', self::URL), $fileToRun);
         self::$serverProcess = exec($command);
         if (empty(self::$serverProcess) || !is_numeric(self::$serverProcess)) {
-            throw new \Exception('Could not start test server');
+            throw new Exception('Could not start test server');
         }
         sleep(1);
     }
 
     public function testGetRequest()
     {
-        $response = http_client(['base_url' => self::URL, 'headers' => ['Authorization' => 'Bearer secret_token']])->get('/api/data');
-        $this->assertEquals( 200, $response->getStatusCode() );
+        $response = http_client(
+            ['base_url' => self::URL, 'headers' => ['Authorization' => 'Bearer secret_token']],
+            function ($info) {
+                $this->assertEquals( 'GET', $info['request']['method']);
+                $this->assertEquals( 'Bearer secret_token', $info['request']['headers']['Authorization']);
+                $this->assertEquals( '{"message":"GET request received"}', $info['response']['body']);
+            }
+        )->get('/api/data');
+        $this->assertEquals(200, $response->getStatusCode());
         $this->assertNotEmpty($response->getBody());
     }
 
     public function testGetWithQueryRequest()
     {
-        $client = new HttpClient(['base_url' => self::URL,'headers' => ['Authorization' => 'Bearer secret_token']]);
+        $client = new HttpClient(['base_url' => self::URL, 'headers' => ['Authorization' => 'Bearer secret_token']]);
         $response = $client->get('/api/search', [
             'name' => 'foo',
         ]);
 
-        $this->assertEquals( 200, $response->getStatusCode() );
+        $this->assertEquals(200, $response->getStatusCode());
         $this->assertNotEmpty($response->getBody());
 
         $data = $response->bodyToArray();
-        $this->assertEquals( 'foo', $data['name'] );
-        $this->assertEquals( 1, $data['page'] );
-        $this->assertEquals( 10, $data['limit'] );
+        $this->assertEquals('foo', $data['name']);
+        $this->assertEquals(1, $data['page']);
+        $this->assertEquals(10, $data['limit']);
 
 
         $response = $client->get('/api/search', [
@@ -50,13 +60,13 @@ public function testGetWithQueryRequest()
             'limit' => 100
         ]);
 
-        $this->assertEquals( 200, $response->getStatusCode() );
+        $this->assertEquals(200, $response->getStatusCode());
         $this->assertNotEmpty($response->getBody());
 
         $data = $response->bodyToArray();
-        $this->assertEquals( 'foo', $data['name'] );
-        $this->assertEquals( 10, $data['page'] );
-        $this->assertEquals( 100, $data['limit'] );
+        $this->assertEquals('foo', $data['name']);
+        $this->assertEquals(10, $data['page']);
+        $this->assertEquals(100, $data['limit']);
     }
 
     public function testPostJsonRequest()
@@ -67,14 +77,14 @@ public function testPostJsonRequest()
             'userId' => 1
         ];
         $client = new HttpClient(['headers' => ['Authorization' => 'Bearer secret_token']]);
-        $response = $client->post(self::URL.'/api/post/data', [
+        $response = $client->post(self::URL . '/api/post/data', [
             'title' => 'foo',
             'body' => 'bar',
             'userId' => 1
         ], true);
 
-        $this->assertEquals( 200, $response->getStatusCode());
-        $this->assertEquals( $dataToPost, $response->bodyToArray());
+        $this->assertEquals(200, $response->getStatusCode());
+        $this->assertEquals($dataToPost, $response->bodyToArray());
     }
 
     public function testPostFormRequest()
@@ -85,18 +95,50 @@ public function testPostFormRequest()
             'userId' => 1
         ];
         $client = new HttpClient(['headers' => ['Authorization' => 'Bearer secret_token']]);
-        $response = $client->post(self::URL.'/api/post/data/form', $dataToPost);
+        $response = $client->post(self::URL . '/api/post/data/form', $dataToPost);
 
-        $this->assertEquals( 200, $response->getStatusCode());
-        $this->assertEquals( $dataToPost, $response->bodyToArray());
+        $this->assertEquals(200, $response->getStatusCode());
+        $this->assertEquals($dataToPost, $response->bodyToArray());
     }
 
     public function testPostEmptyFormRequest()
     {
         $client = new HttpClient(['headers' => ['Authorization' => 'Bearer secret_token']]);
-        $response = $client->post(self::URL.'/api/post/data/form', []);
+        $response = $client->post(self::URL . '/api/post/data/form', []);
+
+        $this->assertEquals(400, $response->getStatusCode());
+    }
+
+    public function testWrongOptions()
+    {
+        $this->expectException(LogicException::class);
+        new HttpClient(['headers' => 'string']);
+    }
+
+    public function testWrongOptions2()
+    {
+        $this->expectException(LogicException::class);
+        new HttpClient(['options_not_supported' => 'value']);
+    }
+
+    public function testWrongOptions3()
+    {
+        $this->expectException(LogicException::class);
+        new HttpClient(['timeout' => 'string']);
+    }
+
+    public function testWrongMethod()
+    {
+        $client = new HttpClient(['headers' => ['Authorization' => 'Bearer secret_token']]);
+        $this->expectException(LogicException::class);
+        $client->fetch(self::URL . '/api/data', ['method' => 'WRONG']);
+    }
 
-        $this->assertEquals( 400,  $response->getStatusCode() );
+    public function testWrongUrl()
+    {
+        $client = new HttpClient(['headers' => ['Authorization' => 'Bearer secret_token']]);
+        $this->expectException(LogicException::class);
+        $client->fetch('WRONG_URL', ['method' => 'GET']);
     }
 
 

Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,9 @@`
`11`	`11`	`* @param array $options The options to configure the HttpClient`
`12`	`12`	`* @return HttpClient The newly created HttpClient instance`
`13`	`13`	`*/`
`14`		`- function http_client(array $options = []): HttpClient`
	`14`	`+ function http_client(array $options = [], callable $logger = null): HttpClient`
`15`	`15`	`{`
`16`		`- return new HttpClient($options);`
	`16`	`+ return new HttpClient($options, $logger);`
`17`	`17`	`}`
`18`	`18`	`}`
`19`	`19`
`@@ -28,7 +28,7 @@ function http_client(array $options = []): HttpClient`
`28`	`28`	`*/`
`29`	`29`	`function http_post(string $url, array $data = [], array $headers = []): Response`
`30`	`30`	`{`
`31`		`- return http_client()->post($url, $data, false,$headers);`
	`31`	`+ return http_client()->post($url, $data, false, $headers);`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
`@@ -43,7 +43,7 @@ function http_post(string $url, array $data = [], array $headers = []): Response`
`43`	`43`	`*/`
`44`	`44`	`function http_post_json(string $url, array $data = [], array $headers = []): Response`
`45`	`45`	`{`
`46`		`- return http_client()->post($url, $data, true ,$headers);`
	`46`	`+ return http_client()->post($url, $data, true, $headers);`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`