feat: React Emails > default template (#3194)

Co-authored-by: Daniel Krizan <danyelkrizan@gmail.com>

Author: JanCizmar

backend/api/src/main/kotlin/io/tolgee/controllers/resetPassword/ResetPasswordRequestHandler.kt

@@ -47,15 +47,12 @@ class ResetPasswordRequestHandler(
       EmailParams(
         to = request.email,
         subject = if (isInitial) "Initial password configuration" else "Password reset",
-        text =
+        header = "Password reset",
+          text =
           """
-          Hello! 👋<br/><br/>
           ${if (isInitial) "To set a password for your account, <b>follow this link</b>:<br/>" else "To reset your password, <b>follow this link</b>:<br/>"}
           <a href="$url">$url</a><br/><br/>
           If you have not requested this e-mail, please ignore it.<br/><br/>
-          
-          Regards,<br/>
-          Tolgee
           """.trimIndent(),
       )
 
@@ -67,15 +64,12 @@ class ResetPasswordRequestHandler(
       EmailParams(
         to = request.email,
         subject = "Password reset - SSO managed account",
+        header = "Password reset",
         text =
           """
-          Hello! 👋<br/><br/>
           We received a request to reset the password for your account. However, your account is managed by your organization and uses a single sign-on (SSO) service to log in.<br/><br/>
           To access your account, please use the "SSO Login" button on the Tolgee login page. No password reset is needed.<br/><br/>
           If you did not make this request, you may safely ignore this email.<br/><br/>
-          
-          Regards,<br/>
-          Tolgee
           """.trimIndent(),
       )
 

backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/V2UserControllerTest.kt

@@ -131,7 +131,9 @@ class V2UserControllerTest : AuthorizedControllerTest() {
       )
     performAuthPut("/v2/user", requestDTO).andIsOk
 
-    emailTestUtil.verifyEmailSent()
+    waitForNotThrowing(timeout = 2000, pollTime = 25) {
+      emailTestUtil.verifyEmailSent()
+    }
     assertThat(emailTestUtil.messageContents.single())
       .contains(tolgeeProperties.frontEndUrl.toString())
 

backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/organizationController/OrganizationControllerInvitingTest.kt

@@ -162,7 +162,9 @@ class OrganizationControllerInvitingTest : AuthorizedControllerTest() {
     val organization = prepareTestOrganization()
 
     val code = inviteWithUserWithNameAndEmail(organization.id)
-    emailTestUtil.verifyEmailSent()
+    waitForNotThrowing(timeout = 2000, pollTime = 25) {
+      emailTestUtil.verifyEmailSent()
+    }
 
     val messageContent = emailTestUtil.messageContents.single()
     assertThat(messageContent).contains(code)
@@ -176,7 +178,9 @@ class OrganizationControllerInvitingTest : AuthorizedControllerTest() {
     val organization = prepareTestOrganization()
 
     inviteWithUserWithNameAndEmail(organization.id)
-    emailTestUtil.verifyEmailSent()
+    waitForNotThrowing(timeout = 2000, pollTime = 25) {
+      emailTestUtil.verifyEmailSent()
+    }
 
     val messageContent = emailTestUtil.messageContents.single()
     assertThat(messageContent).doesNotContain("<a href='https://evil.local")

backend/app/src/test/kotlin/io/tolgee/api/v2/controllers/v2ProjectsController/ProjectsControllerInvitationTest.kt

@@ -150,7 +150,9 @@ class ProjectsControllerInvitationTest : ProjectAuthControllerTest("/v2/projects
   @ProjectJWTAuthTestMethod
   fun `sends invitation e-mail`() {
     val code = inviteWithUserWithNameAndEmail()
-    emailTestUtil.verifyEmailSent()
+    waitForNotThrowing(timeout = 2000, pollTime = 25) {
+      emailTestUtil.verifyEmailSent()
+    }
 
     val messageContent = emailTestUtil.messageContents.single()
     assertThat(messageContent).contains(code)
@@ -162,7 +164,9 @@ class ProjectsControllerInvitationTest : ProjectAuthControllerTest("/v2/projects
   @ProjectJWTAuthTestMethod
   fun `uses frontEnd url when possible`() {
     inviteWithUserWithNameAndEmail()
-    emailTestUtil.verifyEmailSent()
+    waitForNotThrowing(timeout = 2000, pollTime = 25) {
+      emailTestUtil.verifyEmailSent()
+    }
 
     val messageContent = emailTestUtil.messageContents.single()
     assertThat(messageContent).contains("https://dummy-url.com")

backend/app/src/test/kotlin/io/tolgee/controllers/resetPassword/ResetPasswordControllerTest.kt

@@ -1,18 +1,17 @@
 package io.tolgee.controllers.resetPassword
 
-import com.posthog.java.PostHog
 import io.tolgee.development.testDataBuilder.data.BaseTestData
 import io.tolgee.dtos.request.auth.ResetPasswordRequest
 import io.tolgee.fixtures.EmailTestUtil
 import io.tolgee.fixtures.andIsOk
+import io.tolgee.fixtures.waitForNotThrowing
 import io.tolgee.testing.AbstractControllerTest
 import io.tolgee.testing.assert
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
-import org.springframework.boot.test.mock.mockito.MockBean
 
 @AutoConfigureMockMvc
 class ResetPasswordControllerTest :
@@ -37,25 +36,25 @@ class ResetPasswordControllerTest :
   @Autowired
   private lateinit var emailTestUtil: EmailTestUtil
 
-  @MockBean
-  @Autowired
-  lateinit var postHog: PostHog
-
   @Test
   fun `email contains correct callback url with frontend url provided`() {
     executePasswordChangeRequest()
-    emailTestUtil.firstMessageContent.assert.contains("https://dummy-url.com/reset_password/")
-    // We don't want double slashes
-    emailTestUtil.firstMessageContent.assert.doesNotContain("reset_password//")
+    waitForNotThrowing(timeout = 2000, pollTime = 25) {
+      emailTestUtil.firstMessageContent.assert.contains("https://dummy-url.com/reset_password/")
+      // We don't want double slashes
+      emailTestUtil.firstMessageContent.assert.doesNotContain("reset_password//")
+    }
   }
 
   @Test
   fun `email contains correct callback url without frontend url provided`() {
     tolgeeProperties.frontEndUrl = null
     executePasswordChangeRequest()
-    emailTestUtil.firstMessageContent.assert.contains("https://hello.com/aa/")
-    // We don't want double slashes
-    emailTestUtil.firstMessageContent.assert.doesNotContain("aa//")
+    waitForNotThrowing(timeout = 2000, pollTime = 25) {
+      emailTestUtil.firstMessageContent.assert.contains("https://hello.com/aa/")
+      // We don't want double slashes
+      emailTestUtil.firstMessageContent.assert.doesNotContain("aa//")
+    }
   }
 
   private fun executePasswordChangeRequest() {

backend/app/src/test/kotlin/io/tolgee/service/notification/NotificationServiceTest.kt

@@ -2,6 +2,7 @@ package io.tolgee.service.notification
 
 import io.tolgee.AbstractSpringTest
 import io.tolgee.development.Base
+import io.tolgee.fixtures.waitForNotThrowing
 import io.tolgee.model.notifications.Notification
 import io.tolgee.model.notifications.NotificationChannel
 import io.tolgee.model.notifications.NotificationType
@@ -81,8 +82,10 @@ class NotificationServiceTest : AbstractSpringTest() {
   private fun assertInAppNotificationNotExists() = notificationTestUtil.assertNoInAppNotifications()
 
   private fun assertEmailNotificationExists() {
-    notificationTestUtil.newestEmailNotification().also {
-      assertThat(it).contains("Password has been changed for your account")
+    waitForNotThrowing(timeout = 2000, pollTime = 25) {
+      notificationTestUtil.newestEmailNotification().also {
+        assertThat(it).contains("Password has been changed for your account")
+      }
     }
   }
 

backend/data/src/main/kotlin/io/tolgee/component/email/EmailVerificationSender.kt

@@ -1,34 +1,31 @@
 package io.tolgee.component.email
 
 import io.tolgee.dtos.misc.EmailParams
+import io.tolgee.model.UserAccount
 import org.springframework.stereotype.Component
 
 @Component
 class EmailVerificationSender(
   private val tolgeeEmailSender: TolgeeEmailSender,
 ) {
   fun sendEmailVerification(
-    userId: Long,
+    user: UserAccount,
     email: String,
     resultCallbackUrl: String?,
     code: String,
     isSignUp: Boolean = true,
   ) {
-    val url = "$resultCallbackUrl/$userId/$code"
+    val url = "$resultCallbackUrl/${user.id}/$code"
     val params =
       EmailParams(
         to = email,
         subject = "Tolgee e-mail verification",
-        text =
-          """
-          Hello! 👋<br/><br/>
+        header = "Verify your e-mail",
+        text = """
           ${if (isSignUp) "Welcome to Tolgee. Thanks for signing up. \uD83C\uDF89<br/><br/>" else ""}
           
           To verify your e-mail, <b>follow this link</b>:<br/>
           <a href="$url">$url</a><br/><br/>
-          
-          Regards,<br/>
-          Tolgee
           """.trimIndent(),
       )
     tolgeeEmailSender.sendEmail(params)

backend/data/src/main/kotlin/io/tolgee/component/email/InvitationEmailSender.kt

@@ -23,14 +23,10 @@ class InvitationEmailSender(
         subject = "Invitation to Tolgee",
         text =
           """
-          Hello! 👋<br/><br/>
           Good news. ${getInvitationSentence(invitation)}<br/><br/>
           
           To accept the invitation, <b>follow this link</b>:<br/>
           <a href="$url">$url</a><br/><br/>
-          
-          Regards,<br/>
-          Tolgee
           """.trimIndent(),
       )
     tolgeeEmailSender.sendEmail(params)

backend/data/src/main/kotlin/io/tolgee/component/email/TolgeeEmailSender.kt

@@ -1,69 +1,28 @@
 package io.tolgee.component.email
 
-import io.tolgee.configuration.tolgee.TolgeeProperties
 import io.tolgee.dtos.misc.EmailParams
-import org.springframework.core.io.ClassPathResource
-import org.springframework.mail.javamail.JavaMailSender
+import io.tolgee.email.EmailService
 import org.springframework.stereotype.Component
+import java.util.Locale
 
 @Component
 class TolgeeEmailSender(
-  private val tolgeeProperties: TolgeeProperties,
-  private val mailSender: JavaMailSender,
-  private val mimeMessageHelperFactory: MimeMessageHelperFactory,
+  private val emailService: EmailService,
 ) {
   fun sendEmail(params: EmailParams) {
-    validateProps()
-    val helper = mimeMessageHelperFactory.create()
-    helper.setFrom(params.from ?: tolgeeProperties.smtp.from!!)
-    helper.setTo(params.to)
-    params.replyTo?.let {
-      helper.setReplyTo(it)
-    }
-    if (!params.bcc.isNullOrEmpty()) {
-      helper.setBcc(params.bcc!!)
-    }
-    helper.setSubject(params.subject)
-    val content =
-      """
-      <html>
-      <body style="font-size: 15px">
-      ${params.text}<br/><br/>
-      <img style="max-width: 100%; width:120px" src="cid:logo.png" />
-      </body>
-      </html>
-      """.trimIndent()
-    helper.setText(content, true)
-
-    params.attachments.forEach {
-      helper.addAttachment(it.name, it.inputStreamSource)
-    }
-
-    helper.addInline(
-      "logo.png",
-      { ClassPathResource("tolgee-logo.png").inputStream },
-      "image/png",
+    val properties = mapOf<String, Any>()
+      .let { if (params.text != null) it.plus("content" to params.text!!) else it }
+      .let { if (params.header != null) it.plus("header" to params.header!!) else it }
+      .let { if (params.recipientName != null) it.plus("recipientName" to params.recipientName!!) else it }
+    emailService.sendEmailTemplate(
+      recipient = params.to,
+      subject = params.subject,
+      template = params.templateName ?: "default",
+      locale = Locale.ENGLISH,
+      properties = properties,
+      attachments = params.attachments,
+      bcc = params.bcc,
+      replyTo = params.replyTo,
     )
-
-    mailSender.send(helper.mimeMessage)
-  }
-
-  private fun validateProps() {
-    if (tolgeeProperties.smtp.from.isNullOrEmpty()) {
-      throw IllegalStateException(
-        """tolgee.smtp.from property not provided.
-        |You have to configure smtp properties to send an e-mail.
-        """.trimMargin(),
-      )
-    }
-  }
-
-  fun getSignature(): String {
-    return """
-      <br /><br />
-      Best regards,
-      <br />
-      Tolgee Team
-      """.trimIndent()
   }
 }

backend/data/src/main/kotlin/io/tolgee/configuration/tolgee/TolgeeProperties.kt

@@ -135,4 +135,10 @@ open class TolgeeProperties(
     description = "LLM Providers configuration",
   )
   var llmProperties: LlmProperties = LlmProperties(),
+  @DocProperty(
+    description = "Public URL of the Tolgee API endpoint. While this typically matches the 'frontEndUrl', " +
+      "it should be set separately when running the backend on a different URL." +
+      "\n\n"
+  )
+  var backEndUrl: String? = null,
 )