OXDEV-9078 Add User DTO with temporary NewUser name, also a repository to get it

Sieg · Sieg · commit 45860409c56f · 2026-04-02T14:18:50.000+03:00
diff --git a/src/Authentication/TwoFactorAuth/DTO/NewUser.php b/src/Authentication/TwoFactorAuth/DTO/NewUser.php
@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO;
+
+class NewUser implements NewUserInterface
+{
+    public function __construct(
+        private string $userId,
+        private string $email,
+    ) {
+    }
+
+    public function getUserId(): string
+    {
+        return $this->userId;
+    }
+
+    public function getEmail(): string
+    {
+        return $this->email;
+    }
+}
diff --git a/src/Authentication/TwoFactorAuth/DTO/NewUserInterface.php b/src/Authentication/TwoFactorAuth/DTO/NewUserInterface.php
@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO;
+
+interface NewUserInterface
+{
+    public function getUserId(): string;
+
+    public function getEmail(): string;
+}
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Factory/NewUserFactory.php b/src/Authentication/TwoFactorAuth/Infrastructure/Factory/NewUserFactory.php
@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory;
+
+use OxidEsales\Eshop\Application\Model\User;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\NewUser;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\NewUserInterface;
+
+class NewUserFactory implements NewUserFactoryInterface
+{
+    public function createFromModel(User $userModel): NewUserInterface
+    {
+        return new NewUser(
+            userId: $userModel->getId(),
+            email: $userModel->getFieldData('oxusername'),
+        );
+    }
+}
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Factory/NewUserFactoryInterface.php b/src/Authentication/TwoFactorAuth/Infrastructure/Factory/NewUserFactoryInterface.php
@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory;
+
+use OxidEsales\Eshop\Application\Model\User;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\NewUserInterface;
+
+interface NewUserFactoryInterface
+{
+    public function createFromModel(User $userModel): NewUserInterface;
+}
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Factory/UserModelFactory.php b/src/Authentication/TwoFactorAuth/Infrastructure/Factory/UserModelFactory.php
@@ -11,7 +11,7 @@
 
 use OxidEsales\Eshop\Application\Model\User;
 
-class UserFactory implements UserFactoryInterface
+class UserModelFactory implements UserModelFactoryInterface
 {
     /**
      * @inheritDoc
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Factory/UserModelFactoryInterface.php b/src/Authentication/TwoFactorAuth/Infrastructure/Factory/UserModelFactoryInterface.php
@@ -9,7 +9,7 @@
 
 use OxidEsales\Eshop\Application\Model\User;
 
-interface UserFactoryInterface
+interface UserModelFactoryInterface
 {
     public function create(): User;
 }
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Repository/NewUserRepository.php b/src/Authentication/TwoFactorAuth/Infrastructure/Repository/NewUserRepository.php
@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\NewUserInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\UserNotFoundException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\NewUserFactoryInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserModelFactoryInterface;
+
+class NewUserRepository implements NewUserRepositoryInterface
+{
+    public function __construct(
+        private UserModelFactoryInterface $userFactory,
+        private NewUserFactoryInterface $userDtoFactory,
+    ) {
+    }
+
+    public function getUserById(string $userId): NewUserInterface
+    {
+        $userModel = $this->userFactory->create();
+
+        if (!$userModel->load($userId)) {
+            throw new UserNotFoundException();
+        }
+
+        return $this->userDtoFactory->createFromModel($userModel);
+    }
+}
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Repository/NewUserRepositoryInterface.php b/src/Authentication/TwoFactorAuth/Infrastructure/Repository/NewUserRepositoryInterface.php
@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\NewUserInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\UserNotFoundException;
+
+interface NewUserRepositoryInterface
+{
+    /** @throws UserNotFoundException */
+    public function getUserById(string $userId): NewUserInterface;
+}
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Repository/UserRepository.php b/src/Authentication/TwoFactorAuth/Infrastructure/Repository/UserRepository.php
@@ -17,12 +17,12 @@
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\UserInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\User as UserDTO;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\UserNotFoundException;
-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserFactoryInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserModelFactoryInterface;
 
 class UserRepository implements UserRepositoryInterface
 {
     public function __construct(
-        private readonly UserFactoryInterface $userFactory,
+        private readonly UserModelFactoryInterface $userFactory,
         private readonly QueryBuilderFactoryInterface $queryBuilderFactory,
         private readonly ContextInterface $context,
     ) {
diff --git a/src/Authentication/TwoFactorAuth/Infrastructure/Repository/services.yaml b/src/Authentication/TwoFactorAuth/Infrastructure/Repository/services.yaml
@@ -3,6 +3,9 @@ services:
     autowire: true
     public: false
 
+  OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository\NewUserRepositoryInterface:
+    class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository\NewUserRepository
+
   OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository\UserRepositoryInterface:
     class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository\UserRepository
     public: true
diff --git a/src/Authentication/TwoFactorAuth/Service/UserService.php b/src/Authentication/TwoFactorAuth/Service/UserService.php
@@ -13,13 +13,13 @@
 use OxidEsales\EshopCommunity\Internal\Framework\Session\SessionInterface;
 use OxidEsales\SecurityModule\Authentication\Service\InternalRedirectServiceInterface;
 use OxidEsales\SecurityModule\Authentication\Session\SessionKeys;
-use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserFactoryInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserModelFactoryInterface;
 
 readonly class UserService implements UserServiceInterface
 {
     public function __construct(
         private AuthorizeServiceInterface $authorizeService,
-        private UserFactoryInterface $userFactory,
+        private UserModelFactoryInterface $userFactory,
         private SessionInterface $session,
         private Utils $utils,
         private InternalRedirectServiceInterface $redirectService,
diff --git a/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Factory/UserFactoryTest.php b/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Factory/UserFactoryTest.php
diff --git a/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Factory/UserModelFactoryTest.php b/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Factory/UserModelFactoryTest.php
@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Tests\Integration\Authentication\TwoFactorAuth\Infrastructure\Factory;
+
+use OxidEsales\Eshop\Application\Model\User;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserModelFactory;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\UserModelFactoryInterface;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class UserModelFactoryTest extends TestCase
+{
+    #[Test]
+    public function createReturnsUserModel(): void
+    {
+        $sut = $this->getSut();
+
+        $this->assertInstanceOf(User::class, $sut->create());
+    }
+
+    #[Test]
+    public function createReturnsNewInstanceOnEachCall(): void
+    {
+        $sut = $this->getSut();
+
+        $this->assertNotSame($sut->create(), $sut->create());
+    }
+
+    private function getSut(): UserModelFactoryInterface
+    {
+        return new UserModelFactory();
+    }
+}
diff --git a/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Repository/NewUserRepositoryTest.php b/tests/Integration/Authentication/TwoFactorAuth/Infrastructure/Repository/NewUserRepositoryTest.php
@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\SecurityModule\Tests\Integration\Authentication\TwoFactorAuth\Infrastructure\Repository;
+
+use OxidEsales\Eshop\Application\Model\User;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\NewUserInterface;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Exception\UserNotFoundException;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository\NewUserRepositoryInterface;
+use OxidEsales\SecurityModule\Tests\Integration\IntegrationTestCase;
+use PHPUnit\Framework\Attributes\Test;
+
+class NewUserRepositoryTest extends IntegrationTestCase
+{
+    #[Test]
+    public function getUserByIdThrowsWhenUserNotFound(): void
+    {
+        $sut = $this->getSut();
+
+        $this->expectException(UserNotFoundException::class);
+
+        $sut->getUserById(userId: uniqid());
+    }
+
+    #[Test]
+    public function getUserByIdReturnsUserDto(): void
+    {
+        $userModel = oxNew(User::class);
+        $userModel->setId($userId = uniqid());
+        $userModel->assign([
+            'oxactive'   => 1,
+            'oxusername' => $email = uniqid() . '@example.com',
+        ]);
+        $userModel->save();
+
+        $sut = $this->getSut();
+
+        $result = $sut->getUserById(userId: $userId);
+
+        $this->assertInstanceOf(NewUserInterface::class, $result);
+        $this->assertSame($userId, $result->getUserId());
+        $this->assertSame($email, $result->getEmail());
+    }
+
+    private function getSut(): NewUserRepositoryInterface
+    {
+        return $this->get(NewUserRepositoryInterface::class);
+    }
+}
diff --git a/tests/Unit/Authentication/TwoFactorAuth/DTO/NewUserTest.php b/tests/Unit/Authentication/TwoFactorAuth/DTO/NewUserTest.php
@@ -0,0 +1,31 @@
+<?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\DTO;
+
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\NewUser;
+use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\NewUserInterface;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class NewUserTest extends TestCase
+{
+    #[Test]
+    public function initializeAndReadProperties(): void
+    {
+        $sut = new NewUser(
+            userId: $userId = uniqid(),
+            email: $email = uniqid(),
+        );
+
+        $this->assertInstanceOf(NewUserInterface::class, $sut);
+        $this->assertSame($userId, $sut->getUserId());
+        $this->assertSame($email, $sut->getEmail());
+    }
+}
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Infrastructure/Factory/NewUserFactoryTest.php b/tests/Unit/Authentication/TwoFactorAuth/Infrastructure/Factory/NewUserFactoryTest.php
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Infrastructure/Repository/UserRepositoryTest.php b/tests/Unit/Authentication/TwoFactorAuth/Infrastructure/Repository/UserRepositoryTest.php
diff --git a/tests/Unit/Authentication/TwoFactorAuth/Service/UserServiceTest.php b/tests/Unit/Authentication/TwoFactorAuth/Service/UserServiceTest.php

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`use OxidEsales\Eshop\Application\Model\User;`
`13`	`13`
`14`		`-class UserFactory implements UserFactoryInterface`
	`14`	`+class UserModelFactory implements UserModelFactoryInterface`
`15`	`15`	`{`
`16`	`16`	`/**`
`17`	`17`	`* @inheritDoc`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`use OxidEsales\Eshop\Application\Model\User;`
`11`	`11`
`12`		`-interface UserFactoryInterface`
	`12`	`+interface UserModelFactoryInterface`
`13`	`13`	`{`
`14`	`14`	`public function create(): User;`
`15`	`15`	`}`