Issue #2840669: Expand order logging to cover all state changes. (#603)

Author: steveoliver

modules/log/commerce_log.commerce_log_templates.yml

@@ -11,3 +11,15 @@ order_placed:
   category: commerce_order
   label: 'Order placed'
   template: '<p>The order was placed.</p>'
+order_validated:
+  category: commerce_order
+  label: 'Order validated'
+  template: '<p>The order was validated.</p>'
+order_fulfilled:
+  category: commerce_order
+  label: 'Order fulfilled'
+  template: '<p>The order was fulfilled.</p>'
+order_canceled:
+  category: commerce_order
+  label: 'Order canceled'
+  template: '<p>The order was canceled.</p>'

modules/log/src/EventSubscriber/OrderEventSubscriber.php

@@ -31,6 +31,9 @@ public function __construct(EntityTypeManagerInterface $entity_type_manager) {
   public static function getSubscribedEvents() {
     $events = [
       'commerce_order.place.pre_transition' => ['onPlaceTransition', -100],
+      'commerce_order.validate.pre_transition' => ['onValidateTransition', -100],
+      'commerce_order.fulfill.pre_transition' => ['onFulfillTransition', -100],
+      'commerce_order.cancel.pre_transition' => ['onCancelTransition', -100],
     ];
     return $events;
   }
@@ -47,4 +50,40 @@ public function onPlaceTransition(WorkflowTransitionEvent $event) {
     $this->logStorage->generate($order, 'order_placed')->save();
   }
 
+  /**
+   * Creates a log when an order is validated.
+   *
+   * @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
+   *   The transition event.
+   */
+  public function onValidateTransition(WorkflowTransitionEvent $event) {
+    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
+    $order = $event->getEntity();
+    $this->logStorage->generate($order, 'order_validated')->save();
+  }
+
+  /**
+   * Creates a log when an order is fulfilled.
+   *
+   * @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
+   *   The transition event.
+   */
+  public function onFulfillTransition(WorkflowTransitionEvent $event) {
+    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
+    $order = $event->getEntity();
+    $this->logStorage->generate($order, 'order_fulfilled')->save();
+  }
+
+  /**
+   * Creates a log when an order is canceled.
+   *
+   * @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
+   *   The transition event.
+   */
+  public function onCancelTransition(WorkflowTransitionEvent $event) {
+    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
+    $order = $event->getEntity();
+    $this->logStorage->generate($order, 'order_canceled')->save();
+  }
+
 }

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

@@ -3,6 +3,7 @@
 namespace Drupal\Tests\commerce_log\Kernel;
 
 use Drupal\commerce_order\Entity\Order;
+use Drupal\commerce_order\Entity\OrderType;
 use Drupal\commerce_price\Price;
 use Drupal\commerce_product\Entity\Product;
 use Drupal\commerce_product\Entity\ProductVariation;
@@ -71,6 +72,11 @@ protected function setUp() {
     $this->logStorage = $this->container->get('entity_type.manager')->getStorage('commerce_log');
     $this->logViewBuilder = $this->container->get('entity_type.manager')->getViewBuilder('commerce_log');
 
+    // Change the workflow of the default order type.
+    $order_type = OrderType::load('default');
+    $order_type->setWorkflowId('order_fulfillment_validation');
+    $order_type->save();
+
     // Turn off title generation to allow explicit values to be used.
     $variation_type = ProductVariationType::load('default');
     $variation_type->setGenerateTitle(FALSE);
@@ -123,9 +129,28 @@ protected function setUp() {
   }
 
   /**
-   * Tests that a log is generated when an order is placed.
+   * Tests that a log is generated for the cancel transition.
    */
-  public function testPlacedLog() {
+  public function testCancelLog() {
+    // Draft -> Canceled.
+    $transition = $this->order->getState()->getTransitions();
+    $this->order->getState()->applyTransition($transition['cancel']);
+    $this->order->save();
+
+    $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 canceled.');
+  }
+
+  /**
+   * Tests that a log is generated for place, validate, and fulfill transitions.
+   */
+  public function testPlaceValidateFulfillLogs() {
+    // Draft -> Placed.
     $transition = $this->order->getState()->getTransitions();
     $this->order->getState()->applyTransition($transition['place']);
     $this->order->save();
@@ -137,6 +162,32 @@ public function testPlacedLog() {
     $this->render($build);
 
     $this->assertText('The order was placed.');
+
+    // Placed -> Validated.
+    $transition = $this->order->getState()->getTransitions();
+    $this->order->getState()->applyTransition($transition['validate']);
+    $this->order->save();
+
+    $logs = $this->logStorage->loadByEntity($this->order);
+    $this->assertEquals(2, count($logs));
+    $log = $logs[2];
+    $build = $this->logViewBuilder->view($log);
+    $this->render($build);
+
+    $this->assertText('The order was validated.');
+
+    // Validated -> Fulfilled.
+    $transition = $this->order->getState()->getTransitions();
+    $this->order->getState()->applyTransition($transition['fulfill']);
+    $this->order->save();
+
+    $logs = $this->logStorage->loadByEntity($this->order);
+    $this->assertEquals(3, count($logs));
+    $log = $logs[3];
+    $build = $this->logViewBuilder->view($log);
+    $this->render($build);
+
+    $this->assertText('The order was fulfilled.');
   }
 
 }