#518 Simplest “By Priority” Algorithm implementation

app/code/Magento/Inventory/Model/StockSourceLink/Command/GetAssignedSourcesForStock.php

@@ -15,6 +15,7 @@
 use Magento\InventoryApi\Api\GetStockSourceLinksInterface;
 use Magento\InventoryApi\Api\SourceRepositoryInterface;
 use Psr\Log\LoggerInterface;
+use Magento\Framework\Api\SortOrderBuilder;
 
 /**
  * @inheritdoc
@@ -41,22 +42,30 @@ class GetAssignedSourcesForStock implements GetAssignedSourcesForStockInterface
      */
     private $logger;
 
+    /**
+     * @var SortOrderBuilder
+     */
+    private $sortOrderBuilder;
+
     /**
      * @param SearchCriteriaBuilder $searchCriteriaBuilder
      * @param SourceRepositoryInterface $sourceRepository
      * @param GetStockSourceLinksInterface $getStockSourceLinks
+     * @param SortOrderBuilder $sortOrderBuilder
      * @param LoggerInterface $logger
      */
     public function __construct(
         SearchCriteriaBuilder $searchCriteriaBuilder,
         SourceRepositoryInterface $sourceRepository,
         GetStockSourceLinksInterface $getStockSourceLinks,
+        SortOrderBuilder $sortOrderBuilder,
         LoggerInterface $logger
     ) {
         $this->searchCriteriaBuilder = $searchCriteriaBuilder;
         $this->sourceRepository = $sourceRepository;
         $this->getStockSourceLinks = $getStockSourceLinks;
         $this->logger = $logger;
+        $this->sortOrderBuilder = $sortOrderBuilder;
     }
 
     /**
@@ -88,8 +97,13 @@ public function execute(int $stockId): array
      */
     private function getAssignedSourceCodes(int $stockId): array
     {
+        $sortOrder = $this->sortOrderBuilder
+            ->setField(StockSourceLinkInterface::PRIORITY)
+            ->setAscendingDirection()
+            ->create();
         $searchCriteria = $this->searchCriteriaBuilder
             ->addFilter(StockSourceLinkInterface::STOCK_ID, $stockId)
+            ->addSortOrder($sortOrder)
             ->create();
         $searchResult = $this->getStockSourceLinks->execute($searchCriteria);
 

app/code/Magento/InventoryShipping/Model/DefaultShippingAlgorithm.php

@@ -7,25 +7,32 @@
 
 namespace Magento\InventoryShipping\Model;
 
-use Magento\Inventory\Model\SourceItem\Command\GetSourceItemsBySkuInterface;
+use Magento\Framework\Api\SearchCriteriaBuilder;
+use Magento\Inventory\Model\SourceItem\Command\GetSourceItemsBySkuInterfffface;
+use Magento\InventoryApi\Api\Data\SourceInterface;
+use Magento\InventoryApi\Api\Data\SourceItemInterface;
+use Magento\InventoryApi\Api\Data\SourceItemInterfaceFactory;
+use Magento\InventoryApi\Api\GetAssignedSourcesForStockInterface;
+use Magento\InventoryApi\Api\SourceItemRepositoryInterface;
+use Magento\InventorySalesApi\Api\Data\SalesChannelInterface;
+use Magento\InventorySalesApi\Api\StockResolverInterface;
 use Magento\InventoryShipping\Model\ShippingAlgorithmResult\ShippingAlgorithmResultInterface;
 use Magento\InventoryShipping\Model\ShippingAlgorithmResult\ShippingAlgorithmResultInterfaceFactory;
 use Magento\InventoryShipping\Model\ShippingAlgorithmResult\SourceItemSelectionInterfaceFactory;
 use Magento\InventoryShipping\Model\ShippingAlgorithmResult\SourceSelectionInterfaceFactory;
 use Magento\Sales\Api\Data\OrderInterface;
+use Magento\Sales\Api\Data\OrderItemInterface;
+use Magento\Sales\Model\Order\Item as OrderItem;
+use Magento\Store\Api\WebsiteRepositoryInterface;
+use Magento\Store\Model\StoreManagerInterface;
 
 /**
  * {@inheritdoc}
  *
- * This shipping algorithm just iterates over all the sources one by one in no particular order
+ * This shipping algorithm just iterates over all the sources one by one in priority order
  */
-class DefaultShippingAlgorithm implements ShippingAlgorithmInterface
+class PriorityShippingAlgorithm implements ShippingAlgorithmInterface
 {
-    /**
-     * @var GetSourceItemsBySkuInterface
-     */
-    private $getSourceItemsBySku;
-
     /**
      * @var SourceSelectionInterfaceFactory
      */
@@ -42,93 +49,174 @@ class DefaultShippingAlgorithm implements ShippingAlgorithmInterface
     private $shippingAlgorithmResultFactory;
 
     /**
-     * @var bool
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
+    /**
+     * @var WebsiteRepositoryInterface
+     */
+    private $websiteRepository;
+
+    /**
+     * @var StockResolverInterface
+     */
+    private $stockResolver;
+
+    /**
+     * @var GetAssignedSourcesForStockInterface
+     */
+    private $getAssignedSourcesForStock;
+
+    /**
+     * @var SourceItemRepositoryInterface
      */
-    private $isShippable;
+    private $sourceItemRepository;
+
+    /**
+     * @var SearchCriteriaBuilder
+     */
+    private $searchCriteriaBuilder;
+    /**
+     * @var SourceItemInterfaceFactory
+     */
+    private $sourceItemFactory;
 
     /**
-     * @param GetSourceItemsBySkuInterface $getSourceItemsBySku
      * @param SourceSelectionInterfaceFactory $sourceSelectionFactory
      * @param SourceItemSelectionInterfaceFactory $sourceItemSelectionFactory
      * @param ShippingAlgorithmResultInterfaceFactory $shippingAlgorithmResultFactory
+     * @param StoreManagerInterface $storeManager
+     * @param WebsiteRepositoryInterface $websiteRepository
+     * @param StockResolverInterface $stockResolver
+     * @param GetAssignedSourcesForStockInterface $getAssignedSourcesForStock
+     * @param SourceItemRepositoryInterface $sourceItemRepository
+     * @param SourceItemInterfaceFactory $sourceItemFactory
+     * @param SearchCriteriaBuilder $searchCriteriaBuilder
      */
     public function __construct(
-        GetSourceItemsBySkuInterface $getSourceItemsBySku,
         SourceSelectionInterfaceFactory $sourceSelectionFactory,
         SourceItemSelectionInterfaceFactory $sourceItemSelectionFactory,
-        ShippingAlgorithmResultInterfaceFactory $shippingAlgorithmResultFactory
+        ShippingAlgorithmResultInterfaceFactory $shippingAlgorithmResultFactory,
+        StoreManagerInterface $storeManager,
+        WebsiteRepositoryInterface $websiteRepository,
+        StockResolverInterface $stockResolver,
+        GetAssignedSourcesForStockInterface $getAssignedSourcesForStock,
+        SourceItemRepositoryInterface $sourceItemRepository,
+        SourceItemInterfaceFactory $sourceItemFactory,
+        SearchCriteriaBuilder $searchCriteriaBuilder
     ) {
-        $this->getSourceItemsBySku = $getSourceItemsBySku;
         $this->shippingAlgorithmResultFactory = $shippingAlgorithmResultFactory;
         $this->sourceSelectionFactory = $sourceSelectionFactory;
         $this->sourceItemSelectionFactory = $sourceItemSelectionFactory;
+        $this->storeManager = $storeManager;
+        $this->websiteRepository = $websiteRepository;
+        $this->stockResolver = $stockResolver;
+        $this->getAssignedSourcesForStock = $getAssignedSourcesForStock;
+        $this->sourceItemRepository = $sourceItemRepository;
+        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
+        $this->sourceItemFactory = $sourceItemFactory;
     }
 
     /**
      * @inheritdoc
      */
     public function execute(OrderInterface $order): ShippingAlgorithmResultInterface
     {
-        $this->isShippable = true;
-        $sourceItemSelectionsData = $this->getSourceItemSelectionsData($order);
-
+        $isShippable = true;
         $sourceSelections = [];
-        foreach ($sourceItemSelectionsData as $sourceCode => $sourceItemSelections) {
-            $sourceSelections[] = $this->sourceSelectionFactory->create([
-                'sourceCode' => $sourceCode,
-                'sourceItemSelections' => $sourceItemSelections,
-            ]);
-        }
-
-        $shippingResult = $this->shippingAlgorithmResultFactory->create([
-            'sourceSelections' => $sourceSelections,
-            'isShippable' => $this->isShippable
-        ]);
-        return $shippingResult;
-    }
-
-    /**
-     * Key is source code, value is list of SourceItemSelectionInterface related to this source
-     * @param OrderInterface $order
-     * @return array
-     */
-    private function getSourceItemSelectionsData(OrderInterface $order): array
-    {
-        $sourceItemSelections = [];
+        $storeId = $order->getStoreId();
+        $sources = $this->getSourcesByStoreId($storeId);
 
+        /** @var OrderItemInterface|OrderItem $orderItem */
         foreach ($order->getItems() as $orderItem) {
-            if ($orderItem->isDeleted() || $orderItem->getParentItemId()) {
+            $itemSku = $orderItem->getSku();
+            $qtyToDeliver = $orderItem->getQtyOrdered();
+
+            if ($orderItem->isDeleted() || $orderItem->getParentItemId() || $this->isZero($qtyToDeliver)) {
                 continue;
             }
 
-            $itemSku = $orderItem->getSku();
-            $sourceItems = $this->getSourceItemsBySku->execute($itemSku)->getItems();
+            foreach ($sources as $source) {
+                $sourceItem = $this->getStockItemBySku($source->getSourceCode(), $itemSku);
+                $sourceItemQty = $sourceItem->getQuantity();
+                $qtyToDeduct = min($sourceItemQty, $qtyToDeliver);
 
-            $qtyToDeliver = $orderItem->getQtyOrdered();
-            foreach ($sourceItems as $sourceItem) {
-                if ($qtyToDeliver < 0.0001) {
-                    break;
+                if ($this->isZero($sourceItemQty)) {
+                    continue;
                 }
 
-                $sourceItemQty = $sourceItem->getQuantity();
-                if ($sourceItemQty > 0) {
-                    $qtyToDeduct = min($sourceItemQty, $qtyToDeliver);
-
-                    $sourceItemSelections[$sourceItem->getSourceCode()][] = $this->sourceItemSelectionFactory->create([
+                $sourceSelections[] = $this->sourceSelectionFactory->create([
+                    'sourceCode' => $sourceItem->getSourceCode(),
+                    'sourceItemSelections' => $this->sourceItemSelectionFactory->create([
                         'sku' => $itemSku,
                         'qty' => $qtyToDeduct,
                         'qtyAvailable' => $sourceItemQty,
-                    ]);
+                    ]),
+                ]);
 
-                    $qtyToDeliver -= $qtyToDeduct;
-                }
+                $qtyToDeliver -= $qtyToDeduct;
             }
 
-            if ($qtyToDeliver > 0.0001) {
-                $this->isShippable = false;
+            if (!$this->isZero($qtyToDeliver)) {
+                $isShippable = false;
             }
         }
 
-        return $sourceItemSelections;
+        return $this->shippingAlgorithmResultFactory->create([
+            'sourceSelections' => $sourceSelections,
+            'isShippable' => $isShippable
+        ]);
+    }
+
+    /**
+     * Retrieve sources are related to current stock that are ordered by priority
+     *
+     * @param int $storeId
+     *
+     * @return SourceInterface[]
+     */
+    private function getSourcesByStoreId(int $storeId): array
+    {
+        $store = $this->storeManager->getStore($storeId);
+        $website = $this->websiteRepository->getById($store->getId());
+        $stock = $this->stockResolver->get(SalesChannelInterface::TYPE_WEBSITE, $website->getCode());
+
+       return $this->getAssignedSourcesForStock->execute($stock->getStockId());
+    }
+
+    /**
+     * Retrieve stock item from specific source by SKU
+     *
+     * @param string $stockCode
+     * @param string $sku
+     *
+     * @return SourceItemInterface
+     */
+    private function getStockItemBySku(string $stockCode, string $sku): SourceItemInterface
+    {
+        $searchCriteria = $this->searchCriteriaBuilder
+            ->addFilter(SourceItemInterface::SOURCE_CODE, $stockCode)
+            ->addFilter(SourceItemInterface::SKU, $sku)
+            ->create();
+        $sourceItemsResult = $this->sourceItemRepository->getList($searchCriteria);
+
+        if ($sourceItemsResult->getTotalCount() > 0) {
+            return reset($sourceItemsResult->getItems());
+        }
+
+        return $this->sourceItemFactory->create();
+    }
+
+    /**
+     * Compare float number with some epsilon
+     *
+     * @param float $floatNumber
+     *
+     * @return bool
+     */
+    private function isZero(float $floatNumber): bool
+    {
+        return $floatNumber < 0.0001;
     }
 }

app/code/Magento/InventoryShipping/Model/ShippingAlgorithmProvider.php

@@ -33,6 +33,6 @@ public function __construct(
      */
     public function execute(): ShippingAlgorithmInterface
     {
-        return $this->objectManager->get(DefaultShippingAlgorithm::class);
+        return $this->objectManager->get(PriorityShippingAlgorithm::class);
     }
 }

app/code/Magento/InventoryShipping/Test/Integration/DefaultShippingAlgorithmTest.php

@@ -8,14 +8,14 @@
 namespace Magento\InventoryShipping\Test\Integration;
 
 use Magento\InventoryCatalog\Api\DefaultSourceProviderInterface;
-use Magento\InventoryShipping\Model\DefaultShippingAlgorithm;
+use Magento\InventoryShipping\Model\PriorityShippingAlgorithm;
 use Magento\Sales\Api\Data\OrderInterface;
 use Magento\Sales\Api\Data\OrderInterfaceFactory;
 use Magento\Sales\Api\Data\OrderItemInterfaceFactory;
 use Magento\TestFramework\Helper\Bootstrap;
 use PHPUnit\Framework\TestCase;
 
-class DefaultShippingAlgorithmTest extends TestCase
+class PriorityShippingAlgorithmTest extends TestCase
 {
     /**
      * @var DefaultSourceProviderInterface
@@ -33,13 +33,16 @@ class DefaultShippingAlgorithmTest extends TestCase
     private $orderFactory;
 
     /**
-     * @var DefaultShippingAlgorithm
+     * @var PriorityShippingAlgorithm
      */
     private $shippingAlgorithm;
 
+    /**
+     * @return void
+     */
     protected function setUp()
     {
-        $this->shippingAlgorithm = Bootstrap::getObjectManager()->get(DefaultShippingAlgorithm::class);
+        $this->shippingAlgorithm = Bootstrap::getObjectManager()->get(PriorityShippingAlgorithm::class);
         $this->defaultSourceProvider = Bootstrap::getObjectManager()->get(DefaultSourceProviderInterface::class);
         $this->orderFactory = Bootstrap::getObjectManager()->get(OrderInterfaceFactory::class);
         $this->orderItemFactory = Bootstrap::getObjectManager()->get(OrderItemInterfaceFactory::class);

app/code/Magento/InventoryShipping/etc/module.xml

@@ -9,6 +9,7 @@
     <module name="Magento_InventoryShipping" setup_version="1.0.0">
         <sequence>
             <module name="Magento_Inventory"/>
+            <module name="Magento_InventorySalesApi"/>
         </sequence>
     </module>
 </config>