magento2-login-as-customer/issues/104: Global refactoring

- SaveAuthenticationDataInterface refactoring

Author: naydav

app/code/Magento/LoginAsCustomer/Api/CreateSecretInterface.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomer\Api;
+
+use Magento\Framework\Exception\LocalizedException;
+use Magento\LoginAsCustomer\Api\Data\AuthenticationDataInterface;
+
+/**
+ * Save authentication data. Return secret key
+ *
+ * @api
+ */
+interface SaveAuthenticationDataInterface
+{
+    /**
+     * Save authentication data. Return secret key
+     *
+     * @param Data\AuthenticationDataInterface $authenticationData
+     * @return string
+     * @throws LocalizedException
+     */
+    public function execute(AuthenticationDataInterface $authenticationData): string;
+}

app/code/Magento/LoginAsCustomer/Api/SaveAuthenticationDataInterface.php

@@ -10,12 +10,13 @@
 use Magento\Framework\App\ResourceConnection;
 use Magento\Framework\Stdlib\DateTime\DateTime;
 use Magento\Framework\Math\Random;
-use Magento\LoginAsCustomer\Api\CreateSecretInterface;
+use Magento\LoginAsCustomer\Api\Data\AuthenticationDataInterface;
+use Magento\LoginAsCustomer\Api\SaveAuthenticationDataInterface;
 
 /**
- * @api
+ * @inheritdoc
  */
-class CreateSecret implements CreateSecretInterface
+class SaveAuthenticationData implements SaveAuthenticationDataInterface
 {
     /**
      * @var ResourceConnection
@@ -34,6 +35,8 @@ class CreateSecret implements CreateSecretInterface
 
     /**
      * @param ResourceConnection $resourceConnection
+     * @param DateTime $dateTime
+     * @param Random $random
      */
     public function __construct(
         ResourceConnection $resourceConnection,
@@ -46,12 +49,9 @@ public function __construct(
     }
 
     /**
-     * Create a new secret key
-     * @return string
-     * @param int $customerId
-     * @param int $adminId
+     * @inheritdoc
      */
-    public function execute(int $customerId, int $adminId):string
+    public function execute(AuthenticationDataInterface $authenticationData): string
     {
         $connection = $this->resourceConnection->getConnection();
         $tableName = $this->resourceConnection->getTableName('login_as_customer');
@@ -61,13 +61,12 @@ public function execute(int $customerId, int $adminId):string
         $connection->insert(
             $tableName,
             [
-                'customer_id' => $customerId,
-                'admin_id' => $adminId,
+                'customer_id' => $authenticationData->getCustomerId(),
+                'admin_id' => $authenticationData->getAdminId(),
                 'secret' => $secret,
                 'created_at' => $this->dateTime->gmtDate(),
             ]
         );
-
         return $secret;
     }
 }

app/code/Magento/LoginAsCustomer/Model/ResourceModel/CreateSecret.php renamed to app/code/Magento/LoginAsCustomer/Model/ResourceModel/SaveAuthenticationData.php

@@ -7,7 +7,7 @@
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <preference for="Magento\LoginAsCustomer\Api\Data\AuthenticationDataInterface" type="Magento\LoginAsCustomer\Model\AuthenticationData"/>
-    <preference for="Magento\LoginAsCustomer\Api\CreateSecretInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\CreateSecret"/>
+    <preference for="Magento\LoginAsCustomer\Api\SaveAuthenticationDataInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\SaveAuthenticationData"/>
     <preference for="Magento\LoginAsCustomer\Api\GetAuthenticationDataBySecretInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\GetAuthenticationDataBySecret"/>
     <preference for="Magento\LoginAsCustomer\Api\AuthenticateCustomerInterface" type="Magento\LoginAsCustomer\Model\AuthenticateCustomer"/>
     <preference for="Magento\LoginAsCustomer\Api\DeleteAuthenticationDataBySecretInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\DeleteAuthenticationDataBySecret"/>

app/code/Magento/LoginAsCustomer/etc/di.xml

@@ -7,22 +7,28 @@
 
 namespace Magento\LoginAsCustomerUi\Controller\Adminhtml\Login;
 
+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\Controller\Result\Redirect;
+use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Controller\ResultInterface;
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\Action\HttpPostActionInterface;
-use Magento\Backend\App\Action;
 use Magento\Customer\Api\CustomerRepositoryInterface;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Message\ManagerInterface;
 use Magento\LoginAsCustomer\Api\ConfigInterface;
-use Magento\LoginAsCustomer\Api\CreateSecretInterface;
+use Magento\LoginAsCustomer\Api\Data\AuthenticationDataInterface;
+use Magento\LoginAsCustomer\Api\Data\AuthenticationDataInterfaceFactor;
+use Magento\LoginAsCustomer\Api\SaveAuthenticationDataInterface;
 
 /**
  * Login as customer action
  * Generate secret key and forward to the storefront action
  *
  * This action can be executed via GET request when "Store View To Login In" is disabled, and POST when it is enabled
  */
-class Login extends Action implements HttpGetActionInterface, HttpPostActionInterface
+class Login implements HttpGetActionInterface, HttpPostActionInterface
 {
     /**
      * Authorization level of a basic admin session
@@ -31,6 +37,21 @@ class Login extends Action implements HttpGetActionInterface, HttpPostActionInte
      */
     const ADMIN_RESOURCE = 'Magento_LoginAsCustomerUi::login_button';
 
+    /**
+     * @var ResultFactory
+     */
+    private $resultFactory;
+
+    /**
+     * @var RequestInterface
+     */
+    private $request;
+
+    /**
+     * @var ManagerInterface
+     */
+    private $messageManager;
+
     /**
      * @var \Magento\Backend\Model\Auth\Session
      */
@@ -57,58 +78,71 @@ class Login extends Action implements HttpGetActionInterface, HttpPostActionInte
     private $config;
 
     /**
-     * @var CreateSecretInterface
+     * @var AuthenticationDataInterfaceFactory
      */
-    private $createSecretProcessor;
+    private $authenticationDataFactory;
 
     /**
-     * Login constructor.
-     * @param \Magento\Backend\App\Action\Context $context
+     * @var SaveAuthenticationDataInterface
+     */
+    private $saveAuthenticationData;
+
+    /**
+     * @param ResultFactory $resultFactory
+     * @param RequestInterface $request
+     * @param ManagerInterface $messageManager
      * @param \Magento\Backend\Model\Auth\Session $authSession
      * @param \Magento\Store\Model\StoreManagerInterface $storeManager
      * @param \Magento\Framework\Url $url
      * @param CustomerRepositoryInterface $customerRepository
-     * @param ConfigInterface $config,
-     * @param CreateSecretInterface $createSecretProcessor
+     * @param ConfigInterface $config
+     * @param AuthenticationDataInterfaceFactory $authenticationDataFactory
+     * @param SaveAuthenticationDataInterface $saveAuthenticationData
      */
     public function __construct(
-        \Magento\Backend\App\Action\Context $context,
+        ResultFactory $resultFactory,
+        RequestInterface $request,
+        ManagerInterface $messageManager,
         \Magento\Backend\Model\Auth\Session $authSession,
         \Magento\Store\Model\StoreManagerInterface $storeManager,
         \Magento\Framework\Url $url,
         CustomerRepositoryInterface $customerRepository,
         ConfigInterface $config,
-        CreateSecretInterface $createSecretProcessor
+        AuthenticationDataInterfaceFactory $authenticationDataFactory,
+        SaveAuthenticationDataInterface $saveAuthenticationData
     ) {
-        parent::__construct($context);
+        $this->resultFactory = $resultFactory;
+        $this->request = $request;
+        $this->messageManager = $messageManager;
         $this->authSession = $authSession;
         $this->storeManager = $storeManager;
         $this->url = $url;
         $this->customerRepository = $customerRepository;
         $this->config = $config;
-        $this->createSecretProcessor = $createSecretProcessor;
+        $this->authenticationDataFactory = $authenticationDataFactory;
+        $this->saveAuthenticationData = $saveAuthenticationData;
     }
 
     /**
      * Login as customer
      *
      * @return ResultInterface
+     * @throws NoSuchEntityException
+     * @throws LocalizedException
      */
     public function execute(): ResultInterface
     {
-        /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
-        $resultRedirect = $this->resultRedirectFactory->create();
+        /** @var Redirect $resultRedirect */
+        $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
 
         if (!$this->config->isEnabled()) {
             $this->messageManager->addErrorMessage(__('Login As Customer is disabled.'));
             return $resultRedirect->setPath('customer/index/index');
         }
 
-        $request = $this->getRequest();
-
-        $customerId = (int) $request->getParam('customer_id');
+        $customerId = (int)$this->request->getParam('customer_id');
         if (!$customerId) {
-            $customerId = (int) $request->getParam('entity_id');
+            $customerId = (int)$this->request->getParam('entity_id');
         }
 
         try {
@@ -118,24 +152,46 @@ public function execute(): ResultInterface
             return $resultRedirect->setPath('customer/index/index');
         }
 
-        $customerStoreId = $request->getParam('store_id');
-        if (!isset($customerStoreId) && $this->config->isStoreManualChoiceEnabled()) {
+        $storeId = $this->request->getParam('store_id');
+        if (empty($storeId) && $this->config->isStoreManualChoiceEnabled()) {
             $this->messageManager->addNoticeMessage(__('Please select a Store View to login in.'));
-            return $resultRedirect->setPath('loginascustomer/login/manual', ['entity_id' => $customerId ]);
+            return $resultRedirect->setPath('loginascustomer/login/manual', ['customer_id' => $customerId]);
         }
 
+        $adminUser = $this->authSession->getUser();
+
+        /** @var AuthenticationDataInterface $authenticationData */
+        $authenticationData = $this->authenticationDataFactory->create(
+            [
+                'customerId' => $customerId,
+                'adminId' => (int)$adminUser->getId(),
+                'extensionAttributes' => null,
+            ]
+        );
+        $secret = $this->saveAuthenticationData->execute($authenticationData);
+
+        $redirectUrl = $this->getLoginProceedRedirectUrl($secret, $storeId);
+        $resultRedirect->setUrl($redirectUrl);
+        return $resultRedirect;
+    }
 
-        $user = $this->authSession->getUser();
-        $secret = $this->createSecretProcessor->execute($customerId, (int)$user->getId());
-
-        $store = $this->storeManager->getStore();
-        if (null === $store) {
+    /**
+     * @param string $secret
+     * @param int|null $storeId
+     * @return string
+     * @throws NoSuchEntityException
+     */
+    private function getLoginProceedRedirectUrl(string $secret, ?int $storeId): string
+    {
+        if (null === $storeId) {
             $store = $this->storeManager->getDefaultStoreView();
+        } else {
+            $store = $this->storeManager->getStore($storeId);
         }
 
-        $redirectUrl = $this->url->setScope($store)
+        $redirectUrl = $this->url
+            ->setScope($store)
             ->getUrl('loginascustomer/login/index', ['secret' => $secret, '_nosid' => true]);
-
-        return $resultRedirect->setUrl($redirectUrl);
+        return $redirectUrl;
     }
 }