Issue #2842356 by agoradesign: Rethink the default order number generation (#609)

Author: agoradesign

modules/order/commerce_order.services.yml

@@ -38,6 +38,11 @@ services:
     tags:
       - { name: event_subscriber }
 
+  commerce_order.order_number_subscriber:
+    class: Drupal\commerce_order\EventSubscriber\OrderNumberSubscriber
+    tags:
+      - { name: event_subscriber }
+
   commerce_order.order_receipt_subscriber:
     class: Drupal\commerce_order\EventSubscriber\OrderReceiptSubscriber
     arguments: ['@entity_type.manager', '@language_manager', '@plugin.manager.mail', '@commerce_order.order_total_summary', '@renderer']

modules/order/src/Entity/Order.php

@@ -522,14 +522,6 @@ protected function getOrderCurrencyCode() {
   public function postSave(EntityStorageInterface $storage, $update = TRUE) {
     parent::postSave($storage, $update);
 
-    // If no order number has been set explicitly, set it to the order ID.
-    if (!$this->getOrderNumber()) {
-      $this->setOrderNumber($this->id());
-      // Order was refreshed in the save that just occurred, don't repeat it.
-      $this->setRefreshState(self::REFRESH_SKIP);
-      $this->save();
-    }
-
     // Ensure there's a back-reference on each order item.
     foreach ($this->getItems() as $order_item) {
       if ($order_item->order_id->isEmpty()) {

modules/order/src/EventSubscriber/OrderNumberSubscriber.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Drupal\commerce_order\EventSubscriber;
+
+use Drupal\state_machine\Event\WorkflowTransitionEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Generates the order number for placed orders.
+ *
+ * Modules wishing to override this logic can register their
+ * own event subscriber with a higher weight (e.g. -10).
+ */
+class OrderNumberSubscriber implements EventSubscriberInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getSubscribedEvents() {
+    $events = [
+      'commerce_order.place.pre_transition' => ['setOrderNumber', -100],
+    ];
+    return $events;
+  }
+
+  /**
+   * Sets the order number, if not already set explicitly, to the order ID.
+   *
+   * @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
+   *   The transition event.
+   */
+  public function setOrderNumber(WorkflowTransitionEvent $event) {
+    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
+    $order = $event->getEntity();
+    if (!$order->getOrderNumber()) {
+      $order->setOrderNumber($order->id());
+    }
+  }
+
+}

modules/order/tests/src/Functional/OrderTest.php

@@ -34,7 +34,6 @@ public function testCreateOrder() {
 
     $order_exists = (bool) Order::load($order->id());
     $this->assertNotEmpty($order_exists, 'The new order has been created in the database.');
-    $this->assertEquals($order->id(), $order->getOrderNumber(), 'The order number matches the order ID');
   }
 
   /**

modules/order/tests/src/Functional/OrderUserTest.php

@@ -54,6 +54,7 @@ public function testViewOrder() {
       'uid' => $uid,
       'order_items' => [$order_item],
       'mail' => '[email protected]',
+      'order_number' => '1',
     ]);
     $order->save();
 

modules/order/tests/src/Kernel/OrderNumberTest.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Drupal\Tests\commerce_order\Kernel;
+
+use Drupal\commerce_order\Entity\Order;
+use Drupal\Tests\commerce\Kernel\CommerceKernelTestBase;
+
+/**
+ * Tests the setting of the order number during order placement.
+ *
+ * @group commerce
+ */
+class OrderNumberTest extends CommerceKernelTestBase {
+
+  /**
+   * Modules to enable.
+   *
+   * @var array
+   */
+  public static $modules = [
+    'entity_reference_revisions',
+    'path',
+    'profile',
+    'state_machine',
+    'commerce_product',
+    'commerce_order',
+    'commerce_test',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    $this->installEntitySchema('profile');
+    $this->installEntitySchema('commerce_order');
+    $this->installEntitySchema('commerce_order_item');
+    $this->installEntitySchema('commerce_product');
+    $this->installEntitySchema('commerce_product_variation');
+    $this->installConfig(['commerce_product', 'commerce_order']);
+  }
+
+  /**
+   * Tests setting the order number.
+   */
+  public function testSetOrderNumber() {
+    $user = $this->createUser(['mail' => $this->randomString() . '@example.com']);
+
+    /** @var \Drupal\commerce_order\Entity\Order $order1 */
+    $order1 = Order::create([
+      'type' => 'default',
+      'state' => 'draft',
+      'mail' => '[email protected]',
+      'uid' => $user->id(),
+      'ip_address' => '127.0.0.1',
+      'store_id' => $this->store->id(),
+    ]);
+    $order1->save();
+
+    $transition = $order1->getState()->getTransitions();
+    $order1->getState()->applyTransition($transition['place']);
+    $order1->save();
+    $this->assertEquals($order1->id(), $order1->getOrderNumber(), 'During placement transition, the order number is set to the order ID.');
+
+    /** @var \Drupal\commerce_order\Entity\Order $order2 */
+    $order2 = Order::create([
+      'type' => 'default',
+      'state' => 'draft',
+      'mail' => '[email protected]',
+      'uid' => $user->id(),
+      'ip_address' => '127.0.0.1',
+      'order_number' => '9999',
+      'store_id' => $this->store->id(),
+    ]);
+    $order2->save();
+
+    $transition = $order2->getState()->getTransitions();
+    $order2->getState()->applyTransition($transition['place']);
+    $order2->save();
+    $this->assertEquals('9999', $order2->getOrderNumber(), 'Explicitly set order number should not get overridden.');
+  }
+
+}