PLGMAG2V2-522: Remove payment link from frontend order (#532)

* PLGMAG2V2-522: Remove payment link from frontend order

* PLGMAG2V2-522: Improve isAreaCodeAdminHtml method

* PLGMAG2V2-522: Add CHANGELOG entry

* PLGMAG2V2-522: PHPCS tuning

* Fix integration test

* Small code and doc improvements

* doc fix

* PLGMAG2V2-522: Ignore PHP mess detector warning

Co-authored-by: Vinod MultiSafepay <vinod.sowdagar@multisafepay.com>

Author: danielcivit

CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Fixed
+- Fixed an issue where the order state switch to 'Pending payment', after 'Completed' in rare cases 
+
+### Removed
+- Removed the payment link order comment for frontend orders, since it was causing an issue in rare cases because of saving the order
 
 ## [2.16.0] - 2022-06-29
 ### Added

Observer/OrderPlaceAfterObserver.php

@@ -82,6 +82,7 @@ public function execute(Observer $observer): void
             try {
                 $paymentUrl = $this->paymentLink->getPaymentLinkByOrder($order);
                 $this->paymentLink->addPaymentLink($order, $paymentUrl);
+                $this->logger->logInfoForOrder($orderId, 'Payment URL is: ' . $paymentUrl);
             } catch (InvalidApiKeyException $invalidApiKeyException) {
                 $this->logger->logInvalidApiKeyException($invalidApiKeyException);
                 $this->messageManager->addErrorMessage(__('The order can not be created, because the

Service/PaymentLink.php

@@ -17,19 +17,23 @@
 
 namespace MultiSafepay\ConnectCore\Service;
 
+use Exception;
 use Magento\Framework\App\Area;
 use Magento\Framework\App\State;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
-use Magento\Framework\Phrase;
 use Magento\Sales\Api\Data\OrderInterface;
 use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\Sales\Model\Order\Payment;
 use Magento\Sales\Model\Order\Payment\Transaction;
 use MultiSafepay\ConnectCore\Model\Api\Initializer\OrderRequestInitializer;
 use MultiSafepay\Exception\ApiException;
 use Psr\Http\Client\ClientExceptionInterface;
+use MultiSafepay\ConnectCore\Logger\Logger;
 
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class PaymentLink
 {
     public const MULTISAFEPAY_PAYMENT_LINK_PARAM_NAME = 'payment_link';
@@ -49,21 +53,29 @@ class PaymentLink
      */
     private $state;
 
+    /**
+     * @var Logger
+     */
+    private $logger;
+
     /**
      * PaymentLink constructor.
      *
      * @param OrderRequestInitializer $orderRequestInitializer
      * @param OrderRepositoryInterface $orderRepository
      * @param State $state
+     * @param Logger $logger
      */
     public function __construct(
         OrderRequestInitializer $orderRequestInitializer,
         OrderRepositoryInterface $orderRepository,
-        State $state
+        State $state,
+        Logger $logger
     ) {
         $this->orderRequestInitializer = $orderRequestInitializer;
         $this->orderRepository = $orderRepository;
         $this->state = $state;
+        $this->logger = $logger;
     }
 
     /**
@@ -85,10 +97,13 @@ public function getPaymentLinkByOrder(OrderInterface $order): string
     }
 
     /**
+     * Add the payment link to the order
+     *
      * @param OrderInterface $order
      * @param string $paymentLink
      * @return void
      * @throws LocalizedException
+     * @throws Exception
      */
     public function addPaymentLink(OrderInterface $order, string $paymentLink): void
     {
@@ -128,30 +143,35 @@ private function addToAdditionalInformation(Payment $payment, string $paymentUrl
     }
 
     /**
+     * Add the Payment link to the order comments if the order was placed in the admin backend
+     *
      * @param OrderInterface $order
      * @param string $paymentUrl
      * @return void
+     * @throws Exception
      */
     private function addPaymentLinkToOrderComments(OrderInterface $order, string $paymentUrl): void
     {
-        $order->addCommentToStatusHistory($this->getOrderCommentByAreaCode($paymentUrl));
-        $this->orderRepository->save($order);
+        if ($this->isAreaCodeAdminHtml()) {
+            $order->addCommentToStatusHistory(__('Payment link for this transaction: %1', $paymentUrl)->render());
+            $this->orderRepository->save($order);
+        }
     }
 
     /**
-     * @param string $paymentUrl
-     * @return Phrase
+     * Check if this is being executed from the backend
+     *
+     * @return bool
      */
-    private function getOrderCommentByAreaCode(string $paymentUrl): Phrase
+    private function isAreaCodeAdminHtml(): bool
     {
         try {
             $areaCode = $this->state->getAreaCode();
         } catch (LocalizedException $localizedException) {
-            $areaCode = Area::AREA_ADMINHTML;
+            $this->logger->logException($localizedException);
+            return false;
         }
 
-        return $areaCode === Area::AREA_ADMINHTML
-            ? __('Payment link for this transaction: %1', $paymentUrl)
-            : __('The user has been redirected to the following page: %1', $paymentUrl);
+        return $areaCode === Area::AREA_ADMINHTML;
     }
 }

Test/Integration/Service/PaymentLinkTest.php

@@ -38,7 +38,7 @@ class PaymentLinkTest extends AbstractPaymentTestCase
     protected function setUp(): void
     {
         $this->paymentLinkService = $this->getObjectManager()->create(PaymentLink::class);
-        $this->getObjectManager()->get(State::class)->setAreaCode(Area::AREA_FRONTEND);
+        $this->getObjectManager()->get(State::class)->setAreaCode(Area::AREA_ADMINHTML);
     }
 
     /**
@@ -74,7 +74,7 @@ public function testAddPaymentLink(): void
             $payment->getAdditionalInformation(PaymentLink::MULTISAFEPAY_PAYMENT_LINK_PARAM_NAME)
         );
         self::assertEquals(
-            __('The user has been redirected to the following page: %1', $fakePaymentLink)->render(),
+            __('Payment link for this transaction: %1', $fakePaymentLink)->render(),
             $order->getStatusHistoryCollection()->getFirstItem()->getComment()
         );
     }