Refactor \Order\Shipment\AddTrack Controller to use ResultInterface

Author: Jeroen

app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/AddTrack.php

@@ -1,12 +1,23 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Shipping\Controller\Adminhtml\Order\Shipment;
 
 use Magento\Backend\App\Action;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\Controller\ResultInterface;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Serialize\SerializerInterface;
+use Magento\Sales\Api\Data\ShipmentTrackInterfaceFactory;
+use Magento\Sales\Api\ShipmentRepositoryInterface;
+use Magento\Sales\Model\Order\Shipment\TrackFactory;
+use Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader;
 
 class AddTrack extends \Magento\Backend\App\Action
 {
@@ -18,56 +29,84 @@ class AddTrack extends \Magento\Backend\App\Action
     const ADMIN_RESOURCE = 'Magento_Sales::shipment';
 
     /**
-     * @var \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader
+     * @var ShipmentLoader
      */
     protected $shipmentLoader;
 
+    /**
+     * @var ShipmentRepositoryInterface
+     */
+    private $shipmentRepository;
+
+    /**
+     * @var TrackFactory
+     */
+    private $trackFactory;
+
+    /**
+     * @var SerializerInterface
+     */
+    private $serializer;
+
     /**
      * @param Action\Context $context
-     * @param \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader
+     * @param ShipmentLoader $shipmentLoader
+     * @param ShipmentRepositoryInterface|null $shipmentRepository
+     * @param TrackFactory|null $trackFactory
+     * @param SerializerInterface|null $serializer
      */
     public function __construct(
         Action\Context $context,
-        \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader $shipmentLoader
+        ShipmentLoader $shipmentLoader,
+        ShipmentRepositoryInterface $shipmentRepository = null,
+        TrackFactory $trackFactory = null,
+        SerializerInterface $serializer = null
     ) {
-        $this->shipmentLoader = $shipmentLoader;
         parent::__construct($context);
+
+        $this->shipmentLoader = $shipmentLoader;
+        $this->shipmentRepository = $shipmentRepository ?: ObjectManager::getInstance()
+            ->get(ShipmentRepositoryInterface::class);
+        $this->trackFactory = $trackFactory ?: ObjectManager::getInstance()
+            ->get(ShipmentTrackInterfaceFactory::class);
+        $this->serializer = $serializer ?: ObjectManager::getInstance()
+            ->get(SerializerInterface::class);
     }
 
     /**
-     * Add new tracking number action
+     * Add new tracking number action.
      *
-     * @return void
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @return ResultInterface
      */
-    public function execute()
+    public function execute(): ResultInterface
     {
         try {
             $carrier = $this->getRequest()->getPost('carrier');
             $number = $this->getRequest()->getPost('number');
             $title = $this->getRequest()->getPost('title');
+
             if (empty($carrier)) {
-                throw new \Magento\Framework\Exception\LocalizedException(__('Please specify a carrier.'));
+                throw new LocalizedException(__('Please specify a carrier.'));
             }
             if (empty($number)) {
-                throw new \Magento\Framework\Exception\LocalizedException(__('Please enter a tracking number.'));
+                throw new LocalizedException(__('Please enter a tracking number.'));
             }
+
             $this->shipmentLoader->setOrderId($this->getRequest()->getParam('order_id'));
             $this->shipmentLoader->setShipmentId($this->getRequest()->getParam('shipment_id'));
             $this->shipmentLoader->setShipment($this->getRequest()->getParam('shipment'));
             $this->shipmentLoader->setTracking($this->getRequest()->getParam('tracking'));
             $shipment = $this->shipmentLoader->load();
             if ($shipment) {
-                $track = $this->_objectManager->create(
-                    \Magento\Sales\Model\Order\Shipment\Track::class
-                )->setNumber(
+                $track = $this->trackFactory->create()->setNumber(
                     $number
                 )->setCarrierCode(
                     $carrier
                 )->setTitle(
                     $title
                 );
-                $shipment->addTrack($track)->save();
+                $shipment->addTrack($track);
+                $this->shipmentRepository->save($shipment);
 
                 $this->_view->loadLayout();
                 $this->_view->getPage()->getConfig()->getTitle()->prepend(__('Shipments'));
@@ -78,16 +117,18 @@ public function execute()
                     'message' => __('We can\'t initialize shipment for adding tracking number.'),
                 ];
             }
-        } catch (\Magento\Framework\Exception\LocalizedException $e) {
+        } catch (LocalizedException $e) {
             $response = ['error' => true, 'message' => $e->getMessage()];
         } catch (\Exception $e) {
             $response = ['error' => true, 'message' => __('Cannot add tracking number.')];
         }
-        if (is_array($response)) {
-            $response = $this->_objectManager->get(\Magento\Framework\Json\Helper\Data::class)->jsonEncode($response);
-            $this->getResponse()->representJson($response);
-        } else {
-            $this->getResponse()->setBody($response);
+
+        if (\is_array($response)) {
+            $response = $this->serializer->serialize($response);
+
+            return $this->resultFactory->create(ResultFactory::TYPE_JSON)->setJsonData($response);
         }
+
+        return $this->resultFactory->create(ResultFactory::TYPE_RAW)->setContents($response);
     }
 }