Displaying Title/Method name under shipping information in Magento orders tab, instead of Title/method code (#496)

* ordermapper

* deleting things

* changing

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* change

* Category collection class split into 2 small files

* Comments addressed

* supress warning added

* commandeering PR and addressing feedback

* Change arbitrary delimiter

---------

Co-authored-by: singhramanpreett <[email protected]>
Co-authored-by: Paul Kang <[email protected]>

Author: 3 people

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

@@ -31,6 +31,7 @@
 use Magento\Store\Model\StoreManagerInterface;
 use Meta\BusinessExtension\Helper\GraphAPIAdapter;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
+use Meta\Sales\Plugin\ShippingData;
 use Meta\Sales\Plugin\ShippingMethodTypes;
 use Meta\Sales\Helper\ShippingHelper;
 
@@ -75,6 +76,11 @@ class OrderMapper
      */
     private OrderItemMapper $orderItemMapper;
 
+    /**
+     * @var ShippingData
+     */
+    private ShippingData $shippingData;
+
     /**
      * @var ShippingHelper
      */
@@ -88,6 +94,7 @@ class OrderMapper
      * @param OrderPaymentInterfaceFactory $paymentFactory
      * @param OrderAddressInterfaceFactory $orderAddressFactory
      * @param OrderItemMapper $orderItemMapper
+     * @param ShippingData $shippingData
      * @param ShippingHelper $shippingHelper
      */
     public function __construct(
@@ -98,6 +105,7 @@ public function __construct(
         OrderPaymentInterfaceFactory $paymentFactory,
         OrderAddressInterfaceFactory $orderAddressFactory,
         OrderItemMapper              $orderItemMapper,
+        ShippingData                 $shippingData,
         ShippingHelper               $shippingHelper
     ) {
         $this->storeManager = $storeManager;
@@ -107,6 +115,7 @@ public function __construct(
         $this->paymentFactory = $paymentFactory;
         $this->orderAddressFactory = $orderAddressFactory;
         $this->orderItemMapper = $orderItemMapper;
+        $this->shippingData = $shippingData;
         $this->shippingHelper = $shippingHelper;
     }
 
@@ -130,8 +139,8 @@ public function map(array $data, int $storeId): Order
             ->setAccessToken($accessToken);
 
         $channel = ucfirst($data['channel']);
-        $shippingOptionName = $data['selected_shipping_option']['name'];
-        $shippingReferenceId = $data['selected_shipping_option']['reference_id'];
+        $metaShippingOptionName = $data['selected_shipping_option']['name'];
+        $magentoShippingReferenceID = $data['selected_shipping_option']['reference_id'];
         $billingAddress = $this->getOrderBillingAddress($data);
         $shippingAddress = clone $billingAddress;
         $shippingAddress
@@ -158,13 +167,16 @@ public function map(array $data, int $storeId): Order
 
         $this->applyTotalsToOrder($order, $data, $storeId);
 
-        $shippingMethod = $this->getShippingMethod($shippingOptionName, $shippingReferenceId, $storeId);
-        $shippingDescription = $this->getShippingMethodLabel($shippingOptionName, $storeId);
+        $shippingMethod = $this->getShippingMethod($metaShippingOptionName, $magentoShippingReferenceID, $storeId);
+        $shippingDescription = $this->getShippingDescription($metaShippingOptionName, $shippingMethod, $storeId);
+        // This should never happen, as it means Meta has passed a shipping method with no equivalent in Magento.
+        // @todo strictly handle this edge case by canceling the entire Meta order if this happens.
+        $fallbackShippingDescription = $metaShippingOptionName . " - {$shippingMethod}";
 
         $order->setStoreId($storeId)
             // @todo have to set shipping method like this
             ->setShippingMethod($shippingMethod)
-            ->setShippingDescription($shippingDescription ?? $shippingOptionName . " / {$shippingMethod}")
+            ->setShippingDescription($shippingDescription ?? $fallbackShippingDescription)
             ->setPayment($payment);
 
         // @todo implement paging and tax for order items
@@ -191,10 +203,7 @@ public function map(array $data, int $storeId): Order
      */
     private function getShippingMethod(string $shippingOptionName, string $shippingReferenceId, int $storeId): ?string
     {
-        $static_shipping_options = [ShippingMethodTypes::FREE_SHIPPING,
-            ShippingMethodTypes::FLAT_RATE,
-            ShippingMethodTypes::TABLE_RATE];
-        if (in_array($shippingReferenceId, $static_shipping_options)) {
+        if (in_array($shippingReferenceId, $this->getSyncableShippingMethodTypes())) {
             return $shippingReferenceId;
         }
         $map = $this->systemConfig->getShippingMethodsMap($storeId);
@@ -226,6 +235,49 @@ private function getShippingMethodLabel(string $shippingOptionName, int $storeId
         return null;
     }
 
+    /**
+     * Get ShippingMethodDescription
+     *
+     * @param string $metaShippingTitle
+     * @param string $shippingMethod
+     * @param int $storeId
+     * @return string|null
+     */
+    private function getShippingDescription(string $metaShippingTitle, string $shippingMethod, int $storeId): ?string
+    {
+        $shippingLabel = $this->getShippingMethodLabel($metaShippingTitle, $storeId);
+        if ($shippingLabel) {
+            return $shippingLabel;
+        }
+
+        if (in_array($shippingMethod, $this->getSyncableShippingMethodTypes())) {
+            $this->shippingData->setStoreId($storeId);
+            [$carrier] = explode('_', $shippingMethod);
+            // Possible values are string, '' and null. Falsey check is acceptable here.
+            if ($carrier) {
+                $shippingMethodName = $this->shippingData->getFieldFromModel($carrier, 'name');
+                $shippingOptionTitle = $this->shippingData->getFieldFromModel($carrier, 'title');
+                return $shippingOptionTitle . ' - ' . $shippingMethodName;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * This function returns a list of shipping methods that can be synced to Meta
+     *
+     * @return array
+     */
+    public function getSyncableShippingMethodTypes(): array
+    {
+        return [
+            ShippingMethodTypes::FREE_SHIPPING,
+            ShippingMethodTypes::FLAT_RATE,
+            ShippingMethodTypes::TABLE_RATE
+        ];
+    }
+
     /**
      * Create a magento order billing address from facebook order data
      *

app/code/Meta/Sales/Plugin/ShippingData.php

@@ -128,7 +128,7 @@ public function buildShippingProfile(string $shippingProfileType): array
      * @param string $field
      * @return mixed
      */
-    private function getFieldFromModel(string $shippingProfileType, string $field)
+    public function getFieldFromModel(string $shippingProfileType, string $field)
     {
         $path = 'carriers/' . $shippingProfileType . '/' . $field;
         return $this->scopeConfig->getValue($path, \Magento\Store\Model\ScopeInterface::SCOPE_STORE, $this->storeId);