feat(mail): support the use of markdown in the email body

build.gradle.kts

@@ -47,6 +47,7 @@ dependencies {
     implementation("com.amazonaws:aws-java-sdk-ses:1.11.880")
     implementation("com.amazonaws:aws-java-sdk-sqs:1.12.+")
     implementation("io.github.microutils:kotlin-logging-jvm:3.0.0")
+    implementation("org.jetbrains:markdown:0.5.0")
     compileOnly("io.jsonwebtoken:jjwt-api:0.11.2")
     runtimeOnly("io.jsonwebtoken:jjwt-impl:0.11.2")
     runtimeOnly("io.jsonwebtoken:jjwt-jackson:0.11.2")

src/main/kotlin/apply/application/mail/MailData.kt

@@ -1,6 +1,7 @@
 package apply.application.mail
 
 import apply.domain.mail.MailHistory
+import apply.utils.MarkdownProcessor
 import org.springframework.core.io.ByteArrayResource
 import java.time.LocalDateTime
 import javax.validation.constraints.NotEmpty
@@ -38,4 +39,8 @@ data class MailData(
         mailHistory.sentTime,
         id = mailHistory.id
     )
+
+    fun getHtmlBody(): String {
+        return MarkdownProcessor.generateToHtml(body)
+    }
 }

src/main/kotlin/apply/application/mail/MailService.kt

@@ -89,15 +89,7 @@ class MailService(
 
     @Async
     fun sendMailsByBcc(request: MailData, files: Map<String, ByteArrayResource>) {
-        val context = Context().apply {
-            setVariables(
-                mapOf(
-                    "content" to request.body,
-                    "url" to applicationProperties.url
-                )
-            )
-        }
-        val body = templateEngine.process("mail/common", context)
+        val body = createCommonMailBodyFrom(request)
         val recipients = request.recipients + mailProperties.username
 
         // TODO: 성공과 실패를 분리하여 히스토리 관리
@@ -119,4 +111,16 @@ class MailService(
             )
         )
     }
+
+    fun createCommonMailBodyFrom(mailData: MailData): String {
+        val context = Context().apply {
+            setVariables(
+                mapOf(
+                    "content" to mailData.getHtmlBody(),
+                    "url" to applicationProperties.url
+                )
+            )
+        }
+        return templateEngine.process("mail/common", context)
+    }
 }

src/main/kotlin/apply/infra/mail/FakeMailSender.kt

@@ -0,0 +1,24 @@
+package apply.infra.mail
+
+import apply.application.mail.MailSender
+import mu.KotlinLogging
+import org.springframework.core.io.ByteArrayResource
+
+private val logger = KotlinLogging.logger { }
+
+class FakeMailSender : MailSender {
+    override fun send(toAddress: String, subject: String, body: String) {
+        logger.info("send mail: to - {}, subject - {}", toAddress, subject)
+        logger.info("body: {}", body)
+    }
+
+    override fun sendBcc(
+        toAddresses: List<String>,
+        subject: String,
+        body: String,
+        attachments: Map<String, ByteArrayResource>
+    ) {
+        logger.info("send mail: to - {}, subject - {}", toAddresses, subject)
+        logger.info("body: {}", body)
+    }
+}

src/main/kotlin/apply/utils/MarkdownProcessor.kt

@@ -0,0 +1,14 @@
+package apply.utils
+
+import org.intellij.markdown.flavours.commonmark.CommonMarkFlavourDescriptor
+import org.intellij.markdown.html.HtmlGenerator
+import org.intellij.markdown.parser.MarkdownParser
+
+object MarkdownProcessor {
+    private val flavour = CommonMarkFlavourDescriptor()
+
+    fun generateToHtml(source: String): String {
+        val parsedTree = MarkdownParser(flavour).buildMarkdownTreeFromString(source)
+        return HtmlGenerator(source, parsedTree, flavour).generateHtml()
+    }
+}

src/main/resources/templates/mail/common.html

@@ -63,7 +63,7 @@
                         padding-right: 8px;
                       "
                     >
-                      <span th:utext="${content}"></span>
+                      [(${content})]
                     </td>
                   </tr>
                 </table>

src/test/kotlin/apply/application/mail/MailServiceTest.kt

@@ -0,0 +1,30 @@
+package apply.application.mail
+
+import apply.config.TestMailConfig
+import apply.createMailData
+import io.kotest.core.spec.style.BehaviorSpec
+import io.kotest.matchers.string.shouldContain
+import org.springframework.test.context.ContextConfiguration
+import support.test.IntegrationTest
+
+@IntegrationTest
+@ContextConfiguration(classes = [TestMailConfig::class])
+class MailServiceTest(
+    private val mailService: MailService
+) : BehaviorSpec({
+
+    Given("MailData를 사용해서 메일을 보내는 경우") {
+        val body = "안녕하세요. 우아한테크코스입니다.\n" + "\n" +
+            "1주 차 미션은 개발 환경을 세팅하고, GitHub에 과제를 제출하는 등 미션 외에도 추가로 익혀야 하는 부분들이 있어 가벼운 미션으로 준비했어요."
+        val mailData = createMailData(body = body)
+
+        When("common 메일 본문에 적용하면") {
+            val commonMailBody = mailService.createCommonMailBodyFrom(mailData)
+
+            Then("본문이 포함된 HTML로 작성된다.") {
+                println(commonMailBody)
+                commonMailBody shouldContain "<body><p>안녕하세요. 우아한테크코스입니다."
+            }
+        }
+    }
+})

src/test/kotlin/apply/config/TestMailConfig.kt

@@ -0,0 +1,16 @@
+package apply.config
+
+import apply.application.mail.MailSender
+import apply.infra.mail.FakeMailSender
+import org.springframework.boot.test.context.TestConfiguration
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Primary
+
+@TestConfiguration
+class TestMailConfig {
+    @Primary
+    @Bean
+    fun testMailSender(): MailSender {
+        return FakeMailSender()
+    }
+}

src/test/kotlin/apply/utils/MarkdownProcessorTest.kt

@@ -0,0 +1,29 @@
+package apply.utils
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.string.shouldContain
+
+class MarkdownProcessorTest : StringSpec({
+    "마크다운 문법으로 작성된 내용을 HTML로 변환할 수 있다" {
+        val src = "안녕하세요. 우아한테크코스입니다.\n" +
+            "3주 차 미션에서는 2주 차에서 학습한 것에 2가지 목표를 추가했어요.\n" +
+            "1. 클래스(객체)를 분리하는 연습\n" +
+            "2. 도메인 로직에 대한 단위 테스트를 작성하는 연습\n" +
+            "## 프리코스 진행방식\n" +
+            "### 미션 제출 방법\n" +
+            "- 미션 구현을 완료한 후 GitHub을 통해 제출해야 한다.\n" +
+            "- GitHub을 활용한 제출 방법은 " +
+            "[문서](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse)를 참고해 제출한다.\n" +
+            "- GitHub에 미션을 제출한 후 " +
+            "[우아한테크코스 지원 플랫폼](https://apply.techcourse.co.kr/)에서 프리코스 과제를 제출한다.\n" +
+            "- 지원 플랫폼에서 과제를 제출할 때 미션을 진행하며 경험한 내용에 대한 소감문을 작성한다."
+
+        val html = MarkdownProcessor.generateToHtml(src)
+
+        println(html)
+        html shouldContain "<ul>"
+        html shouldContain "<li>클래스(객체)를 분리하는 연습</li>"
+        html shouldContain "<h3>"
+        html shouldContain "<a href"
+    }
+})