Save reset stock in order line item custom field with refund

src/Components/RefundManager/RefundData/OrderItem/AbstractItem.php

@@ -17,9 +17,10 @@ abstract class AbstractItem
      * @param float $promotionDiscount
      * @param int $promotionAffectedQty
      * @param int $refundedQty
+     * @param int $resetStockQuantity
      * @return array<mixed>
      */
-    protected function buildArray(string $id, string $label, string $referenceNumber, bool $isPromotion, bool $isDelivery, float $unitPrice, int $quantity, float $totalPrice, float $promotionDiscount, int $promotionAffectedQty, int $refundedQty): array
+    protected function buildArray(string $id, string $label, string $referenceNumber, bool $isPromotion, bool $isDelivery, float $unitPrice, int $quantity, float $totalPrice, float $promotionDiscount, int $promotionAffectedQty, int $refundedQty, int $resetStockQuantity): array
     {
         return [
             'refunded' => $refundedQty,
@@ -37,6 +38,7 @@ protected function buildArray(string $id, string $label, string $referenceNumber
                 ],
                 'isPromotion' => $isPromotion,
                 'isDelivery' => $isDelivery,
+                'resetStockQuantity' => $resetStockQuantity
             ],
         ];
     }

src/Components/RefundManager/RefundData/OrderItem/DeliveryItem.php

@@ -51,7 +51,8 @@ public function toArray(): array
             $this->delivery->getShippingCosts()->getTotalPrice(),
             0,
             0,
-            $this->alreadyRefundedQty
+            $this->alreadyRefundedQty,
+            0
         );
     }
 

src/Components/RefundManager/RefundData/OrderItem/ProductItem.php

@@ -2,6 +2,7 @@
 
 namespace Kiener\MolliePayments\Components\RefundManager\RefundData\OrderItem;
 
+use Kiener\MolliePayments\Struct\OrderLineItemEntity\OrderLineItemEntityAttributes;
 use Shopware\Core\Checkout\Order\Aggregate\OrderLineItem\OrderLineItemEntity;
 
 class ProductItem extends AbstractItem
@@ -68,6 +69,9 @@ private function extractPromotionDiscounts(array $promotionCompositions)
      */
     public function toArray(): array
     {
+        $lineItemAttributes = new OrderLineItemEntityAttributes($this->lineItem);
+        $resetStockQuantity = $lineItemAttributes->getResetStockQuantity();
+
         return $this->buildArray(
             $this->lineItem->getId(),
             $this->lineItem->getLabel(),
@@ -79,7 +83,8 @@ public function toArray(): array
             $this->lineItem->getTotalPrice(),
             $this->promotionDiscount,
             $this->promotionAffectedQuantity,
-            $this->alreadyRefundedQty
+            $this->alreadyRefundedQty,
+            $resetStockQuantity
         );
     }
 

src/Components/RefundManager/RefundData/OrderItem/PromotionItem.php

@@ -44,7 +44,8 @@ public function toArray(): array
             $this->lineItem->getTotalPrice(),
             0,
             0,
-            $this->alreadyRefundedQty
+            $this->alreadyRefundedQty,
+            0
         );
     }
 

src/Components/RefundManager/RefundManager.php

@@ -30,6 +30,7 @@
 use Shopware\Core\Checkout\Order\Aggregate\OrderLineItem\OrderLineItemEntity;
 use Shopware\Core\Checkout\Order\OrderEntity;
 use Shopware\Core\Framework\Context;
+use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
 
 class RefundManager implements RefundManagerInterface
 {
@@ -74,6 +75,11 @@ class RefundManager implements RefundManagerInterface
      */
     private $logger;
 
+    /**
+     * @var EntityRepositoryInterface
+     */
+    private $orderLineItemRepository;
+
 
     /**
      * @param RefundDataBuilder $refundDataBuilder
@@ -84,20 +90,20 @@ class RefundManager implements RefundManagerInterface
      * @param FlowBuilderEventFactory $flowBuilderEventFactory
      * @param StockManagerInterface $stockUpdater
      * @param LoggerInterface $logger
+     * @param EntityRepositoryInterface $orderLineItemRepository
      * @throws \Exception
      */
-    public function __construct(RefundDataBuilder $refundDataBuilder, OrderServiceInterface $orderService, RefundServiceInterface $refundService, Order $mollieOrder, FlowBuilderFactoryInterface $flowBuilderFactory, FlowBuilderEventFactory $flowBuilderEventFactory, StockManagerInterface $stockUpdater, LoggerInterface $logger)
+    public function __construct(RefundDataBuilder $refundDataBuilder, OrderServiceInterface $orderService, RefundServiceInterface $refundService, Order $mollieOrder, FlowBuilderFactoryInterface $flowBuilderFactory, FlowBuilderEventFactory $flowBuilderEventFactory, StockManagerInterface $stockUpdater, LoggerInterface $logger, EntityRepositoryInterface $orderLineItemRepository)
     {
         $this->builderData = $refundDataBuilder;
         $this->orderService = $orderService;
         $this->mollie = $mollieOrder;
         $this->refundService = $refundService;
         $this->stockManager = $stockUpdater;
         $this->logger = $logger;
-
         $this->flowBuilderEventFactory = $flowBuilderEventFactory;
-
         $this->flowBuilderDispatcher = $flowBuilderFactory->createDispatcher();
+        $this->orderLineItemRepository = $orderLineItemRepository;
     }
 
 
@@ -241,6 +247,21 @@ public function refund(OrderEntity $order, RefundRequest $request, Context $cont
                     $refund->id
                 );
             }
+            # also add reset stock to order line item, so we can retrieve it through API
+            # multiple refunds for a single line item are possible, so if previous reset stock exists, increase it
+            $lineItemAttributes = new OrderLineItemEntityAttributes($orderItem);
+            $alreadyResetStock = $lineItemAttributes->getResetStockQuantity() ?? 0;
+
+            #todo: The mollieOrderLineID always gets removed when upserting/updating the repository, for now update the array
+            $customFields = $orderItem->getCustomFields();
+            $customFields['mollie_payments']['reset_stock_quantity'] = $alreadyResetStock + $item->getStockIncreaseQty();
+
+            $data = [
+                'id' => $orderItem->getId(),
+                'customFields' => $customFields
+            ];
+
+            $this->orderLineItemRepository->upsert([$data], $context);
         }
 
         return $refund;

src/Resources/config/services/components.xml

@@ -14,6 +14,7 @@
             <argument type="service" id="Kiener\MolliePayments\Compatibility\Bundles\FlowBuilder\FlowBuilderEventFactory"/>
             <argument type="service" id="Kiener\MolliePayments\Service\Stock\StockManager"/>
             <argument type="service" id="mollie_payments.logger"/>
+            <argument type="service" id="order_line_item.repository"/>
         </service>
 
         <service id="Kiener\MolliePayments\Components\RefundManager\Builder\RefundDataBuilder">

src/Struct/OrderLineItemEntity/OrderLineItemEntityAttributes.php

@@ -39,6 +39,11 @@ class OrderLineItemEntityAttributes
      */
     private $subscriptionRepetitionCount;
 
+    /**
+     * @var int
+     */
+    private $resetStockQuantity;
+
 
     /**
      * @param OrderLineItemEntity $lineItem
@@ -47,6 +52,7 @@ public function __construct(OrderLineItemEntity $lineItem)
     {
         $this->voucherType = $this->getCustomFieldValue($lineItem, 'voucher_type');
         $this->mollieOrderLineID = $this->getCustomFieldValue($lineItem, 'order_line_id');
+        $this->resetStockQuantity = (int)$this->getCustomFieldValue($lineItem, 'reset_stock_quantity');
 
         $this->subscriptionProduct = (bool)$this->getCustomFieldValue($lineItem, 'subscription_enabled');
         $this->subscriptionInterval = (int)$this->getCustomFieldValue($lineItem, 'subscription_interval');
@@ -81,6 +87,14 @@ public function getMollieOrderLineID(): string
         return $this->mollieOrderLineID;
     }
 
+    /**
+     * @return int
+     */
+    public function getResetStockQuantity(): int
+    {
+        return $this->resetStockQuantity;
+    }
+
     /**
      * @return bool
      */

tests/PHPUnit/Components/RefundManager/RefundData/RefundDataTest.php

@@ -56,6 +56,11 @@ public function testCartItems()
         $lineItem->setTotalPrice(2 * 19.99);
         $lineItem->setReferencedId('product-id-1');
         $lineItem->setPayload(['productNumber' => 'P123']);
+        $lineItem->setCustomFields([
+            'mollie_payments' => [
+                'reset_stock_quantity' => 2
+            ],
+        ]);
 
         $items[] = new ProductItem($lineItem, [], 2);
 
@@ -78,6 +83,7 @@ public function testCartItems()
                     ],
                     'isPromotion' => false,
                     'isDelivery' => false,
+                    'resetStockQuantity' => 2
                 ],
             ]
         ];

tests/PHPUnit/Components/RefundManager/RefundManagerTest.php

@@ -10,6 +10,7 @@
 use Kiener\MolliePayments\Components\RefundManager\Request\RefundRequest;
 use Kiener\MolliePayments\Components\RefundManager\Request\RefundRequestItem;
 use Kiener\MolliePayments\Service\MollieApi\Order;
+use MolliePayments\Tests\Fakes\FakeEntityRepository;
 use MolliePayments\Tests\Fakes\FakeOrderService;
 use MolliePayments\Tests\Fakes\FakeRefundService;
 use MolliePayments\Tests\Fakes\FlowBuilder\FakeFlowBuilderDispatcher;
@@ -19,6 +20,7 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Log\NullLogger;
 use Shopware\Core\Checkout\Order\Aggregate\OrderLineItem\OrderLineItemCollection;
+use Shopware\Core\Checkout\Order\Aggregate\OrderLineItem\OrderLineItemDefinition;
 use Shopware\Core\Checkout\Order\Aggregate\OrderLineItem\OrderLineItemEntity;
 use Shopware\Core\Checkout\Order\OrderEntity;
 use Shopware\Core\Framework\Context;
@@ -60,6 +62,7 @@ protected function setUp(): void
 
         $fakeOrderService = new FakeOrderService($order);
         $fakeRefundService = new FakeRefundService('r-xyz-123', 9999);
+        $fakeOrderLineItemRepository = new FakeEntityRepository(new OrderLineItemDefinition());
         $this->fakeStockUpdater = new FakeStockManager();
 
         /** @var Order $fakeOrder */
@@ -77,7 +80,8 @@ protected function setUp(): void
             new FakeFlowBuilderFactory($this->fakeFlowBuilderDispatcher),
             $flowBuilderEventFactory,
             $this->fakeStockUpdater,
-            new NullLogger()
+            new NullLogger(),
+            $fakeOrderLineItemRepository
         );
     }
 
@@ -162,4 +166,4 @@ public function testStockReset()
         $this->assertEquals('r-xyz-123', $this->fakeStockUpdater->getMollieRefundID());
     }
 
-}
+}