add request body to exception messge (#8)

Author: nick-zh

src/ErrorHandler.php

@@ -17,13 +17,15 @@
 use Jobcloud\Kafka\SchemaRegistryClient\Exception\UnauthorizedException;
 use Jobcloud\Kafka\SchemaRegistryClient\Exception\UnprocessableEntityException;
 use Jobcloud\Kafka\SchemaRegistryClient\Exception\VersionNotFoundException;
+use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
 class ErrorHandler implements ErrorHandlerInterface
 {
     /**
-     * @param ResponseInterface $response
-     * @param string|null       $uri
+     * @param ResponseInterface     $response
+     * @param string|null           $uri
+     * @param RequestInterface|null $request
      * @return void
      * @throws BackendDatastoreException
      * @throws ClientException
@@ -41,7 +43,7 @@ class ErrorHandler implements ErrorHandlerInterface
      * @throws VersionNotFoundException
      * @throws ImportException
      */
-    public function handleError(ResponseInterface $response, string $uri = null): void
+    public function handleError(ResponseInterface $response, string $uri = null, RequestInterface $request = null): void
     {
         $responseContent = json_decode($response->getBody(), true, 512, JSON_THROW_ON_ERROR);
 
@@ -56,6 +58,10 @@ public function handleError(ResponseInterface $response, string $uri = null): vo
             $message .= sprintf(' (%s)', $uri);
         }
 
+        if (null !== $request) {
+            $message .= sprintf(' with request body: %s', $request->getBody()->getContents());
+        }
+
         switch ($code) {
             case 50001:
                 throw new BackendDatastoreException($message);

src/ErrorHandlerInterface.php

@@ -2,6 +2,7 @@
 
 namespace Jobcloud\Kafka\SchemaRegistryClient;
 
+use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
 interface ErrorHandlerInterface
@@ -10,5 +11,9 @@ interface ErrorHandlerInterface
      * @param ResponseInterface $response
      * @param string|null       $uri
      */
-    public function handleError(ResponseInterface $response, string $uri = null): void;
+    public function handleError(
+        ResponseInterface $response,
+        string $uri = null,
+        RequestInterface $request = null
+    ): void;
 }

src/HttpClient.php

@@ -114,9 +114,11 @@ private function createRequest(
      */
     public function call(string $method, string $uri, array $body = [], array $queryParams = [])
     {
-        $response = $this->client->sendRequest($this->createRequest($method, $uri, $body, $queryParams));
+        $request = $this->createRequest($method, $uri, $body, $queryParams);
 
-        $this->errorHandler->handleError($response, $uri);
+        $response = $this->client->sendRequest($request);
+
+        $this->errorHandler->handleError($response, $uri, $request);
 
         return json_decode($response->getBody(), true, 512, JSON_THROW_ON_ERROR);
     }

tests/ErrorHandlerTest.php

@@ -20,9 +20,13 @@
 use Jobcloud\Kafka\SchemaRegistryClient\Exception\VersionNotFoundException;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 
+/**
+ * @covers \Jobcloud\Kafka\SchemaRegistryClient\ErrorHandler
+ */
 class ErrorHandlerTest extends TestCase
 {
     private const TEST_MESSAGE = 'Test Message';
@@ -123,6 +127,22 @@ public function testExceptionThrowWithUri(): void
         $errorHandler->handleError($responseMock, 'http://test.com');
     }
 
+    public function testExceptionThrowWithRequest(): void
+    {
+        /** @var ResponseInterface|MockObject $responseMock */
+        $responseMock = $this->makeResponseInterfaceMock(50001, self::TEST_MESSAGE);
+        $requestMock = $this->getMockForAbstractClass(RequestInterface::class);
+        $streamMock = $this->getMockForAbstractClass(StreamInterface::class);
+        $streamMock->expects(self::once())->method('getContents')->willReturn('test body');
+        $requestMock->expects(self::once())->method('getBody')->willReturn($streamMock);
+
+        $errorHandler = new ErrorHandler();
+
+        $this->expectException(BackendDatastoreException::class);
+        $this->expectExceptionMessage(self::TEST_MESSAGE . sprintf(' (%s) with request body: %s', 'http://test.com', 'test body'));
+echo 'asdfasf';
+        $errorHandler->handleError($responseMock, 'http://test.com', $requestMock);
+    }
 
     public function testNoExceptionIfNoErrorCode(): void
     {

tests/HttpClientTest.php

@@ -12,7 +12,9 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 
-
+/**
+ * @covers \Jobcloud\Kafka\SchemaRegistryClient\HttpClient
+ */
 class HttpClientTest extends TestCase
 {
     use ReflectionAccessTrait;
@@ -162,4 +164,4 @@ public function testCallMethodWithThrownException(): void
         $this->expectException(Exception::class);
         $httpClient->call('GET', 'uri');
     }
-}
+}

tests/KafkaSchemaRegistryApiClientProviderTest.php

@@ -11,6 +11,9 @@
 use Pimple\Container;
 use Psr\Http\Message\RequestFactoryInterface;
 
+/**
+ * @covers \Jobcloud\Kafka\SchemaRegistryClient\ServiceProvider\KafkaSchemaRegistryApiClientProvider
+ */
 class KafkaSchemaRegistryApiClientProviderTest extends TestCase
 {
     use ReflectionAccessTrait;
@@ -93,4 +96,4 @@ public function testUserNameAndPasswordFromSettingsArePassedToHttpClient(): void
         );
 
     }
-}
+}

tests/KafkaSchemaRegistryApiApiClientTest.php tests/KafkaSchemaRegistryApiClientTest.php

@@ -12,6 +12,9 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * @covers \Jobcloud\Kafka\SchemaRegistryClient\KafkaSchemaRegistryApiClient
+ */
 class KafkaSchemaRegistryApiApiClientTest extends TestCase
 {
     private const TEST_SUBJECT_NAME = 'some-subject';
@@ -438,4 +441,4 @@ public function testImportModeSuccess(): void
         $result = $api->setImportMode('ABC');
         self::assertTrue($result);
     }
-}
+}