magento/magento2-login-as-customer#144: Session interfaces introduction.

Author: engcom-Foxtrot

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

@@ -11,6 +11,7 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\LoginAsCustomerApi\Api\AuthenticateCustomerBySecretInterface;
 use Magento\LoginAsCustomerApi\Api\GetAuthenticationDataBySecretInterface;
+use Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerAdminIdInterface;
 
 /**
  * @inheritdoc
@@ -29,16 +30,24 @@ class AuthenticateCustomerBySecret implements AuthenticateCustomerBySecretInterf
      */
     private $customerSession;
 
+    /**
+     * @var SetLoggedAsCustomerAdminIdInterface
+     */
+    private $setLoggedAsCustomerAdminId;
+
     /**
      * @param GetAuthenticationDataBySecretInterface $getAuthenticationDataBySecret
      * @param Session $customerSession
+     * @param SetLoggedAsCustomerAdminIdInterface $setLoggedAsCustomerAdminId
      */
     public function __construct(
         GetAuthenticationDataBySecretInterface $getAuthenticationDataBySecret,
-        Session $customerSession
+        Session $customerSession,
+        SetLoggedAsCustomerAdminIdInterface $setLoggedAsCustomerAdminId
     ) {
         $this->getAuthenticationDataBySecret = $getAuthenticationDataBySecret;
         $this->customerSession = $customerSession;
+        $this->setLoggedAsCustomerAdminId = $setLoggedAsCustomerAdminId;
     }
 
     /**
@@ -58,6 +67,6 @@ public function execute(string $secret): void
         }
 
         $this->customerSession->regenerateId();
-        $this->customerSession->setLoggedAsCustomerAdmindId($authenticationData->getAdminId());
+        $this->setLoggedAsCustomerAdminId->execute($authenticationData->getAdminId());
     }
 }

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

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomer\Model;
+
+use Magento\Customer\Model\Session;
+use Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerAdminIdInterface;
+
+/**
+ * @inheritdoc
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
+ */
+class GetLoggedAsCustomerAdminId implements GetLoggedAsCustomerAdminIdInterface
+{
+    /**
+     * @var Session
+     */
+    private $session;
+
+    /**
+     * @param Session $session
+     */
+    public function __construct(Session $session)
+    {
+        $this->session = $session;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function execute(): int
+    {
+        return (int)$this->session->getLoggedAsCustomerAdmindId();
+    }
+}

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

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomer\Model;
+
+use Magento\Backend\Model\Auth\Session;
+use Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerCustomerIdInterface;
+
+/**
+ * @inheritdoc
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
+ */
+class GetLoggedAsCustomerCustomerId implements GetLoggedAsCustomerCustomerIdInterface
+{
+    /**
+     * @var Session
+     */
+    private $session;
+
+    /**
+     * @param Session $session
+     */
+    public function __construct(Session $session)
+    {
+        $this->session = $session;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function execute(): int
+    {
+        return (int)$this->session->getLoggedAsCustomerCustomerId();
+    }
+}

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

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomer\Model;
+
+use Magento\Customer\Model\Session;
+use Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerAdminIdInterface;
+
+/**
+ * @inheritdoc
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
+ */
+class SetLoggedAsCustomerAdminId implements SetLoggedAsCustomerAdminIdInterface
+{
+    /**
+     * @var Session
+     */
+    private $session;
+
+    /**
+     * @param Session $session
+     */
+    public function __construct(Session $session)
+    {
+        $this->session = $session;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function execute(int $adminId): void
+    {
+        $this->session->setLoggedAsCustomerAdmindId($adminId);
+    }
+}

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

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomer\Model;
+
+use Magento\Backend\Model\Auth\Session;
+use Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerCustomerIdInterface;
+
+/**
+ * @inheritdoc
+ *
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
+ */
+class SetLoggedAsCustomerCustomerId implements SetLoggedAsCustomerCustomerIdInterface
+{
+    /**
+     * @var Session
+     */
+    private $session;
+
+    /**
+     * @param Session $session
+     */
+    public function __construct(Session $session)
+    {
+        $this->session = $session;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function execute(int $customerId): void
+    {
+        $this->session->setLoggedAsCustomerCustomerId($customerId);
+    }
+}

app/code/Magento/LoginAsCustomer/Plugin/AdminLogoutPlugin.php

@@ -8,9 +8,9 @@
 namespace Magento\LoginAsCustomer\Plugin;
 
 use Magento\Backend\Model\Auth;
-use Magento\Backend\Model\Auth\Session as AuthSession;
 use Magento\LoginAsCustomerApi\Api\ConfigInterface;
 use Magento\LoginAsCustomerApi\Api\DeleteAuthenticationDataForUserInterface;
+use Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerCustomerIdInterface;
 
 /**
  * Delete all Login as Customer sessions for logging out admin.
@@ -19,11 +19,6 @@
  */
 class AdminLogoutPlugin
 {
-    /**
-     * @var AuthSession
-     */
-    private $authSession;
-
     /**
      * @var ConfigInterface
      */
@@ -35,18 +30,23 @@ class AdminLogoutPlugin
     private $deleteAuthenticationDataForUser;
 
     /**
-     * @param AuthSession $authSession
+     * @var GetLoggedAsCustomerCustomerIdInterface
+     */
+    private $getLoggedAsCustomerCustomerId;
+
+    /**
      * @param ConfigInterface $config
      * @param DeleteAuthenticationDataForUserInterface $deleteAuthenticationDataForUser
+     * @param GetLoggedAsCustomerCustomerIdInterface $getLoggedAsCustomerCustomerId
      */
     public function __construct(
-        AuthSession $authSession,
         ConfigInterface $config,
-        DeleteAuthenticationDataForUserInterface $deleteAuthenticationDataForUser
+        DeleteAuthenticationDataForUserInterface $deleteAuthenticationDataForUser,
+        GetLoggedAsCustomerCustomerIdInterface $getLoggedAsCustomerCustomerId
     ) {
-        $this->authSession = $authSession;
         $this->config = $config;
         $this->deleteAuthenticationDataForUser = $deleteAuthenticationDataForUser;
+        $this->getLoggedAsCustomerCustomerId = $getLoggedAsCustomerCustomerId;
     }
 
     /**
@@ -57,7 +57,7 @@ public function __construct(
     public function beforeLogout(Auth $subject): void
     {
         $user = $subject->getUser();
-        $isLoggedAsCustomer = $this->authSession->getIsLoggedAsCustomer();
+        $isLoggedAsCustomer = (bool)$this->getLoggedAsCustomerCustomerId->execute();
         if ($this->config->isEnabled() && $user && $isLoggedAsCustomer) {
             $userId = (int)$user->getId();
             $this->deleteAuthenticationDataForUser->execute($userId);

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

@@ -13,6 +13,10 @@
     <preference for="Magento\LoginAsCustomerApi\Api\DeleteAuthenticationDataForUserInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\DeleteAuthenticationDataForUser"/>
     <preference for="Magento\LoginAsCustomerApi\Api\ConfigInterface" type="Magento\LoginAsCustomer\Model\Config"/>
     <preference for="Magento\LoginAsCustomerApi\Api\IsLoginAsCustomerSessionActiveInterface" type="Magento\LoginAsCustomer\Model\ResourceModel\IsLoginAsCustomerSessionActive"/>
+    <preference for="Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerAdminIdInterface" type="Magento\LoginAsCustomer\Model\GetLoggedAsCustomerAdminId"/>
+    <preference for="Magento\LoginAsCustomerApi\Api\GetLoggedAsCustomerCustomerIdInterface" type="Magento\LoginAsCustomer\Model\GetLoggedAsCustomerCustomerId"/>
+    <preference for="Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerAdminIdInterface" type="Magento\LoginAsCustomer\Model\SetLoggedAsCustomerAdminId"/>
+    <preference for="Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerCustomerIdInterface" type="Magento\LoginAsCustomer\Model\SetLoggedAsCustomerCustomerId"/>
     <type name="Magento\Backend\Model\Auth">
         <plugin name="login_as_customer_admin_logout" type="Magento\LoginAsCustomer\Plugin\AdminLogoutPlugin"/>
     </type>

app/code/Magento/LoginAsCustomerAdminUi/Controller/Adminhtml/Login/Login.php

@@ -23,6 +23,7 @@
 use Magento\LoginAsCustomerApi\Api\Data\AuthenticationDataInterfaceFactory;
 use Magento\LoginAsCustomerApi\Api\DeleteAuthenticationDataForUserInterface;
 use Magento\LoginAsCustomerApi\Api\SaveAuthenticationDataInterface;
+use Magento\LoginAsCustomerApi\Api\SetLoggedAsCustomerCustomerIdInterface;
 use Magento\Store\Model\StoreManagerInterface;
 
 /**
@@ -80,6 +81,11 @@ class Login extends Action implements HttpGetActionInterface
      */
     private $url;
 
+    /**
+     * @var SetLoggedAsCustomerCustomerIdInterface
+     */
+    private $setLoggedAsCustomerCustomerId;
+
     /**
      * @param Context $context
      * @param Session $authSession
@@ -90,6 +96,9 @@ class Login extends Action implements HttpGetActionInterface
      * @param SaveAuthenticationDataInterface $saveAuthenticationData ,
      * @param DeleteAuthenticationDataForUserInterface $deleteAuthenticationDataForUser
      * @param Url $url
+     * @param SetLoggedAsCustomerCustomerIdInterface $setLoggedAsCustomerCustomerId
+     *
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         Context $context,
@@ -100,7 +109,8 @@ public function __construct(
         AuthenticationDataInterfaceFactory $authenticationDataFactory,
         SaveAuthenticationDataInterface $saveAuthenticationData,
         DeleteAuthenticationDataForUserInterface $deleteAuthenticationDataForUser,
-        Url $url
+        Url $url,
+        SetLoggedAsCustomerCustomerIdInterface $setLoggedAsCustomerCustomerId
     ) {
         parent::__construct($context);
 
@@ -112,6 +122,7 @@ public function __construct(
         $this->saveAuthenticationData = $saveAuthenticationData;
         $this->deleteAuthenticationDataForUser = $deleteAuthenticationDataForUser;
         $this->url = $url;
+        $this->setLoggedAsCustomerCustomerId = $setLoggedAsCustomerCustomerId;
     }
 
     /**
@@ -167,7 +178,7 @@ public function execute(): ResultInterface
 
         $this->deleteAuthenticationDataForUser->execute($userId);
         $secret = $this->saveAuthenticationData->execute($authenticationData);
-        $this->authSession->setIsLoggedAsCustomer(true);
+        $this->setLoggedAsCustomerCustomerId->execute($customerId);
 
         $redirectUrl = $this->getLoginProceedRedirectUrl($secret, $storeId);
         $resultRedirect->setUrl($redirectUrl);

app/code/Magento/LoginAsCustomerApi/Api/GetLoggedAsCustomerAdminIdInterface.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomerApi\Api;
+
+/**
+ * Get id of Admin logged as Customer.
+ *
+ * @api
+ */
+interface GetLoggedAsCustomerAdminIdInterface
+{
+    /**
+     * Get id of Admin logged as Customer.
+     *
+     * @return int
+     */
+    public function execute(): int;
+}

app/code/Magento/LoginAsCustomerApi/Api/GetLoggedAsCustomerCustomerIdInterface.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\LoginAsCustomerApi\Api;
+
+/**
+ * Get id of Customer Admin is logged as.
+ *
+ * @api
+ */
+interface GetLoggedAsCustomerCustomerIdInterface
+{
+    /**
+     * Get id of Customer Admin is logged as.
+     *
+     * @return int
+     */
+    public function execute(): int;
+}