Double store credit refunds when a error is received before redirecting to external psp.

Preconditions and environment

Adobe Commerce: 2.4.6-p4 php 8.1

Steps to reproduce

First create a customer where you add store credit (magento_customerbalance).
Than add a product which you can pay of partially or full with store credit.
Than it could trigger a error from an external psp.
In magento the order has been processed even though this error was given back. I get twice as much store credit back.

Expected result

I get my store credit back, but not doubled.

Actual result

I get two times as much store credit back.

Additional information

Additional info If this function (\Magento\Quote\Model\QuoteManagement::submitQuote) receives an error of an external psp after the order has been created Magento will rollbackAddresses using this function: \Magento\Quote\Model\QuoteManagement::rollbackAddresses.

This than triggers the dispatch the event sales_model_service_quote_submit_failure which in turn invokes this observer: \Magento\CustomerBalance\Observer\RevertStoreCreditObserver::execute

Afterwards on the same event the external psp has this event:

    <event name="sales_model_service_quote_submit_failure">
        <observer name="external_psp_failed_quote_order" instance="Example\Magento2\Observer\HandleFailedQuoteOrder"/>
    </event>

Which triggers a cancellation of the order which triggers this function (\Magento\Sales\Model\Order::cancel) Which adds the following event order_cancel_after which triggers the same observer again: \Magento\CustomerBalance\Observer\RevertStoreCreditObserver::execute

In my opinion \Magento\CustomerBalance\Observer\RevertStoreCreditForOrder should check if the customer has already received a refund of store balance and if this has already been triggered it should skip saving an additional time. This is prone to add issues since it does not check if it has already refunded the store credit on quote level or order level.

Workaround fix/ patch

# Prevent double refund of store credit.
#
# Github link: https://github.com/magento/magento2/issues/38815
# Github link: https://github.com/buckaroo-it/Magento2/issues/989

diff --git a/Observer/RevertStoreCreditForOrder.php b/Observer/RevertStoreCreditForOrder.php
--- a/Observer/RevertStoreCreditForOrder.php
+++ b/Observer/RevertStoreCreditForOrder.php
@@ -5,6 +5,11 @@
  */
 namespace Magento\CustomerBalance\Observer;

+use Magento\CustomerBalance\Model\Balance\History;
+use Magento\CustomerBalance\Model\Balance\History as BalanceHistory;
+use Magento\CustomerBalance\Model\ResourceModel\Balance\History\Collection as HistoryCol;
+use Magento\CustomerBalance\Model\ResourceModel\Balance\History\CollectionFactory as HistoryColFactory;
+
 /**
  * Customer balance observer
  */
@@ -28,7 +33,8 @@
      */
     public function __construct(
         \Magento\CustomerBalance\Model\BalanceFactory $balanceFactory,
-        \Magento\Store\Model\StoreManagerInterface $storeManager
+        \Magento\Store\Model\StoreManagerInterface $storeManager,
+        private readonly HistoryColFactory $historyColFactory,
     ) {
         $this->_balanceFactory = $balanceFactory;
         $this->_storeManager = $storeManager;
@@ -45,6 +51,32 @@
         if (!$order->getCustomerId() || !$order->getBaseCustomerBalanceAmount()) {
             return $this;
         }
+
+        if (!$order->getBaseCustomerBalanceInvoiced()) {
+            /** @var HistoryCol $historyCol */
+            $historyCol = $this->historyColFactory->create();
+            /** @var BalanceHistory $history */
+            $history = $historyCol->addFieldToFilter(
+                'customer_id',
+                ['eq' => $order->getCustomerId()]
+            )->addFieldToFilter(
+                'website_id',
+                ['eq' => $this->_storeManager->getStore($order->getStoreId())->getWebsiteId()]
+            )->addFieldToFilter(
+                'balance_delta',
+                ['eq' => $order->getBaseCustomerBalanceAmount()]
+            )->addFieldToFilter(
+                'action',
+                ['eq' => History::ACTION_REVERTED]
+            )->addFieldToFilter(
+                'additional_info',
+                ['like' => '%' . $order->getIncrementId() . '%']
+            )->getFirstItem();
+
+            if ($history->getId()) {
+                return $this;
+            }
+        }

         $customerAmountDelta = $order->getBaseCustomerBalanceAmount() - $order->getBaseCustomerBalanceInvoiced();

Release note

No response

Triage and priority

[ ] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
[x] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
[X] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
[ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
[ ] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

Hi @leonhelmus. Thank you for your report. To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release
For more details, review the Magento Contributor Assistant documentation.
Add a comment to assign the issue: @magento I am working on this
To learn more about issue processing workflow, refer to the Code Contributions.

Join Magento Community Engineering Slack and ask your questions in #github channel. :warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting. :clock10: You can find the schedule on the Magento Community Calendar page. :telephone_receiver: The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

Hi @engcom-Dash. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
1. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
1. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
1. Verify that the issue is reproducible on 2.4-develop branch
  Details
  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

Join Magento Community Engineering Slack and ask your questions in #github channel.

Hi @leonhelmus

Thanks for reporting and collaboration.

Verified the issue on Magento 2.4.7-p1 but the issue is not reproducible.

Steps to reproduce First create a customer where you add store credit (magento_customerbalance). Than add a product which you can pay of partially or full with store credit. Than it could trigger a error from an external psp. In magento the order has been processed even though this error was given back. I get twice as much store credit back.

I am getting the store credit back, but not doubled.

Please refer the attached screenshots.

Customer store credit in admin

Placing the order with partial store credit and partially with Paypal and the error is triggered

Refund received

Hi @leonhelmus

We have noticed that this issue has not been updated for a long time. Hence we assume this issue is fixed, so we are closing it. Please feel free to raise a fresh ticket or reopen this ticket if you need more assistance.

Thanks.

magento / magento2