Merge pull request #1263 from BearGroup/release/5.18.1

Release/5.18.1

Author: shangamesh

Block/Config.php

@@ -75,7 +75,8 @@ public function getConfig()
             'is_lwa_enabled'            => $this->isLwaEnabled(),
             'is_guest_checkout_enabled' => $this->amazonConfig->isGuestCheckoutEnabled(),
             'has_restricted_products'   => $this->amazonHelper->hasRestrictedProducts(),
-            'is_multicurrency_enabled'  => $this->amazonConfig->multiCurrencyEnabled()
+            'is_multicurrency_enabled'  => $this->amazonConfig->multiCurrencyEnabled(),
+            'acceptance_mark'           => $this->amazonConfig->getAcceptanceMark()
         ];
 
         if ($subscriptionLabel = $this->subscriptionManager->getSubscriptionLabel()) {

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 5.18.1
+* Add new logos/acceptance marks at checkout
+* Improved clarity of order comments on cancelled orders
+* Fixed issue where order confirmation emails could be sent before payment processed successfully
+* Fixed issue with some inventory reservations not being adjusted after a cancelled order
+* Fixed issue where credit memos occasionally fail to process due to a missing parent transaction ID
+* Fixed APB issue where billing address information may fail to be set on virtual quotes
+* Fixed APB issue with family name/first name being passed incorrectly in JP region
+* Fixed dynamic property declaration in subscription classes (thanks, @navarr!)
+* Fixed failures and corrected logging in CleanUpIncompleteSessions cron job (thanks, @mohit-sharma-rp!)
+* Fixed various code smells
+
 ## 5.18.0
 * Added product page promo banner functionality and configuration
 

Command/Async/ProcessCommand.php

@@ -74,6 +74,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $this->asyncUpdater->processPending($item);
         }
 
-        return Command::SUCCESS;
+        $code = defined('Command::SUCCESS') ? Command::SUCCESS : 0;
+        return $code;
     }
 }

Command/Sales/AmazonChargePermissionCommand.php

@@ -123,9 +123,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
             }
 
             $verified = $referenceID == $orderId;
-            $output->writeln(var_export($verified));
+            if (!empty($verified) && $dump = var_export($verified)) {
+                $output->writeln($dump);
+            }
         }
 
-        return Command::SUCCESS;
+        $code = defined('Command::SUCCESS') ? Command::SUCCESS : 0;
+        return $code;
     }
 }

Controller/Checkout/Cancel.php

@@ -71,6 +71,8 @@ public function execute()
         $redirectParam = $this->request->getParam('redirect');
         $result = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
 
+        $this->messageManager->addErrorMessage(__('This transaction was cancelled. Please try again.'));
+
         // redirect to cart if no redirect param provided
         if (empty($redirectParam)) {
             return $result->setPath('checkout/cart');
@@ -92,8 +94,6 @@ public function execute()
                     $this->checkoutSessionManagement->cancelOrder($order, $quote);
 
                     $this->magentoCheckoutSession->restoreQuote();
-
-                    $this->messageManager->addErrorMessage(__('This transaction was cancelled. Please try again.'));
                 }
             }
         }

Cron/CleanUpIncompleteSessions.php

@@ -17,12 +17,11 @@
 namespace Amazon\Pay\Cron;
 
 use Amazon\Pay\Helper\Transaction as TransactionHelper;
+use Amazon\Pay\Logger\Logger;
 use Amazon\Pay\Model\Adapter\AmazonPayAdapter;
-use Amazon\Pay\Model\AsyncManagement\Charge;
 use Amazon\Pay\Model\CheckoutSessionManagement;
 use Magento\Sales\Api\Data\OrderInterface;
 use Magento\Sales\Api\OrderRepositoryInterface;
-use Psr\Log\LoggerInterface;
 use Amazon\Pay\Model\AsyncManagement\Charge as AsyncCharge;
 
 class CleanUpIncompleteSessions
@@ -39,7 +38,7 @@ class CleanUpIncompleteSessions
     protected $transactionHelper;
 
     /**
-     * @var LoggerInterface
+     * @var Logger
      */
     protected $logger;
 
@@ -65,15 +64,15 @@ class CleanUpIncompleteSessions
 
     /**
      * @param TransactionHelper $transactionHelper
-     * @param LoggerInterface $logger
+     * @param Logger $logger
      * @param AmazonPayAdapter $amazonPayAdapter
      * @param CheckoutSessionManagement $checkoutSessionManagement
      * @param OrderRepositoryInterface $orderRepository
      * @param AsyncCharge $asyncCharge
      */
     public function __construct(
         TransactionHelper $transactionHelper,
-        LoggerInterface $logger,
+        Logger $logger,
         AmazonPayAdapter $amazonPayAdapter,
         CheckoutSessionManagement $checkoutSessionManagement,
         OrderRepositoryInterface $orderRepository,
@@ -114,31 +113,31 @@ protected function processTransaction(array $transactionData)
         $checkoutSessionId = $transactionData['checkout_session_id'];
         $orderId = $transactionData['order_id'];
 
-        $this->logger->info(self::LOG_PREFIX . 'Cleaning up checkout session id: ' . $checkoutSessionId);
+        $this->logger->debug(self::LOG_PREFIX . 'Cleaning up checkout session id: ' . $checkoutSessionId);
 
         try {
-
             // Check current state of Amazon checkout session
-            $amazonSession = $this->amazonPayAdapter->getCheckoutSession(null, $checkoutSessionId);
+            $amazonSession = $this->amazonPayAdapter->getCheckoutSession($transactionData['store_id'], $checkoutSessionId);
             $state = $amazonSession['statusDetails']['state'] ?? false;
             switch ($state) {
                 case self::SESSION_STATUS_STATE_CANCELED:
                     $logMessage = 'Checkout session Canceled, cancelling order and closing transaction: ';
                     $logMessage .= $checkoutSessionId;
                     $this->logger->info(self::LOG_PREFIX . $logMessage);
-                    $this->cancelOrder($orderId);
+                    $cancelledMessage = $this->checkoutSessionManagement->getCanceledMessage($amazonSession);
+                    $this->cancelOrder($orderId, $cancelledMessage);
                     $this->transactionHelper->closeTransaction($transactionData['transaction_id']);
                     break;
                 case self::SESSION_STATUS_STATE_OPEN:
                     $logMessage = 'Checkout session Open, completing: ';
                     $logMessage .= $checkoutSessionId;
-                    $this->logger->info(self::LOG_PREFIX . $logMessage);
+                    $this->logger->debug(self::LOG_PREFIX . $logMessage);
                     $this->checkoutSessionManagement->completeCheckoutSession($checkoutSessionId, null, $orderId);
                     break;
                 case self::SESSION_STATUS_STATE_COMPLETED:
                     $logMessage = 'Checkout session Completed, nothing more needed: ';
                     $logMessage .= $checkoutSessionId;
-                    $this->logger->info(self::LOG_PREFIX . $logMessage);
+                    $this->logger->debug(self::LOG_PREFIX . $logMessage);
                     break;
             }
         } catch (\Exception $e) {
@@ -153,12 +152,12 @@ protected function processTransaction(array $transactionData)
      * @param int $orderId
      * @return void
      */
-    protected function cancelOrder($orderId)
+    protected function cancelOrder($orderId, $reasonMessage = '')
     {
         $order = $this->loadOrder($orderId);
 
         if ($order) {
-            $this->checkoutSessionManagement->cancelOrder($order);
+            $this->checkoutSessionManagement->cancelOrder($order, null, $reasonMessage);
         } else {
             $this->logger->error(self::LOG_PREFIX . 'Order not found for ID: ' . $orderId);
         }

Gateway/Request/SettlementRequestBuilder.php

@@ -104,6 +104,27 @@ protected function getHeaders($payment)
         return $result;
     }
 
+    /**
+     * Get charge ID from payment transaction information
+     *
+     * @param \Magento\Payment\Model\InfoInterface $payment
+     * @return string
+     */
+    protected function getChargeId($payment) {
+        $chargeId = '';
+
+        if ($parentTransactionId = $payment->getParentTransactionId()) {
+            $chargeId = rtrim($parentTransactionId, '-capture');
+            return $chargeId;
+        }
+
+        if (preg_match('/[A-Z]..-[0-9]*-[0-9]*-C[0-9]*/', $payment->getLastTransId(), $matches)) {
+            $chargeId = array_shift($matches);
+        }
+
+        return $chargeId;
+    }
+
     /**
      * @inheritdoc
      */
@@ -128,7 +149,7 @@ public function build(array $buildSubject)
 
         $data = [
             'store_id' => $storeId,
-            'charge_id' => rtrim($paymentDO->getPayment()->getParentTransactionId(), '-capture'),
+            'charge_id' => $this->getChargeId($payment),
             'amount' => $total,
             'currency_code' => $currencyCode,
         ];

Helper/Transaction.php

@@ -18,7 +18,6 @@
 
 use Amazon\Pay\Gateway\Config\Config;
 use Magento\Framework\App\ResourceConnection;
-use Magento\Sales\Api\Data\TransactionInterface;
 use Magento\Sales\Api\TransactionRepositoryInterface;
 use Magento\Sales\Model\Order;
 
@@ -28,6 +27,9 @@ class Transaction
     // Length of time in minutes we wait before cleaning up the transaction
     protected const MIN_ORDER_AGE_MINUTES = 30;
 
+    // Avoid deprecation warnings with prepared statement
+    protected const MAX_SQL_PARAM_LENGTH = 5;
+
     /**
      * @var int
      */
@@ -143,8 +145,15 @@ public function closeTransaction(mixed $transactionId)
      */
     private function getMaxOrderPlacedTime()
     {
-        // phpcs:ignore Magento2.SQL.RawQuery
-        $query = 'SELECT NOW() - INTERVAL ' . self::MIN_ORDER_AGE_MINUTES . ' MINUTE';
-        return $this->resourceConnection->getConnection()->fetchOne($query);
+        $query = $this->resourceConnection->getConnection()
+            ->select()
+            ->getAdapter()
+            ->prepare("SELECT NOW() - INTERVAL :minutes MINUTE");
+
+        $minutes = self::MIN_ORDER_AGE_MINUTES;
+        $query->bindParam(':minutes', $minutes, \PDO::PARAM_INT, self::MAX_SQL_PARAM_LENGTH);
+        $query->execute();
+
+        return $query->fetchColumn(0);
     }
 }

Model/Adapter/AmazonPayAdapter.php

@@ -160,7 +160,8 @@ protected function createPrice($amount, $currencyCode)
      */
     public function getCheckoutSession($storeId, $checkoutSessionId)
     {
-        $response = $this->clientFactory->create($storeId)->getCheckoutSession($checkoutSessionId);
+        $headers = $this->getPlatformHeaders();
+        $response = $this->clientFactory->create($storeId)->getCheckoutSession($checkoutSessionId, $headers);
 
         return $this->processResponse($response, __FUNCTION__);
     }
@@ -201,7 +202,8 @@ public function updateCheckoutSession($quote, $checkoutSessionId, $paymentIntent
             'platformId' => $this->amazonConfig->getPlatformId(),
         ];
 
-        $response = $this->clientFactory->create($storeId)->updateCheckoutSession($checkoutSessionId, $payload);
+        $headers = $this->getPlatformHeaders();
+        $response = $this->clientFactory->create($storeId)->updateCheckoutSession($checkoutSessionId, $payload, $headers);
 
         return $this->processResponse($response, __FUNCTION__);
     }
@@ -215,7 +217,8 @@ public function updateCheckoutSession($quote, $checkoutSessionId, $paymentIntent
      */
     public function getCharge($storeId, $chargeId)
     {
-        $response = $this->clientFactory->create($storeId)->getCharge($chargeId);
+        $headers = $this->getPlatformHeaders();
+        $response = $this->clientFactory->create($storeId)->getCharge($chargeId, $headers);
         return $this->processResponse($response, __FUNCTION__);
     }
 
@@ -232,7 +235,7 @@ public function getCharge($storeId, $chargeId)
      */
     public function createCharge($storeId, $chargePermId, $amt, $currency, $captureNow = false, $merchantRefId = null)
     {
-        $headers = $this->getIdempotencyHeader();
+        $headers = array_merge($this->getIdempotencyHeader(), $this->getPlatformHeaders());
 
         $payload = [
             'chargePermissionId' => $chargePermId,
@@ -261,7 +264,7 @@ public function createCharge($storeId, $chargePermId, $amt, $currency, $captureN
      */
     public function captureCharge($storeId, $chargeId, $amount, $currency, $headers = [])
     {
-        $headers = array_merge($headers, $this->getIdempotencyHeader());
+        $headers = array_merge($headers, $this->getIdempotencyHeader(), $this->getPlatformHeaders());
 
         $payload = [
             'captureAmount' => $this->createPrice($amount, $currency),
@@ -283,7 +286,7 @@ public function captureCharge($storeId, $chargeId, $amount, $currency, $headers
      */
     public function createRefund($storeId, $chargeId, $amount, $currency)
     {
-        $headers = $this->getIdempotencyHeader();
+        $headers = array_merge($this->getIdempotencyHeader(), $this->getPlatformHeaders());
 
         $payload = [
             'chargeId' => $chargeId,
@@ -304,7 +307,8 @@ public function createRefund($storeId, $chargeId, $amount, $currency)
      */
     public function getRefund($storeId, $refundId)
     {
-        $response = $this->clientFactory->create($storeId)->getRefund($refundId);
+        $headers = $this->getPlatformHeaders();
+        $response = $this->clientFactory->create($storeId)->getRefund($refundId, $headers);
         return $this->processResponse($response, __FUNCTION__);
     }
 
@@ -317,7 +321,8 @@ public function getRefund($storeId, $refundId)
      */
     public function getChargePermission(int $storeId, string $chargePermissionId)
     {
-        $response = $this->clientFactory->create($storeId)->getChargePermission($chargePermissionId);
+        $headers = $this->getPlatformHeaders();
+        $response = $this->clientFactory->create($storeId)->getChargePermission($chargePermissionId, $headers);
 
         return $this->processResponse($response, __FUNCTION__);
     }
@@ -355,7 +360,8 @@ public function updateChargePermission(int $storeId, string $chargePermissionId,
             $payload['recurringMetadata'] = $data['recurringMetadata'];
         }
 
-        $response = $this->clientFactory->create($storeId)->updateChargePermission($chargePermissionId, $payload);
+        $headers = $this->getPlatformHeaders();
+        $response = $this->clientFactory->create($storeId)->updateChargePermission($chargePermissionId, $payload, $headers);
 
         return $this->processResponse($response, __FUNCTION__);
     }
@@ -373,7 +379,8 @@ public function cancelCharge($storeId, $chargeId, $reason = 'ADMIN VOID')
             'cancellationReason' => $reason
         ];
 
-        $response = $this->clientFactory->create($storeId)->cancelCharge($chargeId, $payload);
+        $headers = $this->getPlatformHeaders();
+        $response = $this->clientFactory->create($storeId)->cancelCharge($chargeId, $payload, $headers);
 
         return $this->processResponse($response, __FUNCTION__);
     }
@@ -394,7 +401,8 @@ public function closeChargePermission($storeId, $chargePermissionId, $reason, $c
             'cancelPendingCharges' => $cancelPendingCharges,
         ];
 
-        $response = $this->clientFactory->create($storeId)->closeChargePermission($chargePermissionId, $payload);
+        $headers = $this->getPlatformHeaders();
+        $response = $this->clientFactory->create($storeId)->closeChargePermission($chargePermissionId, $payload, $headers);
 
         return $this->processResponse($response, __FUNCTION__);
     }
@@ -452,9 +460,11 @@ public function completeCheckoutSession($storeId, $sessionId, $amount, $currency
             'chargeAmount' => $this->createPrice($amount, $currencyCode),
         ];
 
+        $headers = $this->getPlatformHeaders();
         $rawResponse = $this->clientFactory->create($storeId)->completeCheckoutSession(
             $sessionId,
-            json_encode($payload)
+            json_encode($payload),
+            $headers
         );
         return $this->processResponse($rawResponse, __FUNCTION__);
     }
@@ -549,6 +559,20 @@ protected function getIdempotencyHeader()
         ];
     }
 
+    /**
+     * Create headers for platform and integration/module version
+     *
+     * @return array
+     */
+    protected function getPlatformHeaders()
+    {
+        return[
+            'x-amz-pay-platform-version'    => $this->productMetadata->getVersion(),
+            'x-amz-pay-integrator-version'  => $this->amazonHelper->getModuleVersion('Amazon_Pay'),
+            'x-amz-pay-integrator-id'       => $this->amazonConfig->getPlatformId()
+        ];
+    }
+
     /**
      * Generate login static signature for amazon.Pay.renderButton used by checkout.js
      *