Merge pull request #100 from swlodarski-sumoheavy/9.2.x

Update BPRedirect to always return ResultInterface

Author: p-maguire

Diff for: Model/BPRedirect.php

@@ -3,24 +3,15 @@
 
 use Bitpay\BPCheckout\Logger\Logger;
 use Magento\Checkout\Model\Session;
-use Magento\Framework\App\Action\Action;
-use Magento\Framework\App\ActionFlag;
-use Magento\Framework\App\Response\RedirectInterface;
-use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\DataObject;
-use Magento\Framework\Event\Observer;
-use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\Message\Manager;
 use Magento\Framework\Registry;
-use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\UrlInterface;
-use Magento\Framework\View\Result\Page;
 use Magento\Sales\Api\Data\OrderInterface;
-use Magento\Framework\App\ResponseFactory;
-use Magento\Framework\View\Result\PageFactory;
-use Magento\Sales\Model\Order;
+use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\Controller\ResultInterface;
 use Magento\Sales\Model\OrderRepository;
 
 /**
@@ -31,72 +22,60 @@
 class BPRedirect
 {
     protected Session $checkoutSession;
-    protected RedirectInterface $redirect;
-    protected ResponseInterface $response;
     protected OrderInterface $orderInterface;
     protected TransactionRepository $transactionRepository;
     protected Config $config;
-    protected ResponseFactory $responseFactory;
     protected Invoice $invoice;
     protected Manager $messageManager;
     protected Registry $registry;
     protected UrlInterface $url;
     protected Logger $logger;
-    protected PageFactory $resultPageFactory;
+    protected ResultFactory $resultFactory;
     protected Client $client;
     protected OrderRepository $orderRepository;
     protected BitpayInvoiceRepository $bitpayInvoiceRepository;
 
     /**
      * @param Session $checkoutSession
-     * @param RedirectInterface $redirect
-     * @param ResponseInterface $response
      * @param OrderInterface $orderInterface
      * @param \Bitpay\BPCheckout\Model\Config $config
      * @param \Bitpay\BPCheckout\Model\TransactionRepository $transactionRepository
-     * @param ResponseFactory $responseFactory
      * @param \Bitpay\BPCheckout\Model\Invoice $invoice
      * @param Manager $messageManager
      * @param Registry $registry
      * @param UrlInterface $url
      * @param Logger $logger
-     * @param PageFactory $resultPageFactory
+     * @param ResultFactory $resultFactory
      * @param Client $client
      * @param OrderRepository $orderRepository
      * @param BitpayInvoiceRepository $bitpayInvoiceRepository
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         Session $checkoutSession,
-        RedirectInterface $redirect,
-        ResponseInterface $response,
         OrderInterface $orderInterface,
         Config $config,
         TransactionRepository $transactionRepository,
-        ResponseFactory $responseFactory,
         Invoice $invoice,
         Manager $messageManager,
         Registry $registry,
         UrlInterface $url,
         Logger $logger,
-        PageFactory $resultPageFactory,
+        ResultFactory $resultFactory,
         Client $client,
         OrderRepository $orderRepository,
         BitpayInvoiceRepository $bitpayInvoiceRepository
     ) {
         $this->checkoutSession = $checkoutSession;
-        $this->redirect = $redirect;
-        $this->response = $response;
         $this->orderInterface = $orderInterface;
         $this->config = $config;
         $this->transactionRepository = $transactionRepository;
-        $this->responseFactory = $responseFactory;
         $this->invoice = $invoice;
         $this->messageManager = $messageManager;
         $this->registry = $registry;
         $this->url = $url;
         $this->logger = $logger;
-        $this->resultPageFactory = $resultPageFactory;
+        $this->resultFactory = $resultFactory;
         $this->client = $client;
         $this->orderRepository = $orderRepository;
         $this->bitpayInvoiceRepository = $bitpayInvoiceRepository;
@@ -105,23 +84,29 @@ public function __construct(
     /**
      * Create bitpay invoice after order creation during redirect to success page
      *
-     * @return Page|void
+     * @return ResultInterface
      * @throws LocalizedException
      * @throws NoSuchEntityException|\Exception
      */
-    public function execute()
+    public function execute(): ResultInterface
     {
         $orderId = $this->checkoutSession->getData('last_order_id');
         if (!$orderId) {
-            $this->response->setRedirect($this->url->getUrl('checkout/cart'))->sendResponse();
-            return;
+            return $this->resultFactory->create(\Magento\Framework\Controller\ResultFactory::TYPE_REDIRECT)
+                ->setUrl($this->url->getUrl('checkout/cart'));
         }
 
         $order = $this->orderInterface->load($orderId);
         $incrementId = $order->getIncrementId();
+        if (!$incrementId) {
+            return $this->resultFactory->create(\Magento\Framework\Controller\ResultFactory::TYPE_REDIRECT)
+                ->setUrl($this->url->getUrl('checkout/cart'));
+        }
         $baseUrl = $this->config->getBaseUrl();
         if ($order->getPayment()->getMethodInstance()->getCode() !== Config::BITPAY_PAYMENT_METHOD_NAME) {
-            return $this->resultPageFactory->create();
+            return $this->resultFactory->create(
+                \Magento\Framework\Controller\ResultFactory::TYPE_PAGE
+            );
         }
 
         try {
@@ -142,29 +127,30 @@ public function execute()
                 $invoice->getAcceptanceWindow()
             );
             $this->transactionRepository->add($incrementId, $invoiceID, 'new');
-        } catch (\Exception $exception) {
-            $this->deleteOrderAndRedirectToCart($exception, $order);
 
-            return;
-        } catch (\Error $error) {
-            $this->deleteOrderAndRedirectToCart($error, $order);
+            switch ($modal) {
+                case true:
+                case 1:
+                    #set some info for guest checkout
+                    $this->setSessionCustomerData($billingAddressData, $order->getCustomerEmail(), $incrementId);
 
-            return;
-        }
+                    $redirectUrl = $this->url->getUrl('bitpay-invoice', ['_query' => ['invoiceID' => $invoiceID, 'order_id' => $incrementId, 'm' => 1]]);
 
-        switch ($modal) {
-            case true:
-            case 1:
-                #set some info for guest checkout
-                $this->setSessionCustomerData($billingAddressData, $order->getCustomerEmail(), $incrementId);
-                $RedirectUrl = $baseUrl . 'bitpay-invoice/?invoiceID=' . $invoiceID . '&order_id='
-                    . $incrementId . '&m=1';
-                $this->responseFactory->create()->setRedirect($RedirectUrl)->sendResponse();
-                break;
-            case false:
-            default:
-                $this->redirect->redirect($this->response, $invoice->getUrl());
-                break;
+                    return $this->resultFactory->create(
+                            \Magento\Framework\Controller\ResultFactory::TYPE_REDIRECT
+                        )
+                        ->setUrl($redirectUrl);
+                case false:
+                default:
+                    return $this->resultFactory->create(
+                        \Magento\Framework\Controller\ResultFactory::TYPE_REDIRECT
+                    )
+                    ->setUrl($invoice->getUrl());
+            }
+        } catch (\Exception $exception) {
+            return $this->deleteOrderAndRedirectToCart($exception, $order);
+        } catch (\Error $error) {
+            return $this->deleteOrderAndRedirectToCart($error, $order);
         }
     }
 
@@ -194,7 +180,7 @@ private function setSessionCustomerData(array $billingAddressData, string $email
      * @return void
      * @throws \Exception
      */
-    private function setToPendingAndOverrideMagentoStatus(OrderInterface $order): Order
+    private function setToPendingAndOverrideMagentoStatus(OrderInterface $order): OrderInterface
     {
         $order->setState('new', true);
         $order_status = $this->config->getBPCheckoutOrderStatus();
@@ -246,13 +232,18 @@ private function getParams(
      * @return void
      * @throws \Exception
      */
-    private function deleteOrderAndRedirectToCart($exception, OrderInterface $order): void
+    private function deleteOrderAndRedirectToCart($exception, OrderInterface $order): ResultInterface
     {
         $this->logger->error($exception->getMessage());
         $this->registry->register('isSecureArea', 'true');
         $order->delete();
         $this->registry->unregister('isSecureArea');
         $this->messageManager->addErrorMessage('We are unable to place your Order at this time');
-        $this->responseFactory->create()->setRedirect($this->url->getUrl('checkout/cart'))->sendResponse();
+
+        return $this->resultFactory->create(
+                \Magento\Framework\Controller\ResultFactory::TYPE_REDIRECT
+            )
+            ->setUrl($this->url->getUrl('checkout/cart'));
+
     }
 }

Diff for: Test/Integration/Model/BPRedirectTest.php

@@ -18,8 +18,6 @@
 use Bitpay\BPCheckout\Model\TransactionRepository;
 use Magento\Framework\App\Action\Action;
 use Magento\Framework\App\ActionFlag;
-use Magento\Framework\App\Response\RedirectInterface;
-use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\DataObject;
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
@@ -29,8 +27,7 @@
 use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\UrlInterface;
 use Magento\Sales\Api\Data\OrderInterface;
-use Magento\Framework\App\ResponseFactory;
-use Magento\Framework\View\Result\PageFactory;
+use Magento\Framework\Controller\ResultFactory;
 use Magento\Sales\Model\OrderRepository;
 use Magento\TestFramework\Helper\Bootstrap;
 use PHPUnit\Framework\TestCase;
@@ -56,16 +53,6 @@ class BPRedirectTest extends TestCase
      */
     private $checkoutSession;
 
-    /**
-     * @var RedirectInterface $redirect
-     */
-    private $redirect;
-
-    /**
-     * @var ResponseInterface $response
-     */
-    private $response;
-
     /**
      * @var OrderInterface $orderInterface
      */
@@ -81,11 +68,6 @@ class BPRedirectTest extends TestCase
      */
     private $transactionRepository;
 
-    /**
-     * @var ResponseFactory $responseFactory
-     */
-    private $responseFactory;
-
     /**
      * @var Invoice|MockObject $invoice
      */
@@ -112,9 +94,9 @@ class BPRedirectTest extends TestCase
     private $logger;
 
     /**
-     * @var PageFactory $resultPageFactory
+     * @var ResultFactory $resultFactory
      */
-    private $resultPageFactory;
+    private $resultFactory;
     /**
      * @var Client $client
      */
@@ -134,36 +116,30 @@ public function setUp(): void
     {
         $this->objectManager =  Bootstrap::getObjectManager();
         $this->checkoutSession = $this->objectManager->get(Session::class);
-        $this->redirect = $this->objectManager->get(RedirectInterface::class);
-        $this->response = $this->objectManager->get(ResponseInterface::class);
         $this->orderInterface = $this->objectManager->get(OrderInterface::class);
         $this->config = $this->objectManager->get(Config::class);
         $this->transactionRepository = $this->objectManager->get(TransactionRepository::class);
-        $this->responseFactory = $this->objectManager->get(ResponseFactory::class);
         $this->invoice = $this->getMockBuilder(Invoice::class)->disableOriginalConstructor()->getMock();
         $this->messageManager = $this->objectManager->get(Manager::class);
         $this->registry = $this->objectManager->get(Registry::class);
         $this->url = $this->objectManager->get(UrlInterface::class);
         $this->logger = $this->objectManager->get(Logger::class);
-        $this->resultPageFactory = $this->objectManager->get(PageFactory::class);
+        $this->resultFactory = $this->objectManager->get(ResultFactory::class);
         $this->client = $this->getMockBuilder(Client::class)->disableOriginalConstructor()->getMock();
         $this->orderRepository = $this->objectManager->get(OrderRepository::class);
         $this->bitpayInvoiceRepository = $this->objectManager->get(BitpayInvoiceRepository::class);
 
         $this->bpRedirect = new BPRedirect(
             $this->checkoutSession,
-            $this->redirect,
-            $this->response,
             $this->orderInterface,
             $this->config,
             $this->transactionRepository,
-            $this->responseFactory,
             $this->invoice,
             $this->messageManager,
             $this->registry,
             $this->url,
             $this->logger,
-            $this->resultPageFactory,
+            $this->resultFactory,
             $this->client,
             $this->orderRepository,
             $this->bitpayInvoiceRepository