Fixed minor issues and code duplications for CABPI-467

Author: nishant04412

app/code/Magento/AdminAdobeIms/Controller/Adminhtml/OAuth/ImsCallback.php

@@ -17,6 +17,9 @@
 use Magento\Backend\Model\View\Result\Redirect;
 use Magento\Framework\App\Action\HttpGetActionInterface;
 
+/**
+ * Callback for handling redirect from Adobe IMS
+ */
 class ImsCallback extends Auth implements HttpGetActionInterface
 {
     public const ACTION_NAME = 'imscallback';

app/code/Magento/AdminAdobeIms/Controller/Adminhtml/OAuth/ImsReauthCallback.php

@@ -9,18 +9,14 @@
 
 use Exception;
 use Magento\AdminAdobeIms\Logger\AdminAdobeImsLogger;
-use Magento\AdminAdobeIms\Service\AdminReauthProcessService;
+use Magento\AdminAdobeIms\Model\Authorization\AdobeImsAdminTokenUserService;
 use Magento\AdminAdobeIms\Service\ImsConfig;
-use Magento\AdobeImsApi\Api\OrganizationMembershipInterface;
-use Magento\AdobeImsApi\Api\GetProfileInterface;
 use Magento\Backend\App\Action\Context;
 use Magento\Backend\Controller\Adminhtml\Auth;
 use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\Controller\Result\Raw;
 use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Controller\ResultInterface;
-use Magento\AdobeImsApi\Api\GetTokenInterface;
-use Magento\Framework\Exception\AuthenticationException;
 
 class ImsReauthCallback extends Auth implements HttpGetActionInterface
 {
@@ -42,56 +38,32 @@ class ImsReauthCallback extends Auth implements HttpGetActionInterface
      */
     private ImsConfig $adminImsConfig;
 
-    /**
-     * @var OrganizationMembershipInterface
-     */
-    private OrganizationMembershipInterface $organizationMembership;
-
-    /**
-     * @var AdminReauthProcessService
-     */
-    private AdminReauthProcessService $adminReauthProcessService;
-
     /**
      * @var AdminAdobeImsLogger
      */
     private AdminAdobeImsLogger $logger;
 
     /**
-     * @var GetTokenInterface
-     */
-    private GetTokenInterface $token;
-
-    /**
-     * @var GetProfileInterface
+     * @var AdobeImsAdminTokenUserService
      */
-    private GetProfileInterface $profile;
+    private AdobeImsAdminTokenUserService $adminTokenUserService;
 
     /**
      * @param Context $context
-     * @param GetProfileInterface $profile
      * @param ImsConfig $adminImsConfig
-     * @param OrganizationMembershipInterface $organizationMembership
-     * @param AdminReauthProcessService $adminReauthProcessService
+     * @param AdobeImsAdminTokenUserService $adminTokenUserService
      * @param AdminAdobeImsLogger $logger
-     * @param GetTokenInterface $token
      */
     public function __construct(
         Context                         $context,
-        GetProfileInterface             $profile,
         ImsConfig                       $adminImsConfig,
-        OrganizationMembershipInterface $organizationMembership,
-        AdminReauthProcessService       $adminReauthProcessService,
-        AdminAdobeImsLogger             $logger,
-        GetTokenInterface               $token
+        AdobeImsAdminTokenUserService $adminTokenUserService,
+        AdminAdobeImsLogger             $logger
     ) {
         parent::__construct($context);
-        $this->profile = $profile;
         $this->adminImsConfig = $adminImsConfig;
-        $this->organizationMembership = $organizationMembership;
-        $this->adminReauthProcessService = $adminReauthProcessService;
+        $this->adminTokenUserService = $adminTokenUserService;
         $this->logger = $logger;
-        $this->token = $token;
     }
 
     /**
@@ -119,24 +91,7 @@ public function execute(): ResultInterface
         }
 
         try {
-            $code = $this->getRequest()->getParam('code');
-
-            if ($code === null) {
-                throw new AuthenticationException(__('An authentication error occurred. Verify and try again.'));
-            }
-
-            $tokenResponse = $this->token->getTokenResponse($code);
-            $accessToken = $tokenResponse->getAccessToken();
-
-            $profile = $this->profile->getProfile($accessToken);
-            if (empty($profile['email'])) {
-                throw new AuthenticationException(__('An authentication error occurred. Verify and try again.'));
-            }
-
-            //check membership in organization
-            $this->organizationMembership->checkOrganizationMembership($accessToken);
-
-            $this->adminReauthProcessService->execute($tokenResponse);
+            $this->adminTokenUserService->processLoginRequest(true);
 
             $response = sprintf(
                 self::RESPONSE_TEMPLATE,

app/code/Magento/AdminAdobeIms/Model/Authorization/AdobeImsAdminTokenUserContext.php

@@ -3,7 +3,6 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\AdminAdobeIms\Model\Authorization;
@@ -84,7 +83,11 @@ public function getUserId(): ?int
                 throw new AuthenticationException(__('An authentication error occurred. Verify and try again.'));
             }
         } else {
-            $this->adminTokenUserService->processLoginRequest();
+            try {
+                $this->adminTokenUserService->processLoginRequest();
+            } catch (\Exception $e) {
+                throw new AuthenticationException(__('An authentication error occurred. Verify and try again.'));
+            }
         }
 
         $this->userId = (int) $session->getUser()->getUserId();

app/code/Magento/AdminAdobeIms/Model/Authorization/AdobeImsAdminTokenUserService.php

@@ -10,6 +10,7 @@
 
 use Magento\AdminAdobeIms\Exception\AdobeImsAuthorizationException;
 use Magento\AdminAdobeIms\Service\AdminLoginProcessService;
+use Magento\AdminAdobeIms\Service\AdminReauthProcessService;
 use Magento\AdminAdobeIms\Service\ImsConfig;
 use Magento\AdobeIms\Exception\AdobeImsOrganizationAuthorizationException;
 use Magento\AdobeImsApi\Api\GetProfileInterface;
@@ -19,6 +20,8 @@
 use Magento\Framework\Exception\AuthenticationException;
 
 /**
+ * Adobe IMS Auth Model for getting Admin Token
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class AdobeImsAdminTokenUserService
@@ -50,6 +53,11 @@ class AdobeImsAdminTokenUserService
      */
     private AdminLoginProcessService $adminLoginProcessService;
 
+    /**
+     * @var AdminReauthProcessService
+     */
+    private AdminReauthProcessService $adminReauthProcessService;
+
     /**
      * @var RequestInterface
      */
@@ -59,6 +67,7 @@ class AdobeImsAdminTokenUserService
      * @param ImsConfig $adminImsConfig
      * @param OrganizationMembershipInterface $organizationMembership
      * @param AdminLoginProcessService $adminLoginProcessService
+     * @param AdminReauthProcessService $adminReauthProcessService
      * @param RequestInterface $request
      * @param GetTokenInterface $token
      * @param GetProfileInterface $profile
@@ -67,13 +76,15 @@ public function __construct(
         ImsConfig $adminImsConfig,
         OrganizationMembershipInterface $organizationMembership,
         AdminLoginProcessService $adminLoginProcessService,
+        AdminReauthProcessService $adminReauthProcessService,
         RequestInterface $request,
         GetTokenInterface $token,
         GetProfileInterface $profile
     ) {
         $this->adminImsConfig = $adminImsConfig;
         $this->organizationMembership = $organizationMembership;
         $this->adminLoginProcessService = $adminLoginProcessService;
+        $this->adminReauthProcessService = $adminReauthProcessService;
         $this->request = $request;
         $this->token = $token;
         $this->profile = $profile;
@@ -82,12 +93,13 @@ public function __construct(
     /**
      * Process login request to Admin Adobe IMS.
      *
+     * @param bool $isReauthorize
      * @return void
      * @throws AdobeImsAuthorizationException
      * @throws AdobeImsOrganizationAuthorizationException
      * @throws AuthenticationException
      */
-    public function processLoginRequest()
+    public function processLoginRequest(bool $isReauthorize = false): void
     {
         if ($this->adminImsConfig->enabled() && $this->request->getParam('code')
             && $this->request->getModuleName() === self::ADOBE_IMS_MODULE_NAME) {
@@ -107,7 +119,11 @@ public function processLoginRequest()
                 //check membership in organization
                 $this->organizationMembership->checkOrganizationMembership($accessToken);
 
-                $this->adminLoginProcessService->execute($tokenResponse, $profile);
+                if ($isReauthorize) {
+                    $this->adminReauthProcessService->execute($tokenResponse);
+                } else {
+                    $this->adminLoginProcessService->execute($tokenResponse, $profile);
+                }
             } catch (AdobeImsAuthorizationException $e) {
                 throw new AdobeImsAuthorizationException(
                     __('You don\'t have access to this Commerce instance')

app/code/Magento/AdminAdobeIms/Test/Unit/Model/Authorization/AdobeImsAdminTokenUserContextTest.php

@@ -10,8 +10,8 @@
 use Magento\AdminAdobeIms\Model\Auth;
 use Magento\AdminAdobeIms\Model\Authorization\AdobeImsAdminTokenUserContext;
 use Magento\AdminAdobeIms\Model\Authorization\AdobeImsAdminTokenUserService;
-use Magento\AdobeImsApi\Api\IsTokenValidInterface;
 use Magento\AdminAdobeIms\Service\ImsConfig;
+use Magento\AdobeImsApi\Api\IsTokenValidInterface;
 use Magento\Authorization\Model\UserContextInterface;
 use Magento\Backend\Model\Auth\Session;
 use Magento\Framework\Exception\AuthenticationException;
@@ -101,6 +101,8 @@ public function testGetUserId()
     }
 
     /**
+     * Test exception with invalid access token
+     *
      * @return void
      * @throws AuthenticationException
      */
@@ -127,6 +129,8 @@ public function testGetUserType()
     }
 
     /**
+     * Setting up User Id
+     *
      * @param int|null $userId
      * @return void
      */

app/code/Magento/AdminAdobeIms/Test/Unit/Model/Authorization/AdobeImsAdminTokenUserServiceTest.php

@@ -9,12 +9,12 @@
 
 use Magento\AdminAdobeIms\Exception\AdobeImsAuthorizationException;
 use Magento\AdminAdobeIms\Model\Authorization\AdobeImsAdminTokenUserService;
-use Magento\AdobeImsApi\Api\GetProfileInterface;
-use Magento\AdobeImsApi\Api\GetTokenInterface;
 use Magento\AdminAdobeIms\Service\AdminLoginProcessService;
 use Magento\AdminAdobeIms\Service\ImsConfig;
-use Magento\AdobeImsApi\Api\OrganizationMembershipInterface;
 use Magento\AdobeImsApi\Api\Data\TokenResponseInterface;
+use Magento\AdobeImsApi\Api\GetProfileInterface;
+use Magento\AdobeImsApi\Api\GetTokenInterface;
+use Magento\AdobeImsApi\Api\OrganizationMembershipInterface;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Exception\AuthenticationException;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
@@ -132,6 +132,8 @@ public function testProcessLoginRequest(string $code, array $responseData)
     }
 
     /**
+     * Test exception when tried to access from other module
+     *
      * @return void
      * @param string $code
      * @dataProvider responseDataProvider
@@ -152,6 +154,8 @@ public function testExceptionWhenTriedToAccessFromOtherModule(string $code): voi
     }
 
     /**
+     * Test exception when profile not found
+     *
      * @return void
      * @param string $code
      * @param array $responseData
@@ -190,6 +194,8 @@ public function testExceptionWhenProfileNotFoundBasedOnAccessToken(
     }
 
     /**
+     * Test exception when admin login provided with wrong info
+     *
      * @return void
      * @param string $code
      * @param array $responseData