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

- Introduce Magento\LoginAsCustomer\Api\Data\AuthenticationDataInterface

Author: naydav

app/code/Magento/LoginAsCustomer/Api/Data/AuthenticationDataInterface.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomer\Api\Data;
+
+use Magento\Framework\Api\ExtensibleDataInterface;
+
+/**
+ * Authentication data
+ *
+ * @api
+ */
+interface AuthenticationDataInterface extends ExtensibleDataInterface
+{
+    /**
+     * Get Customer Id
+     *
+     * @return int
+     */
+    public function getCustomerId(): int;
+
+    /**
+     * Get Admin Id
+     *
+     * @return int
+     */
+    public function getAdminId(): int;
+
+    /**
+     * @inheritdoc
+     */
+    public function getExtensionAttributes(): ?AuthenticationDataExtensionInterface;
+}

app/code/Magento/LoginAsCustomer/Api/GetAuthenticateDataInterface.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;
+
+/**
+ * Get authentication data by secret
+ *
+ * @api
+ */
+interface GetAuthenticationDataBySecretInterface
+{
+    /**
+     * Load login details based on secret key
+     *
+     * @param string $secretKey
+     * @return AuthenticationDataInterface
+     * @throws LocalizedException
+     */
+    public function execute(string $secretKey): AuthenticationDataInterface;
+}

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

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomer\Model;
+
+use Magento\LoginAsCustomer\Api\Data\AuthenticationDataInterface;
+use Magento\LoginAsCustomer\Api\Data\AuthenticationDataExtensionInterface;
+
+/**
+ * @inheritdoc
+ */
+class AuthenticationData implements AuthenticationDataInterface
+{
+    /**
+     * @var int
+     */
+    private $customerId;
+
+    /**
+     * @var int
+     */
+    private $adminId;
+
+    /**
+     * @var AuthenticationDataExtensionInterface|null
+     */
+    private $extensionAttributes;
+
+    /**
+     * @param int $customerId
+     * @param int $adminId
+     * @param AuthenticationDataExtensionInterface|null $extensionAttributes
+     */
+    public function __construct(
+        int $customerId,
+        int $adminId,
+        AuthenticationDataExtensionInterface $extensionAttributes = null
+    ) {
+        $this->customerId = $customerId;
+        $this->adminId = $adminId;
+        $this->extensionAttributes = $extensionAttributes;
+    }
+
+    /**
+     * @return int
+     */
+    public function getCustomerId(): int
+    {
+        return $this->customerId;
+    }
+
+    /**
+     * @return int
+     */
+    public function getAdminId(): int
+    {
+        return $this->adminId;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getExtensionAttributes(): ?AuthenticationDataExtensionInterface
+    {
+        return $this->extensionAttributes;
+    }
+}

app/code/Magento/LoginAsCustomer/Model/AuthenticationData.php

@@ -11,12 +11,14 @@
 use Magento\Framework\Stdlib\DateTime\DateTime;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\LoginAsCustomer\Api\ConfigInterface;
-use Magento\LoginAsCustomer\Api\GetAuthenticateDataInterface;
+use Magento\LoginAsCustomer\Api\Data\AuthenticationDataInterface;
+use Magento\LoginAsCustomer\Api\Data\AuthenticationDataInterfaceFactor;
+use Magento\LoginAsCustomer\Api\GetAuthenticationDataBySecretInterface;
 
 /**
- * @api
+ * @inheritdoc
  */
-class GetAuthenticateData implements GetAuthenticateDataInterface
+class GetAuthenticationDataBySecret implements GetAuthenticationDataBySecretInterface
 {
     /**
      * @var ResourceConnection
@@ -33,28 +35,33 @@ class GetAuthenticateData implements GetAuthenticateDataInterface
      */
     private $config;
 
+    /**
+     * @var AuthenticationDataInterfaceFactor
+     */
+    private $authenticationDataFactory;
+
     /**
      * @param ResourceConnection $resourceConnection
      * @param DateTime $dateTime
      * @param ConfigInterface $config
+     * @param AuthenticationDataInterfaceFactory $authenticationDataFactory
      */
     public function __construct(
         ResourceConnection $resourceConnection,
         DateTime $dateTime,
-        ConfigInterface $config
+        ConfigInterface $config,
+        AuthenticationDataInterfaceFactory $authenticationDataFactory
     ) {
         $this->resourceConnection = $resourceConnection;
         $this->dateTime = $dateTime;
         $this->config = $config;
+        $this->authenticationDataFactory = $authenticationDataFactory;
     }
 
     /**
-     * Load logic details based on secret key
-     * @return array
-     * @throws LocalizedException
-     * @param string $secretKey
+     * @inheritdoc
      */
-    public function execute(string $secretKey):array
+    public function execute(string $secretKey): AuthenticationDataInterface
     {
         $connection = $this->resourceConnection->getConnection();
         $tableName = $this->resourceConnection->getTableName('login_as_customer');
@@ -64,16 +71,22 @@ public function execute(string $secretKey):array
         $select = $connection->select()
             ->from(['main_table' => $tableName])
             ->where('main_table.secret = ?', $secretKey)
-            ->where('main_table.created_at > ?', $timePoint)
-            ->limit(1);
+            ->where('main_table.created_at > ?', $timePoint);
 
         $data = $connection->fetchRow($select);
 
         if (!$data) {
-            throw new LocalizedException(__('Secret key is not valid.'));
+            throw new LocalizedException(__('Secret key is not found or was expired.'));
         }
 
-
-        return $data;
+        /** @var AuthenticationDataInterface $authenticationData */
+        $authenticationData = $this->authenticationDataFactory->create(
+            [
+                'customerId' => (int)$data['admin_id'],
+                'adminId' => (int)$data['customer_id'],
+                'extensionAttributes' => null,
+            ]
+        );
+        return $authenticationData;
     }
 }

app/code/Magento/LoginAsCustomer/Model/ResourceModel/GetAuthenticateData.php renamed to app/code/Magento/LoginAsCustomer/Model/ResourceModel/GetAuthenticationDataBySecret.php

@@ -6,8 +6,9 @@
  */
 -->
 <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\GetAuthenticateDataInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\GetAuthenticateData" />
+    <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\DeleteOutdatedSecretsInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\DeleteOutdatedSecrets" />

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

@@ -17,7 +17,7 @@
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\Message\ManagerInterface;
 use Psr\Log\LoggerInterface;
-use Magento\LoginAsCustomer\Api\GetAuthenticateDataInterface;
+use Magento\LoginAsCustomer\Api\GetAuthenticationDataBySecretInterface;
 use Magento\LoginAsCustomer\Api\AuthenticateCustomerInterface;
 use Magento\LoginAsCustomer\Api\DeleteSecretInterface;
 
@@ -42,14 +42,14 @@ class Index implements HttpGetActionInterface
     private $customerRepository;
 
     /**
-     * @var GetAuthenticateDataInterface
+     * @var GetAuthenticationDataBySecretInterface
      */
-    private $getAuthenticateDataProcessor;
+    private $getAuthenticationDataBySecret;
 
     /**
      * @var AuthenticateCustomerInterface
      */
-    private $authenticateCustomerProcessor;
+    private $authenticateCustomer;
 
     /**
      * @var DeleteSecretInterface
@@ -70,7 +70,7 @@ class Index implements HttpGetActionInterface
      * @param ResultFactory $resultFactory
      * @param RequestInterface $request
      * @param CustomerRepositoryInterface $customerRepository
-     * @param GetAuthenticateDataInterface $getAuthenticateDataProcessor
+     * @param GetAuthenticationDataBySecretInterface $getAuthenticateDataProcessor
      * @param AuthenticateCustomerInterface $authenticateCustomerProcessor
      * @param DeleteSecretInterface $deleteSecretProcessor
      * @param ManagerInterface $messageManager
@@ -80,7 +80,7 @@ public function __construct(
         ResultFactory $resultFactory,
         RequestInterface $request,
         CustomerRepositoryInterface $customerRepository,
-        GetAuthenticateDataInterface $getAuthenticateDataProcessor,
+        GetAuthenticationDataBySecretInterface $getAuthenticateDataProcessor,
         AuthenticateCustomerInterface $authenticateCustomerProcessor,
         DeleteSecretInterface $deleteSecretProcessor,
         ManagerInterface $messageManager,
@@ -89,8 +89,8 @@ public function __construct(
         $this->resultFactory = $resultFactory;
         $this->request = $request;
         $this->customerRepository = $customerRepository;
-        $this->getAuthenticateDataProcessor = $getAuthenticateDataProcessor;
-        $this->authenticateCustomerProcessor = $authenticateCustomerProcessor;
+        $this->getAuthenticationDataBySecret = $getAuthenticateDataProcessor;
+        $this->authenticateCustomer = $authenticateCustomerProcessor;
         $this->deleteSecretProcessor = $deleteSecretProcessor;
         $this->messageManager = $messageManager;
         $this->logger = $logger;
@@ -112,20 +112,19 @@ public function execute(): ResultInterface
                 throw new LocalizedException(__('Cannot login to account. No secret key provided.'));
             }
 
-            /* Can throw LocalizedException */
-            $authenticateData = $this->getAuthenticateDataProcessor->execute($secret);
+            $authenticateData = $this->getAuthenticationDataBySecret->execute($secret);
 
             $this->deleteSecretProcessor->execute($secret);
 
             try {
-                $customer = $this->customerRepository->getById($authenticateData['customer_id']);
+                $customer = $this->customerRepository->getById($authenticateData->getCustomerId());
             } catch (NoSuchEntityException $e) {
                 throw new LocalizedException(__('Customer are no longer exist.'));
             }
 
-            $loggedIn = $this->authenticateCustomerProcessor->execute(
-                (int)$authenticateData['customer_id'],
-                (int)$authenticateData['admin_id']
+            $loggedIn = $this->authenticateCustomer->execute(
+                $authenticateData->getCustomerId(),
+                $authenticateData->getAdminId()
             );