feat(msi): support multiple sources (#633)

* feat: support multiple msi sources

Author: RichardPerdaan

Controller/Adminhtml/Order/CreateAndPrintMyParcelTrack.php

@@ -112,6 +112,10 @@ private function massAction()
 
         if (! $this->orderCollection->hasShipment()) {
             $this->messageManager->addErrorMessage(__(MagentoOrderCollection::ERROR_ORDER_HAS_NO_SHIPMENT));
+        }
+
+        if ($this->messageManager->getMessages()->getErrors()) {
+            $this->messageManager->getMessages();
 
             return $this;
         }

Model/Sales/MagentoCollection.php

@@ -30,10 +30,12 @@
  */
 abstract class MagentoCollection implements MagentoCollectionInterface
 {
-    public const PATH_HELPER_DATA            = '\MyParcelNL\Magento\Helper\Data';
-    public const PATH_MODEL_ORDER            = '\Magento\Sales\Model\ResourceModel\Order\Collection';
-    public const PATH_MODEL_SHIPMENT         = '\Magento\Sales\Model\ResourceModel\Order\Shipment\Collection';
-    public const ERROR_ORDER_HAS_NO_SHIPMENT = 'No shipment can be made with this order. Shipments can not be created if the status is On Hold or if the product is digital.';
+    public const PATH_HELPER_DATA                    = '\MyParcelNL\Magento\Helper\Data';
+    public const PATH_MODEL_ORDER                    = '\Magento\Sales\Model\ResourceModel\Order\Collection';
+    public const PATH_MODEL_SHIPMENT                 = '\Magento\Sales\Model\ResourceModel\Order\Shipment\Collection';
+    public const ERROR_ORDER_HAS_NO_SHIPMENT         = 'No shipment can be made with this order. Shipments can not be created if the status is On Hold or if the product is digital.';
+    public const ERROR_ORDER_HAS_NO_SOURCE           = 'Creating shipments via bulk actions is not possible for orders without a source. Go to the details of the order and process the shipment manually.';
+    public const DEFAULT_ERROR_ORDER_HAS_NO_SOURCE   = 'Source item not found by source code';
 
     private const PATH_ORDER_TRACK            = '\Magento\Sales\Model\Order\Shipment\Track';
     private const PATH_MANAGER_INTERFACE      = '\Magento\Framework\Message\ManagerInterface';

Model/Sales/MagentoOrderCollection.php

@@ -28,6 +28,7 @@
 use MyParcelNL\Sdk\src\Support\Collection;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 
+
 /**
  * Class MagentoOrderCollection
  *
@@ -63,9 +64,9 @@ class MagentoOrderCollection extends MagentoCollection
     private $shippingRecipient;
 
     /**
-     * @param ObjectManagerInterface                  $objectManager
-     * @param \Magento\Framework\App\RequestInterface $request
-     * @param null                                    $areaList
+     * @param  ObjectManagerInterface                   $objectManager
+     * @param  \Magento\Framework\App\RequestInterface  $request
+     * @param  null                                     $areaList
      */
     public function __construct(ObjectManagerInterface $objectManager, $request = null, $areaList = null)
     {
@@ -510,6 +511,13 @@ private function createShipment(Order $order)
         $convertOrder = $this->objectManager->create('Magento\Sales\Model\Convert\Order');
         $shipment     = $convertOrder->toShipment($order);
 
+        $shipmentAttributes = $shipment->getExtensionAttributes();
+
+        if (method_exists($shipmentAttributes, 'setSourceCode')) {
+            $shipmentAttributes->setSourceCode($this->sourceItem->getSource($order, $order->getAllItems()));
+            $shipment->setExtensionAttributes($shipmentAttributes);
+        }
+
         // Loop through order items
         foreach ($order->getAllItems() as $orderItem) {
             // Check if order item has qty to ship or is virtual
@@ -524,11 +532,6 @@ private function createShipment(Order $order)
 
             // Add shipment item to shipment
             $shipment->addItem($shipmentItem);
-
-            if ($this->sourceItem) {
-                $source = $this->getMultiStockInventory($orderItem);
-                $shipment->getExtensionAttributes()->setSourceCode($source);
-            }
         }
 
         // Register shipment
@@ -544,29 +547,15 @@ private function createShipment(Order $order)
             $this->objectManager->create('Magento\Shipping\Model\ShipmentNotifier')
                                 ->notify($shipment);
         } catch (\Exception $e) {
-            throw new LocalizedException(
-                __($e->getMessage())
-            );
-        }
-    }
 
-    /**
-     * @param \Magento\Sales\Model\Order\Item $orderItem
-     *
-     * @return string
-     */
-    private function getMultiStockInventory(\Magento\Sales\Model\Order\Item $orderItem): string
-    {
-        $sku    = $orderItem->getSku();
-        $result = $this->sourceItem->getSourceItemDetailBySKU($sku);
-
-        foreach ($result as $item) {
-            if ($item->getSourceCode() !== 'default') {
-                return $item->getSourceCode();
+            if (preg_match('/' . MagentoOrderCollection::DEFAULT_ERROR_ORDER_HAS_NO_SOURCE . '/', $e->getMessage())) {
+                $this->messageManager->addErrorMessage(__(MagentoOrderCollection::ERROR_ORDER_HAS_NO_SOURCE));
+            } else {
+                $this->messageManager->addErrorMessage(__($e->getMessage()));
             }
-        }
 
-        return 'default';
+            $this->objectManager->get('Psr\Log\LoggerInterface')->critical($e);
+        }
     }
 
     /**

Model/Source/SourceItem.php

@@ -2,42 +2,38 @@
 
 namespace MyParcelNL\Magento\Model\Source;
 
-use Magento\Framework\Api\SearchCriteriaBuilder;
-use Magento\InventoryApi\Api\Data\SourceItemInterface;
-use Magento\InventoryApi\Api\SourceItemRepositoryInterface;
+use Magento\Sales\Model\Order\ShipmentFactory;
 
 class SourceItem
 {
     /**
-     * @var SearchCriteriaBuilder
+     * @var ShipmentFactory
      */
-    private $searchCriteriaBuilder;
-
-    /**
-     * @var SourceItemRepositoryInterface
-     */
-    private $sourceItemRepository;
+    private $shipmentFactory;
 
     public function __construct(
-        SearchCriteriaBuilder $searchCriteriaBuilder,
-        SourceItemRepositoryInterface $sourceItemRepository
+        ShipmentFactory $shipmentFactory
     ) {
-        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
-        $this->sourceItemRepository = $sourceItemRepository;
+        $this->shipmentFactory = $shipmentFactory;
     }
 
     /**
-     * Retrieves links that are assigned to $stockId
+     * Magento uses an afterCreate plugin on the shipmentFactory to set the SourceCode. In the default flow Magento
+     * runs this code when you open the Create Shipment page. This behaviour doesn't occur in this flow, so we force
+     * that flow to happen here.
+     *
+     * @param $order
+     * @param $shipmentItems
      *
-     * @param string $sku
-     * @return SourceItemInterface[]
      */
-    public function getSourceItemDetailBySKU(string $sku): array
+    public function getSource($order, $shipmentItems)
     {
-        $searchCriteria = $this->searchCriteriaBuilder
-            ->addFilter(SourceItemInterface::SKU, $sku)
-            ->create();
+        $shipment = $this->shipmentFactory->create(
+            $order,
+            $shipmentItems
+        );
 
-        return $this->sourceItemRepository->getList($searchCriteria)->getItems();
+        $extensionAttributes = $shipment->getExtensionAttributes();
+        return $extensionAttributes->getSourceCode();
     }
 }

i18n/nl_NL.csv

@@ -114,6 +114,7 @@ Please select an item from the list,Selecteer eerst een order uit de lijst
 Please check address,Controleer het adres
 No key found. Go to Configuration and then to MyParcel to enter the key.,Geen API key gevonden. Ga naar Configuratie en vervolgens naar MyParcel om de API key in te voeren.
 "No shipment can be made with this order. Shipments can not be created if the status is On Hold or if the product is digital.","Er kan geen zending met deze bestelling gemaakt worden. Zendingen kunnen niet worden aangemaakt als de status 'Wordt vastgehouden' is of als het product digitaal is."
+"Creating shipments via bulk actions is not possible for orders without a source. Go to the details of the order and process the shipment manually.","Een zending aanmaken via een bulkactie is niet mogelijk voor orders zonder source. Ga naar de details van de order en boek de zending handmatig in."
 MyParcel Track,MyParcel barcode
 Use Shipment template,Gebruik Verzending template
 Enable this option to add the MyParcel barcode in the email.,Activeer deze optie om de MyParcel barcode toe te voegen in de email.