Merge pull request #15 from skoro/14-bug-error-on-payment-status

Fix LiqPay payment status error

src/Controller/Api/V1/PaymentController.php

@@ -115,6 +115,6 @@ public function getPaymentStatus(
         $event = $this->eventDispatcher->dispatch(new PaymentStatusEvent($order, $statusResponse));
         $statusResponse = $event->paymentStatusResponse;
 
-        return $this->json(PaymentStatusDto::makeFromResponse($paymentGateway->getId(), $statusResponse));
+        return $this->json(PaymentStatusDto::makeFromPaymentGatewayResponse($paymentGateway->getId(), $statusResponse));
     }
 }

src/Dto/PaymentStatusDto.php

@@ -37,17 +37,17 @@ public function __construct(
     ) {
     }
 
-    public static function makeFromResponse(
+    public static function makeFromPaymentGatewayResponse(
         string $paymentGatewayId,
         ResponseInterface $response,
     ): self {
         return new self(
             paymentGatewayId: $paymentGatewayId,
             isSuccess: $response->isSuccessful(),
             transactionId: $response->getTransactionId(),
-            message: $response->getMessage(),
-            code: $response->getCode(),
-            data: $response->getRawData(),
+            message: (string) $response->getMessage(),
+            code: (string) $response->getCode(),
+            data: (array) $response->getRawData(),
         );
     }
 }

src/Payment/LiqPay/Response/AbstractResponse.php

@@ -8,6 +8,7 @@
 use App\Payment\Common\Message\MessageInterface;
 use App\Payment\Common\Message\NullRequest;
 use App\Payment\Common\Message\RequestInterface;
+use Override;
 
 abstract class AbstractResponse extends CommonAbstractResponse
 {
@@ -18,6 +19,17 @@ public function __construct(
         parent::__construct($request);
     }
 
+    #[Override]
+    public function getCode(): string
+    {
+        return (string) ($this->data['code'] ?? '');
+    }
+
+    public function getStatus(): string
+    {
+        return (string) ($this->data['status'] ?? '');
+    }
+
     public static function makeOfMessage(MessageInterface $message, RequestInterface | null $request = null): static
     {
         return new static($message->getRawData(), $request ?? new NullRequest());

src/Payment/LiqPay/Response/PaymentStatusResponse.php

@@ -15,7 +15,7 @@ public function isRedirect(): false
 
     public function isSuccessful(): bool
     {
-        $status = $this->data['status'] ?? '';
+        $status = $this->getStatus();
 
         return $status === self::SUCCESS;
     }

tests/Unit/Dto/PaymentStatusDtoTest.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Tests\Unit\Dto;
+
+use App\Dto\PaymentStatusDto;
+use App\Payment\Common\Message\ResponseInterface;
+use PHPUnit\Framework\TestCase;
+
+final class PaymentStatusDtoTest extends TestCase
+{
+    public function testCastToStringPaymentResponseValues(): void
+    {
+        $response = $this->createStub(ResponseInterface::class);
+        $response->method('isSuccessful')->willReturn(true);
+        $response->method('getTransactionId')->willReturn('');
+        $response->method('getMessage')->willReturn(null);
+        $response->method('getCode')->willReturn(null);
+        $response->method('getRawData')->willReturn(false);
+
+        $dto = PaymentStatusDto::makeFromPaymentGatewayResponse('123', $response);
+
+        $this->assertEquals('123', $dto->paymentGatewayId);
+        $this->assertEquals('', $dto->message);
+        $this->assertEquals('', $dto->code);
+        $this->assertTrue($dto->isSuccess);
+        $this->assertEquals('', $dto->transactionId);
+    }
+
+    /**
+     * @dataProvider paymentStatusRawDataProvider
+     */
+    public function testPaymentStatusDataAlwaysCastToArray(mixed $data, $expected): void
+    {
+        $response = $this->createStub(ResponseInterface::class);
+        $response->method('isSuccessful')->willReturn(true);
+        $response->method('getTransactionId')->willReturn('');
+        $response->method('getMessage')->willReturn(null);
+        $response->method('getCode')->willReturn(null);
+        $response->method('getRawData')->willReturn($data);
+
+        $dto = PaymentStatusDto::makeFromPaymentGatewayResponse('123', $response);
+
+        $this->assertEquals($expected, $dto->data);
+    }
+
+    public function paymentStatusRawDataProvider(): array
+    {
+        return [
+            [false, [false]],
+            ['', ['']],
+            [null, []],
+        ];
+    }
+}

tests/Unit/Payment/LiqPay/Response/PaymentStatusResponseTest.php

@@ -29,4 +29,22 @@ public function testLiqPayPaymentStatusSuccessResponse(): void
         $this->assertEquals('123456789', $response->getTransactionId(), 'Payment transaction is not matched');
         $this->assertEquals(123456789, $response->getPaymentId(), 'Payment id is not matched');
     }
+
+    public function testLiqPayPaymentNotFoundResponse(): void
+    {
+        $data = $this->loadJsonFixture('liqpay/payment-not-found-status.json');
+
+        $message = $this->createStub(MessageInterface::class);
+        $message
+            ->method('getRawData')
+            ->willReturn($data);
+
+        $response = PaymentStatusResponse::makeOfMessage($message);
+
+        $this->assertFalse($response->isSuccessful());
+        $this->assertEquals('Платіж не знайдено', $response->getMessage());
+        $this->assertEquals('', $response->getTransactionId(), 'Transaction id must be empty');
+        $this->assertEquals('', $response->getPaymentId());
+        $this->assertEquals('payment_not_found', $response->getCode(), 'Payment code is not matched');
+    }
 }

tests/fixtures/liqpay/payment-not-found-status.json

@@ -0,0 +1,7 @@
+{
+  "code": "payment_not_found",
+  "err_code": "payment_not_found",
+  "err_description": "Платіж не знайдено",
+  "result": "error",
+  "status": "error"
+}