PLGMAG2V2-575: Bring back the payment link in order history (#552)

* PLGMAG2V2-575: Bring back the payment link in order history

* Fix feedback

* Clarify changelog

* Remove unused private method

* Fix feedback

Author: vinodsowdagar

CHANGELOG.md

@@ -5,6 +5,8 @@ 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]
+### Added
+- Payment links will now always be added to the order comment history again. For backend orders it happens immediately, for frontend orders it now happens when the first MultiSafepay notification arrives.
 
 ## [2.18.1] - 2022-09-12
 ### Fixed

Service/OrderService.php

@@ -82,6 +82,11 @@ class OrderService
      */
     private $jsonHandler;
 
+    /**
+     * @var PaymentLink
+     */
+    private $paymentLink;
+
     /**
      * OrderService constructor.
      *
@@ -94,6 +99,7 @@ class OrderService
      * @param ProcessChangePaymentMethod $processChangePaymentMethod
      * @param ProcessOrderByTransactionStatus $processOrderByTransactionStatus
      * @param JsonHandler $jsonHandler
+     * @param PaymentLink $paymentLink
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -105,7 +111,8 @@ public function __construct(
         ProcessVaultInitialization $processVaultInitialization,
         ProcessChangePaymentMethod $processChangePaymentMethod,
         ProcessOrderByTransactionStatus $processOrderByTransactionStatus,
-        JsonHandler $jsonHandler
+        JsonHandler $jsonHandler,
+        PaymentLink $paymentLink
     ) {
         $this->orderRepository = $orderRepository;
         $this->emailSender = $emailSender;
@@ -116,6 +123,7 @@ public function __construct(
         $this->processChangePaymentMethod = $processChangePaymentMethod;
         $this->processOrderByTransactionStatus = $processOrderByTransactionStatus;
         $this->jsonHandler = $jsonHandler;
+        $this->paymentLink = $paymentLink;
     }
 
     /**
@@ -206,6 +214,12 @@ public function processOrderTransaction(OrderInterface $order, array $transactio
             );
         }
 
+        $this->paymentLink->addPaymentLinkToOrderComments(
+            $order,
+            $this->paymentLink->getPaymentLinkFromOrder($order) ?? 'not found',
+            true
+        );
+
         $this->orderRepository->save($order);
         $this->logger->logInfoForOrder(
             $orderId,

Service/PaymentLink.php

@@ -143,21 +143,88 @@ private function addToAdditionalInformation(Payment $payment, string $paymentUrl
     }
 
     /**
-     * Add the Payment link to the order comments if the order was placed in the admin backend
+     * Add the Payment link to the order comments
+     *
+     * Saving the order when the order is being placed on the frontend can cause issues with the initialized
+     * or completed notification, so we want to save the comments only in the notification process in those cases.
+     * For admin backend orders, a payment link should always be added immediately.
      *
      * @param OrderInterface $order
      * @param string $paymentUrl
+     * @param bool $isNotification
      * @return void
+     * @throws LocalizedException
      * @throws Exception
      */
-    private function addPaymentLinkToOrderComments(OrderInterface $order, string $paymentUrl): void
-    {
-        if ($this->isAreaCodeAdminHtml()) {
-            $order->addCommentToStatusHistory(__('Payment link for this transaction: %1', $paymentUrl)->render());
+    public function addPaymentLinkToOrderComments(
+        OrderInterface $order,
+        string $paymentUrl,
+        bool $isNotification = false
+    ): void {
+        $isAdmin = $this->isAreaCodeAdminHtml();
+
+        if (!$isNotification && !$isAdmin) {
+            return;
+        }
+
+        /** @var Payment $payment */
+        $payment = $order->getPayment();
+        $orderId = $order->getIncrementId();
+
+        if ($payment === null) {
+            $this->logger->logInfoForOrder($orderId, 'Payment object could not be found', Logger::DEBUG);
+
+            return;
+        }
+
+        if ($this->hasMultiSafepayPaymentLinkComment($payment->getAdditionalInformation())) {
+            $this->logger->logInfoForOrder(
+                $orderId,
+                'Payment link comment already added to the comment history, skipping',
+                Logger::DEBUG
+            );
+
+            return;
+        }
+
+        $order->addCommentToStatusHistory(__('Payment link for this transaction: %1', $paymentUrl)->render());
+
+        $this->logger->logInfoForOrder(
+            $orderId,
+            'Payment link comment added to the comment history',
+            Logger::DEBUG
+        );
+
+        $payment->setAdditionalInformation('has_multisafepay_paymentlink_comment', true);
+
+        if ($isAdmin) {
             $this->orderRepository->save($order);
         }
     }
 
+    /**
+     * Check if the order already has a payment link in the order history
+     *
+     * @param array $additionalInformation
+     * @return bool
+     */
+    private function hasMultiSafepayPaymentLinkComment(array $additionalInformation): bool
+    {
+        if (isset($additionalInformation['has_multisafepay_paymentlink_comment'])
+            && $additionalInformation['has_multisafepay_paymentlink_comment']
+        ) {
+            return true;
+        }
+
+        if (isset($additionalInformation[Transaction::RAW_DETAILS]['has_multisafepay_paymentlink_comment'])
+            && $additionalInformation[Transaction::RAW_DETAILS]['has_multisafepay_paymentlink_comment']
+        ) {
+            return true;
+        }
+
+        return false;
+    }
+
     /**
      * Check if this is being executed from the backend
      *