Deprecate remaining exceptions in \OpenSearch\Common\Exceptions and r…

…eplace with new ones (#274) * Deprecate remaining exceptions Signed-off-by: Kim Pepper <[email protected]> * Generate API Signed-off-by: Kim Pepper <[email protected]> --------- Signed-off-by: Kim Pepper <[email protected]>
opensearch-project · Feb 3, 2025 · 289a387 · 289a387
1 parent e9ebb86
commit 289a387
Show file tree

Hide file tree

Showing 221 changed files with 351 additions and 292 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,13 +24,15 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Connections, Connection pools and Selectors are deprecated. Use a PSR HTTP Client that supports retries instead.
 - Throwing exceptions for different HTTP status codes is deprecated. Use the response object to check the status code instead.
 - The following namespaces have been deprecated and will be removed in 3.0.0: 'async_search', 'searchable_snapshots', 'ssl', 'data_frame_transform_deprecated', 'monitoring'.
+- A number of exceptions under `\OpenSearch\Common\Exceptions` are deprecated and moved to `\OpenSearch\Exception`. 
 ### Removed
 - Removed support for PHP 7.3, 7.4 and 8.0.
 - Removed support for async requests which were never actually working.
 ### Fixed
 - Fixed PHP 8.4 deprecations
 - Fixed outdated tests
 ### Updated APIs
+- Updated opensearch-php APIs to reflect [opensearch-api-specification@b9dcb25](https://github.com/opensearch-project/opensearch-api-specification/commit/b9dcb251d551e90ecfc416ba134efe83cbcbc1b3)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@9df46f8](https://github.com/opensearch-project/opensearch-api-specification/commit/9df46f8134641ae5b429e3e9269858c7cb27e4f0)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@592336a](https://github.com/opensearch-project/opensearch-api-specification/commit/592336afb88844f0c5785ba4b085dba3884ac580)
 - Updated opensearch-php APIs to reflect [opensearch-api-specification@799d046](https://github.com/opensearch-project/opensearch-api-specification/commit/799d04622aeddce7b697665d63a29fc049e5088e)

diff --git a/src/OpenSearch/Common/Exceptions/BadMethodCallException.php b/src/OpenSearch/Common/Exceptions/BadMethodCallException.php
@@ -31,6 +31,6 @@
  *
  * @deprecated in 2.4.0 and will be removed in 3.0.0.
  */
-class BadMethodCallException extends \BadMethodCallException implements OpenSearchException
+class BadMethodCallException extends \OpenSearch\Exception\BadMethodCallException
 {
 }
diff --git a/src/OpenSearch/Common/Exceptions/RuntimeException.php b/src/OpenSearch/Common/Exceptions/RuntimeException.php
@@ -21,8 +21,12 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-use OpenSearch\Exception\OpenSearchExceptionInterface;
+// @phpstan-ignore classConstant.deprecatedClass
+@trigger_error(RuntimeException::class . ' is deprecated in 2.4.0 and will be removed in 3.0.0. Use \OpenSearch\Exception\RuntimeException instead.', E_USER_DEPRECATED);
 
-class RuntimeException extends \RuntimeException implements OpenSearchExceptionInterface
+/**
+ * @deprecated in 2.4.0 and will be removed in 3.0.0. Use \OpenSearch\Exception\RuntimeException instead.
+ */
+class RuntimeException extends \OpenSearch\Exception\RuntimeException
 {
 }
diff --git a/src/OpenSearch/Common/Exceptions/Serializer/JsonErrorException.php b/src/OpenSearch/Common/Exceptions/Serializer/JsonErrorException.php
@@ -21,69 +21,14 @@
 
 namespace OpenSearch\Common\Exceptions\Serializer;
 
-use OpenSearch\Exception\OpenSearchExceptionInterface;
+// @phpstan-ignore classConstant.deprecatedClass
+@trigger_error(JsonErrorException::class . ' is deprecated in 2.4.0 and will be removed in 3.0.0. Use \OpenSearch\Exception\JsonErrorException instead.', E_USER_DEPRECATED);
 
 /**
  * Class JsonErrorException
+ *
+ * @deprecated in 2.4.0 and will be removed in 3.0.0. Use \OpenSearch\Exception\JsonErrorException instead.
  */
-class JsonErrorException extends \Exception implements OpenSearchExceptionInterface
+class JsonErrorException extends \OpenSearch\Exception\JsonException
 {
-    /**
-     * @var mixed
-     */
-    private $input;
-
-    /**
-     * @var mixed
-     */
-    private $result;
-
-    /**
-     * @var string[]
-     */
-    private static $messages = array(
-        JSON_ERROR_DEPTH => 'The maximum stack depth has been exceeded',
-        JSON_ERROR_STATE_MISMATCH => 'Invalid or malformed JSON',
-        JSON_ERROR_CTRL_CHAR => 'Control character error, possibly incorrectly encoded',
-        JSON_ERROR_SYNTAX => 'Syntax error',
-        JSON_ERROR_UTF8 => 'Malformed UTF-8 characters, possibly incorrectly encoded',
-        JSON_ERROR_RECURSION => 'One or more recursive references in the value to be encoded',
-        JSON_ERROR_INF_OR_NAN => 'One or more NAN or INF values in the value to be encoded',
-        JSON_ERROR_UNSUPPORTED_TYPE => 'A value of a type that cannot be encoded was given',
-
-        // JSON_ERROR_* constant values that are available on PHP >= 7.0
-        9 => 'Decoding of value would result in invalid PHP property name', //JSON_ERROR_INVALID_PROPERTY_NAME
-        10 => 'Attempted to decode nonexistent UTF-16 code-point' //JSON_ERROR_UTF16
-    );
-
-    /**
-     * @param mixed $input
-     * @param mixed $result
-     */
-    public function __construct(int $code, $input, $result, ?\Throwable $previous = null)
-    {
-        if (isset(self::$messages[$code]) !== true) {
-            throw new \InvalidArgumentException(sprintf('Encountered unknown JSON error code: [%d]', $code));
-        }
-
-        parent::__construct(self::$messages[$code], $code, $previous);
-        $this->input = $input;
-        $this->result = $result;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getInput()
-    {
-        return $this->input;
-    }
-
-    /**
-     * @return mixed
-     */
-    public function getResult()
-    {
-        return $this->result;
-    }
 }
diff --git a/src/OpenSearch/Common/Exceptions/UnexpectedValueException.php b/src/OpenSearch/Common/Exceptions/UnexpectedValueException.php
@@ -21,8 +21,12 @@
 
 namespace OpenSearch\Common\Exceptions;
 
-use OpenSearch\Exception\OpenSearchExceptionInterface;
+// @phpstan-ignore classConstant.deprecatedClass
+@trigger_error(UnexpectedValueException::class . ' is deprecated in 2.4.0 and will be removed in 3.0.0. Use \OpenSearch\Exception\UnexpectedValueException instead.', E_USER_DEPRECATED);
 
-class UnexpectedValueException extends \UnexpectedValueException implements OpenSearchExceptionInterface
+/**
+ * @deprecated in 2.4.0 and will be removed in 3.0.0. Use \OpenSearch\Exception\UnexpectedValueException instead.
+ */
+class UnexpectedValueException extends \OpenSearch\Exception\UnexpectedValueException
 {
 }
diff --git a/src/OpenSearch/Endpoints/AbstractEndpoint.php b/src/OpenSearch/Endpoints/AbstractEndpoint.php
@@ -21,8 +21,8 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\UnexpectedValueException;
 use OpenSearch\EndpointInterface;
+use OpenSearch\Exception\UnexpectedValueException;
 use OpenSearch\Serializers\SerializerInterface;
 
 use function array_filter;

diff --git a/src/OpenSearch/Endpoints/AsyncSearch/Delete.php b/src/OpenSearch/Endpoints/AsyncSearch/Delete.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\AsyncSearch;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 class Delete extends AbstractEndpoint

diff --git a/src/OpenSearch/Endpoints/AsyncSearch/Get.php b/src/OpenSearch/Endpoints/AsyncSearch/Get.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\AsyncSearch;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 class Get extends AbstractEndpoint

diff --git a/src/OpenSearch/Endpoints/AsynchronousSearch/Delete.php b/src/OpenSearch/Endpoints/AsynchronousSearch/Delete.php
@@ -15,7 +15,7 @@
 
 namespace OpenSearch\Endpoints\AsynchronousSearch;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/AsynchronousSearch/Get.php b/src/OpenSearch/Endpoints/AsynchronousSearch/Get.php
@@ -15,7 +15,7 @@
 
 namespace OpenSearch\Endpoints\AsynchronousSearch;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Cluster/DeleteComponentTemplate.php b/src/OpenSearch/Endpoints/Cluster/DeleteComponentTemplate.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\Cluster;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Cluster/ExistsComponentTemplate.php b/src/OpenSearch/Endpoints/Cluster/ExistsComponentTemplate.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\Cluster;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Cluster/GetDecommissionAwareness.php b/src/OpenSearch/Endpoints/Cluster/GetDecommissionAwareness.php
@@ -15,7 +15,7 @@
 
 namespace OpenSearch\Endpoints\Cluster;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Cluster/GetWeightedRouting.php b/src/OpenSearch/Endpoints/Cluster/GetWeightedRouting.php
@@ -15,7 +15,7 @@
 
 namespace OpenSearch\Endpoints\Cluster;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Cluster/PutComponentTemplate.php b/src/OpenSearch/Endpoints/Cluster/PutComponentTemplate.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\Cluster;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Cluster/PutDecommissionAwareness.php b/src/OpenSearch/Endpoints/Cluster/PutDecommissionAwareness.php
@@ -15,7 +15,7 @@
 
 namespace OpenSearch\Endpoints\Cluster;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Cluster/PutWeightedRouting.php b/src/OpenSearch/Endpoints/Cluster/PutWeightedRouting.php
@@ -15,7 +15,7 @@
 
 namespace OpenSearch\Endpoints\Cluster;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Create.php b/src/OpenSearch/Endpoints/Create.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/CreatePit.php b/src/OpenSearch/Endpoints/CreatePit.php
@@ -15,7 +15,7 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/DanglingIndices/DeleteDanglingIndex.php b/src/OpenSearch/Endpoints/DanglingIndices/DeleteDanglingIndex.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\DanglingIndices;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/DanglingIndices/ImportDanglingIndex.php b/src/OpenSearch/Endpoints/DanglingIndices/ImportDanglingIndex.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\DanglingIndices;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/DeleteTransform.php b/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/DeleteTransform.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\DataFrameTransformDeprecated;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 class DeleteTransform extends AbstractEndpoint

diff --git a/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/GetTransformStats.php b/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/GetTransformStats.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\DataFrameTransformDeprecated;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 class GetTransformStats extends AbstractEndpoint

diff --git a/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/PutTransform.php b/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/PutTransform.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\DataFrameTransformDeprecated;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 class PutTransform extends AbstractEndpoint

diff --git a/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/StartTransform.php b/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/StartTransform.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\DataFrameTransformDeprecated;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 class StartTransform extends AbstractEndpoint

diff --git a/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/StopTransform.php b/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/StopTransform.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\DataFrameTransformDeprecated;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 class StopTransform extends AbstractEndpoint

diff --git a/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/UpdateTransform.php b/src/OpenSearch/Endpoints/DataFrameTransformDeprecated/UpdateTransform.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints\DataFrameTransformDeprecated;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 class UpdateTransform extends AbstractEndpoint

diff --git a/src/OpenSearch/Endpoints/Delete.php b/src/OpenSearch/Endpoints/Delete.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/DeleteByQuery.php b/src/OpenSearch/Endpoints/DeleteByQuery.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/DeleteByQueryRethrottle.php b/src/OpenSearch/Endpoints/DeleteByQueryRethrottle.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/DeleteScript.php b/src/OpenSearch/Endpoints/DeleteScript.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Exists.php b/src/OpenSearch/Endpoints/Exists.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/ExistsSource.php b/src/OpenSearch/Endpoints/ExistsSource.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/Explain.php b/src/OpenSearch/Endpoints/Explain.php
@@ -21,7 +21,7 @@
 
 namespace OpenSearch\Endpoints;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**

diff --git a/src/OpenSearch/Endpoints/FlowFramework/Delete.php b/src/OpenSearch/Endpoints/FlowFramework/Delete.php
@@ -15,7 +15,7 @@
 
 namespace OpenSearch\Endpoints\FlowFramework;
 
-use OpenSearch\Common\Exceptions\RuntimeException;
+use OpenSearch\Exception\RuntimeException;
 use OpenSearch\Endpoints\AbstractEndpoint;
 
 /**