Addressed review feedback in PR #553 and updated related tests

Author: sinashakouri

src/Exceptions/UnexpectedStatusCodeException.php

@@ -5,19 +5,123 @@
 namespace OpenAI\Exceptions;
 
 use Exception;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
 
 final class UnexpectedStatusCodeException extends Exception
 {
+    private RequestInterface $request;
+
+    private ResponseInterface $response;
+
     /**
-     * Creates a new Exception instance.
-     *
-     * @param int $statusCode The HTTP status code.
+     * @var array{message: string|null, type: string|null, code: int|string|null}
      */
+    private array $contents;
 
-    public function __construct(int $statusCode)
+    /**
+     * Creates a new UnexpectedStatusCodeException instance.
+     *
+     * @param  int  $statusCode  The unexpected HTTP status code.
+     * @param  RequestInterface  $request  The request that was sent.
+     * @param  ResponseInterface  $response  The response that was received.
+     */
+    public function __construct(int $statusCode, RequestInterface $request, ResponseInterface $response)
     {
-        $message = "Unexpected status code: {$statusCode}";
+        $this->request = $request;
+        $this->response = $response;
+
+        $body = (string) $response->getBody();
+        $decoded = json_decode($body, true);
+
+        $error = [];
+        if (is_array($decoded) && isset($decoded['error']) && is_array($decoded['error'])) {
+            $error = $decoded['error'];
+        }
+
+        $this->contents = [
+            'message' => ($error['message'] ?? null) ?: "Unexpected status code: {$statusCode}",
+            'type' => $error['type'] ?? null,
+            'code' => $error['code'] ?? null,
+        ];
+
+        $message = $this->contents['message'];
+        if (is_array($message)) {
+            $message = implode(PHP_EOL, $message);
+        }
 
         parent::__construct($message, $statusCode);
     }
+
+    /**
+     * Returns the HTTP status code of the response.
+     */
+    public function getStatusCode(): int
+    {
+        return $this->response->getStatusCode();
+    }
+
+    /**
+     * Returns the error message.
+     */
+    public function getErrorMessage(): string
+    {
+        return $this->getMessage();
+    }
+
+    /**
+     * Returns the error code if available.
+     */
+    public function getErrorCode(): string|int|null
+    {
+        return $this->contents['code'] ?? null;
+    }
+
+    /**
+     * Returns the error type if available.
+     */
+    public function getErrorType(): ?string
+    {
+        return $this->contents['type'] ?? null;
+    }
+
+    /**
+     * Returns the request that was made.
+     */
+    public function getRequest(): RequestInterface
+    {
+        return $this->request;
+    }
+
+    /**
+     * Returns the response that was received.
+     */
+    public function getResponse(): ResponseInterface
+    {
+        return $this->response;
+    }
+
+    /**
+     * Returns a string representation of the request.
+     */
+    public function getRequestDetails(): string
+    {
+        return sprintf(
+            'Request: %s %s',
+            $this->request->getMethod(),
+            $this->request->getUri()
+        );
+    }
+
+    /**
+     * Returns a string representation of the response.
+     */
+    public function getResponseDetails(): string
+    {
+        return sprintf(
+            'Response: %d %s',
+            $this->response->getStatusCode(),
+            $this->response->getReasonPhrase()
+        );
+    }
 }

src/Transporters/HttpTransporter.php

@@ -20,6 +20,7 @@
 use OpenAI\ValueObjects\Transporter\Response;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
 /**
@@ -49,7 +50,7 @@ public function requestObject(Payload $payload): Response
 
         $response = $this->sendRequest(fn (): \Psr\Http\Message\ResponseInterface => $this->client->sendRequest($request));
 
-        $this->throwIfNotSuccessfulStatusCode($response);
+        $this->throwIfNotSuccessfulStatusCode($response, $request);
 
         $contents = (string) $response->getBody();
 
@@ -78,7 +79,7 @@ public function requestContent(Payload $payload): string
 
         $response = $this->sendRequest(fn (): \Psr\Http\Message\ResponseInterface => $this->client->sendRequest($request));
 
-        $this->throwIfNotSuccessfulStatusCode($response);
+        $this->throwIfNotSuccessfulStatusCode($response, $request);
 
         $contents = (string) $response->getBody();
 
@@ -96,7 +97,7 @@ public function requestStream(Payload $payload): ResponseInterface
 
         $response = $this->sendRequest(fn () => ($this->streamHandler)($request));
 
-        $this->throwIfNotSuccessfulStatusCode($response);
+        $this->throwIfNotSuccessfulStatusCode($response, $request);
 
         $this->throwIfJsonError($response, $response);
 
@@ -144,12 +145,12 @@ private function throwIfJsonError(ResponseInterface $response, string|ResponseIn
         }
     }
 
-    private function throwIfNotSuccessfulStatusCode(ResponseInterface $response): void
+    private function throwIfNotSuccessfulStatusCode(ResponseInterface $response, RequestInterface $request): void
     {
         $statusCode = $response->getStatusCode();
 
         if ($statusCode < 200 || $statusCode >= 300) {
-            throw new UnexpectedStatusCodeException($statusCode);
+            throw new UnexpectedStatusCodeException($statusCode, $request, $response);
         }
     }
 }

tests/Arch.php

@@ -19,6 +19,7 @@
     ->expect('OpenAI\Exceptions')
     ->toOnlyUse([
         'Psr\Http\Client',
+        'Psr\Http\Message',
     ])->toImplement(Throwable::class);
 
 test('resources')->expect('OpenAI\Resources')->toOnlyUse([