가게 개별 테이블 이미지 등록/삭제 API 구현

[sonjunkyu]

💡 작업 개요

1. S3 저장 경로

stores/{storeId}/tables/{tableId}/

2. 테이블 이미지 등록 (POST)

• POST /api/v1/stores/{storeId}/tables/{tableId}/image
• 테이블 이미지를 AWS S3에 업로드
• 기존에 이미지가 존재할 경우 삭제 후 새로운 이미지 등록
• 응답 DTO 반환 시 S3 Key -> URL로 변환

3. 테이블 이미지 삭제 (DELETE)

• DELETE /api/v1/stores/{storeId}/tables/{tableId}/image
• 서비스 로직에서 이미지가 존재하는지 확인 후 삭제
• Soft delete가 아닌 Hard delete

4. 테이블 상세 조회 시 테이블 이미지 URL 반환 (REFACTOR)

• Entity에는 S3 Key만 저장되어 있음
• 따라서 null 아니면 S3 Key를 반환
• 서비스 로직에서 S3 Key -> URL 반환하도록 개선

✅ 작업 내용

• 기능 개발
• 버그 수정
• 리팩토링
• 주석/포맷 정리
• 기타 설정

🧪 테스트 내용

• 로컬 환경에서 빌드 정상 실행 확인
• API 테스트는 CD 후 배포 서버에서 Swagger 기반으로 진행 예정

📝 기타 참고 사항

• Closes [FEAT]: 가게 개별 테이블 이미지 등록/삭제 API 구현 #79

Summary by CodeRabbit

• New Features
  • Table image uploads: Store owners can now upload images for individual dining tables, allowing customers to view table details before booking
  • Image management: Delete existing table images and upload replacements to keep content current
  • Enhanced table presentation: Images are automatically stored and retrieved with table information

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

The PR implements table image upload and delete functionality for individual store tables. Two new endpoints are added to manage table images in S3, with supporting DTOs, converters, and service implementations. The table detail query flow is updated to include converted image URLs.

Changes

Cohort / File(s)	Summary
Controller & Documentation src/main/java/com/eatsfine/eatsfine/domain/storetable/controller/StoreTableController.java, StoreTableControllerDocs.java	Added POST/DELETE endpoints for table image operations; uploadTableImage accepts multipart file and returns upload DTO with status; deleteTableImage removes image and returns deletion DTO.
Response DTOs src/main/java/com/eatsfine/eatsfine/domain/storetable/dto/res/StoreTableResDto.java	Introduced UploadTableImageDto (tableId, tableImageUrl) and DeleteTableImageDto (tableId) as nested records with @Builder annotation.
Converter src/main/java/com/eatsfine/eatsfine/domain/storetable/converter/StoreTableConverter.java	Updated toTableDetailDto signature to accept tableImageUrl parameter; added toUploadTableImageDto and toDeleteTableImageDto converter methods.
Entity src/main/java/com/eatsfine/eatsfine/domain/storetable/entity/StoreTable.java	Added updateTableImage(String imageKey) and deleteTableImage() mutation methods.
Service Interface & Implementation src/main/java/com/eatsfine/eatsfine/domain/storetable/service/StoreTableCommandService.java, StoreTableCommandServiceImpl.java	Added uploadTableImage and deleteTableImage methods; implementation includes store/table validation, S3 file operations via injected S3Service, and entity updates.
Query Service src/main/java/com/eatsfine/eatsfine/domain/storetable/service/StoreTableQueryServiceImpl.java	Integrated S3Service dependency to convert table image keys to URLs in getTableDetail flow.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Controller as StoreTableController
    participant Service as StoreTableCommandServiceImpl
    participant Entity as StoreTable
    participant S3 as S3Service
    participant DB as Database

    Client->>Controller: POST /stores/{storeId}/tables/{tableId}/table-image<br/>(multipart file)
    activate Controller
    
    Controller->>Service: uploadTableImage(storeId, tableId, file)
    activate Service
    
    Service->>DB: findStore(storeId)
    activate DB
    DB-->>Service: Store
    deactivate DB
    
    Service->>DB: findTable(tableId)
    activate DB
    DB-->>Service: StoreTable
    deactivate DB
    
    alt Existing Image
        Service->>S3: deleteImage(existingImageKey)
        activate S3
        S3-->>Service: deleted
        deactivate S3
    end
    
    Service->>S3: uploadImage(file, stores/{storeId}/tables/{tableId}/)
    activate S3
    S3-->>Service: imageKey
    deactivate S3
    
    Service->>Entity: updateTableImage(imageKey)
    activate Entity
    Entity->>DB: save(updatedTable)
    activate DB
    DB-->>Entity: saved
    deactivate DB
    deactivate Entity
    
    Service->>Service: toUploadTableImageDto(tableId, imageUrl)
    Service-->>Controller: UploadTableImageDto
    deactivate Service
    
    Controller-->>Client: ApiResponse<UploadTableImageDto> 200
    deactivate Controller

Loading

sequenceDiagram
    participant Client
    participant Controller as StoreTableController
    participant Service as StoreTableCommandServiceImpl
    participant Entity as StoreTable
    participant S3 as S3Service
    participant DB as Database

    Client->>Controller: DELETE /stores/{storeId}/tables/{tableId}/table-image
    activate Controller
    
    Controller->>Service: deleteTableImage(storeId, tableId)
    activate Service
    
    Service->>DB: findStore(storeId)
    activate DB
    DB-->>Service: Store
    deactivate DB
    
    Service->>DB: findTable(tableId)
    activate DB
    DB-->>Service: StoreTable
    deactivate DB
    
    alt Image Exists
        Service->>S3: deleteImage(imageKey)
        activate S3
        S3-->>Service: deleted
        deactivate S3
        
        Service->>Entity: deleteTableImage()
        activate Entity
        Entity->>DB: save(updatedTable)
        activate DB
        DB-->>Entity: saved
        deactivate DB
        deactivate Entity
    end
    
    Service->>Service: toDeleteTableImageDto(tableId)
    Service-->>Controller: DeleteTableImageDto
    deactivate Service
    
    Controller-->>Client: ApiResponse<DeleteTableImageDto> 200
    deactivate Controller

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• [FEAT]: 가게 테이블 상세 조회/수정/삭제 API 구현 #77: Modifies the same StoreTable surface (controller, converter, DTO, entity, and service layers); the current PR builds upon the table detail flow by adding image URL parameter to toTableDetailDto and implementing image management endpoints.

Suggested reviewers

• CokaNuri
• SungMinju
• zerochani
• twodo0

Poem

🐰 A rabbit hops through S3 skies,
Uploading table images with careful eyes,
Delete with care, update with grace,
Each photo finds its perfect place!
Tables shine in detail now so bright,
Fluffy paws make everything right. ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 30.77% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: implementing table image upload/delete APIs for individual store tables.
Description check	✅ Passed	The PR description covers all required template sections including overview, work items, testing approach, and references the related issue.
Linked Issues check	✅ Passed	Code changes fully implement the requirements from issue #79: table image upload/delete APIs, S3 storage path configuration, and service layer URL conversion.
Out of Scope Changes check	✅ Passed	All code changes are directly related to implementing table image upload/delete functionality and the refactored table detail query with image URLs.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In
`@src/main/java/com/eatsfine/eatsfine/domain/storetable/controller/StoreTableController.java`:
- Around line 85-91: The Delete endpoint mapping in StoreTableController is
using the wrong path segment and missing the `@Override` annotation; update the
`@DeleteMapping` on the deleteTableImage method to use
"/stores/{storeId}/tables/{tableId}/image" (matching the upload endpoint and API
spec) and add the `@Override` annotation above the deleteTableImage method to
indicate it implements the interface, leaving the return logic
(ApiResponse.of(..., storeTableCommandService.deleteTableImage(storeId,
tableId))) and TableImageSuccessStatus reference unchanged.
- Around line 73-83: The controller method uploadTableImage currently maps to
"/stores/{storeId}/tables/{tableId}/table-image" and may be missing an
`@Override`; change the `@PostMapping` path to
"/stores/{storeId}/tables/{tableId}/image" to match the API spec/issue `#79` and
add the `@Override` annotation above uploadTableImage if this method implements
the signature from StoreTableControllerDocs; update any related references to
the mapping constant if used so the endpoint path stays consistent.

🧹 Nitpick comments (2)

src/main/java/com/eatsfine/eatsfine/domain/storetable/service/StoreTableCommandServiceImpl.java (1)

168-196: Consider operation ordering for resilience against partial failures.

The current sequence deletes the old S3 image (line 185), then uploads the new one (line 188), then updates the entity (line 190). Since S3 operations are outside the transaction:

1. If upload fails after delete, the old image is lost with no replacement.
2. If the transaction rolls back after S3 operations succeed, an orphan file remains in S3.

A safer approach is to upload the new image first, update the entity, then delete the old image after the transaction commits (or asynchronously). This ensures:

• On upload failure: old image remains intact.
• On transaction failure: only an orphan new file, which can be cleaned up.

♻️ Suggested ordering

-        // 기존 이미지가 존재할 경우 삭제
-        if (table.getTableImageUrl() != null && !table.getTableImageUrl().isBlank()) {
-            s3Service.deleteByKey(table.getTableImageUrl());
-        }
-
-        String key = s3Service.upload(tableImage, "stores/" + storeId + "/tables/" + tableId);
+        // 기존 이미지 키 보존 (나중에 삭제)
+        String oldImageKey = table.getTableImageUrl();
+
+        // 새 이미지 먼저 업로드
+        String key = s3Service.upload(tableImage, "stores/" + storeId + "/tables/" + tableId);

         table.updateTableImage(key);

         // URL 변환 및 응답
         String tableImageUrl = s3Service.toUrl(key);

+        // 기존 이미지가 존재할 경우 삭제 (새 이미지 업로드 성공 후)
+        if (oldImageKey != null && !oldImageKey.isBlank()) {
+            s3Service.deleteByKey(oldImageKey);
+        }
+
         return StoreTableConverter.toUploadTableImageDto(tableId, tableImageUrl);

src/main/java/com/eatsfine/eatsfine/domain/storetable/controller/StoreTableController.java (1)

80-80: Consider adding validation for the uploaded file.

The MultipartFile parameter has no validation. Consider adding checks for empty files or file type validation to prevent invalid uploads from reaching the service layer.

Optional: Add validation annotation or check

You could use a custom validator or add a simple check in the service layer. For controller-level validation:

`@RequestPart`("tableImage") `@NotNull` MultipartFile tableImage

Or ensure the service layer validates:

• File is not empty (!tableImage.isEmpty())
• Content type is an image (tableImage.getContentType().startsWith("image/"))
• File size is within acceptable limits

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

URL path inconsistency with requirements.

The PR description and issue #79 specify the endpoint path as /api/v1/stores/{storeId}/tables/{tableId}/image, but the implementation uses /table-image. Consider aligning with the documented API specification.

Additionally, the @Override annotation appears to be missing if this method is declared in StoreTableControllerDocs.

Suggested path alignment

     `@PostMapping`(
-            value = "/stores/{storeId}/tables/{tableId}/table-image",
+            value = "/stores/{storeId}/tables/{tableId}/image",
             consumes = MediaType.MULTIPART_FORM_DATA_VALUE
     )
+    `@Override`
     public ApiResponse<StoreTableResDto.UploadTableImageDto> uploadTableImage(

🤖 Prompt for AI Agents

In
`@src/main/java/com/eatsfine/eatsfine/domain/storetable/controller/StoreTableController.java`
around lines 73 - 83, The controller method uploadTableImage currently maps to
"/stores/{storeId}/tables/{tableId}/table-image" and may be missing an
`@Override`; change the `@PostMapping` path to
"/stores/{storeId}/tables/{tableId}/image" to match the API spec/issue `#79` and
add the `@Override` annotation above uploadTableImage if this method implements
the signature from StoreTableControllerDocs; update any related references to
the mapping constant if used so the endpoint path stays consistent.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Same path inconsistency and missing annotation.

Same observations as the upload endpoint - the path uses /table-image instead of /image per the API specification, and @Override annotation should be added for interface implementation consistency.

Suggested fix

-    `@DeleteMapping`("/stores/{storeId}/tables/{tableId}/table-image")
+    `@Override`
+    `@DeleteMapping`("/stores/{storeId}/tables/{tableId}/image")
     public ApiResponse<StoreTableResDto.DeleteTableImageDto> deleteTableImage(

🤖 Prompt for AI Agents

In
`@src/main/java/com/eatsfine/eatsfine/domain/storetable/controller/StoreTableController.java`
around lines 85 - 91, The Delete endpoint mapping in StoreTableController is
using the wrong path segment and missing the `@Override` annotation; update the
`@DeleteMapping` on the deleteTableImage method to use
"/stores/{storeId}/tables/{tableId}/image" (matching the upload endpoint and API
spec) and add the `@Override` annotation above the deleteTableImage method to
indicate it implements the interface, leaving the return logic
(ApiResponse.of(..., storeTableCommandService.deleteTableImage(storeId,
tableId))) and TableImageSuccessStatus reference unchanged.