SDK-2143: Add error code and description in failure receipt message (#284)

* SDK-2143: Add error code and description in failure receipt message

* SDK-2143 Add more info to ActivityDetailsException

* SDK-2143 Small fix for error details

* SDK-2143 Delete unnecessary method

* SDK-2143 Delete unnecessary method2

Co-authored-by: Rodion Liuborets <[email protected]>

Author: LuborRod

examples/profile/app/Http/Controllers/DbsCheckController.php

@@ -16,13 +16,13 @@ public function show(YotiClient $client)
                 'trust_framework' => 'UK_TFIDA',
                 'scheme' => [
                     'type' => 'DBS',
-                    'objective' => 'STANDARD'
+                    'objective' => 'BASIC'
                 ]
             ])
             ->build();
 
         $dynamicScenario = (new DynamicScenarioBuilder())
-            ->withCallbackEndpoint("/account/connect")
+            ->withCallbackEndpoint("/profile")
             ->withPolicy($dynamicPolicy)
             ->withSubject((object)[
                 'subject_id' => "some_subject_id_string"

src/Exception/ActivityDetailsException.php

@@ -4,8 +4,47 @@
 
 namespace Yoti\Exception;
 
+use Psr\Http\Message\ResponseInterface;
 use Yoti\Exception\base\YotiException;
+use Yoti\Util\Json;
 
 class ActivityDetailsException extends YotiException
 {
+    /**
+     * @var array<string, mixed>|null
+     */
+    private $responseBody;
+
+    /**
+     * @param string $message
+     * @param ResponseInterface|null $response
+     * @param array<string, mixed>|null $responseBody
+     * @param \Throwable|null $previous
+     */
+    public function __construct(
+        $message = "",
+        ?ResponseInterface $response = null,
+        ?array $responseBody = null,
+        \Throwable $previous = null
+    ) {
+        parent::__construct($message, $response, $previous);
+
+        $this->responseBody = $responseBody;
+    }
+
+    /**
+     * @return string
+     */
+    public function getReceiptErrorDetails(): string
+    {
+        $result = [];
+        if (!is_null($this->responseBody)) {
+            $result['receipt_id'] = $this->responseBody['receipt']['receipt_id'] ?? ' ';
+            if (isset($this->responseBody['error_details'])) {
+                $result['description'] = $this->responseBody['error_details']['description'] ?? ' ';
+                $result['error_code'] = $this->responseBody['error_details']['error_code'] ?? ' ';
+            }
+        }
+        return Json::encode($result);
+    }
 }

src/Profile/Receipt.php

@@ -23,6 +23,7 @@ class Receipt
     private const ATTR_WRAPPED_RECEIPT_KEY = 'wrapped_receipt_key';
     private const ATTR_OTHER_PARTY_PROFILE_CONTENT = 'other_party_profile_content';
     private const ATTR_EXTRA_DATA_CONTENT = 'extra_data_content';
+    private const ATTR_ERROR_DETAILS = 'error_details';
 
     /**
      * @var array<string, mixed>
@@ -45,8 +46,6 @@ public function __construct(array $receiptData, ?LoggerInterface $logger = null)
     {
         $this->logger = $logger ?? new Logger();
 
-        $this->validateReceipt($receiptData);
-
         $this->receiptData = $receiptData;
     }
 
@@ -165,18 +164,4 @@ private function decryptAttribute(string $attributeName, PemFile $pemFile): ?str
             $pemFile
         );
     }
-
-    /**
-     * Check Wrapped_receipt_key exists and is not NULL.
-     *
-     * @param array<string, mixed> $receiptData
-     *
-     * @throws ReceiptException
-     */
-    private function validateReceipt(array $receiptData): void
-    {
-        if (!isset($receiptData[self::ATTR_WRAPPED_RECEIPT_KEY])) {
-            throw new ReceiptException('Wrapped Receipt key attr is missing');
-        }
-    }
 }

src/Profile/Service.php

@@ -88,7 +88,13 @@ public function getActivityDetails(string $encryptedConnectToken): ActivityDetai
 
         // Check response was successful
         if ($receipt->getSharingOutcome() !== self::OUTCOME_SUCCESS) {
-            throw new ActivityDetailsException('Outcome was unsuccessful', $response);
+            throw new ActivityDetailsException(
+                'Sharing activity unsuccessful for ' . $receipt->getReceiptId() . ' '
+                . $result['error_details']['description'] . ' '
+                . $result['error_details']['error_code'],
+                $response,
+                $result
+            );
         }
 
         return new ActivityDetails($receipt, $this->pemFile, $this->config->getLogger());

tests/Profile/ReceiptTest.php

@@ -35,26 +35,21 @@ class ReceiptTest extends TestCase
      */
     public $receipt;
 
+    /**
+     * @throws \Yoti\Exception\PemFileException
+     * @throws \Yoti\Exception\ReceiptException
+     * @covers ::__construct
+     */
     public function setup(): void
     {
         $this->pemFile = PemFile::fromFilePath(TestData::PEM_FILE);
         $this->receiptArr = json_decode(file_get_contents(TestData::RECEIPT_JSON), true)['receipt'];
         $this->receipt = new Receipt($this->receiptArr);
     }
 
-    /**
-     * @covers ::__construct
-     * @covers ::validateReceipt
-     */
-    public function testShouldThrowExceptionForInvalidReceipt()
-    {
-        $this->expectException(\Yoti\Exception\ReceiptException::class);
-
-        new Receipt([]);
-    }
-
     /**
      * @covers ::getTimestamp
+     * @covers ::__construct
      */
     public function testGetTimestamp()
     {

tests/Profile/ServiceTest.php

@@ -7,6 +7,7 @@
 use GuzzleHttp\Psr7;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\ResponseInterface;
+use Yoti\Exception\ActivityDetailsException;
 use Yoti\Profile\ActivityDetails;
 use Yoti\Profile\Service;
 use Yoti\Test\TestCase;
@@ -160,8 +161,10 @@ public function testWrongPemFile()
      */
     public function testSharingOutcomeFailure()
     {
+        $mes1 = "Sharing activity unsuccessful for 9HNJDX5bEIN5TqBm0OGzVIc1LaAmbzfx6eIrwNdwpHvKeQmgPujyogC+r7hJCVPl ";
+        $mes2 = "UNKNOWN FRAUD_DETECTED";
         $this->expectException(\Yoti\Exception\ActivityDetailsException::class);
-        $this->expectExceptionMessage('Outcome was unsuccessful');
+        $this->expectExceptionMessage($mes1 . $mes2);
 
         $json = json_decode(file_get_contents(TestData::RECEIPT_JSON), true);
         $json['receipt']['sharing_outcome'] = 'FAILURE';
@@ -170,6 +173,27 @@ public function testSharingOutcomeFailure()
         $profileService->getActivityDetails(file_get_contents(TestData::YOTI_CONNECT_TOKEN));
     }
 
+    /**
+     * @covers \Yoti\Exception\ActivityDetailsException::getReceiptErrorDetails
+     * @covers \Yoti\Exception\ActivityDetailsException::__construct
+     */
+    public function testReceiptErrorDetailsException()
+    {
+        $json = json_decode(file_get_contents(TestData::RECEIPT_JSON), true);
+        $json['receipt']['sharing_outcome'] = 'FAILURE';
+
+        $profileService = $this->createProfileServiceWithResponse(200, json_encode($json));
+        try {
+            $profileService->getActivityDetails(file_get_contents(TestData::YOTI_CONNECT_TOKEN));
+        } catch (ActivityDetailsException $e) {
+            $this->assertEquals([
+                'receipt_id' => '9HNJDX5bEIN5TqBm0OGzVIc1LaAmbzfx6eIrwNdwpHvKeQmgPujyogC+r7hJCVPl',
+                'description' => 'UNKNOWN',
+                'error_code' => 'FRAUD_DETECTED',
+            ], json_decode($e->getReceiptErrorDetails(), true));
+        }
+    }
+
     /**
      * @covers ::getActivityDetails
      * @covers ::checkForReceipt

tests/sample-data/receipt.json

@@ -13,5 +13,9 @@
         "parent_remember_me_id": "f5RjVQMyoKOvO/hkv43Ik+t6d6mGfP2tdrNijH4k4qafTG0FSNUgQIvd2Z3Nx1j8",
         "sharing_outcome": "SUCCESS",
         "timestamp": "2016-07-19T08:55:38Z"
+    },
+    "error_details": {
+        "description": "UNKNOWN",
+        "error_code" : "FRAUD_DETECTED"
     }
 }