OXDEV-9078 Translate OTP emails

Author: TitaKoleva

src/Authentication/TwoFactorAuth/OTP/Notifier/Email/OtpEmailNotifier.php

@@ -9,6 +9,7 @@
 
 namespace OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Notifier\Email;
 
+use OxidEsales\Eshop\Core\Language;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\EmailFactoryInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository\NewUserRepositoryInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Notifier\OtpNotifierInterface;
@@ -18,18 +19,18 @@ class OtpEmailNotifier implements OtpNotifierInterface
     public function __construct(
         private EmailFactoryInterface $emailFactory,
         private NewUserRepositoryInterface $userRepository,
+        private Language $language,
     ) {
     }
 
     public function notify(string $userId, #[\SensitiveParameter] string $code): void
     {
         $email = $this->userRepository->getUserById($userId)->getEmail();
 
-        // todo-critical: load the translations
         $this->emailFactory->create()->sendEmail(
             $email,
-            'Your verification code',
-            "Your verification code is: {$code}"
+            $this->language->translateString('OTP_EMAIL_SUBJECT'),
+            sprintf($this->language->translateString('OTP_EMAIL_BODY'), $code)
         );
     }
 }

src/Authentication/TwoFactorAuth/OTP/Notifier/services.yaml

@@ -2,6 +2,8 @@ services:
   _defaults:
     autowire: true
     public: false
+    bind:
+      OxidEsales\Eshop\Core\Language: '@=service("OxidEsales\\SecurityModule\\Core\\Registry").getLang()'
 
   OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Notifier\OtpNotifierInterface:
     class: OxidEsales\SecurityModule\Authentication\TwoFactorAuth\OTP\Notifier\Email\OtpEmailNotifier

tests/Unit/Authentication/TwoFactorAuth/OTP/Notifier/Email/OtpEmailNotifierTest.php

@@ -10,6 +10,7 @@
 namespace OxidEsales\SecurityModule\Tests\Unit\Authentication\TwoFactorAuth\OTP\Notifier\Email;
 
 use OxidEsales\Eshop\Core\Email;
+use OxidEsales\Eshop\Core\Language;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\DTO\NewUserInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Factory\EmailFactoryInterface;
 use OxidEsales\SecurityModule\Authentication\TwoFactorAuth\Infrastructure\Repository\NewUserRepositoryInterface;
@@ -24,6 +25,8 @@ public function notifySendsEmailToUserAddress(): void
     {
         $email = uniqid() . '@example.com';
         $code = uniqid();
+        $subject = uniqid();
+        $bodyTemplate = uniqid() . ' %s';
 
         $userStub = $this->createStub(NewUserInterface::class);
         $userStub->method('getEmail')->willReturn($email);
@@ -34,13 +37,22 @@ public function notifySendsEmailToUserAddress(): void
             ->with($userId = uniqid())
             ->willReturn($userStub);
 
+        $translations = [
+            'OTP_EMAIL_SUBJECT' => $subject,
+            'OTP_EMAIL_BODY'    => $bodyTemplate,
+        ];
+        $languageStub = $this->createStub(Language::class);
+        $languageStub->method('translateString')->willReturnCallback(
+            fn(string $key) => $translations[$key] ?? $key
+        );
+
         $emailModelSpy = $this->createMock(Email::class);
         $emailModelSpy->expects($this->once())
             ->method('sendEmail')
             ->with(
                 $email,
-                'Your verification code',
-                "Your verification code is: {$code}"
+                $subject,
+                sprintf($bodyTemplate, $code)
             );
 
         $emailFactoryStub = $this->createStub(EmailFactoryInterface::class);
@@ -49,6 +61,7 @@ public function notifySendsEmailToUserAddress(): void
         $sut = $this->getSut(
             emailFactory: $emailFactoryStub,
             userRepository: $userRepositoryMock,
+            language: $languageStub,
         );
 
         $sut->notify(userId: $userId, code: $code);
@@ -57,10 +70,12 @@ public function notifySendsEmailToUserAddress(): void
     private function getSut(
         EmailFactoryInterface $emailFactory = null,
         NewUserRepositoryInterface $userRepository = null,
+        Language $language = null,
     ): OtpEmailNotifier {
         return new OtpEmailNotifier(
             emailFactory: $emailFactory ?? $this->createStub(EmailFactoryInterface::class),
             userRepository: $userRepository ?? $this->createStub(NewUserRepositoryInterface::class),
+            language: $language ?? $this->createStub(Language::class),
         );
     }
 }

translations/de/oesecuritymodule_lang.php

@@ -42,6 +42,9 @@
 
     'SIGN_IN_PROVIDER' => 'Anmelden mit %s',
 
+    'OTP_EMAIL_SUBJECT' => 'Ihr Verifizierungscode',
+    'OTP_EMAIL_BODY'    => 'Ihr Verifizierungscode lautet: %s',
+
     'TWO_FACTOR_AUTHENTICATION_TITLE'       => 'Zwei-Faktor-Authentifizierung',
     'TWO_FACTOR_AUTHENTICATION_DESCRIPTION' => 'Ein Code wurde an Ihre E-Mail-Adresse gesendet. Bitte geben Sie ihn unten ein, um fortzufahren.',
 

translations/en/oesecuritymodule_lang.php

@@ -42,6 +42,9 @@
 
     'SIGN_IN_PROVIDER' => 'Sign in with %s',
 
+    'OTP_EMAIL_SUBJECT' => 'Your verification code',
+    'OTP_EMAIL_BODY'    => 'Your verification code is: %s',
+
     'TWO_FACTOR_AUTHENTICATION_TITLE'       => 'Two Factor Authentication',
     'TWO_FACTOR_AUTHENTICATION_DESCRIPTION' => 'Code has been sent to your email. Please enter it below to proceed.',