feat(mission): support markdown syntax for mission descriptions

src/docs/asciidoc/mission.adoc

@@ -1,5 +1,9 @@
 = 과제 관련 API
 
-== 내 과제 조회
+== 내 과제 목록 조회
+
+operation::mission-list-me-get[snippets='http-request,http-response']
+
+== 내 과제 상세 조회
 
 operation::mission-me-get[snippets='http-request,http-response']

src/main/kotlin/apply/application/MissionDtos.kt

@@ -95,10 +95,9 @@ data class MissionResponse(
     )
 }
 
-data class MyMissionResponse(
+data class MyMissionAndJudgementResponse(
     val id: Long,
     val title: String,
-    val description: String,
     val submittable: Boolean,
     val submitted: Boolean,
     val startDateTime: LocalDateTime,
@@ -115,7 +114,6 @@ data class MyMissionResponse(
     ) : this(
         mission.id,
         mission.title,
-        mission.description,
         mission.submittable,
         submitted,
         mission.period.startDateTime,
@@ -126,6 +124,28 @@ data class MyMissionResponse(
     )
 }
 
+data class MyMissionResponse(
+    val id: Long,
+    val title: String,
+    val description: String,
+    val submittable: Boolean,
+    val startDateTime: LocalDateTime,
+    val endDateTime: LocalDateTime,
+    val status: MissionStatus,
+    val submitted: Boolean,
+) {
+    constructor(mission: Mission, submitted: Boolean, formattedDescription: String) : this(
+        mission.id,
+        mission.title,
+        formattedDescription,
+        mission.submittable,
+        mission.period.startDateTime,
+        mission.period.endDateTime,
+        mission.status,
+        submitted
+    )
+}
+
 data class JudgmentItemData(
     var id: Long = 0L,
     var testName: String = "",

src/main/kotlin/apply/application/MissionService.kt

@@ -11,6 +11,7 @@ import apply.domain.mission.getOrThrow
 import org.springframework.data.repository.findByIdOrNull
 import org.springframework.stereotype.Service
 import org.springframework.transaction.annotation.Transactional
+import support.markdownToEmbeddedHtml
 
 @Transactional
 @Service
@@ -120,4 +121,8 @@ class MissionService(
             ?.let(::EvaluationItemSelectData)
             ?: EvaluationItemSelectData()
     }
+
+    fun parseDescription(description: String): String {
+        return markdownToEmbeddedHtml(description)
+    }
 }

src/main/kotlin/apply/application/MyMissionService.kt

@@ -12,8 +12,10 @@ import apply.domain.judgmentitem.JudgmentItem
 import apply.domain.judgmentitem.JudgmentItemRepository
 import apply.domain.mission.Mission
 import apply.domain.mission.MissionRepository
+import apply.domain.mission.getOrThrow
 import org.springframework.stereotype.Service
 import org.springframework.transaction.annotation.Transactional
+import support.markdownToEmbeddedHtml
 
 @Transactional(readOnly = true)
 @Service
@@ -25,12 +27,12 @@ class MyMissionService(
     private val assignmentRepository: AssignmentRepository,
     private val judgmentRepository: JudgmentRepository
 ) {
-    fun findAllByMemberIdAndRecruitmentId(memberId: Long, recruitmentId: Long): List<MyMissionResponse> {
+    fun findAllByMemberIdAndRecruitmentId(memberId: Long, recruitmentId: Long): List<MyMissionAndJudgementResponse> {
         val missions = findMissions(memberId, recruitmentId)
         if (missions.isEmpty()) return emptyList()
 
         val assignments = assignmentRepository.findAllByMemberId(memberId)
-        if (assignments.isEmpty()) return missions.map(::MyMissionResponse)
+        if (assignments.isEmpty()) return missions.map(::MyMissionAndJudgementResponse)
 
         val judgmentItems = judgmentItemRepository.findAllByMissionIdIn(missions.map { it.id })
         if (judgmentItems.isEmpty()) return missions.mapBy(assignments)
@@ -46,23 +48,23 @@ class MyMissionService(
         return missionRepository.findAllByEvaluationIdIn(targets.map { it.id }).filterNot { it.hidden }
     }
 
-    private fun List<Mission>.mapBy(assignments: List<Assignment>): List<MyMissionResponse> {
+    private fun List<Mission>.mapBy(assignments: List<Assignment>): List<MyMissionAndJudgementResponse> {
         return map { mission ->
             val assignment = assignments.find { it.missionId == mission.id }
-            MyMissionResponse(mission, assignment != null)
+            MyMissionAndJudgementResponse(mission, assignment != null)
         }
     }
 
     private fun List<Mission>.mapBy(
         assignments: List<Assignment>,
         judgmentItems: List<JudgmentItem>,
         judgments: List<Judgment>
-    ): List<MyMissionResponse> {
+    ): List<MyMissionAndJudgementResponse> {
         return map { mission ->
             val assignment = assignments.find { it.missionId == mission.id }
             val judgmentItem = judgmentItems.find { it.missionId == mission.id }
             val judgment = judgments.findLastJudgment(assignment, judgmentItem)
-            MyMissionResponse(
+            MyMissionAndJudgementResponse(
                 mission = mission,
                 submitted = assignment != null,
                 runnable = assignment != null && judgmentItem != null,
@@ -94,4 +96,23 @@ class MyMissionService(
             judgmentRecord = judgment?.lastRecord
         )
     }
+
+    fun findByMemberIdAndMissionId(memberId: Long, missionId: Long): MyMissionResponse {
+        val mission = missionRepository.getOrThrow(missionId)
+
+        evaluationTargetRepository.findByEvaluationIdAndMemberId(mission.evaluationId, memberId)
+            ?: throw NoSuchElementException("과제가 존재하지 않습니다. id: $missionId")
+
+        if (!mission.isDescriptionViewable) {
+            throw NoSuchElementException("과제가 존재하지 않습니다. id: $missionId")
+        }
+
+        val assignment = assignmentRepository.findByMemberIdAndMissionId(memberId, missionId)
+
+        return MyMissionResponse(
+            mission = mission,
+            submitted = assignment != null,
+            markdownToEmbeddedHtml(mission.description),
+        )
+    }
 }

src/main/kotlin/apply/config/DatabaseInitializer.kt

@@ -412,7 +412,15 @@ class DatabaseInitializer(
         val missions = listOf(
             Mission(
                 title = "1주 차 프리코스 - 숫자 야구 게임",
-                description = "https://github.com/woowacourse/java-baseball-precourse",
+                description = """
+                    |# 미션 - 숫자 야구 게임
+                    |
+                    |## 🔍 진행 방식
+                    |
+                    |- 미션은 **기능 요구 사항, 프로그래밍 요구 사항, 과제 진행 요구 사항** 세 가지로 구성되어 있다.
+                    |- 세 개의 요구 사항을 만족하기 위해 노력한다. 특히 기능을 구현하기 전에 기능 목록을 만들고, 기능 단위로 커밋 하는 방식으로 진행한다.
+                    |- 기능 요구 사항에 기재되지 않은 내용은 스스로 판단하여 구현한다.
+                """.trimMargin(),
                 evaluationId = 2L,
                 startDateTime = createLocalDateTime(2020, 11, 24, 15),
                 endDateTime = createLocalDateTime(2120, 12, 1, 0),
@@ -421,7 +429,15 @@ class DatabaseInitializer(
             ),
             Mission(
                 title = "2주 차 프리코스 - 자동차 경주 게임",
-                description = "https://github.com/woowacourse/java-racingcar-precourse",
+                description = """
+                    |# 미션 - 자동차 경주 게임
+                    |
+                    |## 🔍 진행 방식
+                    |
+                    |- 미션은 **기능 요구 사항, 프로그래밍 요구 사항, 과제 진행 요구 사항** 세 가지로 구성되어 있다.
+                    |- 세 개의 요구 사항을 만족하기 위해 노력한다. 특히 기능을 구현하기 전에 기능 목록을 만들고, 기능 단위로 커밋 하는 방식으로 진행한다.
+                    |- 기능 요구 사항에 기재되지 않은 내용은 스스로 판단하여 구현한다.
+                """.trimMargin(),
                 evaluationId = 3L,
                 startDateTime = createLocalDateTime(2020, 12, 1, 15),
                 endDateTime = createLocalDateTime(2120, 12, 8, 0),

src/main/kotlin/apply/domain/mission/Mission.kt

@@ -7,6 +7,7 @@ import java.time.LocalDateTime
 import javax.persistence.Column
 import javax.persistence.Embedded
 import javax.persistence.Entity
+import javax.persistence.Lob
 
 @SQLDelete(sql = "update mission set deleted = true where id = ?")
 @Where(clause = "deleted = false")
@@ -16,6 +17,7 @@ class Mission(
     val title: String,
 
     @Column(nullable = false)
+    @Lob
     val description: String,
 
     @Column(nullable = false)
@@ -40,6 +42,9 @@ class Mission(
     val isSubmitting: Boolean
         get() = status == MissionStatus.SUBMITTING
 
+    val isDescriptionViewable: Boolean
+        get() = !hidden && (status == MissionStatus.SUBMITTING || status == MissionStatus.UNSUBMITTABLE)
+
     constructor(
         title: String,
         description: String,

src/main/kotlin/apply/ui/admin/mail/MailPreviewDialog.kt → src/main/kotlin/apply/ui/admin/PreviewDialog.kt

@@ -1,4 +1,4 @@
-package apply.ui.admin.mail
+package apply.ui.admin
 
 import com.vaadin.flow.component.Component
 import com.vaadin.flow.component.Html
@@ -11,7 +11,7 @@ import com.vaadin.flow.component.orderedlayout.VerticalLayout
 import org.jsoup.Jsoup
 import support.views.createContrastButton
 
-class MailPreviewDialog(
+class PreviewDialog(
     htmlText: String
 ) : Dialog() {
     init {
@@ -22,7 +22,7 @@ class MailPreviewDialog(
     }
 
     private fun createHeader(): VerticalLayout {
-        return VerticalLayout(H2("메일 미리 보기")).apply {
+        return VerticalLayout(H2("미리 보기")).apply {
             isPadding = false
             element.style["margin-bottom"] = "10px"
         }

src/main/kotlin/apply/ui/admin/mail/MailsFormView.kt

@@ -8,6 +8,7 @@ import apply.application.RecruitmentService
 import apply.application.mail.MailData
 import apply.application.mail.MailService
 import apply.ui.admin.BaseLayout
+import apply.ui.admin.PreviewDialog
 import com.vaadin.flow.component.Component
 import com.vaadin.flow.component.UI
 import com.vaadin.flow.component.button.Button
@@ -82,7 +83,7 @@ class MailsFormView(
 
     private fun createPreviewButton(): Button {
         return createContrastButton("미리 보기") {
-            handleMailData { mail -> MailPreviewDialog(mailService.generateMailBody(mail)) }
+            handleMailData { mail -> PreviewDialog(mailService.generateMailBody(mail)) }
         }
     }
 

src/main/kotlin/apply/ui/admin/mission/MissionsFormView.kt

@@ -1,8 +1,10 @@
 package apply.ui.admin.mission
 
 import apply.application.EvaluationService
+import apply.application.MissionData
 import apply.application.MissionService
 import apply.ui.admin.BaseLayout
+import apply.ui.admin.PreviewDialog
 import com.vaadin.flow.component.Component
 import com.vaadin.flow.component.UI
 import com.vaadin.flow.component.button.Button
@@ -22,6 +24,7 @@ import support.views.createPrimaryButton
 import support.views.toDisplayName
 
 private val MISSION_FORM_URL_PATTERN: Regex = Regex("^(\\d*)/?(\\d*)/?($NEW_VALUE|$EDIT_VALUE)$")
+private const val DATA_NOT_BIND_MESSAGE: String = "모든 항목이 잘 입력되었는지 확인해 주세요."
 
 @Route(value = "admin/missions", layout = BaseLayout::class)
 class MissionsFormView(
@@ -54,11 +57,18 @@ class MissionsFormView(
         submitButton.text = displayName
     }
 
+    private fun createButtons(): Component {
+        return HorizontalLayout(submitButton, createCancelButton(), createPreviewButton()).apply {
+            setSizeFull()
+            justifyContentMode = FlexComponent.JustifyContentMode.CENTER
+        }
+    }
+
     private fun createSubmitButton(): Button {
         return createPrimaryButton {
-            missionForm.bindOrNull()?.let {
+            handleMissionData { mission ->
                 try {
-                    missionService.save(it)
+                    missionService.save(mission)
                     UI.getCurrent().navigate(MissionsView::class.java, recruitmentId)
                 } catch (e: Exception) {
                     createNotification(e.localizedMessage)
@@ -67,16 +77,27 @@ class MissionsFormView(
         }
     }
 
-    private fun createButtons(): Component {
-        return HorizontalLayout(submitButton, createCancelButton()).apply {
-            setSizeFull()
-            justifyContentMode = FlexComponent.JustifyContentMode.CENTER
-        }
-    }
-
     private fun createCancelButton(): Button {
         return createContrastButton("취소") {
             UI.getCurrent().navigate(MissionsView::class.java, recruitmentId)
         }
     }
+
+    private fun createPreviewButton(): Button {
+        return createContrastButton("미리보기") {
+            handleMissionData { mission ->
+                val formattedDescription = missionService.parseDescription(mission.description)
+                PreviewDialog("<div>$formattedDescription</div>")
+            }
+        }
+    }
+
+    private fun handleMissionData(action: (MissionData) -> Unit) {
+        val result = missionForm.bindOrNull()
+        if (result == null) {
+            createNotification(DATA_NOT_BIND_MESSAGE)
+        } else {
+            action(result)
+        }
+    }
 }

src/main/kotlin/apply/ui/api/MissionRestController.kt

@@ -4,6 +4,7 @@ import apply.application.MissionAndEvaluationResponse
 import apply.application.MissionData
 import apply.application.MissionResponse
 import apply.application.MissionService
+import apply.application.MyMissionAndJudgementResponse
 import apply.application.MyMissionResponse
 import apply.application.MyMissionService
 import apply.domain.member.Member
@@ -58,11 +59,21 @@ class MissionRestController(
     fun findMyMissionsByRecruitmentId(
         @PathVariable recruitmentId: Long,
         @LoginMember member: Member
-    ): ResponseEntity<ApiResponse<List<MyMissionResponse>>> {
+    ): ResponseEntity<ApiResponse<List<MyMissionAndJudgementResponse>>> {
         val responses = missionQueryService.findAllByMemberIdAndRecruitmentId(member.id, recruitmentId)
         return ResponseEntity.ok(ApiResponse.success(responses))
     }
 
+    @GetMapping("/{missionId}/me")
+    fun findMyMission(
+        @PathVariable recruitmentId: Long,
+        @PathVariable missionId: Long,
+        @LoginMember member: Member
+    ): ResponseEntity<ApiResponse<MyMissionResponse>> {
+        val response = missionQueryService.findByMemberIdAndMissionId(member.id, missionId)
+        return ResponseEntity.ok(ApiResponse.success(response))
+    }
+
     @DeleteMapping("/{missionId}")
     fun deleteById(
         @PathVariable recruitmentId: Long,

src/main/resources/db/migration/V4_5__Alter_mission_table.sql

@@ -0,0 +1,2 @@
+alter table mission
+    modify description longtext not null;