Find email with username and unit tests in workflow

.github/workflows/unit-tests.yml

@@ -0,0 +1,29 @@
+name: Unit Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  unit-tests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          # no matrix across 8.2-8.4 here: these are plain PHP unit tests with no
+          # version-sensitive logic, so one version is enough signal for the added CI cost
+          php-version: '8.4'
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install --no-plugins --prefer-dist
+
+      - name: Run unit tests
+        run: vendor/bin/phpunit Tests/Unit

.gitignore

@@ -5,5 +5,9 @@ vendor/
 # composer
 composer.lock
 
+# phpunit
+.phpunit.result.cache
+phpunit.xml.dist
+
 # IDEs
 .idea/

Classes/Controller/ResetPasswordController.php

@@ -5,6 +5,7 @@
 use Neos\Flow\Property\TypeConverter\PersistentObjectConverter;
 use Sandstorm\UserManagement\Domain\Model\ResetPasswordFlow;
 use Sandstorm\UserManagement\Domain\Repository\ResetPasswordFlowRepository;
+use Sandstorm\UserManagement\Domain\Service\FindEmailAddressForUserServiceInterface;
 use Sandstorm\UserManagement\Domain\Service\UserCreationServiceInterface;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Mvc\Controller\ActionController;
@@ -40,6 +41,12 @@ class ResetPasswordController extends ActionController
      */
     protected $emailService;
 
+    /**
+     * @Flow\Inject
+     * @var FindEmailAddressForUserServiceInterface
+     */
+    protected $findEmailAddressForUserService;
+
     /**
      * @Flow\Inject
      * @var Translator
@@ -104,28 +111,32 @@ public function requestTokenAction(ResetPasswordFlow $resetPasswordFlow)
                 }
             }
 
-            // Send out a confirmation mail
-            $resetPasswordLink = $this->uriBuilder->reset()->setCreateAbsoluteUri(true)->uriFor(
-                'insertNewPassword',
-                ['token' => $resetPasswordFlow->getResetPasswordToken()],
-                'ResetPassword');
-
-            $this->emailService->sendTemplateEmail(
-                'ResetPasswordToken',
-                $this->getSubjectResetPassword(),
-                [$resetPasswordFlow->getEmail()],
-                [
-                    'resetPasswordLink' => $resetPasswordLink,
-                    'resetPasswordFlow' => $resetPasswordFlow
-                ],
-                'sandstorm_usermanagement_sender_email',
-                [], // cc
-                [], // bcc
-                [], // attachments
-                'sandstorm_usermanagement_replyTo_email'
-            );
-
-            $this->resetPasswordFlowRepository->add($resetPasswordFlow);
+            $receiverMail = $this->findEmailAddressForUserService->getEmailAddressByAccount($account);
+
+            if ($receiverMail !== null) {
+                // Send out a confirmation mail
+                $resetPasswordLink = $this->uriBuilder->reset()->setCreateAbsoluteUri(true)->uriFor(
+                    'insertNewPassword',
+                    ['token' => $resetPasswordFlow->getResetPasswordToken()],
+                    'ResetPassword');
+
+                $this->emailService->sendTemplateEmail(
+                    'ResetPasswordToken',
+                    $this->getSubjectResetPassword(),
+                    [$receiverMail],
+                    [
+                        'resetPasswordLink' => $resetPasswordLink,
+                        'resetPasswordFlow' => $resetPasswordFlow
+                    ],
+                    'sandstorm_usermanagement_sender_email',
+                    [], // cc
+                    [], // bcc
+                    [], // attachments
+                    'sandstorm_usermanagement_replyTo_email'
+                );
+
+                $this->resetPasswordFlowRepository->add($resetPasswordFlow);
+            }
         }
 
 

Classes/Domain/Model/ResetPasswordFlow.php

@@ -16,7 +16,6 @@ class ResetPasswordFlow
     /**
      * @var string
      * @Flow\Validate(type="NotEmpty")
-     * @Flow\Validate(type="EmailAddress")
      */
     protected $email;
 

Classes/Domain/Service/FindEmailAddressForUserByAccountIdentifierService.php

@@ -0,0 +1,23 @@
+<?php
+
+
+namespace Sandstorm\UserManagement\Domain\Service;
+
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Security\Account;
+
+/**
+ * @api
+ * @Flow\Scope("singleton")
+ */
+class FindEmailAddressForUserByAccountIdentifierService implements FindEmailAddressForUserServiceInterface
+{
+    /**
+     * @param Account $account
+     * @return string|null
+     */
+    public function getEmailAddressByAccount(Account $account)
+    {
+        return $account->getAccountIdentifier();
+    }
+}

Classes/Domain/Service/FindEmailAddressForUserServiceInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+
+namespace Sandstorm\UserManagement\Domain\Service;
+
+
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Security\Account;
+
+/**
+ * @api
+ */
+interface FindEmailAddressForUserServiceInterface
+{
+    /**
+     * @param Account $account
+     * @return string|null
+     */
+    public function getEmailAddressByAccount(Account $account);
+}

Configuration/Objects.yaml

@@ -3,3 +3,5 @@ Sandstorm\UserManagement\Domain\Service\RedirectTargetServiceInterface:
   className: 'Sandstorm\UserManagement\Domain\Service\Flow\FlowRedirectTargetService'
 Sandstorm\UserManagement\Domain\Service\UserCreationServiceInterface:
   className: 'Sandstorm\UserManagement\Domain\Service\Flow\FlowUserCreationService'
+Sandstorm\UserManagement\Domain\Service\FindEmailAddressForUserServiceInterface:
+  className: 'Sandstorm\UserManagement\Domain\Service\FindEmailAddressForUserByAccountIdentifierService'

README.md

@@ -287,6 +287,16 @@ Sandstorm\UserManagement\Domain\Service\UserCreationServiceInterface:
   className: 'Your\Package\Domain\Service\YourCustomUserCreationService'
 ```
 
+## Customizing how the reset-password e-mail address is resolved
+By default, the "forgot password" flow sends the reset link to the account identifier the user entered (i.e. username
+and e-mail address are assumed to be identical). If your application decouples usernames from e-mail addresses, you
+can override how the recipient address is resolved by implementing `FindEmailAddressForUserServiceInterface` and
+wiring it up via `Objects.yaml`:
+```YAML
+Sandstorm\UserManagement\Domain\Service\FindEmailAddressForUserServiceInterface:
+  className: 'Your\Package\Domain\Service\YourCustomFindEmailAddressForUserService'
+```
+
 ## Hooking into the login/logout process
 The UserManagement package emits three signals during the login and logout process, into which you can hook
 using Flows [Signals and Slots](http://flowframework.readthedocs.io/en/stable/TheDefinitiveGuide/PartIII/SignalsAndSlots.html)
@@ -370,8 +380,11 @@ class RegistrationFlowValidationService implements RegistrationFlowValidationSer
 ```
 
 # 4. Running Tests
-Run all unit tests with:
-`./bin/phpunit -c ./Build/BuildEssentials/PhpUnit/UnitTests.xml Packages/Application/Sandstorm.UserManagement/Tests/Unit`
+Unit tests run standalone in this package, no Flow distribution required:
+```
+composer install
+vendor/bin/phpunit Tests/Unit
+```
 
 To run E2E tests, see [E2E Test Readme](Tests/E2E/README.md)
 

Tests/Unit/Domain/PasswordDtoTest.php

@@ -5,19 +5,16 @@
 use Sandstorm\UserManagement\Domain\Model\PasswordDto;
 
 /**
- * Testcase for the package class
+ * Testcase for PasswordDto
  *
  */
-class PackageTest extends UnitTestCase
+class PasswordDtoTest extends UnitTestCase
 {
-    public function setUp()
+    public function setUp(): void
     {
     }
 
-    /**
-     * @test
-     */
-    public function equalPasswordsAreEqual()
+    public function testEqualPasswordsAreEqual()
     {
         $passwordDto = new PasswordDto();
         $passwordDto->setPassword('foobar');
@@ -26,10 +23,7 @@ public function equalPasswordsAreEqual()
         $this->assertTrue($passwordDto->arePasswordsEqual());
     }
 
-    /**
-     * @test
-     */
-    public function inequalPasswordsAreNotEqual()
+    public function testInequalPasswordsAreNotEqual()
     {
         $passwordDto = new PasswordDto();
         $passwordDto->setPassword('FOOBAR');
@@ -38,10 +32,7 @@ public function inequalPasswordsAreNotEqual()
         $this->assertFalse($passwordDto->arePasswordsEqual());
     }
 
-    /**
-     * @test
-     */
-    public function passwordMinLength()
+    public function testPasswordMinLength()
     {
         $passwordDto = new PasswordDto();
         $passwordDto->setPassword('6chars');
@@ -51,10 +42,7 @@ public function passwordMinLength()
         $this->assertFalse($passwordDto->isPasswordMinLength(7));
     }
 
-    /**
-     * @test
-     */
-    public function passwordMaxLength()
+    public function testPasswordMaxLength()
     {
         $passwordDto = new PasswordDto();
         $passwordDto->setPassword('6chars');
@@ -64,10 +52,7 @@ public function passwordMaxLength()
         $this->assertFalse($passwordDto->isPasswordMaxLength(5));
     }
 
-    /**
-     * @test
-     */
-    public function passwordContainsLowercaseLetters()
+    public function testPasswordContainsLowercaseLetters()
     {
         $passwordDto = new PasswordDto();
         $passwordDto->setPassword('4loweRCASELETTERS');
@@ -78,10 +63,7 @@ public function passwordContainsLowercaseLetters()
         $this->assertFalse($passwordDto->doesPasswordContainLowercaseLetters(5));
     }
 
-    /**
-     * @test
-     */
-    public function passwordContainsUppercaseLetters()
+    public function testPasswordContainsUppercaseLetters()
     {
         $passwordDto = new PasswordDto();
         $passwordDto->setPassword('4UPPErcaseletters');
@@ -92,10 +74,7 @@ public function passwordContainsUppercaseLetters()
         $this->assertFalse($passwordDto->doesPasswordContainUppercaseLetters(5));
     }
 
-    /**
-     * @test
-     */
-    public function passwordContainsNumbers()
+    public function testPasswordContainsNumbers()
     {
         $passwordDto = new PasswordDto();
         $passwordDto->setPassword('fournumbers1234');
@@ -106,10 +85,7 @@ public function passwordContainsNumbers()
         $this->assertFalse($passwordDto->doesPasswordContainNumbers(5));
     }
 
-    /**
-     * @test
-     */
-    public function passwordContainsSpecialCharacters()
+    public function testPasswordContainsSpecialCharacters()
     {
         $passwordDto = new PasswordDto();
         $passwordDto->setPassword('4specialCHARS!"%$');

Tests/Unit/Domain/Service/FindEmailAddressForUserByAccountIdentifierServiceTest.php

@@ -0,0 +1,33 @@
+<?php
+namespace Sandstorm\UserManagement\Tests\Unit\Domain\Service;
+
+use Neos\Flow\Security\Account;
+use Neos\Flow\Tests\UnitTestCase;
+use Sandstorm\UserManagement\Domain\Service\FindEmailAddressForUserByAccountIdentifierService;
+
+/**
+ * Testcase for the FindEmailAddressForUserByAccountIdentifierService
+ *
+ */
+class FindEmailAddressForUserByAccountIdentifierServiceTest extends UnitTestCase
+{
+    public function testReturnsTheAccountIdentifierWhenItIsAnEmailAddress()
+    {
+        $account = new Account();
+        $account->setAccountIdentifier('user@example.com');
+
+        $service = new FindEmailAddressForUserByAccountIdentifierService();
+
+        $this->assertSame('user@example.com', $service->getEmailAddressByAccount($account));
+    }
+
+    public function testReturnsTheAccountIdentifierUnchangedWhenItIsAPlainUsername()
+    {
+        $account = new Account();
+        $account->setAccountIdentifier('someuser');
+
+        $service = new FindEmailAddressForUserByAccountIdentifierService();
+
+        $this->assertSame('someuser', $service->getEmailAddressByAccount($account));
+    }
+}

composer.json

@@ -26,9 +26,18 @@
         "neos/flow": "^8.3 || ^9.0",
         "sandstorm/templatemailer": "^3.0.1 || dev-master"
     },
+    "require-dev": {
+        "phpunit/phpunit": "^13.0"
+    },
     "autoload": {
         "psr-4": {
             "Sandstorm\\UserManagement\\": "Classes"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Sandstorm\\UserManagement\\Tests\\": "Tests",
+            "Neos\\Flow\\Tests\\": "vendor/neos/flow/Tests"
+        }
     }
 }