Fixes for setting updated at on tokens preventing email sending

Author: silverbackdan

src/Entity/User/AbstractUser.php

@@ -99,7 +99,7 @@ abstract class AbstractUser implements SymfonyUserInterface, PasswordAuthenticat
     protected ?\DateTime $newEmailAddressChangeRequestedAt = null;
 
     #[ApiProperty(readable: false, writable: false)]
-    public ?string $plainNewEmailConfirmationToken = null;
+    private ?string $plainNewEmailConfirmationToken = null;
 
     #[ApiProperty(readable: true, writable: false)]
     #[Groups(['User:output', 'Form:cwa_resource:read'])]
@@ -112,7 +112,7 @@ abstract class AbstractUser implements SymfonyUserInterface, PasswordAuthenticat
     protected ?string $emailAddressVerifyToken = null;
 
     #[ApiProperty(readable: false, writable: false)]
-    public ?string $plainEmailAddressVerifyToken = null;
+    private ?string $plainEmailAddressVerifyToken = null;
 
     #[ApiProperty(readable: false, writable: false)]
     protected ?\DateTime $emailLastUpdatedAt = null;
@@ -253,9 +253,6 @@ public function getNewEmailAddress(): ?string
     public function setNewEmailAddress(?string $newEmailAddress): self
     {
         $this->newEmailAddress = $newEmailAddress;
-        if ($newEmailAddress) {
-            $this->newEmailAddressChangeRequestedAt = new \DateTime();
-        }
 
         return $this;
     }
@@ -268,9 +265,6 @@ public function getNewEmailConfirmationToken(): ?string
     public function setNewEmailConfirmationToken(?string $newEmailConfirmationToken): self
     {
         $this->newEmailConfirmationToken = $newEmailConfirmationToken;
-        if ($newEmailConfirmationToken) {
-            $this->newEmailAddressChangeRequestedAt = new \DateTime();
-        }
 
         return $this;
     }
@@ -300,9 +294,6 @@ public function getEmailAddressVerifyToken(): ?string
     public function setEmailAddressVerifyToken(?string $emailAddressVerifyToken): void
     {
         $this->emailAddressVerifyToken = $emailAddressVerifyToken;
-        if ($emailAddressVerifyToken) {
-            $this->emailLastUpdatedAt = new \DateTime();
-        }
     }
 
     public function isPasswordRequestLimitReached($ttl): bool
@@ -408,4 +399,30 @@ public function getUserIdentifier(): string
     {
         return $this->getUsername();
     }
+
+    public function getPlainNewEmailConfirmationToken(): ?string
+    {
+        return $this->plainNewEmailConfirmationToken;
+    }
+
+    public function setPlainNewEmailConfirmationToken(?string $plainNewEmailConfirmationToken): void
+    {
+        $this->plainNewEmailConfirmationToken = $plainNewEmailConfirmationToken;
+        if ($plainNewEmailConfirmationToken) {
+            $this->newEmailAddressChangeRequestedAt = new \DateTime();
+        }
+    }
+
+    public function getPlainEmailAddressVerifyToken(): ?string
+    {
+        return $this->plainEmailAddressVerifyToken;
+    }
+
+    public function setPlainEmailAddressVerifyToken(?string $plainEmailAddressVerifyToken): void
+    {
+        $this->plainEmailAddressVerifyToken = $plainEmailAddressVerifyToken;
+        if ($plainEmailAddressVerifyToken) {
+            $this->emailLastUpdatedAt = new \DateTime();
+        }
+    }
 }

src/EventListener/Api/UserEventListener.php

@@ -100,7 +100,7 @@ public function postWrite(AbstractUser $user, ?AbstractUser $previousUser): void
         }
 
         // we need the plain token to have been set - it should be, but we cannot read the previous user verify token to match, this fail-safes our process
-        if ($user->plainEmailAddressVerifyToken && ($token = $user->getEmailAddressVerifyToken()) && $token !== $previousUser->getEmailAddressVerifyToken()) {
+        if ($user->getPlainEmailAddressVerifyToken() && ($token = $user->getEmailAddressVerifyToken()) && $token !== $previousUser->getEmailAddressVerifyToken()) {
             $this->userMailer->sendEmailVerifyEmail($user);
         }
 

src/Factory/User/Mailer/ChangeEmailConfirmationEmailFactory.php

@@ -32,8 +32,8 @@ public function create(AbstractUser $user, array $context = []): ?RawMessage
 
         $this->initUser($user);
 
-        $token = $user->plainNewEmailConfirmationToken;
-        $user->plainNewEmailConfirmationToken = null;
+        $token = $user->getPlainNewEmailConfirmationToken();
+        $user->setPlainNewEmailConfirmationToken(null);
         if (!$token) {
             throw new InvalidArgumentException('A `new email confirmation token` must be set to send the confirmation email');
         }

src/Factory/User/Mailer/VerifyEmailFactory.php

@@ -32,8 +32,8 @@ public function create(AbstractUser $user, array $context = []): ?RawMessage
 
         $this->initUser($user);
 
-        $token = $user->plainEmailAddressVerifyToken;
-        $user->plainEmailAddressVerifyToken = null;
+        $token = $user->getPlainEmailAddressVerifyToken();
+        $user->setPlainEmailAddressVerifyToken(null);
         if (!$token) {
             throw new InvalidArgumentException('An `email verify token` must be set to send the verification email');
         }

src/Factory/User/Mailer/WelcomeEmailFactory.php

@@ -31,8 +31,8 @@ public function create(AbstractUser $user, array $context = []): ?RawMessage
 
         $this->initUser($user);
 
-        $token = $user->plainEmailAddressVerifyToken;
-        $user->plainEmailAddressVerifyToken = null;
+        $token = $user->getPlainEmailAddressVerifyToken();
+        $user->setPlainEmailAddressVerifyToken(null);
         if ($token) {
             $context['redirect_url'] = $this->getTokenUrl($token, $user->getUsername());
         }

src/Helper/User/UserDataProcessor.php

@@ -94,8 +94,8 @@ public function processChanges(AbstractUser $user, ?AbstractUser $previousUser):
                     // invalidate any existing requests
                     $user->setNewEmailConfirmationToken(null);
                     // revert any tokens for the new primary saved email address as this was converted from the update
-                    if ($previousUser->getNewEmailAddress() === $user->getEmailAddress() && $user->plainEmailAddressVerifyToken) {
-                        $user->plainEmailAddressVerifyToken = null;
+                    if ($previousUser->getNewEmailAddress() === $user->getEmailAddress() && $user->getPlainEmailAddressVerifyToken()) {
+                        $user->setPlainEmailAddressVerifyToken(null);
                         $user->setEmailAddressVerifyToken(null);
                     }
                 }
@@ -138,13 +138,13 @@ public function updateVerifyEmailToken(string $usernameQuery): ?AbstractUser
     private function setNewEmailConfirmationToken(AbstractUser $user): void
     {
         $user->setNewEmailConfirmationToken($this->passwordHasher->hashPassword($user, $token = TokenGenerator::generateToken()));
-        $user->plainNewEmailConfirmationToken = $token;
+        $user->setPlainNewEmailConfirmationToken($token);
     }
 
     private function setEmailAddressVerifyToken(AbstractUser $user): void
     {
         $user->setEmailAddressVerifyToken($this->passwordHasher->hashPassword($user, $token = TokenGenerator::generateToken()));
-        $user->plainEmailAddressVerifyToken = $token;
+        $user->setPlainEmailAddressVerifyToken($token);
     }
 
     private function hashPassword(AbstractUser $entity): void