Issue #2861664 by mglaman: Order assignment should generate a log to mark the customer conversion (#680)

Author: mglaman

modules/log/commerce_log.commerce_log_templates.yml

@@ -23,3 +23,7 @@ order_canceled:
   category: commerce_order
   label: 'Order canceled'
   template: '<p>The order was canceled.</p>'
+order_assigned:
+  category: commerce_order
+  label: 'Order assigned'
+  template: '<p>The order was assigned to {{ user }}.</p>'

modules/log/src/EventSubscriber/OrderEventSubscriber.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\commerce_log\EventSubscriber;
 
+use Drupal\commerce_order\Event\OrderAssignEvent;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\state_machine\Event\WorkflowTransitionEvent;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -34,6 +35,7 @@ public static function getSubscribedEvents() {
       'commerce_order.validate.pre_transition' => ['onValidateTransition', -100],
       'commerce_order.fulfill.pre_transition' => ['onFulfillTransition', -100],
       'commerce_order.cancel.pre_transition' => ['onCancelTransition', -100],
+      'commerce_order.order.assign' => ['onOrderAssign', -100],
     ];
     return $events;
   }
@@ -86,4 +88,17 @@ public function onCancelTransition(WorkflowTransitionEvent $event) {
     $this->logStorage->generate($order, 'order_canceled')->save();
   }
 
+  /**
+   * Creates a log when an order is assigned.
+   *
+   * @param \Drupal\commerce_order\Event\OrderAssignEvent $event
+   *   The order assign event.
+   */
+  public function onOrderAssign(OrderAssignEvent $event) {
+    $order = $event->getOrder();
+    $this->logStorage->generate($order, 'order_assigned', [
+      'user' => $event->getAccount()->getDisplayName(),
+    ])->save();
+  }
+
 }

modules/log/tests/src/Kernel/OrderIntegrationTest.php

@@ -3,13 +3,15 @@
 namespace Drupal\Tests\commerce_log\Kernel;
 
 use Drupal\commerce_order\Entity\Order;
+use Drupal\commerce_order\Entity\OrderInterface;
 use Drupal\commerce_order\Entity\OrderType;
 use Drupal\commerce_price\Price;
 use Drupal\commerce_product\Entity\Product;
 use Drupal\commerce_product\Entity\ProductVariation;
 use Drupal\commerce_product\Entity\ProductVariationType;
 use Drupal\profile\Entity\Profile;
 use Drupal\Tests\commerce\Kernel\CommerceKernelTestBase;
+use Drupal\user\Entity\User;
 
 /**
  * Tests integration with order events.
@@ -185,4 +187,25 @@ public function testPlaceValidateFulfillLogs() {
     $this->assertText('The order was fulfilled.');
   }
 
+  /**
+   * Tests that an order assignment log is generated.
+   */
+  public function testOrderAssignedLog() {
+    // Reassignment is currently only done on user login.
+    $this->order->setCustomer(User::getAnonymousUser());
+    $this->order->setRefreshState(OrderInterface::REFRESH_SKIP);
+    $this->order->save();
+    $new_user = $this->createUser();
+
+    $order_assignment = $this->container->get('commerce_order.order_assignment');
+    $order_assignment->assign($this->order, $new_user);
+
+    $logs = $this->logStorage->loadByEntity($this->order);
+    $this->assertEquals(1, count($logs));
+    $log = reset($logs);
+    $build = $this->logViewBuilder->view($log);
+    $this->render($build);
+    $this->assertText("The order was assigned to {$new_user->getDisplayName()}.");
+  }
+
 }