refactor alibaba exception

kyto-gmbh · Feb 22, 2024 · a80b62c · a80b62c
1 parent 12fcfdb
commit a80b62c
Show file tree

Hide file tree

Showing 8 changed files with 85 additions and 32 deletions.
diff --git a/src/Client.php b/src/Client.php
@@ -4,7 +4,7 @@
 
 namespace Kyto\Alibaba;
 
-use Kyto\Alibaba\Exception\AlibabaException;
+use Kyto\Alibaba\Exception\AlibabaApiError;
 use Kyto\Alibaba\Util\Clock;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
@@ -96,7 +96,7 @@ private function throwOnError(array $data): void
         $errorResponse = $data['error_response'] ?? null;
 
         if ($errorResponse !== null) {
-            throw new AlibabaException(
+            throw new AlibabaApiError(
                 $errorResponse['msg'],
                 (int) $errorResponse['code'],
                 $errorResponse['sub_msg'],

diff --git a/src/Endpoint/CategoryEndpoint.php b/src/Endpoint/CategoryEndpoint.php
@@ -5,6 +5,7 @@
 namespace Kyto\Alibaba\Endpoint;
 
 use Kyto\Alibaba\Client;
+use Kyto\Alibaba\Exception\UnexpectedApiResultException;
 use Kyto\Alibaba\Factory\CategoryFactory;
 use Kyto\Alibaba\Model\Category;
 use Kyto\Alibaba\Model\CategoryAttribute;
@@ -100,7 +101,7 @@ public function getLevelAttribute(
         );
 
         $attribute = $data['alibaba_icbu_category_level_attr_get_response']['result_list']
-            ?? throw new \RuntimeException($errorMessage);
+            ?? throw new UnexpectedApiResultException($errorMessage);
 
         return $this->categoryFactory->createLevelAttribute($attribute);
     }

diff --git a/src/Exception/AlibabaApiError.php b/src/Exception/AlibabaApiError.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kyto\Alibaba\Exception;
+
+class AlibabaApiError extends AlibabaException
+{
+    /**
+     * @internal
+     */
+    public function __construct(
+        string $message,
+        int $code,
+        private string $subMessage,
+        private string $subCode,
+        ?\Throwable $previous = null
+    ) {
+        $message = sprintf('%s. Sub-code: "%s". Sub-message: "%s".', $message, $this->subCode, $this->subMessage);
+        parent::__construct($message, $code, $previous);
+    }
+
+    public function getSubMessage(): string
+    {
+        return $this->subMessage;
+    }
+
+    public function getSubCode(): string
+    {
+        return $this->subCode;
+    }
+}
diff --git a/src/Exception/AlibabaException.php b/src/Exception/AlibabaException.php
@@ -4,29 +4,6 @@
 
 namespace Kyto\Alibaba\Exception;
 
-class AlibabaException extends \RuntimeException
+abstract class AlibabaException extends \RuntimeException
 {
-    /**
-     * @internal
-     */
-    public function __construct(
-        string $message,
-        int $code,
-        private string $subMessage,
-        private string $subCode,
-        ?\Throwable $previous = null
-    ) {
-        $message = sprintf('%s. Sub-code: "%s". Sub-message: "%s".', $message, $this->subCode, $this->subMessage);
-        parent::__construct($message, $code, $previous);
-    }
-
-    public function getSubMessage(): string
-    {
-        return $this->subMessage;
-    }
-
-    public function getSubCode(): string
-    {
-        return $this->subCode;
-    }
 }
diff --git a/src/Exception/UnexpectedApiResultException.php b/src/Exception/UnexpectedApiResultException.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kyto\Alibaba\Exception;
+
+class UnexpectedApiResultException extends AlibabaException
+{
+    /**
+     * @internal
+     */
+    public function __construct(
+        string $message,
+        int $code = 0,
+        ?\Throwable $previous = null
+    ) {
+        parent::__construct($message, $code, $previous);
+    }
+}
diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -5,7 +5,7 @@
 namespace Kyto\Alibaba\Tests;
 
 use Kyto\Alibaba\Client;
-use Kyto\Alibaba\Exception\AlibabaException;
+use Kyto\Alibaba\Exception\AlibabaApiError;
 use Kyto\Alibaba\Util\Clock;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -81,7 +81,7 @@ public function testRequest(bool $isSuccess, array $responseData): void
         ->willReturn($response);
 
         if (!$isSuccess) {
-            $this->expectException(AlibabaException::class);
+            $this->expectException(AlibabaApiError::class);
         }
 
         $actual = $this->client->request(['hello' => 'world', 'test' => 'data']);

diff --git a/tests/Exception/AlibabaExceptionTest.php → tests/Exception/AlibabaApiErrorTest.php b/tests/Exception/AlibabaExceptionTest.php → tests/Exception/AlibabaApiErrorTest.php
@@ -4,10 +4,10 @@
 
 namespace Kyto\Alibaba\Tests\Exception;
 
-use Kyto\Alibaba\Exception\AlibabaException;
+use Kyto\Alibaba\Exception\AlibabaApiError;
 use PHPUnit\Framework\TestCase;
 
-class AlibabaExceptionTest extends TestCase
+class AlibabaApiErrorTest extends TestCase
 {
     public function testConstruct(): void
     {
@@ -17,7 +17,7 @@ public function testConstruct(): void
         $subCode = 'sub.code';
         $previous = new \RuntimeException('Previous');
 
-        $exception = new AlibabaException($message, $code, $subMessage, $subCode, $previous);
+        $exception = new AlibabaApiError($message, $code, $subMessage, $subCode, $previous);
 
         self::assertSame('Message. Sub-code: "sub.code". Sub-message: "Sub-message".', $exception->getMessage());
         self::assertSame($code, $exception->getCode());

diff --git a/tests/Exception/UnexpectedApiResultExceptionTest.php b/tests/Exception/UnexpectedApiResultExceptionTest.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kyto\Alibaba\Tests\Exception;
+
+use Kyto\Alibaba\Exception\UnexpectedApiResultException;
+use PHPUnit\Framework\TestCase;
+
+class UnexpectedApiResultExceptionTest extends TestCase
+{
+    public function testConstruct(): void
+    {
+        $message = 'Message';
+        $code = 1;
+        $previous = new \RuntimeException('Previous');
+
+        $exception = new UnexpectedApiResultException($message, $code, $previous);
+
+        self::assertSame('Message', $exception->getMessage());
+        self::assertSame($code, $exception->getCode());
+        self::assertSame($previous, $exception->getPrevious());
+    }
+}