OXDEV-9078 Move shop login to the infrastructure layer

Author: Sieg

src/Authentication/TwoFactorAuth/Infrastructure/Service/UserLoginAdapter.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Service;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserModelFactoryInterface;
+
+class UserLoginAdapter implements UserLoginAdapterInterface
+{
+    public function __construct(
+        private UserModelFactoryInterface $userFactory,
+    ) {
+    }
+
+    public function loginUser(string $userId): void
+    {
+        $user = $this->userFactory->create();
+        $user->load($userId);
+        /** @phpstan-ignore argument.type (password is null because user already authenticated to come here) */
+        $user->login($user->getFieldData('oxusername'), null, false);
+    }
+}

src/Authentication/TwoFactorAuth/Infrastructure/Service/UserLoginAdapterInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Service;
+
+interface UserLoginAdapterInterface
+{
+    public function loginUser(string $userId): void;
+}

src/Authentication/TwoFactorAuth/Infrastructure/Service/services.yaml

@@ -0,0 +1,7 @@
+services:
+  _defaults:
+    autowire: true
+    public: false
+
+  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Service\UserLoginAdapterInterface:
+    class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Service\UserLoginAdapter

src/Authentication/TwoFactorAuth/Infrastructure/services.yaml

@@ -2,3 +2,4 @@ imports:
   - { resource: Factory/services.yaml }
   - { resource: Provider/services.yaml }
   - { resource: Repository/services.yaml }
+  - { resource: Service/services.yaml }

src/Authentication/TwoFactorAuth/Service/TwoFAUserService.php

@@ -12,7 +12,7 @@
 use OxidEsales\Eshop\Core\Utils;
 use OxidEsales\EshopCommunity\Internal\Framework\Session\SessionInterface;
 use OxidEsales\SecurityModule\Authentication\Service\InternalRedirectServiceInterface;
-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserModelFactoryInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Service\UserLoginAdapterInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface;
 
 /**
@@ -27,7 +27,7 @@ public function __construct(
         private TwoFASettingsInterface $settings,
         private Utils $utils,
         private SessionInterface $session,
-        private UserModelFactoryInterface $userFactory,
+        private UserLoginAdapterInterface $loginAdapter,
         private InternalRedirectServiceInterface $redirectService,
     ) {
     }
@@ -48,12 +48,7 @@ public function loginUser(string $userId): void
     {
         $this->session->remove(self::USER_SESSION_KEY);
 
-        // todo-high: looks like it can go to the infrastructure layer
-        $user = $this->userFactory->create();
-        $user->load($userId);
-
-        /** @phpstan-ignore argument.type (password is null because user already authenticated to come here) */
-        $user->login($user->getFieldData('oxusername'), null, false);
+        $this->loginAdapter->loginUser($userId);
 
         $this->utils->redirect($this->redirectService->getRedirectUrl(), false);
     }

tests/Unit/Authentication/TwoFactorAuth/Infrastructure/Service/UserLoginAdapterTest.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Infrastructure\Service;
+
+use OxidEsales\Eshop\Application\Model\User;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserModelFactoryInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Service\UserLoginAdapter;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class UserLoginAdapterTest extends TestCase
+{
+    #[Test]
+    public function loginUserLoadsAndLoginsUser(): void
+    {
+        $userSpy = $this->createMock(User::class);
+        $userSpy->expects($this->once())->method('load')->with($userId = uniqid());
+        $userSpy->method('getFieldData')->with('oxusername')->willReturn($username = uniqid());
+        $userSpy->expects($this->once())->method('login')->with($username, null, false);
+
+        $userFactoryStub = $this->createStub(UserModelFactoryInterface::class);
+        $userFactoryStub->method('create')->willReturn($userSpy);
+
+        $sut = $this->getSut(userFactory: $userFactoryStub);
+
+        $sut->loginUser($userId);
+    }
+
+    private function getSut(
+        UserModelFactoryInterface $userFactory = null,
+    ): UserLoginAdapter {
+        return new UserLoginAdapter(
+            userFactory: $userFactory ?? $this->createStub(UserModelFactoryInterface::class),
+        );
+    }
+}

tests/Unit/Authentication/TwoFactorAuth/Service/TwoFAUserServiceTest.php

@@ -9,11 +9,10 @@
 
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\Service;
 
-use OxidEsales\Eshop\Application\Model\User;
 use OxidEsales\Eshop\Core\Utils;
 use OxidEsales\EshopCommunity\Internal\Framework\Session\SessionInterface;
 use OxidEsales\SecurityModule\Authentication\Service\InternalRedirectServiceInterface;
-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserModelFactoryInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Service\UserLoginAdapterInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAServiceInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Service\TwoFAUserService;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Settings\TwoFASettingsInterface;
@@ -84,13 +83,10 @@ public function isChallengeVerifiedProxiesToTwoFAService(): void
     #[Test]
     public function loginUserLoadsUserLoginsClearsSessionAndRedirects(): void
     {
-        $userSpy = $this->createMock(User::class);
-        $userSpy->expects($this->once())->method('load')->with($userId = uniqid());
-        $userSpy->method('getFieldData')->with('oxusername')->willReturn($username = uniqid());
-        $userSpy->expects($this->once())->method('login')->with($username, null, false);
-
-        $userFactoryStub = $this->createStub(UserModelFactoryInterface::class);
-        $userFactoryStub->method('create')->willReturn($userSpy);
+        $loginAdapterSpy = $this->createMock(UserLoginAdapterInterface::class);
+        $loginAdapterSpy->expects($this->once())
+            ->method('loginUser')
+            ->with($userId = uniqid());
 
         $sessionSpy = $this->createMock(SessionInterface::class);
         $sessionSpy->expects($this->once())
@@ -104,7 +100,7 @@ public function loginUserLoadsUserLoginsClearsSessionAndRedirects(): void
         $utilsSpy->expects($this->once())->method('redirect')->with($redirectUrl, false);
 
         $sut = $this->getSut(
-            userFactory: $userFactoryStub,
+            loginAdapter: $loginAdapterSpy,
             session: $sessionSpy,
             redirectService: $redirectServiceStub,
             utils: $utilsSpy,
@@ -118,15 +114,15 @@ private function getSut(
         TwoFASettingsInterface $settings = null,
         Utils $utils = null,
         SessionInterface $session = null,
-        UserModelFactoryInterface $userFactory = null,
+        UserLoginAdapterInterface $loginAdapter = null,
         InternalRedirectServiceInterface $redirectService = null,
     ): TwoFAUserService {
         return new TwoFAUserService(
             twoFAService: $twoFAService ?? $this->createStub(TwoFAServiceInterface::class),
             settings: $settings ?? $this->createStub(TwoFASettingsInterface::class),
             utils: $utils ?? $this->createStub(Utils::class),
             session: $session ?? $this->createStub(SessionInterface::class),
-            userFactory: $userFactory ?? $this->createStub(UserModelFactoryInterface::class),
+            loginAdapter: $loginAdapter ?? $this->createStub(UserLoginAdapterInterface::class),
             redirectService: $redirectService ?? $this->createStub(InternalRedirectServiceInterface::class),
         );
     }