Merge pull request #410 from magento-l3/L3-PR-2023-09-13

L3 pr 2023 09 13

Author: dhorytskyi

InventoryIndexer/Plugin/InventoryApi/ReindexAfterSourceItemsSavePlugin.php

@@ -7,14 +7,13 @@
 
 namespace Magento\InventoryIndexer\Plugin\InventoryApi;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\InventoryApi\Api\Data\SourceItemInterface;
 use Magento\InventoryApi\Api\SourceItemsSaveInterface;
+use Magento\InventoryCatalogApi\Api\DefaultSourceProviderInterface;
 use Magento\InventoryIndexer\Indexer\SourceItem\GetSourceItemIds;
 use Magento\InventoryIndexer\Indexer\SourceItem\SourceItemIndexer;
 
-/**
- * Reindex after source items save plugin
- */
 class ReindexAfterSourceItemsSavePlugin
 {
     /**
@@ -27,31 +26,63 @@ class ReindexAfterSourceItemsSavePlugin
      */
     private $sourceItemIndexer;
 
+    /**
+     * @var DefaultSourceProviderInterface
+     */
+    private $defaultSourceProvider;
+
     /**
      * @param GetSourceItemIds $getSourceItemIds
      * @param SourceItemIndexer $sourceItemIndexer
+     * @param DefaultSourceProviderInterface $defaultSourceProvider
      */
-    public function __construct(GetSourceItemIds $getSourceItemIds, SourceItemIndexer $sourceItemIndexer)
-    {
+    public function __construct(
+        GetSourceItemIds $getSourceItemIds,
+        SourceItemIndexer $sourceItemIndexer,
+        DefaultSourceProviderInterface $defaultSourceProvider
+    ) {
         $this->getSourceItemIds = $getSourceItemIds;
         $this->sourceItemIndexer = $sourceItemIndexer;
+        $this->defaultSourceProvider = $defaultSourceProvider;
     }
 
     /**
+     * Run reindex process for saved source items
+     *
      * @param SourceItemsSaveInterface $subject
      * @param void $result
      * @param SourceItemInterface[] $sourceItems
      * @return void
+     * @throws LocalizedException
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function afterExecute(
         SourceItemsSaveInterface $subject,
         $result,
         array $sourceItems
     ) {
+        $sourceItems = $this->sanitizeSources($sourceItems);
         $sourceItemIds = $this->getSourceItemIds->execute($sourceItems);
         if (count($sourceItemIds)) {
             $this->sourceItemIndexer->executeList($sourceItemIds);
         }
     }
+
+    /**
+     * Remove items with default source
+     *
+     * @param array $sourceItems
+     * @return array
+     */
+    private function sanitizeSources(array $sourceItems) : array
+    {
+        $result = [];
+        $defaultCode = $this->defaultSourceProvider->getCode();
+        foreach ($sourceItems as $item) {
+            if ($item->getSourceCode() !== $defaultCode) {
+                $result[] = $item;
+            }
+        }
+        return $result;
+    }
 }

InventoryIndexer/Test/Unit/Plugin/InventoryApi/ReindexAfterSourceItemsSavePluginTest.php

@@ -0,0 +1,86 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\InventoryIndexer\Test\Unit\Plugin\InventoryApi;
+
+use Magento\InventoryApi\Api\SourceItemsSaveInterface;
+use Magento\InventoryApi\Api\Data\SourceItemInterface;
+use Magento\InventoryCatalogApi\Api\DefaultSourceProviderInterface;
+use Magento\InventoryIndexer\Indexer\SourceItem\GetSourceItemIds;
+use Magento\InventoryIndexer\Indexer\SourceItem\SourceItemIndexer;
+use Magento\InventoryIndexer\Plugin\InventoryApi\ReindexAfterSourceItemsSavePlugin;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+class ReindexAfterSourceItemsSavePluginTest extends TestCase
+{
+    /**
+     * @var GetSourceItemIds|MockObject
+     */
+    private $getSourceItemIds;
+
+    /**
+     * @var SourceItemIndexer|MockObject
+     */
+    private $sourceItemIndexer;
+
+    /**
+     * @var DefaultSourceProviderInterface|MockObject
+     */
+    private $defaultSourceProvider;
+
+    /**
+     * @var SourceItemInterface|MockObject
+     */
+    private $sourceItem;
+
+    /**
+     * @var SourceItemsSaveInterface|MockObject
+     */
+    private $subject;
+
+    /**
+     * @var ReindexAfterSourceItemsSavePlugin
+     */
+    private $plugin;
+
+    /**
+     * @inheridoc
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->getSourceItemIds = $this->createMock(GetSourceItemIds::class);
+        $this->sourceItemIndexer = $this->createMock(SourceItemIndexer::class);
+        $this->defaultSourceProvider = $this->createMock(DefaultSourceProviderInterface::class);
+        $this->sourceItem = $this->createMock(SourceItemInterface::class);
+        $this->subject = $this->createMock(SourceItemsSaveInterface::class);
+        $this->plugin = new ReindexAfterSourceItemsSavePlugin(
+            $this->getSourceItemIds,
+            $this->sourceItemIndexer,
+            $this->defaultSourceProvider
+        );
+    }
+
+    public function testAfterExecuteWithDefaultSource() : void
+    {
+        $defaultCode = 'default';
+        $this->defaultSourceProvider->expects($this->once())
+            ->method('getCode')
+            ->willReturn($defaultCode);
+        $this->sourceItem->expects($this->once())
+            ->method('getSourceCode')
+            ->willReturn($defaultCode);
+        $this->getSourceItemIds->expects($this->once())
+            ->method('execute')
+            ->with([])
+            ->willReturn([]);
+        $this->sourceItemIndexer->expects($this->never())
+            ->method('executeList');
+        $this->plugin->afterExecute($this->subject, null, [$this->sourceItem]);
+    }
+}