Normalize Order History (#567)

* Normalize Order History

* Updated order history to match pattern/casing used by Magento ("Order Placed on ...")
* Fixed inconsistency between expected/actual cancellation notes

* code review feedback

Author: strygo

app/code/Meta/BusinessExtension/Helper/GraphAPIAdapter.php

@@ -775,7 +775,7 @@ public function cancelOrder($fbOrderId)
         // Magento doesn't support admin providing reason code or description for order cancellation
         $cancelReason = [
             'reason_code' => 'CUSTOMER_REQUESTED',
-            'reason_description' => 'Cancelled from Magento',
+            'reason_description' => 'Canceled from Magento',
         ];
         $response = $this->callApi(
             'POST',

app/code/Meta/Sales/Model/Mapper/OrderMapper.php

@@ -139,7 +139,6 @@ public function map(array $data, int $storeId): Order
             ->setDebugMode($isDebugMode)
             ->setAccessToken($accessToken);
 
-        $channel = ucfirst($data['channel']);
         $billingAddress = $this->getOrderBillingAddress($data);
         $shippingAddress = clone $billingAddress;
         $shippingAddress
@@ -174,7 +173,7 @@ public function map(array $data, int $storeId): Order
         $this->applyDiscountsToOrder($order, $data);
         $this->applyTotalsToOrder($order, $data, $storeId);
 
-        $order->addCommentToStatusHistory("Imported order #{$facebookOrderId} from {$channel}.");
+        $order->addCommentToStatusHistory("Order Imported from Meta. Meta Order ID: #{$facebookOrderId}");
 
         return $order;
     }

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

@@ -38,7 +38,7 @@ class CreateCancellation
     /**
      * Constant for the cancellation note to be added to the order
      */
-    public const CANCELLATION_NOTE = 'Cancelled from Meta Commerce Manager';
+    public const CANCELLATION_NOTE = 'Order Canceled from Meta.';
 
     /**
      * @var OrderRepositoryInterface
@@ -115,17 +115,15 @@ public function execute(array $facebookOrderData, array $facebookCancellationDat
             $magentoOrder->setStatus(Order::STATE_CANCELED);
         }
         if (isset($facebookCancellationData['cancel_reason'])) {
-            $concatenatedString = "";
+            $concatenatedString = '';
             if (isset($facebookCancellationData['cancel_reason']['reason_code'])) {
-                $concatenatedString .= 'Code: ' . $facebookCancellationData['cancel_reason']['reason_code'] . '. ';
+                $concatenatedString .= ' Reason: ' . $facebookCancellationData['cancel_reason']['reason_code'];
             }
             if (isset($facebookCancellationData['cancel_reason']['reason_description'])) {
-                $concatenatedString .= 'Description: ' .
+                $concatenatedString .= ' Description: ' .
                     $facebookCancellationData['cancel_reason']['reason_description'];
             }
-            if (!empty($concatenatedString)) {
-                $magentoOrder->addCommentToStatusHistory('Cancellation Details: ' . $concatenatedString);
-            }
+            $magentoOrder->addCommentToStatusHistory(self::CANCELLATION_NOTE . $concatenatedString);
         }
         $this->orderRepository->save($magentoOrder);
     }

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

@@ -226,9 +226,9 @@ public function markAsShipped(Shipment $shipment)
         );
 
         if ($track) {
-            $comment = "Marked order as shipped on Meta with {$track->getTitle()}. Tracking #: {$track->getNumber()}.";
+            $comment = "Order Marked as Shipped on Meta for {$track->getTitle()}. Tracking #: {$track->getNumber()}";
         } else {
-            $comment = "Marked order as shipped on Meta.";
+            $comment = "Order Marked as Shipped on Meta";
         }
 
         $order->addCommentToStatusHistory($comment)->save();
@@ -318,7 +318,7 @@ public function updateShipmentTracking(Shipment $shipment)
             $trackingInfo,
         );
 
-        $comment = "Updated shipment tracking on Meta for {$track->getTitle()}. Tracking #: {$track->getNumber()}.";
+        $comment = "Order Shipment Tracking Updated on Meta for {$track->getTitle()}. Tracking #: {$track->getNumber()}";
         $order->addCommentToStatusHistory($comment)->save();
 
         $fbOrder = $this->orderHelper->loadFacebookOrderFromMagentoId($order->getId());

app/code/Meta/Sales/Observer/Order/Cancel.php

@@ -83,11 +83,10 @@ public function execute(Observer $observer)
             return;
         }
 
-        $statusHistory = $order->getStatusHistoryCollection();
-        foreach ($statusHistory as $historyItem) {
-            if ($historyItem->getComment() &&
-                strpos($historyItem->getComment(), CreateCancellation::CANCELLATION_NOTE) !== false
-            ) {
+        $historyItems = $order->getStatusHistoryCollection();
+        foreach ($historyItems as $historyItem) {
+            $comment = $historyItem->getComment();
+            if ($comment && strpos($comment, CreateCancellation::CANCELLATION_NOTE) !== false) {
                 // No-op if order was originally canceled on Facebook -- avoid infinite cancel loop.
                 return;
             }
@@ -101,7 +100,7 @@ public function execute(Observer $observer)
 
         $this->cancelOrder((int)$storeId, $facebookOrderId);
 
-        $order->addCommentToStatusHistory("Canceled order on Meta.");
+        $order->addCommentToStatusHistory('Order Canceled on Meta');
     }
 
     /**

app/code/Meta/Sales/Observer/Order/Refund.php

@@ -153,7 +153,7 @@ public function execute(Observer $observer)
             $reasonText
         );
 
-        $payment->getOrder()->addCommentToStatusHistory('Refunded order on Meta.');
+        $payment->getOrder()->addCommentToStatusHistory('Order Refunded on Meta');
     }
 
     /**