Handle HTTP exceptions in HttpTransport

Signed-off-by: Kim Pepper <[email protected]>

src/OpenSearch/Common/Exceptions/Forbidden403Exception.php

@@ -21,11 +21,15 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-@trigger_error(Forbidden403Exception::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0.', E_USER_DEPRECATED);
+use OpenSearch\Exception\ForbiddenHttpException;
+
+@trigger_error(Forbidden403Exception::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0. Use \OpenSearch\Exception\ForbiddenHttpException instead', E_USER_DEPRECATED);
 
 /**
  * @deprecated in 2.3.2 and will be removed in 3.0.0.
+ *
+ * @see \OpenSearch\Exception\ForbiddenHttpException
  */
-class Forbidden403Exception extends \Exception implements OpenSearchException
+class Forbidden403Exception extends ForbiddenHttpException
 {
 }

src/OpenSearch/Common/Exceptions/Missing404Exception.php

@@ -21,11 +21,18 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-@trigger_error(Missing404Exception::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0.', E_USER_DEPRECATED);
+use OpenSearch\Exception\NotFoundHttpException;
+
+@trigger_error(
+    Missing404Exception::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0. Use \OpenSearch\Exception\NotFoundHttpException instead.',
+    E_USER_DEPRECATED
+);
 
 /**
  * @deprecated in 2.3.2 and will be removed in 3.0.0.
+ *
+ * @see \OpenSearch\Exception\NotFoundHttpException
  */
-class Missing404Exception extends \Exception implements OpenSearchException
+class Missing404Exception extends NotFoundHttpException
 {
 }

src/OpenSearch/Common/Exceptions/NoDocumentsToGetException.php

@@ -21,11 +21,16 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-@trigger_error(NoDocumentsToGetException::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0.', E_USER_DEPRECATED);
+@trigger_error(
+    NoDocumentsToGetException::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0. Use \OpenSearch\Exception\NoDocumentsToGetException instead.',
+    E_USER_DEPRECATED
+);
 
 /**
- * @deprecated in 2.3.2 and will be removed in 3.0.0.
+ * @deprecated in 2.3.2 and will be removed in 3.0.0. Use \OpenSearch\Exception\NoDocumentsToGetException instead.
+ *
+ * @see \OpenSearch\Exception\ScriptLangNotSupportedException
  */
-class NoDocumentsToGetException extends ServerErrorResponseException implements OpenSearchException
+class NoDocumentsToGetException extends \OpenSearch\Exception\NoDocumentsToGetException
 {
 }

src/OpenSearch/Common/Exceptions/NoNodesAvailableException.php

@@ -21,6 +21,14 @@
 
 namespace OpenSearch\Common\Exceptions;
 
+@trigger_error(
+    NoNodesAvailableException::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0.',
+    E_USER_DEPRECATED
+);
+
+/**
+ * @deprecated in 2.3.2 and will be removed in 3.0.0.
+ */
 class NoNodesAvailableException extends ServerErrorResponseException implements OpenSearchException
 {
 }

src/OpenSearch/Common/Exceptions/NoShardAvailableException.php

@@ -21,6 +21,16 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-class NoShardAvailableException extends ServerErrorResponseException implements OpenSearchException
+@trigger_error(
+    NoShardAvailableException::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0. Use \OpenSearch\Exception\NoShardAvailableException instead.',
+    E_USER_DEPRECATED
+);
+
+/**
+ * @deprecated in 2.3.2 and will be removed in 3.0.0. Use \OpenSearch\Exception\NoShardAvailableException instead.
+ *
+ * @see \OpenSearch\Exception\NoShardAvailableException
+ */
+class NoShardAvailableException extends \OpenSearch\Exception\NoShardAvailableException
 {
 }

src/OpenSearch/Common/Exceptions/OpenSearchException.php

@@ -21,8 +21,16 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-use Throwable;
+use OpenSearch\Exception\OpenSearchExceptionInterface;
 
-interface OpenSearchException extends Throwable
+@trigger_error(
+    NoNodesAvailableException::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0.',
+    E_USER_DEPRECATED
+);
+
+/**
+ * @deprecated in 2.3.2 and will be removed in 3.0.0.
+ */
+interface OpenSearchException extends OpenSearchExceptionInterface
 {
 }

src/OpenSearch/Common/Exceptions/RoutingMissingException.php

@@ -21,6 +21,16 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-class RoutingMissingException extends ServerErrorResponseException implements OpenSearchException
+@trigger_error(
+    RoutingMissingException::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0. Use \OpenSearch\Exception\RoutingMissingException instead.',
+    E_USER_DEPRECATED
+);
+
+/**
+ * @deprecated in 2.3.2 and will be removed in 3.0.0. Use OpenSearch\Exception\UnauthorizedHttpException instead.
+ *
+ * @see \OpenSearch\Exception\ScriptLangNotSupportedException
+ */
+class RoutingMissingException extends \OpenSearch\Exception\RoutingMissingException
 {
 }

src/OpenSearch/Common/Exceptions/RuntimeException.php

@@ -21,6 +21,8 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-class RuntimeException extends \RuntimeException implements OpenSearchException
+use OpenSearch\Exception\OpenSearchExceptionInterface;
+
+class RuntimeException extends \RuntimeException implements OpenSearchExceptionInterface
 {
 }

src/OpenSearch/Common/Exceptions/ScriptLangNotSupportedException.php

@@ -21,6 +21,16 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-class ScriptLangNotSupportedException extends BadRequest400Exception implements OpenSearchException
+@trigger_error(
+    ScriptLangNotSupportedException::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0. Use OpenSearch\Exception\ScriptLangNotSupportedException instead.',
+    E_USER_DEPRECATED
+);
+
+/**
+ * @deprecated in 2.3.2 and will be removed in 3.0.0. Use OpenSearch\Exception\UnauthorizedHttpException instead.
+ *
+ * @see \OpenSearch\Exception\ScriptLangNotSupportedException
+ */
+class ScriptLangNotSupportedException extends \OpenSearch\Exception\ScriptLangNotSupportedException
 {
 }

src/OpenSearch/Common/Exceptions/ServerErrorResponseException.php

@@ -21,6 +21,11 @@
 
 namespace OpenSearch\Common\Exceptions;
 
+@trigger_error(RequestTimeout408Exception::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0.', E_USER_DEPRECATED);
+
+/**
+ * @deprecated in 2.3.2 and will be removed in 3.0.0.
+ */
 class ServerErrorResponseException extends TransportException implements OpenSearchException
 {
 }

src/OpenSearch/Common/Exceptions/Unauthorized401Exception.php

@@ -21,6 +21,18 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-class Unauthorized401Exception extends \Exception implements OpenSearchException
+use OpenSearch\Exception\UnauthorizedHttpException;
+
+@trigger_error(
+    Unauthorized401Exception::class . ' is deprecated in 2.3.2 and will be removed in 3.0.0. Use OpenSearch\Exception\UnauthorizedHttpException instead.',
+    E_USER_DEPRECATED
+);
+
+/**
+ * @deprecated in 2.3.2 and will be removed in 3.0.0. Use OpenSearch\Exception\UnauthorizedHttpException instead.
+ *
+ * @see \OpenSearch\Exception\UnauthorizedHttpException
+ */
+class Unauthorized401Exception extends UnauthorizedHttpException
 {
 }

src/OpenSearch/Common/Exceptions/UnexpectedValueException.php

@@ -21,6 +21,8 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-class UnexpectedValueException extends \UnexpectedValueException implements OpenSearchException
+use OpenSearch\Exception\OpenSearchExceptionInterface;
+
+class UnexpectedValueException extends \UnexpectedValueException implements OpenSearchExceptionInterface
 {
 }

src/OpenSearch/Connections/Connection.php

@@ -664,19 +664,19 @@ private function process4xxError(array $request, array $response, array $ignore)
 
         $responseBody = $this->convertBodyToString($response['body'], $statusCode, $exception);
         if ($statusCode === 401) {
-            $exception = new Unauthorized401Exception($responseBody, $statusCode);
+            $exception = new Unauthorized401Exception($responseBody);
         } elseif ($statusCode === 403) {
-            $exception = new Forbidden403Exception($responseBody, $statusCode);
+            $exception = new Forbidden403Exception($responseBody);
         } elseif ($statusCode === 404) {
-            $exception = new Missing404Exception($responseBody, $statusCode);
+            $exception = new Missing404Exception($responseBody);
         } elseif ($statusCode === 409) {
             $exception = new Conflict409Exception($responseBody, $statusCode);
         } elseif ($statusCode === 400 && strpos($responseBody, 'script_lang not supported') !== false) {
-            $exception = new ScriptLangNotSupportedException($responseBody. $statusCode);
+            $exception = new ScriptLangNotSupportedException($responseBody);
         } elseif ($statusCode === 408) {
-            $exception = new RequestTimeout408Exception($responseBody, $statusCode);
+            $exception = new RequestTimeout408Exception($responseBody);
         } else {
-            $exception = new BadRequest400Exception($responseBody, $statusCode);
+            $exception = new BadRequest400Exception($responseBody);
         }
 
         $this->logRequestFail($request, $response, $exception);
@@ -706,15 +706,14 @@ private function process5xxError(array $request, array $response, array $ignore)
         }
 
         if ($statusCode === 500 && strpos($responseBody, "RoutingMissingException") !== false) {
-            $exception = new RoutingMissingException($exception->getMessage(), $statusCode, $exception);
+            $exception = new RoutingMissingException($exception->getMessage(), [], 0, $exception);
         } elseif ($statusCode === 500 && preg_match('/ActionRequestValidationException.+ no documents to get/', $responseBody) === 1) {
-            $exception = new NoDocumentsToGetException($exception->getMessage(), $statusCode, $exception);
+            $exception = new NoDocumentsToGetException($exception->getMessage(), [], 0, $exception);
         } elseif ($statusCode === 500 && strpos($responseBody, 'NoShardAvailableActionException') !== false) {
-            $exception = new NoShardAvailableException($exception->getMessage(), $statusCode, $exception);
+            $exception = new NoShardAvailableException($exception->getMessage(), [], 0, $exception);
         } else {
             $exception = new ServerErrorResponseException(
                 $this->convertBodyToString($responseBody, $statusCode, $exception),
-                $statusCode
             );
         }
 

src/OpenSearch/Exception/BadRequestHttpException.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenSearch\Exception;
+
+/**
+ * Exception thrown when a 400 Bad Request HTTP error occurs.
+ */
+class BadRequestHttpException extends HttpException
+{
+    public function __construct(string $message = '', array $headers = [], int $code = 0, ?\Throwable $previous = null)
+    {
+        parent::__construct(400, $message, $headers, $code, $previous);
+    }
+
+}

src/OpenSearch/Exception/ConflictHttpException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenSearch\Exception;
+
+/**
+ * Exception thrown when a 409 Conflict HTTP error occurs.
+ */
+class ConflictHttpException extends HttpException
+{
+    public function __construct(string $message = '', array $headers = [], int $code = 0, ?\Throwable $previous = null)
+    {
+        parent::__construct(409, $message, $headers, $code, $previous);
+    }
+}

src/OpenSearch/Exception/ErrorMessageExtractor.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenSearch\Exception;
+
+use OpenSearch\Serializers\SerializerInterface;
+
+/**
+ * Extracts an error message from the response body.
+ */
+class ErrorMessageExtractor
+{
+    public function __construct(
+        private readonly SerializerInterface $serializer,
+    ) {
+    }
+
+    public function extractErrorMessage(mixed $body, array $headers): ?string
+    {
+        if (!is_string($body)) {
+            // Convert non-string response body to string message.
+            return json_encode($body);
+        }
+
+        $error = $this->serializer->deserialize($body, $headers);
+
+        if (is_string($error)) {
+            return $error;
+        }
+
+        if (!isset($error['error'])) {
+            // <2.0 "i just blew up" non-structured exception.
+            // $error is an array, but we don't know the format, so we reuse the response body instead
+            // added json_encode to convert into a string
+            return json_encode($body);
+        }
+
+        // 2.0 structured exceptions
+        if (is_array($error['error']) && array_key_exists('reason', $error['error'])) {
+            // Try to use root cause first (only grabs the first root cause)
+            $info = $error['error']['root_cause'][0] ?? $error['error'];
+            $cause = $info['reason'];
+            $type = $info['type'];
+
+            return "$type: $cause";
+        }
+
+        // <2.0 semi-structured exceptions
+        $legacyError = $error['error'];
+        if (is_array($error['error'])) {
+            return json_encode($legacyError);
+        }
+        return $legacyError;
+    }
+}

src/OpenSearch/Exception/ForbiddenHttpException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenSearch\Exception;
+
+/**
+ * Exception thrown when a 403 Forbidden HTTP error occurs.
+ */
+class ForbiddenHttpException extends HttpException
+{
+    public function __construct(string $message = '', array $headers = [], int $code = 0, ?\Throwable $previous = null)
+    {
+        parent::__construct(403, $message, $headers, $code, $previous);
+    }
+}

src/OpenSearch/Exception/HttpException.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenSearch\Exception;
+
+/**
+ * Exception thrown when an HTTP error occurs.
+ *
+ * @phpstan-consistent-constructor
+ */
+class HttpException extends \RuntimeException implements HttpExceptionInterface
+{
+    public function __construct(
+        protected readonly int $statusCode,
+        string $message = '',
+        protected readonly array $headers = [],
+        int $code = 0,
+        ?\Throwable $previous = null,
+    ) {
+        parent::__construct($message, $code, $previous);
+    }
+
+    public function getStatusCode(): int
+    {
+        return $this->statusCode;
+    }
+
+    public function getHeaders(): array
+    {
+        return $this->headers;
+    }
+
+}