제보 기능 릴리즈 (#79)

* chore: 부하테스트를 위해 운영환경과 유사하게 메모리 설정

* chore: submodule update

* chore: 개발 환경 ecs 메모리 800으로 변경

* chore: cpu 코어 1코어로 증가

* chore: submodule update

* chore: submodule update

* chore: submodule update

* feat: 유저 엔티티 탈퇴 사유 추가

* feat: 탈퇴 사유 업데이트 로직 추가

* feat: 회원탈퇴 API 수정

* feat: 제보 엔티티 설정

* feat: report 엔티티 db flyway 설정

* feat: 제보 등록 API

* feat: multipart 타입을 swagger에서 사용하기 위한 컨버터 구현

* feat: ReportRepository 생성

* [T3-196] Presigned url 발급 및 제보 이미지 등록 (#76)

* feat: presignedUrl 발급을 위한 로직 구현

* feat: 이미지 등록 API 구현

* refactor: 제보 등록 API에 이미지 url도 등록

* refactor: API 엔드포인트 복수형으로 변경

* feat: 제보 엔티티에 reportStatus 컬럼 추가

* feat: flyway report 엔티티 업데이트

* feat: 전체 제보 목록 조회 API 구현

* fix: 누락된 reportId 추가 및 builder 매핑 오류 수정

* fix: 누락된 Transactional 옵션 추가

* feat: 제보 기록 상세 조회 API

* refactor: 스웨거 스펙 수정

* fix: 제보 상세 조회 Response에 날짜 필드 추가

---------

Co-authored-by: thisishwan2 <feel000617@gmail.com>
Co-authored-by: thisishwan2 <112103038+thisishwan2@users.noreply.github.com>

Author: yuseok0215

config

@@ -0,0 +1,24 @@
+package bitnagil.bitnagil_backend.file.controller;
+
+import bitnagil.bitnagil_backend.file.controller.spec.FileSpec;
+import bitnagil.bitnagil_backend.file.request.PresignedUrlRequest;
+import bitnagil.bitnagil_backend.file.service.FileService;
+import bitnagil.bitnagil_backend.global.response.CustomResponseDto;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.List;
+import java.util.Map;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping(value = "/api/v2/files")
+public class FileController implements FileSpec {
+    private final FileService fileService;
+
+    // S3 Presigned URL 발급 API
+    @PostMapping("/presigned-urls")
+    public CustomResponseDto<Map<String, String>> getPresignedUrls(@RequestBody List<PresignedUrlRequest> requests) {
+        return CustomResponseDto.from(fileService.getPresignedUrls(requests));
+    }
+}

src/main/java/bitnagil/bitnagil_backend/file/controller/FileController.java

@@ -0,0 +1,17 @@
+package bitnagil.bitnagil_backend.file.controller.spec;
+
+import bitnagil.bitnagil_backend.file.request.PresignedUrlRequest;
+import bitnagil.bitnagil_backend.global.response.CustomResponseDto;
+import bitnagil.bitnagil_backend.global.swagger.ApiTags;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import java.util.List;
+import java.util.Map;
+
+@Tag(name = ApiTags.FILE)
+public interface FileSpec {
+
+    @Operation(summary = "S3 Presigned URL 발급")
+    CustomResponseDto<Map<String, String>> getPresignedUrls(List<PresignedUrlRequest> requests);
+}

src/main/java/bitnagil/bitnagil_backend/file/controller/spec/FileSpec.java

@@ -0,0 +1,26 @@
+package bitnagil.bitnagil_backend.file.request;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotNull;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@Schema(description = "Presigned URL 발급 요청 DTO")
+public class PresignedUrlRequest {
+
+    @Schema(description = "파일명을 제외한 접두사",
+            example = "report를 prefix로 사용할 경우 실제 S3에 저장되는 경로는 report/image.png가 됩니다.")
+    private String prefix;
+
+    @Schema(description = "파일명",
+            example = "image.png",
+            required = true)
+    @NotNull
+    private String fileName;
+}

src/main/java/bitnagil/bitnagil_backend/file/request/PresignedUrlRequest.java

@@ -0,0 +1,77 @@
+package bitnagil.bitnagil_backend.file.service;
+
+
+import bitnagil.bitnagil_backend.file.request.PresignedUrlRequest;
+import com.amazonaws.HttpMethod;
+import com.amazonaws.services.s3.AmazonS3;
+import com.amazonaws.services.s3.Headers;
+import com.amazonaws.services.s3.model.CannedAccessControlList;
+import com.amazonaws.services.s3.model.GeneratePresignedUrlRequest;
+import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+
+import java.net.URL;
+import java.util.*;
+
+@Service
+@RequiredArgsConstructor
+public class FileService {
+    @Value("${cloud.aws.s3.bucket}")
+    private String bucket;
+
+    private final AmazonS3 amazonS3;
+
+    public Map<String, String> getPresignedUrls(List<PresignedUrlRequest> requests) {
+        Map<String, String> responseMap = new HashMap<>();
+
+        for (PresignedUrlRequest request : requests) {
+            String prefix = request.getPrefix() != null ? request.getPrefix() : "";
+            String fileName = request.getFileName();
+
+            if (!prefix.isEmpty()) {
+                fileName = createPath(prefix, fileName);
+            }
+
+            GeneratePresignedUrlRequest generatePresignedUrlRequest = getGeneratePresignedUrlRequest(bucket, fileName);
+            URL url = amazonS3.generatePresignedUrl(generatePresignedUrlRequest);
+
+            responseMap.put(fileName, url.toString());
+        }
+        return responseMap;
+    }
+
+    // S3 Presigned URL 생성
+    private GeneratePresignedUrlRequest getGeneratePresignedUrlRequest(String bucket, String fileName) {
+        GeneratePresignedUrlRequest generatePresignedUrlRequest = new GeneratePresignedUrlRequest(bucket, fileName)
+                .withMethod(HttpMethod.PUT)
+                .withExpiration(getPresignedUrlExpiration());
+
+        generatePresignedUrlRequest.addRequestParameter(
+                Headers.S3_CANNED_ACL,
+                CannedAccessControlList.PublicRead.toString()
+        );
+
+        return generatePresignedUrlRequest;
+    }
+
+    // Presigned URL 만료 시간 설정 (2분)
+    private Date getPresignedUrlExpiration() {
+        Date expiration = new Date();
+        long expTimeMillis = expiration.getTime();
+        expTimeMillis += 1000 * 60 * 2;
+        expiration.setTime(expTimeMillis);
+
+        return expiration;
+    }
+
+    private String createFileId() {
+        return UUID.randomUUID().toString();
+    }
+
+    private String createPath(String prefix, String fileName) {
+        String fileId = createFileId();
+        return String.format("%s/%s", prefix, fileId + "-" + fileName);
+    }
+}
+

src/main/java/bitnagil/bitnagil_backend/file/service/FileService.java

@@ -83,9 +83,10 @@ public enum ErrorCode {
 
     // 기타 에러 코드
     JSON_CONVERT_ERROR("ETC001", HttpStatus.INTERNAL_SERVER_ERROR, "List를 JSON 문자열로 변환하는 데 실패했습니다."),
-    JSON_PARSE_ERROR("ETC001", HttpStatus.INTERNAL_SERVER_ERROR, "JSON 문자열을 List<String> 으로 변환하는 데 실패했습니다.");
-
+    JSON_PARSE_ERROR("ETC001", HttpStatus.INTERNAL_SERVER_ERROR, "JSON 문자열을 List<String> 으로 변환하는 데 실패했습니다."),
 
+    // 제보 관련 에러코드
+    NOT_FOUND_REPORT("RP001", HttpStatus.NOT_FOUND, "존재하지 않는 제보입니다.");
 
 
 

src/main/java/bitnagil/bitnagil_backend/global/errorcode/ErrorCode.java

@@ -13,4 +13,6 @@ public class ApiTags {
     public static final String EMOTION_MARBLE = "감정구슬 API";
     public static final String RECOMMENDED_ROUTINE = "추천 루틴 API";
     public static final String APP_VERSION = "앱 버전 API";
+    public static final String REPORT = "제보 API";
+    public static final String FILE = "파일 API";
 }

src/main/java/bitnagil/bitnagil_backend/global/swagger/ApiTags.java

@@ -0,0 +1,36 @@
+package bitnagil.bitnagil_backend.global.utils;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.springframework.http.MediaType;
+import org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter;
+import org.springframework.stereotype.Component;
+
+import java.lang.reflect.Type;
+
+// Swagger 에서 Multipart/form-data 전송시 Content-Type 'application/octet-stream'으로 타입으로 인식되는 오류를 해결하기 위한 컨버터
+@Component
+public class MultipartJackson2HttpMessageConverter extends AbstractJackson2HttpMessageConverter {
+
+    /**
+     * "Content-Type: multipart/form-data" 헤더를 지원하는 HTTP 요청 변환기
+     * Multipart 요청을 처리하기 위한 특별한 컨버터로, 파일과 JSON 데이터를 동시에 처리할 수 있게 해준다.
+     */
+    public MultipartJackson2HttpMessageConverter(ObjectMapper objectMapper) {
+        super(objectMapper, MediaType.APPLICATION_OCTET_STREAM);
+    }
+
+    @Override
+    public boolean canWrite(Class<?> clazz, MediaType mediaType) {
+        return false;
+    }
+
+    @Override
+    public boolean canWrite(Type type, Class<?> clazz, MediaType mediaType) {
+        return false;
+    }
+
+    @Override
+    protected boolean canWrite(MediaType mediaType) {
+        return false;
+    }
+}

src/main/java/bitnagil/bitnagil_backend/global/utils/MultipartJackson2HttpMessageConverter.java

@@ -0,0 +1,50 @@
+package bitnagil.bitnagil_backend.report.controller;
+
+import bitnagil.bitnagil_backend.global.annotation.CurrentUser;
+import bitnagil.bitnagil_backend.global.response.CustomResponseDto;
+import bitnagil.bitnagil_backend.report.controller.spec.ReportSpec;
+import bitnagil.bitnagil_backend.report.request.ReportRegisterRequest;
+import bitnagil.bitnagil_backend.report.response.ReportDetailInfoResponse;
+import bitnagil.bitnagil_backend.report.response.ReportInfoResponse;
+import bitnagil.bitnagil_backend.report.service.ReportService;
+import bitnagil.bitnagil_backend.user.domain.User;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.*;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping(value = "/api/v2/reports")
+public class ReportController implements ReportSpec {
+
+    private final ReportService reportService;
+
+    // 제보 등록 API
+    @PostMapping()
+    public CustomResponseDto<Long> registerReport(@CurrentUser User user,
+                                                    @RequestBody ReportRegisterRequest request) {
+        return CustomResponseDto.from(reportService.registerReport(user, request));
+    }
+
+    // 제보 목록 조회 API
+    @GetMapping()
+    public CustomResponseDto<ReportInfoResponse> getAllReportInfo(@CurrentUser User user) {
+        return CustomResponseDto.from(reportService.getAllReportInfo(user));
+    }
+
+    // 제보 상세 조회 API
+    @GetMapping("/{reportId}")
+    public CustomResponseDto<ReportDetailInfoResponse> getReportDetailInfo(@CurrentUser User user,
+                                                                            @PathVariable Long reportId) {
+        return CustomResponseDto.from(reportService.getReportDetailInfo(user, reportId));
+    }
+
+    /* 추후에 변경을 고려해서 소스만 남겨놓음
+    // 제보 파일 저장 API
+    @PutMapping(value = "/{reportId}/images")
+    public CustomResponseDto<Object> updateImages(@PathVariable Long reportId,
+                                                  @RequestParam List<String> urls) {
+        reportService.updateImages(reportId, urls);
+        return CustomResponseDto.from(null);
+    }
+    */
+}

src/main/java/bitnagil/bitnagil_backend/report/controller/ReportController.java

@@ -0,0 +1,48 @@
+package bitnagil.bitnagil_backend.report.controller.spec;
+
+import bitnagil.bitnagil_backend.global.annotation.CurrentUser;
+import bitnagil.bitnagil_backend.global.response.CustomResponseDto;
+import bitnagil.bitnagil_backend.global.swagger.ApiTags;
+import bitnagil.bitnagil_backend.report.request.ReportRegisterRequest;
+import bitnagil.bitnagil_backend.report.response.ReportDetailInfoResponse;
+import bitnagil.bitnagil_backend.report.response.ReportInfoResponse;
+import bitnagil.bitnagil_backend.user.domain.User;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestBody;
+
+import java.util.List;
+
+@Tag(name = ApiTags.REPORT)
+public interface ReportSpec {
+
+    @ApiResponse(responseCode = "200", useReturnTypeSchema = true, content =
+        @Content(mediaType = "application/json", examples = @ExampleObject(name = "성공 예시", value =
+            "{\n \"code\": \"OK\",\n \"message\": \"등록되었습니다.\",\n \"data\": 1\n}")))
+    @Operation(summary = "제보등록",
+            description = "회원이 제보를 등록합니다.\n\n"
+                + "발급된 presigned url 전체를 reportImageUrl에 담아서 보내주세요.\n\n"
+                + "queryParam은 빼고 담아주세요.")
+    CustomResponseDto<Long> registerReport(User user, ReportRegisterRequest request);
+
+    @Operation(summary = "전체 제보 목록 조회",
+        description = "전체 제보 목록을 조회합니다.")
+    CustomResponseDto<ReportInfoResponse> getAllReportInfo(User user);
+
+    @Operation(summary = "제보 기록 상세 조회",
+        description = "제보 기록 상세 정보를 조회합니다.")
+    CustomResponseDto<ReportDetailInfoResponse> getReportDetailInfo(User user, Long reportId);
+
+
+    /* 추후에 변경을 고려해서 소스만 남겨놓음
+    @Operation(summary = "제보 이미지 등록",
+            description = "presigned URL을 통해 업로드된 이미지들의 URL을 제보 이미지로 등록합니다.")
+    CustomResponseDto<Object> updateImages(Long reportId, List<String> urls);
+    */
+}