Skip to content

fix: add throwIfNotSuccessfulStatusCode method to validate HTTP statu… #553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 127 additions & 0 deletions src/Exceptions/UnexpectedStatusCodeException.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<?php

declare(strict_types=1);

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;

/**
* @var array{message: string|null, type: string|null, code: int|string|null}
*/
private array $contents;

/**
* 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)
{
$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()
);
}
}
17 changes: 17 additions & 0 deletions src/Transporters/HttpTransporter.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use OpenAI\Enums\Transporter\ContentType;
use OpenAI\Exceptions\ErrorException;
use OpenAI\Exceptions\TransporterException;
use OpenAI\Exceptions\UnexpectedStatusCodeException;
use OpenAI\Exceptions\UnserializableResponse;
use OpenAI\ValueObjects\Transporter\BaseUri;
use OpenAI\ValueObjects\Transporter\Headers;
Expand All @@ -19,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;

/**
Expand Down Expand Up @@ -48,6 +50,8 @@ public function requestObject(Payload $payload): Response

$response = $this->sendRequest(fn (): \Psr\Http\Message\ResponseInterface => $this->client->sendRequest($request));

$this->throwIfNotSuccessfulStatusCode($response, $request);

$contents = (string) $response->getBody();

if (str_contains($response->getHeaderLine('Content-Type'), ContentType::TEXT_PLAIN->value)) {
Expand Down Expand Up @@ -75,6 +79,8 @@ public function requestContent(Payload $payload): string

$response = $this->sendRequest(fn (): \Psr\Http\Message\ResponseInterface => $this->client->sendRequest($request));

$this->throwIfNotSuccessfulStatusCode($response, $request);

$contents = (string) $response->getBody();

$this->throwIfJsonError($response, $contents);
Expand All @@ -91,6 +97,8 @@ public function requestStream(Payload $payload): ResponseInterface

$response = $this->sendRequest(fn () => ($this->streamHandler)($request));

$this->throwIfNotSuccessfulStatusCode($response, $request);

$this->throwIfJsonError($response, $response);

return $response;
Expand Down Expand Up @@ -136,4 +144,13 @@ private function throwIfJsonError(ResponseInterface $response, string|ResponseIn
throw new UnserializableResponse($jsonException);
}
}

private function throwIfNotSuccessfulStatusCode(ResponseInterface $response, RequestInterface $request): void
{
$statusCode = $response->getStatusCode();

if ($statusCode < 200 || $statusCode >= 300) {
throw new UnexpectedStatusCodeException($statusCode, $request, $response);
}
}
}
1 change: 1 addition & 0 deletions tests/Arch.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
->expect('OpenAI\Exceptions')
->toOnlyUse([
'Psr\Http\Client',
'Psr\Http\Message',
])->toImplement(Throwable::class);

test('resources')->expect('OpenAI\Resources')->toOnlyUse([
Expand Down
Loading