ACP2E-3491: Cart rule sku condition is failing for invoice.

bubasuma · bubasuma · commit 75cb08cd04e8 · 2024-12-04T19:24:19.000-06:00
diff --git a/app/code/Magento/SalesRule/Model/RulesApplier.php b/app/code/Magento/SalesRule/Model/RulesApplier.php
@@ -1,11 +1,13 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2014 Adobe
+ * All Rights Reserved.
  */
+
 namespace Magento\SalesRule\Model;
 
 use Magento\Framework\Event\ManagerInterface;
+use Magento\Framework\Pricing\PriceCurrencyInterface;
 use Magento\Quote\Model\Quote\Address;
 use Magento\Quote\Model\Quote\Item\AbstractItem;
 use Magento\SalesRule\Model\Data\RuleDiscount;
@@ -72,6 +74,11 @@ class RulesApplier
      */
     private $discountAggregator;
 
+    /**
+     * @var PriceCurrencyInterface
+     */
+    private $priceCurrency;
+
     /**
      * @param CalculatorFactory $calculatorFactory
      * @param ManagerInterface $eventManager
@@ -81,6 +88,7 @@ class RulesApplier
      * @param RuleDiscountInterfaceFactory|null $discountInterfaceFactory
      * @param DiscountDataInterfaceFactory|null $discountDataInterfaceFactory
      * @param SelectRuleCoupon|null $selectRuleCoupon
+     * @param PriceCurrencyInterface|null $priceCurrency
      */
     public function __construct(
         CalculatorFactory $calculatorFactory,
@@ -90,7 +98,8 @@ public function __construct(
         DataFactory $discountDataFactory = null,
         RuleDiscountInterfaceFactory $discountInterfaceFactory = null,
         DiscountDataInterfaceFactory $discountDataInterfaceFactory = null,
-        SelectRuleCoupon $selectRuleCoupon = null
+        SelectRuleCoupon $selectRuleCoupon = null,
+        ?PriceCurrencyInterface $priceCurrency = null
     ) {
         $this->calculatorFactory = $calculatorFactory;
         $this->validatorUtility = $utility;
@@ -104,6 +113,7 @@ public function __construct(
             ?: ObjectManager::getInstance()->get(DiscountDataInterfaceFactory::class);
         $this->selectRuleCoupon = $selectRuleCoupon
             ?: ObjectManager::getInstance()->get(SelectRuleCoupon::class);
+        $this->priceCurrency = $priceCurrency ?: ObjectManager::getInstance()->get(PriceCurrencyInterface::class);
     }
 
     /**
@@ -237,21 +247,28 @@ protected function applyRule($item, $rule, $address, array $couponCodes = [])
     {
         if ($item->getChildren() && $item->isChildrenCalculated()) {
             $cloneItem = clone $item;
-
-            $applyToChildren = false;
-            foreach ($item->getChildren() as $childItem) {
-                if ($rule->getActions()->validate($childItem)) {
-                    $discountData = $this->getDiscountData($childItem, $rule, $address, $couponCodes);
-                    $this->setDiscountData($discountData, $childItem);
-                    $applyToChildren = true;
-                }
-            }
             /**
-             * validate without children
+             * Validates item without children to check whether the rule can be applied to the item itself
+             * If the rule can be applied to the item, the discount is applied to the item itself and
+             * distributed among its children
              */
-            if (!$applyToChildren && $rule->getActions()->validate($cloneItem)) {
+            if ($rule->getActions()->validate($cloneItem)) {
+                // Aggregate discount data from children
+                $discountData = $this->getDiscountDataFromChildren($item);
+                $this->setDiscountData($discountData, $item);
+                // Calculate discount data based on parent item
                 $discountData = $this->getDiscountData($item, $rule, $address, $couponCodes);
+                $this->distributeDiscount($discountData, $item);
+                // reset discount data in parent item after distributing discount to children
+                $discountData = $this->discountFactory->create();
                 $this->setDiscountData($discountData, $item);
+            } else {
+                foreach ($item->getChildren() as $childItem) {
+                    if ($rule->getActions()->validate($childItem)) {
+                        $discountData = $this->getDiscountData($childItem, $rule, $address, $couponCodes);
+                        $this->setDiscountData($discountData, $childItem);
+                    }
+                }
             }
         } else {
             $discountData = $this->getDiscountData($item, $rule, $address, $couponCodes);
@@ -264,6 +281,63 @@ protected function applyRule($item, $rule, $address, array $couponCodes = [])
         return $this;
     }
 
+    /**
+     * Get discount data from children
+     *
+     * @param AbstractItem $item
+     * @return Data
+     */
+    private function getDiscountDataFromChildren(AbstractItem $item): Data
+    {
+        $discountData = $this->discountFactory->create();
+
+        foreach ($item->getChildren() as $child) {
+            $discountData->setAmount($discountData->getAmount() + $child->getDiscountAmount());
+            $discountData->setBaseAmount($discountData->getBaseAmount() + $child->getBaseDiscountAmount());
+            $discountData->setOriginalAmount($discountData->getOriginalAmount() + $child->getOriginalDiscountAmount());
+            $discountData->setBaseOriginalAmount(
+                $discountData->getBaseOriginalAmount() + $child->getBaseOriginalDiscountAmount()
+            );
+        }
+
+        return $discountData;
+    }
+
+    /**
+     * Distributes discount applied from parent item to its children items
+     *
+     * This method originates from \Magento\SalesRule\Model\Quote\Discount::distributeDiscount()
+     *
+     * @param Data $discountData
+     * @param AbstractItem $item
+     * @see \Magento\SalesRule\Model\Quote\Discount::distributeDiscount()
+     */
+    private function distributeDiscount(Data $discountData, AbstractItem $item): void
+    {
+        $data = [
+            'discount_amount' => $discountData->getAmount() - $item->getDiscountAmount(),
+            'base_discount_amount' => $discountData->getBaseAmount() - $item->getBaseDiscountAmount(),
+        ];
+
+        $parentBaseRowTotal = max(0, $item->getBaseRowTotal() - $item->getBaseDiscountAmount());
+        $keys = array_keys($data);
+        $roundingDelta = [];
+        foreach ($keys as $key) {
+            //Initialize the rounding delta to a tiny number to avoid floating point precision problem
+            $roundingDelta[$key] = 0.0000001;
+        }
+        foreach ($item->getChildren() as $child) {
+            $childBaseRowTotalWithDiscount = max(0, $child->getBaseRowTotal() - $child->getBaseDiscountAmount());
+            $ratio = min(1, $parentBaseRowTotal != 0 ? $childBaseRowTotalWithDiscount / $parentBaseRowTotal : 0);
+            foreach ($keys as $key) {
+                $value = $data[$key] * $ratio;
+                $roundedValue = $this->priceCurrency->round($value + $roundingDelta[$key]);
+                $roundingDelta[$key] += $value - $roundedValue;
+                $child->setData($key, $child->getData($key) + $roundedValue);
+            }
+        }
+    }
+
     /**
      * Get discount Data
      *
diff --git a/dev/tests/integration/testsuite/Magento/Sales/Model/Service/InvoiceServiceTest.php b/dev/tests/integration/testsuite/Magento/Sales/Model/Service/InvoiceServiceTest.php
@@ -1,18 +1,39 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2019 Adobe
+ * All Rights Reserved.
  */
+
 declare(strict_types=1);
 
 namespace Magento\Sales\Model\Service;
 
+use Magento\Bundle\Test\Fixture\AddProductToCart as AddBundleProductToCartFixture;
+use Magento\Bundle\Test\Fixture\Option as BundleOptionFixture;
+use Magento\Bundle\Test\Fixture\Product as BundleProductFixture;
+use Magento\Catalog\Test\Fixture\Product as ProductFixture;
+use Magento\Checkout\Test\Fixture\PlaceOrder as PlaceOrderFixture;
+use Magento\Checkout\Test\Fixture\SetBillingAddress as SetBillingAddressFixture;
+use Magento\Checkout\Test\Fixture\SetDeliveryMethod as SetDeliveryMethodFixture;
+use Magento\Checkout\Test\Fixture\SetGuestEmail as SetGuestEmailFixture;
+use Magento\Checkout\Test\Fixture\SetPaymentMethod as SetPaymentMethodFixture;
+use Magento\Checkout\Test\Fixture\SetShippingAddress as SetShippingAddressFixture;
+use Magento\Quote\Test\Fixture\GuestCart as GuestCartFixture;
 use Magento\Sales\Api\Data\OrderInterface;
+use Magento\Sales\Api\OrderRepositoryInterface;
 use Magento\Sales\Model\Order;
+use Magento\SalesRule\Model\Rule;
+use Magento\SalesRule\Test\Fixture\ProductCondition as ProductConditionFixture;
+use Magento\SalesRule\Test\Fixture\Rule as RuleFixture;
+use Magento\TestFramework\Fixture\DataFixture;
+use Magento\TestFramework\Fixture\DataFixtureStorage;
+use Magento\TestFramework\Fixture\DataFixtureStorageManager;
 use Magento\TestFramework\Helper\Bootstrap;
 
 /**
  * Tests \Magento\Sales\Model\Service\InvoiceService
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class InvoiceServiceTest extends \PHPUnit\Framework\TestCase
 {
@@ -21,12 +42,24 @@ class InvoiceServiceTest extends \PHPUnit\Framework\TestCase
      */
     private $invoiceService;
 
+    /**
+     * @var OrderRepositoryInterface|null
+     */
+    private ?OrderRepositoryInterface $orderRepository;
+
+    /**
+     * @var DataFixtureStorage|null
+     */
+    private ?DataFixtureStorage $fixtures;
+
     /**
      * @inheritdoc
      */
     protected function setUp(): void
     {
         $this->invoiceService = Bootstrap::getObjectManager()->create(InvoiceService::class);
+        $this->orderRepository = Bootstrap::getObjectManager()->create(OrderRepositoryInterface::class);
+        $this->fixtures = DataFixtureStorageManager::getStorage();
     }
 
     /**
@@ -40,6 +73,7 @@ public function testPrepareInvoiceConfigurableProduct(int $invoiceQty): void
         /** @var OrderInterface $order */
         $order = Bootstrap::getObjectManager()->create(Order::class)->load('100000001', 'increment_id');
         $orderItems = $order->getItems();
+        $parentItemId = 0;
         foreach ($orderItems as $orderItem) {
             if ($orderItem->getParentItemId()) {
                 $parentItemId = $orderItem->getParentItemId();
@@ -164,6 +198,55 @@ public static function bundleProductQtyOrderedDataProvider(): array
         ];
     }
 
+    #[
+        DataFixture(ProductFixture::class, ['price' => 10], as: 'p1'),
+        DataFixture(ProductFixture::class, ['price' => 20], as: 'p2'),
+        DataFixture(BundleOptionFixture::class, ['product_links' => ['$p1$']], 'opt1'),
+        DataFixture(BundleOptionFixture::class, ['product_links' => ['$p2$']], 'opt2'),
+        DataFixture(BundleProductFixture::class, ['_options' => ['$opt1$', '$opt2$']], 'bp1'),
+        DataFixture(ProductConditionFixture::class, ['attribute' => 'sku', 'value' => '$bp1.sku$'], 'cond1'),
+        DataFixture(
+            RuleFixture::class,
+            [
+                'simple_action' => Rule::BY_PERCENT_ACTION,
+                'discount_amount' => 20,
+                'actions' => ['$cond1$'],
+                'simple_free_shipping' => \Magento\OfflineShipping\Model\SalesRule\Rule::FREE_SHIPPING_ITEM
+            ]
+        ),
+        DataFixture(GuestCartFixture::class, as: 'cart'),
+        DataFixture(
+            AddBundleProductToCartFixture::class,
+            [
+                'cart_id' => '$cart.id$',
+                'product_id' => '$bp1.id$',
+                'selections' => [['$p1.id$'], ['$p2.id$']],
+                'qty' => 1
+            ],
+        ),
+        DataFixture(SetBillingAddressFixture::class, ['cart_id' => '$cart.id$']),
+        DataFixture(SetShippingAddressFixture::class, ['cart_id' => '$cart.id$']),
+        DataFixture(SetGuestEmailFixture::class, ['cart_id' => '$cart.id$']),
+        DataFixture(SetDeliveryMethodFixture::class, ['cart_id' => '$cart.id$']),
+        DataFixture(SetPaymentMethodFixture::class, ['cart_id' => '$cart.id$']),
+        DataFixture(PlaceOrderFixture::class, ['cart_id' => '$cart.id$'], 'order'),
+    ]
+    public function testPrepareInvoiceBundleProductDynamicPriceWithDiscount(): void
+    {
+        $order = $this->fixtures->get('order');
+        $order = $this->orderRepository->get($order->getId());
+        $qtyToInvoice = [];
+        foreach ($order->getAllItems() as $item) {
+            if (!$item->getParentItemId()) {
+                $qtyToInvoice[$item->getId()] = 1;
+            }
+        }
+        $this->assertNotEmpty($qtyToInvoice);
+        $invoice = $this->invoiceService->prepareInvoice($order, $qtyToInvoice);
+        $this->assertEquals(-6, $invoice->getBaseDiscountAmount());
+        $this->assertEquals(24, $invoice->getBaseGrandTotal());
+    }
+
     /**
      * Associate product qty to invoice to order item id.
      *
diff --git a/dev/tests/integration/testsuite/Magento/SalesRule/Model/Quote/DiscountTest.php b/dev/tests/integration/testsuite/Magento/SalesRule/Model/Quote/DiscountTest.php
