Add proper logging

webgriffe · Sep 12, 2024 · ced6594 · ced6594
1 parent 4ffa8cd
commit ced6594
Show file tree

Hide file tree

Showing 9 changed files with 139 additions and 107 deletions.
diff --git a/config/services/controller.php b/config/services/controller.php
@@ -15,6 +15,7 @@
             service('payum.security.token_storage'),
             service('router'),
             service('sylius.repository.payment'),
+            service('webgriffe_sylius_pausepay.logger'),
         ])
         ->call('setContainer', [service('service_container')])
         ->tag('controller.service_arguments')

diff --git a/src/Controller/PaymentController.php b/src/Controller/PaymentController.php
@@ -7,6 +7,7 @@
 use Payum\Core\Model\Identity;
 use Payum\Core\Security\TokenInterface;
 use Payum\Core\Storage\StorageInterface;
+use Psr\Log\LoggerInterface;
 use Sylius\Bundle\PayumBundle\Model\GatewayConfigInterface;
 use Sylius\Component\Core\Model\PaymentInterface;
 use Sylius\Component\Core\Model\PaymentMethodInterface;
@@ -16,6 +17,7 @@
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Routing\RouterInterface;
 use Webgriffe\SyliusPausePayPlugin\Helper\PaymentDetailsHelper;
+use Webgriffe\SyliusPausePayPlugin\Logger\LoggingHelperTrait;
 use Webgriffe\SyliusPausePayPlugin\Payum\PausePayApi;
 use Webmozart\Assert\Assert;
 
@@ -26,12 +28,14 @@
  */
 final class PaymentController extends AbstractController
 {
+    use LoggingHelperTrait;
+
     public function __construct(
         private StorageInterface $tokenStorage,
         private RouterInterface $router,
         private PaymentRepositoryInterface $paymentRepository,
+        private LoggerInterface $logger,
     ) {
-        // todo: logging
     }
 
     public function processAction(string $payumToken): Response
@@ -45,20 +49,25 @@ public function processAction(string $payumToken): Response
             throw $this->createNotFoundException();
         }
 
-        $paymentDetails = $this->retrieveDetailsFromToken($token);
+        $syliusPayment = $this->retrievePaymentFromToken($token);
+        $paymentDetails = $syliusPayment->getDetails();
+        if (!PaymentDetailsHelper::areValid($paymentDetails)) {
+            throw $this->createAccessDeniedException();
+        }
 
-        $redirectUrl = PaymentDetailsHelper::getRedirectUrl($paymentDetails);
         $paymentStatusUrl = $this->router->generate(
             'webgriffe_sylius_pausepay_plugin_payment_status',
             ['payumToken' => $payumToken],
             UrlGeneratorInterface::ABSOLUTE_URL,
         );
-
-        return $this->render('@WebgriffeSyliusPausePayPlugin/Process/index.html.twig', [
+        $params = [
             'afterUrl' => $token->getAfterUrl(),
             'paymentStatusUrl' => $paymentStatusUrl,
-            'redirectUrl' => $redirectUrl,
-        ]);
+            'redirectUrl' => PaymentDetailsHelper::getRedirectUrl($paymentDetails),
+        ];
+        $this->logInfo($syliusPayment, 'Showing process page to user.', $params);
+
+        return $this->render('@WebgriffeSyliusPausePayPlugin/Process/index.html.twig', $params);
     }
 
     public function statusAction(string $payumToken): Response
@@ -72,16 +81,20 @@ public function statusAction(string $payumToken): Response
             throw $this->createNotFoundException();
         }
 
-        $paymentDetails = $this->retrieveDetailsFromToken($token);
+        $syliusPayment = $this->retrievePaymentFromToken($token);
+        $paymentDetails = $syliusPayment->getDetails();
+        if (!PaymentDetailsHelper::areValid($paymentDetails)) {
+            throw $this->createAccessDeniedException();
+        }
+
         $paymentStatus = PaymentDetailsHelper::getPaymentStatus($paymentDetails);
 
+        $this->logInfo($syliusPayment, sprintf('Retrieved status "%s"', $paymentStatus ?? 'null'));
+
         return $this->json(['captured' => $paymentStatus !== null]);
     }
 
-    /**
-     * @return PaymentDetails
-     */
-    private function retrieveDetailsFromToken(TokenInterface $token): array
+    private function retrievePaymentFromToken(TokenInterface $token): PaymentInterface
     {
         $paymentIdentity = $token->getDetails();
         Assert::isInstanceOf($paymentIdentity, Identity::class);
@@ -94,12 +107,7 @@ private function retrieveDetailsFromToken(TokenInterface $token): array
 
         $this->assertPausePayPayment($syliusPayment);
 
-        $paymentDetails = $syliusPayment->getDetails();
-        if (!PaymentDetailsHelper::areValid($paymentDetails)) {
-            throw $this->createAccessDeniedException();
-        }
-
-        return $paymentDetails;
+        return $syliusPayment;
     }
 
     private function assertPausePayPayment(PaymentInterface $syliusPayment): void

diff --git a/src/Helper/PaymentDetailsHelper.php b/src/Helper/PaymentDetailsHelper.php
@@ -25,7 +25,7 @@ final class PaymentDetailsHelper
     /**
      * @return PaymentDetails
      */
-    public static function createFromContractCreateResult(CreateOrderResult $result): array
+    public static function createFromCreateOrderResult(CreateOrderResult $result): array
     {
         return [
             self::UUID_KEY => $result->getUuid(),

diff --git a/src/Logger/LoggingHelperTrait.php b/src/Logger/LoggingHelperTrait.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Webgriffe\SyliusPausePayPlugin\Logger;
+
+use Sylius\Component\Core\Model\PaymentInterface as SyliusPaymentInterface;
+
+trait LoggingHelperTrait
+{
+    private function logInfo(SyliusPaymentInterface $payment, string $message, array $context = []): void
+    {
+        $this->logger->info(sprintf('[Payment #%s]: %s.', (string) $payment->getId(), $message, ), $context);
+    }
+
+    private function logError(SyliusPaymentInterface $payment, string $message, array $context = []): void
+    {
+        $this->logger->error(sprintf('[Payment #%s]: %s.', (string) $payment->getId(), $message, ), $context);
+    }
+}
diff --git a/src/Payum/Action/CancelAction.php b/src/Payum/Action/CancelAction.php
@@ -14,13 +14,16 @@
 use Symfony\Component\Routing\RouterInterface;
 use Webgriffe\SyliusPausePayPlugin\Client\PaymentState;
 use Webgriffe\SyliusPausePayPlugin\Helper\PaymentDetailsHelper;
+use Webgriffe\SyliusPausePayPlugin\Logger\LoggingHelperTrait;
 use Webmozart\Assert\Assert;
 
 /**
  * @psalm-type PaymentDetails array{uuid: string, redirect_url: string, created_at: string, status?: string}
  */
 final class CancelAction implements ActionInterface
 {
+    use LoggingHelperTrait;
+
     public function __construct(
         private LoggerInterface $logger,
         private RouterInterface $router,
@@ -34,10 +37,8 @@ public function execute($request): void
     {
         RequestNotSupportedException::assertSupports($this, $request);
         Assert::isInstanceOf($request, Cancel::class);
-
         $payment = $request->getModel();
         Assert::isInstanceOf($payment, SyliusPaymentInterface::class);
-
         $order = $payment->getOrder();
         Assert::isInstanceOf($order, OrderInterface::class);
 
@@ -47,17 +48,11 @@ public function execute($request): void
         $paymentDetails = $payment->getDetails();
         PaymentDetailsHelper::assertPaymentDetailsAreValid($paymentDetails);
 
-        $this->logInfo($payment, 'Redirecting the user to the Sylius PausePay waiting page.');
-
-        $order = $payment->getOrder();
-        Assert::isInstanceOf($order, OrderInterface::class);
-
-        $paymentDetails = PaymentDetailsHelper::addPaymentStatus(
-            $paymentDetails,
-            PaymentState::CANCELLED,
-        );
+        $paymentDetails = PaymentDetailsHelper::addPaymentStatus($paymentDetails, PaymentState::CANCELLED);
         $payment->setDetails($paymentDetails);
 
+        $this->logInfo($payment, 'Redirecting the user to the Sylius PausePay waiting page.');
+
         throw new HttpRedirect(
             $this->router->generate('webgriffe_sylius_pausepay_plugin_payment_process', [
                 'payumToken' => $order->getTokenValue(),
@@ -70,9 +65,4 @@ public function supports($request): bool
     {
         return $request instanceof Cancel && $request->getModel() instanceof SyliusPaymentInterface;
     }
-
-    private function logInfo(SyliusPaymentInterface $payment, string $message, array $context = []): void
-    {
-        $this->logger->info(sprintf('[Payment #%s]: %s.', (string) $payment->getId(), $message, ), $context);
-    }
 }
diff --git a/src/Payum/Action/CaptureAction.php b/src/Payum/Action/CaptureAction.php
@@ -25,6 +25,7 @@
 use Webgriffe\SyliusPausePayPlugin\Client\ValueObject\Response\CreateOrderResult;
 use Webgriffe\SyliusPausePayPlugin\Factory\PaymentOrderFactoryInterface;
 use Webgriffe\SyliusPausePayPlugin\Helper\PaymentDetailsHelper;
+use Webgriffe\SyliusPausePayPlugin\Logger\LoggingHelperTrait;
 use Webgriffe\SyliusPausePayPlugin\Mapper\OrderMapperInterface;
 use Webgriffe\SyliusPausePayPlugin\Payum\PausePayApi;
 use Webgriffe\SyliusPausePayPlugin\Repository\PaymentOrderRepositoryInterface;
@@ -35,7 +36,7 @@
  */
 final class CaptureAction implements ActionInterface, GatewayAwareInterface, GenericTokenFactoryAwareInterface, ApiAwareInterface
 {
-    use GatewayAwareTrait, GenericTokenFactoryAwareTrait, ApiAwareTrait;
+    use GatewayAwareTrait, GenericTokenFactoryAwareTrait, ApiAwareTrait, LoggingHelperTrait;
 
     public function __construct(
         private RouterInterface $router,
@@ -55,42 +56,16 @@ public function execute($request): void
     {
         RequestNotSupportedException::assertSupports($this, $request);
         Assert::isInstanceOf($request, Capture::class);
-
-        /** @var SyliusPaymentInterface $payment */
         $payment = $request->getModel();
-
-        $this->logInfo($payment, 'Start capture action', );
-
+        Assert::isInstanceOf($payment, SyliusPaymentInterface::class);
         $captureToken = $request->getToken();
         Assert::isInstanceOf($captureToken, TokenInterface::class);
 
+        $this->logInfo($payment, 'Start capture action');
+
         $paymentDetails = $payment->getDetails();
         if ($paymentDetails !== []) {
-            if (!PaymentDetailsHelper::areValid($paymentDetails)) {
-                $this->logger->error('Payment details are already populated with others data. Maybe this payment should be marked as error');
-                $payment->setDetails(PaymentDetailsHelper::addPaymentStatus(
-                    $paymentDetails,
-                    PaymentState::CANCELLED,
-                ));
-
-                return;
-            }
-
-            $this->logInfo(
-                $payment,
-                'PausePay payment details are already valued, so no need to continue here.' .
-                ' Redirecting the user to the Sylius PausePay Payments waiting page.',
-            );
-
-            $order = $payment->getOrder();
-            Assert::isInstanceOf($order, OrderInterface::class);
-
-            throw new HttpRedirect(
-                $this->router->generate('webgriffe_sylius_pausepay_plugin_payment_process', [
-                    'payumToken' => $captureToken->getHash(),
-                    '_locale' => $order->getLocaleCode(),
-                ]),
-            );
+            $this->redirectToPaymentProcessPage($payment, $captureToken, $paymentDetails);
         }
 
         $cancelToken = $this->createCancelToken($captureToken);
@@ -111,7 +86,7 @@ public function execute($request): void
         );
 
         $this->createNotifyTokenAndPersistAssociationWithPausePayPayment($payment, $captureToken, $createOrderResult);
-        $payment->setDetails(PaymentDetailsHelper::createFromContractCreateResult($createOrderResult));
+        $payment->setDetails(PaymentDetailsHelper::createFromCreateOrderResult($createOrderResult));
 
         $redirectUrl = $createOrderResult->getRedirectUrl();
         $this->logInfo($payment, sprintf('Redirecting the user to the PausePay redirect URL "%s".', $redirectUrl));
@@ -126,11 +101,6 @@ public function supports($request): bool
             $request->getModel() instanceof SyliusPaymentInterface;
     }
 
-    private function logInfo(SyliusPaymentInterface $payment, string $message, array $context = []): void
-    {
-        $this->logger->info(sprintf('[Payment #%s]: %s.', (string) $payment->getId(), $message, ), $context);
-    }
-
     private function createNotifyTokenAndPersistAssociationWithPausePayPayment(
         SyliusPaymentInterface $payment,
         TokenInterface $captureToken,
@@ -155,4 +125,34 @@ private function createCancelToken(TokenInterface $captureToken): TokenInterface
             $captureToken->getAfterUrl(),
         );
     }
+
+    private function redirectToPaymentProcessPage(
+        SyliusPaymentInterface $payment,
+        TokenInterface $captureToken,
+        array $paymentDetails,
+    ): void {
+        if (!PaymentDetailsHelper::areValid($paymentDetails)) {
+            // todo: is it ok to cancel the payment here?
+            $this->logError($payment, 'Payment details are already populated with others data. Cancel the payment.');
+            $payment->setDetails(PaymentDetailsHelper::addPaymentStatus($paymentDetails, PaymentState::CANCELLED));
+
+            return;
+        }
+
+        $this->logInfo(
+            $payment,
+            'PausePay payment details are already valued, so no need to continue here.' .
+            ' Redirecting the user to the Sylius PausePay Payments waiting page.',
+        );
+
+        $order = $payment->getOrder();
+        Assert::isInstanceOf($order, OrderInterface::class);
+
+        throw new HttpRedirect(
+            $this->router->generate('webgriffe_sylius_pausepay_plugin_payment_process', [
+                'payumToken' => $captureToken->getHash(),
+                '_locale' => $order->getLocaleCode(),
+            ]),
+        );
+    }
 }