Allocate order increment ID (#257)

* Allocate order increment ID

* Address test results

* added return type

* added return type

Author: zlik

app/code/Meta/Sales/Model/Order/CreateOrder.php

@@ -25,6 +25,7 @@
 use Magento\Sales\Api\InvoiceManagementInterface;
 use Magento\Sales\Api\OrderManagementInterface;
 use Magento\Sales\Model\Order;
+use Magento\SalesSequence\Model\Manager as OrderSequenceManager;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 use Meta\Sales\Api\Data\FacebookOrderInterface;
 use Meta\Sales\Api\Data\FacebookOrderInterfaceFactory;
@@ -34,6 +35,7 @@
 
 /**
  * Create order from facebook api data
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class CreateOrder
 {
@@ -72,6 +74,11 @@ class CreateOrder
      */
     private OrderMapper $orderMapper;
 
+    /**
+     * @var OrderSequenceManager
+     */
+    private OrderSequenceManager $orderSequenceManager;
+
     /**
      * @param ManagerInterface $eventManager
      * @param OrderManagementInterface $orderManagement
@@ -80,6 +87,7 @@ class CreateOrder
      * @param InvoiceManagementInterface $invoiceManagement
      * @param TransactionFactory $transactionFactory
      * @param OrderMapper $orderMapper
+     * @param OrderSequenceManager $orderSequenceManager
      */
     public function __construct(
         ManagerInterface $eventManager,
@@ -88,7 +96,8 @@ public function __construct(
         FacebookOrderInterfaceFactory $facebookOrderFactory,
         InvoiceManagementInterface $invoiceManagement,
         TransactionFactory $transactionFactory,
-        OrderMapper $orderMapper
+        OrderMapper $orderMapper,
+        OrderSequenceManager $orderSequenceManager
     ) {
         $this->eventManager = $eventManager;
         $this->orderManagement = $orderManagement;
@@ -97,6 +106,23 @@ public function __construct(
         $this->invoiceManagement = $invoiceManagement;
         $this->transactionFactory = $transactionFactory;
         $this->orderMapper = $orderMapper;
+        $this->orderSequenceManager = $orderSequenceManager;
+    }
+
+    /**
+     * Generate a new increment order ID and associate it with a current order
+     *
+     * @param Order $order
+     * @return string|null
+     * @throws LocalizedException
+     */
+    public function reserveOrderIncrementId(Order $order): ?string
+    {
+        $reservedOrderId = $this->orderSequenceManager
+            ->getSequence(Order::ENTITY, $order->getStoreId())
+            ->getNextValue();
+        $order->setIncrementId($reservedOrderId);
+        return $reservedOrderId;
     }
 
     /**
@@ -119,6 +145,7 @@ public function execute(array $data, int $storeId): Order
         }
 
         $order = $this->orderMapper->map($data, $storeId);
+        $this->reserveOrderIncrementId($order);
         $channel = ucfirst($data['channel']);
 
         $this->orderManagement->place($order);

app/code/Meta/Sales/composer.json

@@ -6,6 +6,7 @@
         "php": "~7.4.0||~8.1.0",
         "magento/framework": "*",
         "magento/module-sales": "*",
+        "magento/module-sales-sequence": "*",
         "magento/module-backend": "*",
         "magento/module-config": "*",
         "magento/module-catalog": "*",

app/code/Meta/Sales/etc/module.xml

@@ -12,6 +12,7 @@
             <module name="Magento_Eav"/>
             <module name="Magento_Directory"/>
             <module name="Magento_Payment"/>
+            <module name="Magento_SalesSequence"/>
             <module name="Magento_Shipping"/>
             <module name="Meta_BusinessExtension"/>
             <module name="Meta_Catalog"/>