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

- \Magento\LoginAsCustomer\Api\DeleteAuthenticationDataBySecretInterface refactoring

Author: naydav

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

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomer\Api;
+
+/**
+ * Delete authentication data by secret
+ *
+ * @api
+ */
+interface DeleteAuthenticationDataBySecretInterface
+{
+    /**
+     * Delete authentication data by secret
+     *
+     * @param string $secret
+     * @return void
+     */
+    public function execute(string $secret): void;
+}

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

@@ -8,12 +8,12 @@
 namespace Magento\LoginAsCustomer\Model\ResourceModel;
 
 use Magento\Framework\App\ResourceConnection;
-use Magento\LoginAsCustomer\Api\DeleteSecretInterface;
+use Magento\LoginAsCustomer\Api\DeleteAuthenticationDataBySecretInterface;
 
 /**
- * @api
+ * @inheritdoc
  */
-class DeleteSecret implements DeleteSecretInterface
+class DeleteAuthenticationDataBySecret implements DeleteAuthenticationDataBySecretInterface
 {
     /**
      * @var ResourceConnection
@@ -30,17 +30,17 @@ public function __construct(
     }
 
     /**
-     * Delete old secret key records
+     * @inheritdoc
      */
-    public function execute(string $secretKey):void
+    public function execute(string $secret): void
     {
         $connection = $this->resourceConnection->getConnection();
         $tableName = $this->resourceConnection->getTableName('login_as_customer');
 
         $connection->delete(
             $tableName,
             [
-                'secret = ?' => $secretKey
+                'secret = ?' => $secret
             ]
         );
     }

app/code/Magento/LoginAsCustomer/Model/ResourceModel/DeleteSecret.php renamed to app/code/Magento/LoginAsCustomer/Model/ResourceModel/DeleteAuthenticationDataBySecret.php

@@ -10,7 +10,7 @@
     <preference for="Magento\LoginAsCustomer\Api\CreateSecretInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\CreateSecret" />
     <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\DeleteSecretInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\DeleteSecret" />
+    <preference for="Magento\LoginAsCustomer\Api\DeleteAuthenticationDataBySecretInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\DeleteAuthenticationDataBySecret" />
     <preference for="Magento\LoginAsCustomer\Api\DeleteOutdatedSecretsInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\DeleteOutdatedSecrets" />
     <preference for="Magento\LoginAsCustomer\Api\ConfigInterface" type="Magento\LoginAsCustomer\Model\Config" />
 </config>

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

@@ -19,7 +19,7 @@
 use Psr\Log\LoggerInterface;
 use Magento\LoginAsCustomer\Api\GetAuthenticationDataBySecretInterface;
 use Magento\LoginAsCustomer\Api\AuthenticateCustomerInterface;
-use Magento\LoginAsCustomer\Api\DeleteSecretInterface;
+use Magento\LoginAsCustomer\Api\DeleteAuthenticationDataBySecretInterface;
 
 /**
  * Login As Customer storefront login action
@@ -52,9 +52,9 @@ class Index implements HttpGetActionInterface
     private $authenticateCustomer;
 
     /**
-     * @var DeleteSecretInterface
+     * @var DeleteAuthenticationDataBySecretInterface
      */
-    private $deleteSecretProcessor;
+    private $deleteAuthenticationDataBySecret;
 
     /**
      * @var ManagerInterface
@@ -72,7 +72,7 @@ class Index implements HttpGetActionInterface
      * @param CustomerRepositoryInterface $customerRepository
      * @param GetAuthenticationDataBySecretInterface $getAuthenticateDataProcessor
      * @param AuthenticateCustomerInterface $authenticateCustomerProcessor
-     * @param DeleteSecretInterface $deleteSecretProcessor
+     * @param DeleteAuthenticationDataBySecretInterface $deleteSecretProcessor
      * @param ManagerInterface $messageManager
      * @param LoggerInterface $logger
      */
@@ -82,7 +82,7 @@ public function __construct(
         CustomerRepositoryInterface $customerRepository,
         GetAuthenticationDataBySecretInterface $getAuthenticateDataProcessor,
         AuthenticateCustomerInterface $authenticateCustomerProcessor,
-        DeleteSecretInterface $deleteSecretProcessor,
+        DeleteAuthenticationDataBySecretInterface $deleteSecretProcessor,
         ManagerInterface $messageManager,
         LoggerInterface $logger
     ) {
@@ -91,7 +91,7 @@ public function __construct(
         $this->customerRepository = $customerRepository;
         $this->getAuthenticationDataBySecret = $getAuthenticateDataProcessor;
         $this->authenticateCustomer = $authenticateCustomerProcessor;
-        $this->deleteSecretProcessor = $deleteSecretProcessor;
+        $this->deleteAuthenticationDataBySecret = $deleteSecretProcessor;
         $this->messageManager = $messageManager;
         $this->logger = $logger;
     }
@@ -108,30 +108,21 @@ public function execute(): ResultInterface
 
         try {
             $secret = $this->request->getParam('secret');
-            if (!$secret || !is_string($secret)) {
+            if (empty($secret) || !is_string($secret)) {
                 throw new LocalizedException(__('Cannot login to account. No secret key provided.'));
             }
 
             $authenticateData = $this->getAuthenticationDataBySecret->execute($secret);
 
-            $this->deleteSecretProcessor->execute($secret);
+            $this->deleteAuthenticationDataBySecret->execute($secret);
 
             try {
                 $customer = $this->customerRepository->getById($authenticateData->getCustomerId());
             } catch (NoSuchEntityException $e) {
                 throw new LocalizedException(__('Customer are no longer exist.'));
             }
 
-            $loggedIn = $this->authenticateCustomer->execute(
-                $authenticateData->getCustomerId(),
-                $authenticateData->getAdminId()
-            );
-
-
-            if (!$loggedIn) {
-                throw new LocalizedException(__('Login was not successful.'));
-            }
-
+            $this->authenticateCustomer->execute($authenticateData);
 
             $this->messageManager->addSuccessMessage(
                 __('You are logged in as customer: %1', $customer->getFirstname() . ' ' . $customer->getLastname())