added toArray() method to convert JSON request/response data into an array for use in the logger's request, response contexts and request_body in info #1

liborm85 · liborm85 · commit 775b046bf79d · 2025-05-21T16:36:26.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- added `toArray()` method to convert JSON request/response data into an array for use in the logger's `request`, `response` contexts and `request_body` in info
+
 ## 2.1.1 - 2024-11-21
 
 - added PHP 8.4 support
diff --git a/README.md b/README.md
@@ -32,6 +32,19 @@ $loggableHttpClient->setLogger(new \MyLogger());
 
 $response = $loggableHttpClient->request('GET', 'https://example.com');
 
+$response->getContent(); // standard response content as string
+$response->toArray(); // standard response content as array
+
+$requestBody = $response->getInfo('request_body');
+if (isset($requestBody) && ($requestBody instanceof \Liborm85\LoggableHttpClient\Body\BodyInterface)) {
+    $requestBody->getContent(); // request content body as string
+    (string)$requestBody; // is Stringable, request content body as string
+    $requestBody->toStream(); // request content body as PHP stream
+    $requestBody->toArray(); // request content body as array (if is possible, otherwise null)
+}
+
+$response->getInfo('response_time'); // the time when the response was received
+
 
 class MyLogger extends \Psr\Log\AbstractLogger
 {
@@ -42,6 +55,7 @@ class MyLogger extends \Psr\Log\AbstractLogger
             $context['request']->getContent(); // request content body as string
             (string)$context['request']; // is Stringable, request content body as string
             $context['request']->toStream(); // request content body as PHP stream
+            $context['request']->toArray(); // request content body as array (if is possible, otherwise null)
             $context['request']->getHeadersAsString(); // request headers as string
             $context['request']->getHeaders(); // request headers as array (string[][])
             $context['request']->getRequestTime(); // request time as DateTimeInterface
@@ -53,6 +67,7 @@ class MyLogger extends \Psr\Log\AbstractLogger
             $context['response']->getContent(); // response content body as string
             (string)$context['response']; // is Stringable, response content body as string
             $context['response']->toStream(); // response content body as PHP stream
+            $context['response']->toArray(); // response content body as array (if is possible, otherwise null)
             $context['response']->getHeadersAsString(); // response headers as string
             $context['response']->getHeaders(); // response headers as array (string[][])
             $context['response']->getResponseTime(); // response time as DateTimeInterface
diff --git a/src/Body/BodyInterface.php b/src/Body/BodyInterface.php
@@ -7,6 +7,8 @@ interface BodyInterface extends \Stringable
 
     public function getContent(): ?string;
 
+    public function toArray(): ?array;
+
     /**
      * @return resource|null
      */
diff --git a/src/Body/RequestBody.php b/src/Body/RequestBody.php
@@ -23,6 +23,26 @@ public function getContent(): ?string
         return $this->getBodyAsString($this->body);
     }
 
+    public function toArray(): ?array
+    {
+        $content = $this->getContent();
+        if ($content === null || $content === '') {
+            return null;
+        }
+
+        try {
+            $content = json_decode($content, true, 512, \JSON_BIGINT_AS_STRING | \JSON_THROW_ON_ERROR);
+        } catch (\JsonException) {
+            return null;
+        }
+
+        if (!is_array($content)) {
+            return null;
+        }
+
+        return $content;
+    }
+
     /**
      * @return resource|null
      */
diff --git a/src/Context/RequestContext.php b/src/Context/RequestContext.php
@@ -88,6 +88,20 @@ public function getContent(): ?string
         }
     }
 
+    public function toArray(): ?array
+    {
+        $requestBody = $this->getRequestBody();
+        if ($requestBody === null) {
+            return null;
+        }
+
+        try {
+            return $requestBody->toArray();
+        } catch (\Throwable) {
+            return null;
+        }
+    }
+
     /**
      * @return resource|null
      */
diff --git a/src/Context/RequestContextInterface.php b/src/Context/RequestContextInterface.php
@@ -17,6 +17,8 @@ public function getHeadersAsString(): ?string;
 
     public function getContent(): ?string;
 
+    public function toArray(): ?array;
+
     /**
      * @return resource|null
      */
diff --git a/src/Context/ResponseContext.php b/src/Context/ResponseContext.php
@@ -67,6 +67,15 @@ public function getContent(): ?string
         }
     }
 
+    public function toArray(): ?array
+    {
+        try {
+            return $this->response->toArray(false);
+        } catch (\Throwable) {
+            return null;
+        }
+    }
+
     public function __toString(): string
     {
         return $this->getContent() ?? '';
diff --git a/src/Context/ResponseContextInterface.php b/src/Context/ResponseContextInterface.php
@@ -15,6 +15,8 @@ public function getHeadersAsString(): ?string;
 
     public function getContent(): ?string;
 
+    public function toArray(): ?array;
+
     /**
      * @return resource|null
      */
diff --git a/tests/AmpHttpClientTest.php b/tests/AmpHttpClientTest.php
@@ -60,6 +60,10 @@ public function testGetContentStringBody(): void
                     'abc' => 'def',
                     'REQUEST_METHOD' => 'POST',
                 ],
+                'response-content-toarray' => [
+                    'abc' => 'def',
+                    'REQUEST_METHOD' => 'POST',
+                ],
             ],
         ];
         $this->assertSameResponseContentLog($expected, $logger->logs);
@@ -101,6 +105,10 @@ public function testGetContentIterableYieldBody(): void
                     'abc' => 'def',
                     'REQUEST_METHOD' => 'POST',
                 ],
+                'response-content-toarray' => [
+                    'abc' => 'def',
+                    'REQUEST_METHOD' => 'POST',
+                ],
             ],
         ];
         $this->assertSameResponseContentLog($expected, $logger->logs);
@@ -134,10 +142,16 @@ public function testGetContentJsonBody(): void
             [
                 'message' => 'Response content: "200 http://127.0.0.1:8057/post"',
                 'request-content' => '{"abc":"def"}',
+                'request-content-json' => ['abc' => 'def'],
+                'request-content-toarray' => ['abc' => 'def'],
                 'response-content-json' => [
                     '{"abc":"def"}' => '',
                     'REQUEST_METHOD' => 'POST',
                 ],
+                'response-content-toarray' => [
+                    '{"abc":"def"}' => '',
+                    'REQUEST_METHOD' => 'POST',
+                ],
             ],
         ];
 
@@ -176,6 +190,10 @@ public function testToArray(): void
                     'abc' => 'def',
                     'REQUEST_METHOD' => 'POST',
                 ],
+                'response-content-toarray' => [
+                    'abc' => 'def',
+                    'REQUEST_METHOD' => 'POST',
+                ],
             ],
         ];
         $this->assertSameResponseContentLog($expected, $logger->logs);
@@ -225,6 +243,10 @@ public function testStream(): void
                     'abc' => 'def',
                     'REQUEST_METHOD' => 'POST',
                 ],
+                'response-content-toarray' => [
+                    'abc' => 'def',
+                    'REQUEST_METHOD' => 'POST',
+                ],
             ],
         ];
         $this->assertSameResponseContentLog($expected, $logger->logs);
@@ -267,6 +289,10 @@ public function testToStream(): void
                     'abc' => 'def',
                     'REQUEST_METHOD' => 'POST',
                 ],
+                'response-content-toarray' => [
+                    'abc' => 'def',
+                    'REQUEST_METHOD' => 'POST',
+                ],
             ],
         ];
         $this->assertSameResponseContentLog($expected, $logger->logs);
@@ -302,6 +328,10 @@ public function testDestroyResponse(): void
                     'abc' => 'def',
                     'REQUEST_METHOD' => 'POST',
                 ],
+                'response-content-toarray' => [
+                    'abc' => 'def',
+                    'REQUEST_METHOD' => 'POST',
+                ],
             ],
         ];
         $this->assertSameResponseContentLog($expected, $logger->logs);
@@ -400,6 +430,10 @@ public function testCancelResponseAfterGetContent(): void
                     'abc' => 'def',
                     'REQUEST_METHOD' => 'POST',
                 ],
+                'response-content-toarray' => [
+                    'abc' => 'def',
+                    'REQUEST_METHOD' => 'POST',
+                ],
                 'response-headers-content-type' => ['application/json'],
                 'info-canceled' => false,
             ],
@@ -491,6 +525,18 @@ public function testHttp404(): void
                     'HTTP_ACCEPT_ENCODING' => 'gzip',
                     'HTTP_HOST' => '127.0.0.1:8057',
                 ],
+                'response-content-toarray' => [
+                    'SERVER_PROTOCOL' => 'HTTP/1.1',
+                    'SERVER_NAME' => '127.0.0.1',
+                    'REQUEST_URI' => '/404',
+                    'REQUEST_METHOD' => 'POST',
+                    'HTTP_ACCEPT' => '*/*',
+                    'HTTP_CONTENT_LENGTH' => '7',
+                    'HTTP_CONTENT_TYPE' => 'application/x-www-form-urlencoded',
+                    'HTTP_USER_AGENT' => 'Symfony HttpClient (Amp)',
+                    'HTTP_ACCEPT_ENCODING' => 'gzip',
+                    'HTTP_HOST' => '127.0.0.1:8057',
+                ],
             ],
         ];
         $this->assertSameResponseContentLog($expected, $logger->logs);
@@ -541,6 +587,18 @@ public function testHttp404ThrowHttpException(): void
                     'HTTP_ACCEPT_ENCODING' => 'gzip',
                     'HTTP_HOST' => '127.0.0.1:8057',
                 ],
+                'response-content-toarray' => [
+                    'SERVER_PROTOCOL' => 'HTTP/1.1',
+                    'SERVER_NAME' => '127.0.0.1',
+                    'REQUEST_URI' => '/404',
+                    'REQUEST_METHOD' => 'POST',
+                    'HTTP_ACCEPT' => '*/*',
+                    'HTTP_CONTENT_LENGTH' => '7',
+                    'HTTP_CONTENT_TYPE' => 'application/x-www-form-urlencoded',
+                    'HTTP_USER_AGENT' => 'Symfony HttpClient (Amp)',
+                    'HTTP_ACCEPT_ENCODING' => 'gzip',
+                    'HTTP_HOST' => '127.0.0.1:8057',
+                ],
             ],
         ];
         $this->assertSameResponseContentLog($expected, $logger->logs);
diff --git a/tests/CurlHttpClientTest.php b/tests/CurlHttpClientTest.php
diff --git a/tests/NativeHttpClientTest.php b/tests/NativeHttpClientTest.php
diff --git a/tests/TestLogger.php b/tests/TestLogger.php

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,15 @@ public function getContent(): ?string`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
	`70`	`+ public function toArray(): ?array`
	`71`	`+ {`
	`72`	`+ try {`
	`73`	`+ return $this->response->toArray(false);`
	`74`	`+ } catch (\Throwable) {`
	`75`	`+ return null;`
	`76`	`+ }`
	`77`	`+ }`
	`78`	`+`
`70`	`79`	`public function __toString(): string`
`71`	`80`	`{`
`72`	`81`	`return $this->getContent() ?? '';`