feat(configuration): S3 및 files 테이블 어댑터와 유스케이스 구현 #26

kotlin.MODULE.bazel

@@ -23,4 +23,10 @@ maven.artifact(artifact = "protobuf-java", group = "com.google.protobuf", versio
 maven.artifact(artifact = "protobuf-kotlin", group = "com.google.protobuf", version = "4.30.2")
 maven.artifact(artifact = "javax.annotation-api", group = "javax.annotation", version = "1.3.2")
 
+# Validation
+maven.artifact(artifact = "spring-boot-starter-validation", group = "org.springframework.boot", version = "4.0.1")
+
+# AWS S3
+maven.artifact(artifact = "s3", group = "software.amazon.awssdk", version = "2.31.0")
+
 use_repo(maven, "maven")

systems/configuration/configuration-adapter-out/BUILD.bazel

@@ -17,5 +17,14 @@ kt_jvm_test(
     javac_opts = "//:javac_options",
     kotlinc_opts = "//:kotlinc_options",
     test_class = "hs.kr.entrydsm.configuration.adapterout.ConfigurationAdapterOutModuleTest",
-    deps = MODULE_DEPS + TEST_DEPS,
+    deps = MODULE_DEPS + TEST_DEPS + [":main"],
+)
+
+kt_jvm_test(
+    name = "s3_storage_adapter_test",
+    srcs = glob(["src/test/kotlin/**/*.kt"]),
+    javac_opts = "//:javac_options",
+    kotlinc_opts = "//:kotlinc_options",
+    test_class = "hs.kr.entrydsm.configuration.adapterout.S3StorageAdapterTest",
+    deps = MODULE_DEPS + TEST_DEPS + [":main"],
 )

systems/configuration/configuration-adapter-out/deps.bzl

@@ -1,6 +1,7 @@
 KOTLIN_DEPS = [
     "@maven//:org_springframework_boot_spring_boot_starter_data_jpa",
     "@maven//:com_mysql_mysql_connector_j",
+    "@maven//:software_amazon_awssdk_s3",
     "//systems/configuration/configuration-domain:main",
 ]
 

systems/configuration/configuration-adapter-out/src/main/kotlin/hs/kr/entrydsm/configuration/adapterout/FileDocumentPersistenceAdapter.kt

@@ -0,0 +1,34 @@
+package hs.kr.entrydsm.configuration.adapterout
+
+import hs.kr.entrydsm.configuration.adapterout.entity.FileDocumentJpaEntity
+import hs.kr.entrydsm.configuration.adapterout.repository.FileDocumentJpaRepository
+import hs.kr.entrydsm.configuration.domain.document.FileDocument
+import hs.kr.entrydsm.configuration.domain.document.port.out.FileDocumentRepository
+import org.springframework.stereotype.Component
+import org.springframework.transaction.annotation.Transactional
+
+@Component
+@Transactional(readOnly = true)
+class FileDocumentPersistenceAdapter(
+    private val fileDocumentJpaRepository: FileDocumentJpaRepository,
+) : FileDocumentRepository {
+
+    @Transactional
+    override fun save(fileDocument: FileDocument): FileDocument =
+        fileDocumentJpaRepository.save(
+            FileDocumentJpaEntity.from(fileDocument)
+        ).toDomain()
+
+    override fun findById(id: Long): FileDocument? =
+        fileDocumentJpaRepository.findById(id).orElse(null)?.toDomain()
+
+    override fun findByObjectKey(objectKey: String): FileDocument? =
+        fileDocumentJpaRepository.findByObjectKey(objectKey)?.toDomain()
+
+    override fun existsById(id: Long): Boolean =
+        fileDocumentJpaRepository.existsById(id)
+
+    @Transactional
+    override fun deleteByObjectKey(objectKey: String) =
+        fileDocumentJpaRepository.deleteByObjectKey(objectKey)
+}

systems/configuration/configuration-adapter-out/src/main/kotlin/hs/kr/entrydsm/configuration/adapterout/S3StorageAdapter.kt

@@ -0,0 +1,107 @@
+package hs.kr.entrydsm.configuration.adapterout
+
+import hs.kr.entrydsm.configuration.domain.document.StoredObject
+import hs.kr.entrydsm.configuration.domain.document.exception.PresignFailedException
+import hs.kr.entrydsm.configuration.domain.document.exception.StorageUnavailableException
+import hs.kr.entrydsm.configuration.domain.document.exception.StorageUploadFailedException
+import hs.kr.entrydsm.configuration.domain.document.port.out.StoragePort
+import org.springframework.beans.factory.annotation.Value
+import org.springframework.stereotype.Component
+import software.amazon.awssdk.core.exception.SdkException
+import software.amazon.awssdk.core.sync.RequestBody
+import software.amazon.awssdk.services.s3.S3Client
+import software.amazon.awssdk.services.s3.model.ChecksumAlgorithm
+import software.amazon.awssdk.services.s3.model.DeleteObjectRequest
+import software.amazon.awssdk.services.s3.model.GetObjectRequest
+import software.amazon.awssdk.services.s3.model.HeadObjectRequest
+import software.amazon.awssdk.services.s3.model.PutObjectRequest
+import software.amazon.awssdk.services.s3.model.S3Exception
+import software.amazon.awssdk.services.s3.presigner.S3Presigner
+import software.amazon.awssdk.services.s3.presigner.model.GetObjectPresignRequest
+import java.io.InputStream
+import java.time.Duration
+
+@Component
+class S3StorageAdapter(
+    private val s3Client: S3Client,
+    private val s3Presigner: S3Presigner,
+    @Value("\${aws.s3.bucket}") private val bucket: String,
+) : StoragePort {
+
+    override fun upload(
+        objectKey: String,
+        contentType: String,
+        sizeBytes: Long,
+        content: InputStream,
+    ): StoredObject {
+        val response = try {
+            s3Client.putObject(
+                PutObjectRequest.builder()
+                    .bucket(bucket)
+                    .key(objectKey)
+                    .contentType(contentType)
+                    .contentLength(sizeBytes)
+                    .checksumAlgorithm(ChecksumAlgorithm.SHA256)
+                    .build(),
+                RequestBody.fromInputStream(content, sizeBytes),
+            )
+        } catch (e: SdkException) {
+            throw StorageUploadFailedException(objectKey, e)
+        }
+        return StoredObject(
+            bucket = bucket,
+            objectKey = objectKey,
+            checksum = response.checksumSHA256() ?: response.eTag().orEmpty().trim('"'),
+        )
+    }
+
+    override fun issueDownloadUrl(objectKey: String, expiresInSeconds: Long): String =
+        try {
+            s3Presigner.presignGetObject(
+                GetObjectPresignRequest.builder()
+                    .signatureDuration(Duration.ofSeconds(expiresInSeconds))
+                    .getObjectRequest(
+                        GetObjectRequest.builder()
+                            .bucket(bucket)
+                            .key(objectKey)
+                            .build()
+                    )
+                    .build()
+            ).url().toString()
+        } catch (e: SdkException) {
+            throw PresignFailedException(objectKey, e)
+        }
+
+    override fun exists(objectKey: String): Boolean =
+        try {
+            s3Client.headObject(
+                HeadObjectRequest.builder()
+                    .bucket(bucket)
+                    .key(objectKey)
+                    .build()
+            )
+            true
+        } catch (e: S3Exception) {
+            // HEAD 응답에는 본문이 없어 객체 없음이 NoSuchKeyException 대신 404 S3Exception 으로 올라오기도 한다.
+            if (e.statusCode() == HTTP_NOT_FOUND) false else throw StorageUnavailableException(objectKey, e)
+        } catch (e: SdkException) {
+            throw StorageUnavailableException(objectKey, e)
+        }
+
+    override fun delete(objectKey: String) {
+        try {
+            s3Client.deleteObject(
+                DeleteObjectRequest.builder()
+                    .bucket(bucket)
+                    .key(objectKey)
+                    .build()
+            )
+        } catch (e: SdkException) {
+            throw StorageUnavailableException(objectKey, e)
+        }
+    }
+
+    private companion object {
+        const val HTTP_NOT_FOUND = 404
+    }
+}

systems/configuration/configuration-adapter-out/src/main/kotlin/hs/kr/entrydsm/configuration/adapterout/config/S3Config.kt

@@ -0,0 +1,26 @@
+package hs.kr.entrydsm.configuration.adapterout.config
+
+import org.springframework.beans.factory.annotation.Value
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import software.amazon.awssdk.regions.Region
+import software.amazon.awssdk.services.s3.S3Client
+import software.amazon.awssdk.services.s3.presigner.S3Presigner
+
+@Configuration
+class S3Config(
+    @Value("\${aws.s3.region:ap-northeast-2}") private val region: String,
+) {
+
+    @Bean
+    fun s3Client(): S3Client =
+        S3Client.builder()
+            .region(Region.of(region))
+            .build()
+
+    @Bean
+    fun s3Presigner(): S3Presigner =
+        S3Presigner.builder()
+            .region(Region.of(region))
+            .build()
+}

systems/configuration/configuration-adapter-out/src/main/kotlin/hs/kr/entrydsm/configuration/adapterout/entity/FileDocumentJpaEntity.kt

@@ -0,0 +1,63 @@
+package hs.kr.entrydsm.configuration.adapterout.entity
+
+import hs.kr.entrydsm.configuration.domain.document.FileDocument
+import jakarta.persistence.Column
+import jakarta.persistence.Entity
+import jakarta.persistence.GeneratedValue
+import jakarta.persistence.GenerationType
+import jakarta.persistence.Id
+import jakarta.persistence.Table
+import java.time.Instant
+
+@Entity
+@Table(name = "files")
+class FileDocumentJpaEntity(
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    val id: Long? = null,
+
+    @Column(name = "original_name", nullable = false, length = 255)
+    val originalName: String,
+
+    @Column(name = "object_key", unique = true, nullable = false, length = 255)
+    val objectKey: String,
+
+    @Column(name = "bucket", nullable = false, length = 100)
+    val bucket: String,
+
+    @Column(name = "content_type", nullable = false, length = 100)
+    val contentType: String,
+
+    @Column(name = "size_bytes", nullable = false)
+    val sizeBytes: Long,
+
+    @Column(name = "checksum", nullable = false, length = 64)
+    val checksum: String,
+
+    @Column(name = "created_at", nullable = false)
+    val createdAt: Instant,
+) {
+    fun toDomain() = FileDocument(
+        id = id,
+        originalName = originalName,
+        objectKey = objectKey,
+        bucket = bucket,
+        contentType = contentType,
+        sizeBytes = sizeBytes,
+        checksum = checksum,
+        createdAt = createdAt,
+    )
+
+    companion object {
+        fun from(domain: FileDocument) = FileDocumentJpaEntity(
+            id = domain.id,
+            originalName = domain.originalName,
+            objectKey = domain.objectKey,
+            bucket = domain.bucket,
+            contentType = domain.contentType,
+            sizeBytes = domain.sizeBytes,
+            checksum = domain.checksum,
+            createdAt = domain.createdAt ?: Instant.now(),
+        )
+    }
+}

systems/configuration/configuration-adapter-out/src/main/kotlin/hs/kr/entrydsm/configuration/adapterout/repository/FileDocumentJpaRepository.kt

@@ -0,0 +1,9 @@
+package hs.kr.entrydsm.configuration.adapterout.repository
+
+import hs.kr.entrydsm.configuration.adapterout.entity.FileDocumentJpaEntity
+import org.springframework.data.jpa.repository.JpaRepository
+
+interface FileDocumentJpaRepository : JpaRepository<FileDocumentJpaEntity, Long> {
+    fun findByObjectKey(objectKey: String): FileDocumentJpaEntity?
+    fun deleteByObjectKey(objectKey: String)
+}

systems/configuration/configuration-adapter-out/src/test/kotlin/hs/kr/entrydsm/configuration/adapterout/S3StorageAdapterTest.kt

@@ -0,0 +1,93 @@
+package hs.kr.entrydsm.configuration.adapterout
+
+import hs.kr.entrydsm.configuration.domain.document.exception.StorageUnavailableException
+import org.junit.Assert.assertFalse
+import org.junit.Assert.assertTrue
+import org.junit.Test
+import software.amazon.awssdk.core.exception.SdkClientException
+import software.amazon.awssdk.services.s3.S3Client
+import software.amazon.awssdk.services.s3.model.DeleteObjectRequest
+import software.amazon.awssdk.services.s3.model.DeleteObjectResponse
+import software.amazon.awssdk.services.s3.model.HeadObjectRequest
+import software.amazon.awssdk.services.s3.model.HeadObjectResponse
+import software.amazon.awssdk.services.s3.model.NoSuchKeyException
+import software.amazon.awssdk.services.s3.model.S3Exception
+import software.amazon.awssdk.services.s3.presigner.S3Presigner
+import java.lang.reflect.Proxy
+
+class S3StorageAdapterTest {
+
+    @Test
+    fun `객체가 있으면 존재한다고 판단한다`() {
+        assertTrue(adapter(FakeS3Client()).exists("photo/a.jpg"))
+    }
+
+    @Test
+    fun `본문 없는 404 응답도 객체 없음으로 처리한다`() {
+        val client = FakeS3Client(headFailure = s3Exception(404))
+
+        assertFalse(adapter(client).exists("photo/a.jpg"))
+    }
+
+    @Test
+    fun `NoSuchKey 예외도 객체 없음으로 처리한다`() {
+        val client = FakeS3Client(headFailure = NoSuchKeyException.builder().statusCode(404).build())
+
+        assertFalse(adapter(client).exists("photo/a.jpg"))
+    }
+
+    @Test(expected = StorageUnavailableException::class)
+    fun `403 응답은 스토리지 오류로 올린다`() {
+        adapter(FakeS3Client(headFailure = s3Exception(403))).exists("photo/a.jpg")
+    }
+
+    @Test(expected = StorageUnavailableException::class)
+    fun `네트워크 오류는 스토리지 오류로 올린다`() {
+        val client = FakeS3Client(headFailure = SdkClientException.builder().message("connect timed out").build())
+
+        adapter(client).exists("photo/a.jpg")
+    }
+
+    @Test(expected = StorageUnavailableException::class)
+    fun `삭제 실패도 스토리지 오류로 올린다`() {
+        val client = FakeS3Client(deleteFailure = s3Exception(500))
+
+        adapter(client).delete("photo/a.jpg")
+    }
+
+    @Test
+    fun `삭제가 성공하면 예외를 던지지 않는다`() {
+        adapter(FakeS3Client()).delete("photo/a.jpg")
+    }
+
+    private fun adapter(client: S3Client) = S3StorageAdapter(client, stubPresigner(), "entrydsm")
+
+    // presign 은 이 테스트에서 쓰지 않는다. 메서드가 7개라 프록시로 대신한다.
+    private fun stubPresigner(): S3Presigner =
+        Proxy.newProxyInstance(
+            S3Presigner::class.java.classLoader,
+            arrayOf(S3Presigner::class.java),
+        ) { _, _, _ -> throw UnsupportedOperationException() } as S3Presigner
+
+    private fun s3Exception(statusCode: Int): S3Exception =
+        S3Exception.builder().statusCode(statusCode).message("status=$statusCode").build() as S3Exception
+
+    private class FakeS3Client(
+        private val headFailure: RuntimeException? = null,
+        private val deleteFailure: RuntimeException? = null,
+    ) : S3Client {
+        override fun serviceName(): String = "s3"
+
+        override fun close() = Unit
+
+        override fun headObject(request: HeadObjectRequest): HeadObjectResponse {
+            headFailure?.let { throw it }
+            return HeadObjectResponse.builder().build()
+        }
+
+        override fun deleteObject(request: DeleteObjectRequest): DeleteObjectResponse {
+            deleteFailure?.let { throw it }
+            return DeleteObjectResponse.builder().build()
+        }
+    }
+}

systems/configuration/configuration-application/BUILD.bazel

@@ -17,5 +17,14 @@ kt_jvm_test(
     javac_opts = "//:javac_options",
     kotlinc_opts = "//:kotlinc_options",
     test_class = "hs.kr.entrydsm.configuration.application.ConfigurationApplicationModuleTest",
-    deps = MODULE_DEPS + TEST_DEPS,
+    deps = MODULE_DEPS + TEST_DEPS + [":main"],
+)
+
+kt_jvm_test(
+    name = "file_document_service_test",
+    srcs = glob(["src/test/kotlin/**/*.kt"]),
+    javac_opts = "//:javac_options",
+    kotlinc_opts = "//:kotlinc_options",
+    test_class = "hs.kr.entrydsm.configuration.application.FileDocumentServiceTest",
+    deps = MODULE_DEPS + TEST_DEPS + [":main"],
 )