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

- Introduce Magento\LoginAsCustomer\Api\ConfigInterface

Author: naydav

app/code/Magento/LoginAsCustomer/Api/ConfigInterface.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;
+
+/**
+ * LoginAsCustomer config
+ *
+ * @api
+ */
+interface ConfigInterface
+{
+    /**
+     * Check if Login As Customer extension is enabled
+     *
+     * @return bool
+     */
+    public function isEnabled(): bool;
+
+    /**
+     * Check if store view manual choice is enabled
+     *
+     * @return bool
+     */
+    public function isStoreManualChoiceEnabled(): bool;
+
+    /**
+     * Gte secrets expiration time (in seconds)
+     *
+     * @return int
+     */
+    public function getSecretExpirationTime(): int;
+}

app/code/Magento/LoginAsCustomer/Api/DeleteOldSecretsInterface.php renamed to app/code/Magento/LoginAsCustomer/Api/DeleteOutdatedSecretsInterface.php

@@ -8,12 +8,14 @@
 namespace Magento\LoginAsCustomer\Api;
 
 /**
+ * Delete outdated secret records
+ *
  * @api
  */
-interface DeleteOldSecretsInterface
+interface DeleteOutdatedSecretsInterface
 {
     /**
-     * Delete old secret key records
+     * Delete outdated secret records
      */
-    public function execute():void;
+    public function execute(): void;
 }

app/code/Magento/LoginAsCustomer/Cron/DeleteOldSecrets.php renamed to app/code/Magento/LoginAsCustomer/Cron/DeleteOutdatedSecrets.php

@@ -7,32 +7,31 @@
 
 namespace Magento\LoginAsCustomer\Cron;
 
-use Magento\LoginAsCustomer\Api\DeleteOldSecretsInterface;
-use Magento\LoginAsCustomer\Model\Config;
+use Magento\LoginAsCustomer\Api\ConfigInterface;
+use Magento\LoginAsCustomer\Api\DeleteOutdatedSecretsInterface;
 
 /**
  * @api
  */
-class DeleteOldSecrets implements DeleteOldSecretsInterface
+class DeleteOutdatedSecrets implements DeleteOutdatedSecretsInterface
 {
     /**
-     * @var DeleteOldSecretsInterface
+     * @var DeleteOutdatedSecretsInterface
      */
     private $deleteOldSecretsProcessor;
 
     /**
-     * @var Config
+     * @var ConfigInterface
      */
     private $config;
 
     /**
-     * DeleteOldSecrets constructor.
-     * @param DeleteOldSecretsInterface $deleteOldSecretsProcessor
-     * @param Config $config
+     * @param DeleteOutdatedSecretsInterface $deleteOldSecretsProcessor
+     * @param ConfigInterface $config
      */
     public function __construct(
-        DeleteOldSecretsInterface $deleteOldSecretsProcessor,
-        Config $config
+        DeleteOutdatedSecretsInterface $deleteOldSecretsProcessor,
+        ConfigInterface $config
     ) {
         $this->deleteOldSecretsProcessor = $deleteOldSecretsProcessor;
         $this->config = $config;

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

@@ -8,70 +8,56 @@
 namespace Magento\LoginAsCustomer\Model;
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
-use Magento\Framework\App\ProductMetadataInterface;
-use Magento\Store\Model\ScopeInterface;
+use Magento\LoginAsCustomer\Api\ConfigInterface;
 
 /**
- * LoginAsCustomer module config model.
+ * @inheritdoc
  */
-class Config
+class Config implements ConfigInterface
 {
     /**
      * Extension config path
      */
-    private const XML_PATH_EXTENSION_ENABLED = 'loginascustomer/general/enabled';
-    private const ENABLE_STORE_VIEW_MANUAL_CHOICE = 'loginascustomer/general/enable_store_view_manual_choice';
-
-    public const TIME_FRAME = 60;
+    private const XML_PATH_ENABLED = 'login_as_customer/general/enabled';
+    private const XML_PATH_STORE_VIEW_MANUAL_CHOICE_ENABLED
+        = 'login_as_customer/general/store_view_manual_choice_enabled';
+    private const XML_PATH_SECRETS_EXPIRATION_TIME = 'login_as_customer/general/secrets_expiration_time';
 
     /**
      * @var ScopeConfigInterface
      */
-
     private $scopeConfig;
 
-    /**
-     * @var \Magento\Framework\App\ProductMetadataInterface
-     */
-    private $metadata;
-
     /**
      * @param ScopeConfigInterface $scopeConfig
-     * @param ProductMetadataInterface $metadata
      */
     public function __construct(
-        ScopeConfigInterface $scopeConfig,
-        ProductMetadataInterface $metadata
+        ScopeConfigInterface $scopeConfig
     ) {
         $this->scopeConfig = $scopeConfig;
-        $this->metadata = $metadata;
     }
 
     /**
-     * Check if Login As Customer extension is enabled.
-     *
-     * @return bool
+     * @inheritdoc
      */
     public function isEnabled(): bool
     {
-        return (bool)$this->scopeConfig->getValue(
-            self::XML_PATH_EXTENSION_ENABLED,
-            ScopeInterface::SCOPE_STORE,
-            null
-        );
+        return (bool)$this->scopeConfig->getValue(self::XML_PATH_ENABLED);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isStoreManualChoiceEnabled(): bool
+    {
+        return (bool)$this->scopeConfig->getValue(self::XML_PATH_STORE_VIEW_MANUAL_CHOICE_ENABLED);
     }
 
     /**
-     * Check if store view manual choice is enabled.
-     *
-     * @return bool
+     * @inheritdoc
      */
-    public function isManualChoiceEnabled(): bool
+    public function getSecretExpirationTime(): int
     {
-        return (bool)$this->scopeConfig->getValue(
-            self::ENABLE_STORE_VIEW_MANUAL_CHOICE,
-            ScopeInterface::SCOPE_STORE,
-            null
-        );
+        return (int)$this->scopeConfig->getValue(self::XML_PATH_SECRETS_EXPIRATION_TIME);
     }
 }

app/code/Magento/LoginAsCustomer/Model/ResourceModel/DeleteOldSecrets.php renamed to app/code/Magento/LoginAsCustomer/Model/ResourceModel/DeleteOutdatedSecrets.php

@@ -9,13 +9,13 @@
 
 use Magento\Framework\App\ResourceConnection;
 use Magento\Framework\Stdlib\DateTime\DateTime;
-use Magento\LoginAsCustomer\Api\DeleteOldSecretsInterface;
-use Magento\LoginAsCustomer\Model\Config;
+use Magento\LoginAsCustomer\Api\ConfigInterface;
+use Magento\LoginAsCustomer\Api\DeleteOutdatedSecretsInterface;
 
 /**
- * @api
+ * @inheritdoc
  */
-class DeleteOldSecrets implements DeleteOldSecretsInterface
+class DeleteOutdatedSecrets implements DeleteOutdatedSecretsInterface
 {
     /**
      * @var ResourceConnection
@@ -27,26 +27,35 @@ class DeleteOldSecrets implements DeleteOldSecretsInterface
      */
     private $dateTime;
 
+    /**
+     * @var ConfigInterface
+     */
+    private $config;
+
     /**
      * @param ResourceConnection $resourceConnection
+     * @param DateTime $dateTime
+     * @param ConfigInterface $config
      */
     public function __construct(
         ResourceConnection $resourceConnection,
-        DateTime $dateTime
+        DateTime $dateTime,
+        ConfigInterface $config
     ) {
         $this->resourceConnection = $resourceConnection;
         $this->dateTime = $dateTime;
+        $this->config = $config;
     }
 
     /**
-     * Delete old secret key records
+     * @inheritdoc
      */
-    public function execute():void
+    public function execute(): void
     {
         $connection = $this->resourceConnection->getConnection();
         $tableName = $this->resourceConnection->getTableName('login_as_customer');
 
-        $timePoint = date('Y-m-d H:i:s', $this->dateTime->gmtTimestamp() - Config::TIME_FRAME);
+        $timePoint = date('Y-m-d H:i:s', $this->dateTime->gmtTimestamp() - $this->config->getSecretExpirationTime());
 
         $connection->delete(
             $tableName,

app/code/Magento/LoginAsCustomer/Model/ResourceModel/GetAuthenticateData.php

@@ -10,8 +10,8 @@
 use Magento\Framework\App\ResourceConnection;
 use Magento\Framework\Stdlib\DateTime\DateTime;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\LoginAsCustomer\Api\ConfigInterface;
 use Magento\LoginAsCustomer\Api\GetAuthenticateDataInterface;
-use Magento\LoginAsCustomer\Model\Config;
 
 /**
  * @api
@@ -28,15 +28,24 @@ class GetAuthenticateData implements GetAuthenticateDataInterface
      */
     private $dateTime;
 
+    /**
+     * @var ConfigInterface
+     */
+    private $config;
+
     /**
      * @param ResourceConnection $resourceConnection
+     * @param DateTime $dateTime
+     * @param ConfigInterface $config
      */
     public function __construct(
         ResourceConnection $resourceConnection,
-        DateTime $dateTime
+        DateTime $dateTime,
+        ConfigInterface $config
     ) {
         $this->resourceConnection = $resourceConnection;
         $this->dateTime = $dateTime;
+        $this->config = $config;
     }
 
     /**
@@ -50,7 +59,7 @@ public function execute(string $secretKey):array
         $connection = $this->resourceConnection->getConnection();
         $tableName = $this->resourceConnection->getTableName('login_as_customer');
 
-        $timePoint = date('Y-m-d H:i:s', $this->dateTime->gmtTimestamp() - Config::TIME_FRAME);
+        $timePoint = date('Y-m-d H:i:s', $this->dateTime->gmtTimestamp() - $this->config->getSecretExpirationTime());
 
         $select = $connection->select()
             ->from(['main_table' => $tableName])

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

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+ -->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <login_as_customer>
+            <general>
+                <enabled>0</enabled>
+                <store_view_manual_choice_enabled>0</store_view_manual_choice_enabled>
+                <secrets_expiration_time>60</secrets_expiration_time>
+            </general>
+        </login_as_customer>
+    </default>
+</config>

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

@@ -10,5 +10,6 @@
     <preference for="Magento\LoginAsCustomer\Api\GetAuthenticateDataInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\GetAuthenticateData" />
     <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\DeleteOldSecretsInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\DeleteOldSecrets" />
+    <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/LoginAsCustomerUi/Controller/Adminhtml/Login/Login.php

@@ -13,6 +13,7 @@
 use Magento\Backend\App\Action;
 use Magento\Customer\Api\CustomerRepositoryInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\LoginAsCustomer\Api\ConfigInterface;
 use Magento\LoginAsCustomer\Api\CreateSecretInterface;
 
 /**
@@ -51,7 +52,7 @@ class Login extends Action implements HttpGetActionInterface, HttpPostActionInte
     private $customerRepository;
 
     /**
-     * @var \Magento\LoginAsCustomer\Model\Config
+     * @var ConfigInterface
      */
     private $config;
 
@@ -67,7 +68,7 @@ class Login extends Action implements HttpGetActionInterface, HttpPostActionInte
      * @param \Magento\Store\Model\StoreManagerInterface $storeManager
      * @param \Magento\Framework\Url $url
      * @param CustomerRepositoryInterface $customerRepository
-     * @param \Magento\LoginAsCustomer\Model\Config $config,
+     * @param ConfigInterface $config,
      * @param CreateSecretInterface $createSecretProcessor
      */
     public function __construct(
@@ -76,7 +77,7 @@ public function __construct(
         \Magento\Store\Model\StoreManagerInterface $storeManager,
         \Magento\Framework\Url $url,
         CustomerRepositoryInterface $customerRepository,
-        \Magento\LoginAsCustomer\Model\Config $config,
+        ConfigInterface $config,
         CreateSecretInterface $createSecretProcessor
     ) {
         parent::__construct($context);
@@ -111,14 +112,14 @@ public function execute(): ResultInterface
         }
 
         try {
-            $customer = $this->customerRepository->getById($customerId);
+            $this->customerRepository->getById($customerId);
         } catch (NoSuchEntityException $e) {
             $this->messageManager->addErrorMessage(__('Customer with this ID are no longer exist.'));
             return $resultRedirect->setPath('customer/index/index');
         }
 
         $customerStoreId = $request->getParam('store_id');
-        if (!isset($customerStoreId) && $this->config->isManualChoiceEnabled()) {
+        if (!isset($customerStoreId) && $this->config->isStoreManualChoiceEnabled()) {
             $this->messageManager->addNoticeMessage(__('Please select a Store View to login in.'));
             return $resultRedirect->setPath('loginascustomer/login/manual', ['entity_id' => $customerId ]);
         }

app/code/Magento/LoginAsCustomerUi/ViewModel/Configuration.php

@@ -8,6 +8,7 @@
 namespace Magento\LoginAsCustomerUi\ViewModel;
 
 use Magento\Customer\Model\Context;
+use Magento\LoginAsCustomer\Api\ConfigInterface;
 
 /**
  * View model to get extension configuration in the template
@@ -28,12 +29,11 @@ class Configuration implements \Magento\Framework\View\Element\Block\ArgumentInt
     private $httpContext;
 
     /**
-     * Configuration constructor.
-     * @param \Magento\LoginAsCustomer\Model\Config $config
+     * @param ConfigInterface $config
      * @param \Magento\Framework\App\Http\Context $httpContext
      */
     public function __construct(
-        \Magento\LoginAsCustomer\Model\Config $config,
+        ConfigInterface $config,
         \Magento\Framework\App\Http\Context $httpContext
     ) {
         $this->config = $config;