Handle events for new shipments and updated tracking (#552)

* Handle events for new shipments and updated tracking

* Reload fb order between shipping events, handle dupe tracking error

* Store synced tracked on shipments

* Fix up logs

---------

Co-authored-by: Sean Winard <[email protected]>

Author: swinard-meta

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

@@ -707,7 +707,7 @@ public function acknowledgeOrders($ordersRootId, array $orderIds)
     }
 
     /**
-     * Mark order as shipped
+     * Mark order items as shipped
      *
      * @param mixed $fbOrderId
      * @param array $items
@@ -717,8 +717,13 @@ public function acknowledgeOrders($ordersRootId, array $orderIds)
      * @return mixed|\Psr\Http\Message\ResponseInterface
      * @throws GuzzleException
      */
-    public function markOrderAsShipped($fbOrderId, $magentoShipmentId, $items, $trackingInfo, $fulfillmentAddressData)
-    {
+    public function markOrderItemsAsShipped(
+        $fbOrderId,
+        $magentoShipmentId,
+        $items,
+        $trackingInfo,
+        $fulfillmentAddressData
+    ) {
         $request = [
             'access_token' => $this->accessToken,
             'external_shipment_id' => $magentoShipmentId,
@@ -736,6 +741,28 @@ public function markOrderAsShipped($fbOrderId, $magentoShipmentId, $items, $trac
         return json_decode($response->getBody()->__toString(), true);
     }
 
+    /**
+     * Update tracking info for a shipment
+     *
+     * @param mixed $fbOrderId
+     * @param string $magentoShipmentId
+     * @param array $trackingInfo
+     * @return mixed|\Psr\Http\Message\ResponseInterface
+     * @throws GuzzleException
+     */
+    public function updateShipmentTracking($fbOrderId, $magentoShipmentId, $trackingInfo)
+    {
+        $request = [
+            'access_token' => $this->accessToken,
+            'idempotency_key' => $this->getUniqId(),
+            'external_shipment_id' => $magentoShipmentId,
+            'tracking_info' => json_encode($trackingInfo),
+        ];
+
+        $response = $this->callApi('POST', "{$fbOrderId}/update_shipment", $request);
+        return json_decode($response->getBody()->__toString(), true);
+    }
+
     /**
      * Cancel order
      *

app/code/Meta/Sales/Api/Data/FacebookOrderInterface.php

@@ -67,6 +67,22 @@ public function getChannel();
      */
     public function setChannel($channel);
 
+    /**
+     * Get synced shipment metadata
+     *
+     * @return array
+     */
+    public function getSyncedShipments();
+
+    /**
+     * Update synced shipment metadata
+     *
+     * @param mixed $magentoShipmentId
+     * @param array $trackingInfo
+     * @return $this
+     */
+    public function updateSyncedShipment($magentoShipmentId, $trackingInfo);
+
     /**
      * Get extra data
      *

app/code/Meta/Sales/Helper/OrderHelper.php

@@ -20,9 +20,9 @@
 
 namespace Meta\Sales\Helper;
 
-use Meta\Sales\Api\Data\FacebookOrderInterfaceFactory;
 use Magento\Sales\Api\Data\OrderExtensionFactory;
 use Magento\Sales\Api\Data\OrderInterface;
+use Meta\Sales\Api\Data\FacebookOrderInterfaceFactory;
 
 class OrderHelper
 {
@@ -48,33 +48,44 @@ public function __construct(
         $this->facebookOrderFactory = $facebookOrderFactory;
     }
 
+    public function loadFacebookOrderFromMagentoId($magentoOrderId)
+    {
+        /** @var \Meta\Sales\Api\Data\FacebookOrderInterface $facebookOrder */
+        $facebookOrder = $this->facebookOrderFactory->create();
+        $facebookOrder->load($magentoOrderId, 'magento_order_id');
+
+        return $facebookOrder;
+    }
+
     /**
      * Assign Meta order's extension attributes such as facebook_order_id to a Magento order
      *
      * @param OrderInterface $order
+     * @param bool $reload
      * @return void
      */
-    public function setFacebookOrderExtensionAttributes(OrderInterface $order)
+    public function setFacebookOrderExtensionAttributes(OrderInterface $order, bool $reload = false)
     {
         // if FB order ID present, do nothing
-        if ($order->getExtensionAttributes()->getFacebookOrderId()) {
+        if ($order->getExtensionAttributes()->getFacebookOrderId() && !$reload) {
             return;
         }
 
         /** @var \Meta\Sales\Api\Data\FacebookOrderInterface $facebookOrder */
-        $facebookOrder = $this->facebookOrderFactory->create();
-        $facebookOrder->load($order->getId(), 'magento_order_id');
+        $facebookOrder = $this->loadFacebookOrderFromMagentoId($order->getId());
 
         if (!$facebookOrder->getId()) {
             return;
         }
 
         $emailRemarketingOption = ($facebookOrder->getExtraData()['email_remarketing_option'] ?? false) === true;
+        $syncedShipments = $facebookOrder->getSyncedShipments();
 
         $extensionAttributes = $order->getExtensionAttributes() ?: $this->orderExtensionFactory->create();
         $extensionAttributes->setFacebookOrderId($facebookOrder->getFacebookOrderId())
             ->setChannel($facebookOrder->getChannel())
-            ->setEmailRemarketingOption($emailRemarketingOption);
+            ->setEmailRemarketingOption($emailRemarketingOption)
+            ->setSyncedShipments($syncedShipments);
         $order->setExtensionAttributes($extensionAttributes);
     }
 }

app/code/Meta/Sales/Model/FacebookOrder.php

@@ -20,9 +20,9 @@
 
 namespace Meta\Sales\Model;
 
+use Magento\Framework\Model\AbstractModel;
 use Meta\Sales\Api\Data\FacebookOrderInterface;
 use Meta\Sales\Model\ResourceModel\FacebookOrder as ResourceModel;
-use Magento\Framework\Model\AbstractModel;
 
 class FacebookOrder extends AbstractModel implements FacebookOrderInterface
 {
@@ -104,6 +104,32 @@ public function setChannel($channel)
         return $this;
     }
 
+    /**
+     * Get synced shipment metadata
+     *
+     * @return array
+     */
+    public function getSyncedShipments()
+    {
+        return json_decode($this->getData('synced_shipments') ?? '{}', true);
+    }
+
+    /**
+     * Update synced shipment metadata
+     *
+     * @param mixed $magentoShipmentId
+     * @param array $trackingInfo
+     * @return $this
+     */
+    public function updateSyncedShipment($magentoShipmentId, $trackingInfo)
+    {
+        $shipments = $this->getSyncedShipments();
+        $shipments[$magentoShipmentId] = self::encodeTrackingInfo($trackingInfo);
+        $this->setData('synced_shipments', json_encode($shipments));
+
+        return $this;
+    }
+
     /**
      * Get extra data
      *
@@ -125,4 +151,34 @@ public function setExtraData(array $extraData)
         $this->setData('extra_data', json_encode($extraData));
         return $this;
     }
+
+    /**
+     * Determine if the given shipment's tracking is not yet synced
+     *
+     * @param Order $order
+     * @param mixed $magentoShipmentId
+     * @param array $trackingInfo
+     * @return bool
+     */
+    public static function isSyncedShipmentOutOfSync($order, $magentoShipmentId, $trackingInfo)
+    {
+        $syncedShipments = $order->getExtensionAttributes()->getSyncedShipments();
+        if (!array_key_exists($magentoShipmentId, $syncedShipments)) {
+            return true;
+        }
+
+        $syncedShipment = $syncedShipments[$magentoShipmentId];
+        return $syncedShipment !== FacebookOrder::encodeTrackingInfo($trackingInfo);
+    }
+
+    /**
+     * Encoding the given tracking info for storage as metadata on a synced Shipment
+     *
+     * @param array $trackingInfo
+     * @return string
+     */
+    private static function encodeTrackingInfo($trackingInfo)
+    {
+        return $trackingInfo['carrier'] . '|' . $trackingInfo['tracking_number'];
+    }
 }