MAGE-1205: handle tax config

Author: damcou

Service/Insights/EventProcessor.php

@@ -11,13 +11,15 @@
 use Magento\Sales\Model\Order;
 use Magento\Sales\Model\Order\Item as OrderItem;
 use Magento\Store\Model\StoreManagerInterface;
+use Magento\Tax\Model\Config as TaxConfig;
 
 class EventProcessor implements EventProcessorInterface
 {
     /** @var string  */
     protected const NO_QUERY_ID_KEY = '__NO_QUERY_ID__';
 
     public function __construct(
+        protected TaxConfig              $taxConfig,
         protected ?InsightsClient        $client = null,
         protected ?string                $userToken = null,
         protected ?string                $authenticatedUserToken = null,
@@ -268,7 +270,9 @@ protected function getQuoteItemDiscount(Item $item): float
      */
     protected function getOrderItemSalePrice(OrderItem $item): float
     {
-        return floatval($item->getPriceInclTax()) - $this->getOrderItemCartDiscount($item);
+        return $this->taxConfig->priceIncludesTax($this->storeManager->getStore()->getId()) ?
+            floatval($item->getPriceInclTax()) - $this->getOrderItemCartDiscount($item):
+            floatval($item->getPrice()) - $this->getOrderItemCartDiscount($item);
     }
 
     /**
@@ -286,7 +290,9 @@ protected function getOrderItemCartDiscount(OrderItem $item): float
      */
     protected function getOrderItemDiscount(OrderItem $item): float
     {
-        $itemDiscount = floatval($item->getOriginalPrice()) - floatval($item->getPriceInclTax());
+        $itemDiscount = $this->taxConfig->priceIncludesTax($this->storeManager->getStore()->getId()) ?
+            floatval($item->getOriginalPrice()) - floatval($item->getPriceInclTax()) :
+            floatval($item->getOriginalPrice()) - floatval($item->getPrice());
         return $itemDiscount + $this->getOrderItemCartDiscount($item);
     }
 
@@ -303,7 +309,7 @@ protected function getObjectDataForPurchase(array $items): array
         return array_map(function($item) {
             return [
                 'price'    => $this->getOrderItemSalePrice($item),
-                'discount' => $this->getOrderItemDiscount($item),
+                'discount' => max(0, $this->getOrderItemDiscount($item)),
                 'quantity' => intval($item->getQtyOrdered())
             ];
         }, $items);

Test/Unit/Service/EventProcessorTest.php

@@ -5,11 +5,14 @@
 use Algolia\AlgoliaSearch\Api\InsightsClient;
 use Algolia\AlgoliaSearch\Service\Insights\EventProcessor;
 use Magento\Sales\Model\Order\Item as OrderItem;
+use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
+use Magento\Tax\Model\Config as TaxConfig;
 use PHPUnit\Framework\TestCase;
 
 class EventProcessorTest extends TestCase
 {
+    protected ?TaxConfig $taxConfig;
     protected ?InsightsClient $client;
     protected ?string $userToken;
     protected ?string $authenticatedUserToken;
@@ -23,7 +26,13 @@ protected function setUp(): void
         $this->authenticatedUserToken = 'authenticated-foo';
         $this->storeManager = $this->createMock(StoreManagerInterface::class);
 
+        $store = $this->createMock(Store::class);
+        $store->method('getId')->willReturn(1);
+        $this->storeManager->method('getStore')->willReturn($store);
+        $this->taxConfig =  $this->createMock(TaxConfig::class);
+
         $this->eventProcessor = new EventProcessorTestable(
+            $this->taxConfig,
             $this->client,
             $this->userToken,
             $this->authenticatedUserToken,
@@ -34,8 +43,10 @@ protected function setUp(): void
     /**
      * @dataProvider orderItemsProvider
      */
-    public function testObjectDataForPurchase($orderItemsData, $expectedResult, $expectedTotalRevenue): void
+    public function testObjectDataForPurchase($priceIncludesTax, $orderItemsData, $expectedResult, $expectedTotalRevenue): void
     {
+        $this->taxConfig->method('priceIncludesTax')->willReturn($priceIncludesTax);
+
         $orderItems = [];
 
         foreach ($orderItemsData as $orderItemData) {
@@ -61,8 +72,10 @@ public function orderItemsProvider(): array
     {
         return [
             [ // One item
+                'priceIncludesTax' => true,
                 'orderItemsData' => [
                     [
+                        'getPrice' => 32.00,
                         'getPriceInclTax' => 32.00,
                         'getOriginalPrice' => 32.00,
                         'getDiscountAmount' => 0.00,
@@ -78,9 +91,31 @@ public function orderItemsProvider(): array
                 ],
                 'expectedTotalRevenue' => 32.00
             ],
+            [ // One item (tax excluded)
+                'priceIncludesTax' => false,
+                'orderItemsData' => [
+                    [
+                        'getPrice' => 25.00,
+                        'getPriceInclTax' => 32.00,
+                        'getOriginalPrice' => 25.00,
+                        'getDiscountAmount' => 0.00,
+                        'getQtyOrdered' => 1,
+                    ]
+                ],
+                'expectedResult' => [
+                    [
+                        'price' => 25.00,
+                        'discount' => 0.00,
+                        'quantity' => 1,
+                    ]
+                ],
+                'expectedTotalRevenue' => 25.00
+            ],
             [ // One item with discount
+                'priceIncludesTax' => true,
                 'orderItemsData' => [
                     [
+                        'getPrice' => 32.00,
                         'getPriceInclTax' => 32.00,
                         'getOriginalPrice' => 32.00,
                         'getDiscountAmount' => 7.00,
@@ -96,15 +131,38 @@ public function orderItemsProvider(): array
                 ],
                 'expectedTotalRevenue' => 25.00
             ],
+            [ // One item with discount (tax excluded)
+                'priceIncludesTax' => false,
+                'orderItemsData' => [
+                    [
+                        'getPrice' => 25.00,
+                        'getPriceInclTax' => 32.00,
+                        'getOriginalPrice' => 25.00,
+                        'getDiscountAmount' => 7.00,
+                        'getQtyOrdered' => 1,
+                    ]
+                ],
+                'expectedResult' => [
+                    [
+                        'price' => 18.00,
+                        'discount' => 7.00,
+                        'quantity' => 1,
+                    ]
+                ],
+                'expectedTotalRevenue' => 18.00
+            ],
             [ // Two items
+                'priceIncludesTax' => true,
                 'orderItemsData' => [
                     [
+                        'getPrice' => 32.00,
                         'getPriceInclTax' => 32.00,
                         'getOriginalPrice' => 32.00,
                         'getDiscountAmount' => 7.00,
                         'getQtyOrdered' => 1,
                     ],
                     [
+                        'getPrice' => 32.00,
                         'getPriceInclTax' => 32.00,
                         'getOriginalPrice' => 32.00,
                         'getDiscountAmount' => 0.00,