Enhances error handling and response tracking in RO class

Improves the management of success states, error messages, and operation tracking within the RO class.

Adds properties for storing messages and operation names, ensuring clearer handling of API responses.

Refines the success method to incorporate new success logic based on response data, enhancing overall robustness.

Updates error parsing to better handle response structures, leading to more informative error reporting.

Author: Vítězslav Dvořák

src/AbraFlexi/RO.php

@@ -323,6 +323,14 @@ class RO extends \Ease\Sand implements \Stringable
      */
     protected bool $ignoreNotFound = false;
 
+    /**
+     * Action Messages.
+     *
+     * @var array<string>
+     */
+    protected array $messages = [];
+    protected ?bool $success = null;
+
     /**
      * Array of errors caused by last request.
      *
@@ -337,6 +345,11 @@ class RO extends \Ease\Sand implements \Stringable
      */
     protected ?array $responseStats = null;
 
+    /**
+     * Performed Operation name.
+     */
+    protected ?string $operation = null;
+
     /**
      * List of Error500 reports sent.
      *
@@ -401,6 +414,10 @@ public function __toString()
      */
     public function __unserialize(array $data): void
     {
+        foreach ($data as $key => $value) {
+            $this->setupProperty($data, $key);
+        }
+
         $this->curlInit();
     }
 
@@ -997,11 +1014,13 @@ public function addDefaultUrlParams(string $urlRaw)
     public function performRequest(
         string $urlSuffix = '',
         string $method = 'GET',
-        $format = null,
+        string $format = '',
     ) {
+        $this->success = null;
         $this->rowCount = null;
         $this->responseStats = [];
         $this->errors = [];
+        $this->messages = [];
 
         if (preg_match('/^http/', $urlSuffix)) {
             $url = $urlSuffix;
@@ -1248,6 +1267,16 @@ public function parseResponse($responseDecoded, $responseCode)
     {
         $mainResult = null;
 
+        if (!empty($responseDecoded) && \is_array($responseDecoded) && \array_key_exists('success', $responseDecoded)) {
+            $this->operation = \array_key_exists('operation', $responseDecoded) ? $responseDecoded['operation'] : 'get';
+
+            $this->success = $responseDecoded['success'] === 'ok';
+
+            $this->messages = \array_key_exists('messages', $responseDecoded) && \is_array($responseDecoded['messages']) ? $responseDecoded['messages'] : [];
+
+            $this->parseError($responseDecoded);
+        }
+
         switch ($responseCode) {
             case 201: // We do not care about Success Write here
             case 202: // Accept eg. unsent mails sent
@@ -1328,10 +1357,6 @@ public function parseResponse($responseDecoded, $responseCode)
                 // no break
             case 400: // Bad Request parameters
             default: // Something goes wrong
-                if (!empty($responseDecoded) && \is_array($responseDecoded)) {
-                    $this->parseError($responseDecoded);
-                }
-
                 if ($this->throwException) {
                     $errors = $this->getErrors();
 
@@ -1354,7 +1379,9 @@ public function parseResponse($responseDecoded, $responseCode)
     public function parseError(array $responseDecoded)
     {
         if (\array_key_exists('success', $responseDecoded)) {
-            $this->errors = [['message' => \array_key_exists('message', $responseDecoded) ? $responseDecoded['message'] : '']];
+            if (\array_key_exists('message', $responseDecoded) && \strlen($responseDecoded['message'])) {
+                $this->errors = [['message' => $responseDecoded['message']]];
+            }
         } else {
             $this->addStatusMessage('Unparsed error: '.$this->lastCurlResponse, 'error');
         }
@@ -1373,9 +1400,9 @@ public function parseError(array $responseDecoded)
      *
      * @return int HTTP Response CODE
      */
-    public function doCurlRequest($url, $method, $format = null)
+    public function doCurlRequest(string $url, string $method, string $format = '')
     {
-        if (null === $format) {
+        if (empty($format)) {
             $format = $this->format;
         }
 
@@ -1434,12 +1461,10 @@ public function doCurlRequest($url, $method, $format = null)
 
     /**
      * Return last response success status.
-     *
-     * @return bool
      */
-    public function success()
+    public function success(): bool
     {
-        return $this->lastResponseCode === 200;
+        return ($this->lastResponseCode === 200) && $this->success;
     }
 
     /**
@@ -2888,6 +2913,19 @@ public function getLastOperationType(): string
         return implode(',', array_keys(array_filter($this->responseStats)));
     }
 
+    /**
+     * @return array<int, string> Description
+     */
+    public function getMessages(): array
+    {
+        return $this->messages;
+    }
+
+    public function getOperation(): string
+    {
+        return $this->operation;
+    }
+
     /**
      * Last operation errors.
      *

src/AbraFlexi/RW.php

@@ -159,7 +159,11 @@ public function parseResponse($responseDecoded, $responseCode)
      */
     public function parseError(array $responseDecoded)
     {
-        if (\array_key_exists('results', $responseDecoded)) {
+        if (\array_key_exists('errors', $responseDecoded) && \is_array($responseDecoded['errors'])) {
+            $this->errors = $responseDecoded['errors'];
+        }
+
+        if (\array_key_exists('results', $responseDecoded) && \is_array($responseDecoded['results'])) {
             if (\array_key_exists(0, $responseDecoded['results'])) {
                 foreach ($responseDecoded['results'] as $result) {
                     if (\array_key_exists('request-id', $result)) {
@@ -514,12 +518,10 @@ public function sync($data = null)
 
     /**
      * Last operation was successfull ?
-     *
-     * @return bool
      */
-    public function success()
+    public function success(): bool
     {
-        $this->curlInfo['http_method'] === 'POST' ? $this->lastResponseCode === 201 : parent::success();
+        return $this->curlInfo['http_method'] === 'POST' ? $this->lastResponseCode === 201 : parent::success();
     }
 
     /**