restore BC in AbstractApi::retrieveAll()

kbsali · Dec 20, 2023 · 308be81 · 308be81
1 parent 9fa08c3
commit 308be81
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 8 deletions.
diff --git a/src/Redmine/Api/AbstractApi.php b/src/Redmine/Api/AbstractApi.php
@@ -4,6 +4,7 @@
 
 use Redmine\Api;
 use Redmine\Client\Client;
+use Redmine\Exception;
 use Redmine\Exception\SerializerException;
 use Redmine\Serializer\JsonSerializer;
 use Redmine\Serializer\PathSerializer;
@@ -169,7 +170,7 @@ protected function sanitizeParams(array $defaults, array $params)
      * @param string $endpoint API end point
      * @param array  $params   optional parameters to be passed to the api (offset, limit, ...)
      *
-     * @return array|false elements found
+     * @return string|array|false elements found or error message of false
      */
     protected function retrieveAll($endpoint, array $params = [])
     {
@@ -178,6 +179,8 @@ protected function retrieveAll($endpoint, array $params = [])
         try {
             $data = $this->retrieveData(strval($endpoint), $params);
         } catch (SerializerException $e) {
+            return 'Error decoding body as JSON: '.$e->getPrevious()->getMessage();
+        } catch (Exception $e) {
             $data = false;
         }
 
@@ -308,10 +311,6 @@ private function getLastResponseBodyAsArray(): array
     {
         $body = $this->client->getLastResponseBody();
 
-        if ($body === '') {
-            return [];
-        }
-
         $contentType = $this->client->getLastResponseContentType();
         $returnData = null;
 

diff --git a/tests/Unit/Api/AbstractApiTest.php b/tests/Unit/Api/AbstractApiTest.php
@@ -5,6 +5,7 @@
 use PHPUnit\Framework\TestCase;
 use Redmine\Api\AbstractApi;
 use Redmine\Client\Client;
+use Redmine\Exception\SerializerException;
 use ReflectionMethod;
 use SimpleXMLElement;
 
@@ -236,14 +237,42 @@ public function testRetrieveData($response, $contentType, $expected)
         $method->setAccessible(true);
 
         $this->assertSame($expected, $method->invoke($api, '/issues.json'));
-
     }
 
     public static function retrieveDataData(): array
     {
         return [
             'test decode by default' => ['{"foo_bar": 12345}', 'application/json', ['foo_bar' => 12345]],
-            'Empty body' => ['', 'application/json', []],
+        ];
+    }
+
+    /**
+     * @covers \Redmine\Api\AbstractApi::retrieveData
+     *
+     * @dataProvider retrieveDataToExceptionData
+     */
+    public function testRetrieveDataThrowsException($response, $contentType, $expectedException, $expectedMessage)
+    {
+        $client = $this->createMock(Client::class);
+        $client->method('requestGet')->willReturn(true);
+        $client->method('getLastResponseBody')->willReturn($response);
+        $client->method('getLastResponseContentType')->willReturn($contentType);
+
+        $api = new class($client) extends AbstractApi {};
+
+        $method = new ReflectionMethod($api, 'retrieveData');
+        $method->setAccessible(true);
+
+        $this->expectException($expectedException);
+        $this->expectExceptionMessage($expectedMessage);
+
+        $method->invoke($api, '/issues.json');
+    }
+
+    public static function retrieveDataToExceptionData(): array
+    {
+        return [
+            'Empty body' => ['', 'application/json', SerializerException::class, 'Syntax error" while decoding JSON: '],
         ];
     }
 
@@ -271,7 +300,7 @@ public static function retrieveAllData(): array
     {
         return [
             'test decode by default' => ['{"foo_bar": 12345}', 'application/json', ['foo_bar' => 12345]],
-            'Empty body' => ['', 'application/json', []],
+            'Empty body' => ['', 'application/json', 'Error decoding body as JSON: Syntax error'],
         ];
     }