MC-38031: Checkout with Multiple Addresses - Review Page does not follow the configured total sort order

Author: tsviklinskyi

app/code/Magento/Multishipping/Block/Checkout/Overview.php

@@ -10,6 +10,8 @@
 use Magento\Quote\Model\Quote\Address;
 use Magento\Checkout\Helper\Data as CheckoutHelper;
 use Magento\Framework\App\ObjectManager;
+use Magento\Quote\Model\Quote\Address\Total\Collector;
+use Magento\Store\Model\ScopeInterface;
 
 /**
  * Multishipping checkout overview information
@@ -430,7 +432,7 @@ public function getBillingAddressTotals()
     public function renderTotals($totals, $colspan = null)
     {
         //check if the shipment is multi shipment
-        $totals = $this->getMultishippingTotals($totals);
+        $totals = $this->sortTotals($this->getMultishippingTotals($totals));
 
         if ($colspan === null) {
             $colspan = 3;
@@ -481,4 +483,37 @@ protected function _getRowItemRenderer($type)
         }
         return $renderer;
     }
+
+    /**
+     * Sort total information based on configuration settings.
+     *
+     * @param array $totals
+     * @return array
+     */
+    private function sortTotals($totals): array
+    {
+        $sortedTotals = [];
+        $sorts = $this->_scopeConfig->getValue(
+            Collector::XML_PATH_SALES_TOTALS_SORT,
+            ScopeInterface::SCOPE_STORES
+        );
+
+        foreach ($sorts as $code => $sortOrder) {
+            $sorted[$sortOrder] = $code;
+        }
+        ksort($sorted);
+
+        foreach ($sorted as $code) {
+            if (isset($totals[$code])) {
+                $sortedTotals[$code] = $totals[$code];
+            }
+        }
+
+        $notSorted = array_diff(array_keys($totals), array_keys($sortedTotals));
+        foreach ($notSorted as $code) {
+            $sortedTotals[$code] = $totals[$code];
+        }
+
+        return $sortedTotals;
+    }
 }

app/code/Magento/Multishipping/Test/Unit/Block/Checkout/OverviewTest.php

@@ -8,6 +8,7 @@
 
 namespace Magento\Multishipping\Test\Unit\Block\Checkout;
 
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\Framework\UrlInterface;
@@ -67,6 +68,11 @@ class OverviewTest extends TestCase
      */
     private $urlBuilderMock;
 
+    /**
+     * @var MockObject
+     */
+    private $scopeConfigMock;
+
     protected function setUp(): void
     {
         $objectManager = new ObjectManager($this);
@@ -85,14 +91,16 @@ protected function setUp(): void
             $this->createMock(Multishipping::class);
         $this->quoteMock = $this->createMock(Quote::class);
         $this->urlBuilderMock = $this->getMockForAbstractClass(UrlInterface::class);
+        $this->scopeConfigMock = $this->getMockForAbstractClass(ScopeConfigInterface::class);
         $this->model = $objectManager->getObject(
             Overview::class,
             [
                 'priceCurrency' => $this->priceCurrencyMock,
                 'totalsCollector' => $this->totalsCollectorMock,
                 'totalsReader' => $this->totalsReaderMock,
                 'multishipping' => $this->checkoutMock,
-                'urlBuilder' => $this->urlBuilderMock
+                'urlBuilder' => $this->urlBuilderMock,
+                '_scopeConfig' => $this->scopeConfigMock
             ]
         );
     }
@@ -187,4 +195,44 @@ public function testGetVirtualProductEditUrl()
         $this->urlBuilderMock->expects($this->once())->method('getUrl')->with('checkout/cart', [])->willReturn($url);
         $this->assertEquals($url, $this->model->getVirtualProductEditUrl());
     }
+
+    /**
+     * Test sort total information
+     *
+     * @return void
+     */
+    public function testSortCollectors(): void
+    {
+        $sorts = [
+            'discount' => 40,
+            'subtotal' => 10,
+            'tax' => 20,
+            'shipping' => 30,
+        ];
+
+        $this->scopeConfigMock->method('getValue')
+            ->with('sales/totals_sort', 'stores')
+            ->willReturn($sorts);
+
+        $totalsNotSorted = [
+            'subtotal' => [],
+            'shipping' => [],
+            'tax' => [],
+        ];
+
+        $totalsExpected = [
+            'subtotal' => [],
+            'tax' => [],
+            'shipping' => [],
+        ];
+
+        $method = new \ReflectionMethod($this->model, 'sortTotals');
+        $method->setAccessible(true);
+        $result = $method->invoke($this->model, $totalsNotSorted);
+
+        $this->assertEquals(
+            $totalsExpected,
+            $result
+        );
+    }
 }