🔀 :: (PiCK-252)upload profile api #257

meltapplee · 2024-07-30T23:37:14Z

close #252

Summary by CodeRabbit

New Features
- 사용자 프로필 사진 업로드 기능 추가.
- 사용자 정보 응답에 프로필 URL 포함.
- 사용자 프로필 정보 응답에 프로필 필드 추가.
- 새로운 사용자 프로필 업데이트 메서드 추가.
- 사용자 프로필 수정 인터페이스 추가.
- 사용자 프로필 업로드를 위한 새로운 엔드포인트 추가.
Bug Fixes
- 프로필 이미지 처리 로직 개선.
Documentation
- 사용자 프로필 관리 및 업로드 관련 API 문서화.
Chores
- 보안 설정 업데이트로 사용자 프로필 접근 권한 강화.

coderabbitai · 2024-07-30T23:37:22Z

Walkthrough

이번 변경사항은 사용자 프로필 이미지를 업로드하고 관리하는 기능을 추가하여, 사용자 데이터 처리를 개선하는 데 중점을 두었습니다. QueryMyApplicationResponse 및 User 데이터 클래스에 새로운 프로퍼티를 추가하고, 여러 서비스에서 프로필 URL을 생성하는 로직을 통합했습니다. 이로써, 사용자 경험을 향상시키고, API의 유연성을 높였습니다.

Changes

파일 경로	변경 요약
`.../dto/response/QueryMyApplicationResponse.kt`	`QueryMyApplicationResponse`에 `profile` 속성 추가.
`.../service/QueryMyApplicationService.kt`	`FileUtil` 의존성 추가 및 프로필 URL 생성 로직 통합.
`.../domain/user/domain/User.kt`	`User` 클래스에 `updateProfileFileName` 메소드 추가.
`.../dto/response/QueryUserSimpleInfoResponse.kt`	`QueryUserSimpleInfoResponse`에 `profile` 속성 추가.
`.../service/QueryUserSimpleInfoService.kt`	`FileUtil` 추가 및 사용자 프로필 이미지 URL 생성 로직 변경.
`.../port/in/ModifyProfileUseCase.kt`	`ModifyProfileUseCase` 인터페이스 추가 및 `modifyProfile` 메소드 정의.
`.../presentation/UserController.kt`	`/profile` 경로에 대한 프로필 업로드 메소드 추가.
`.../service/UploadUserProfileService.kt`	사용자 프로필 이미지 업로드 및 업데이트를 위한 새로운 서비스 클래스 추가.
`.../global/config/security/SecurityConfig.kt`	`Role.STU` 역할에 대한 새로운 권한 규칙 추가.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UserController
    participant UploadUserProfileService
    participant FileUtil

    User->>UserController: 프로필 이미지 업로드 요청
    UserController->>UploadUserProfileService: uploadUserProfile(file)
    UploadUserProfileService->>FileUtil: 기존 프로필 이미지 삭제
    UploadUserProfileService->>FileUtil: 새 프로필 이미지 업로드
    UploadUserProfileService->>UploadUserProfileService: 사용자 프로필 업데이트
    UploadUserProfileService-->>UserController: 응답
    UserController-->>User: 업로드 결과 반환

Assessment against linked issues

Objective	Addressed	Explanation
유저 프로필이미지 기능 추가 ( #252 )	✅
프로필 이미지 URL 생성 ( #252 )	✅
API 확장 및 사용자 경험 개선 ( #252 )	✅

Poem

🐇
귀여운 토끼가 말하길,
"프로필 이미지, 이제는 업로드!
사용자 경험, 훨씬 더 좋아졌네,
모든 변화가 더 나은 길로,
함께 뛰어놀자, 기쁜 마음으로!"
🌟

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7635ff9 and 7b5e0c8.

📒 Files selected for processing (2)

src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt (1 hunks)
src/main/kotlin/dsm/pick2024/global/config/security/SecurityConfig.kt (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt
src/main/kotlin/dsm/pick2024/global/config/security/SecurityConfig.kt

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (3)

src/main/kotlin/dsm/pick2024/domain/user/port/in/UploadUserProfileUseCase.kt (1)
5-7: 인터페이스에 문서 주석을 추가하세요.

UploadUserProfileUseCase 인터페이스와 uploadUserProfile 메서드에 대한 문서 주석이 필요합니다. 이는 코드의 가독성과 유지보수성을 향상시킵니다.
/**
 * Interface for uploading user profile images.
 */
interface UploadUserProfileUseCase {
    /**
     * Uploads a user profile image.
     *
     * @param file the profile image file to upload
     */
    fun uploadUserProfile(file: MultipartFile)
}
src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserDetaileInfoService.kt (1)
21-21: fileUtil import 누락 확인

fileUtil.generateObjectUrl 함수가 사용된 아래 파일들에서 fileUtil의 import 문이 누락되었습니다. 이로 인해 코드가 올바르게 컴파일되지 않거나 작동하지 않을 수 있습니다. fileUtil을 올바르게 import 해 주세요.

src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserDetaileInfoService.kt

src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserSimpleInfoService.kt

src/main/kotlin/dsm/pick2024/domain/bug/AddBugService.kt

src/main/kotlin/dsm/pick2024/domain/application/service/QueryMyApplicationService.kt

Analysis chain

프로필 URL 생성 로직 확인

fileUtil을 사용하여 프로필 URL을 생성하는 로직이 추가되었습니다. 이 변경 사항은 사용자 프로필 이미지를 더 효율적으로 처리합니다.

그러나, fileUtil의 사용이 올바르게 적용되었는지 확인해 주세요.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify all function calls to `fileUtil.generateObjectUrl`.

# Test: Search for the function usage. Expect: Only occurrences of the new usage.
rg --type kotlin -A 5 $'fileUtil.generateObjectUrl'
Length of output: 2598

Script:
#!/bin/bash
# Description: Verify the import of `fileUtil` in the identified files.

# Test: Check for the import statements of `fileUtil` in the identified files.
files=(
  "src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserDetaileInfoService.kt"
  "src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserSimpleInfoService.kt"
  "src/main/kotlin/dsm/pick2024/domain/bug/AddBugService.kt"
  "src/main/kotlin/dsm/pick2024/domain/application/service/QueryMyApplicationService.kt"
)

for file in "${files[@]}"; do
  echo "File: $file"
  rg --type kotlin "import .*fileUtil" "$file"
  echo
done
Length of output: 1605
src/main/kotlin/dsm/pick2024/global/config/security/SecurityConfig.kt (1)
106-107: 엔드포인트 구현 누락 확인

/user/profile 엔드포인트가 보안 설정에 추가되었으나, 실제로 이를 처리하는 컨트롤러나 서비스 메서드가 구현되지 않은 것으로 보입니다. 이로 인해 해당 엔드포인트가 정상적으로 작동하지 않을 수 있습니다.

SecurityConfig.kt 파일에서 /user/profile 엔드포인트가 보호되고 있는 것을 확인했습니다.

그러나, 이 엔드포인트를 처리하는 컨트롤러나 서비스 메서드가 코드베이스에 존재하지 않습니다.

엔드포인트의 기능을 구현하여 예상대로 작동하도록 하는 것이 필요합니다.

Analysis chain

새로운 엔드포인트 추가 확인

/user/profile 엔드포인트가 Role.STU 역할을 요구하는 경로 목록에 추가되었습니다. 이는 사용자 프로필 정보에 대한 접근을 제한하려는 의도와 일치합니다.

그러나, 이 엔드포인트의 기능이 예상대로 작동하는지 확인하는 것이 중요합니다.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the functionality of the new endpoint `/user/profile`.

# Test: Ensure the endpoint is protected and accessible only by users with the `Role.STU` role.
rg --type kotlin -A 5 $'"/user/profile"'
Length of output: 653

Script:
#!/bin/bash
# Description: Search for the implementation details of the `/user/profile` endpoint.

# Find the controller or service methods handling the `/user/profile` endpoint.
rg --type kotlin '"/user/profile"'
Length of output: 138

Script:
#!/bin/bash
# Description: Search for the implementation details of the `/user/profile` endpoint across all Kotlin files.

# Find the controller or service methods handling the `/user/profile` endpoint.
rg --type kotlin 'user/profile'
Length of output: 133

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 76090f0 and 036b5c3.

Files selected for processing (11)

src/main/kotlin/dsm/pick2024/domain/application/presentation/dto/response/QueryMyApplicationResponse.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/application/service/QueryMyApplicationService.kt (2 hunks)
src/main/kotlin/dsm/pick2024/domain/user/domain/User.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/port/in/UploadUserProfileUseCase.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/presentation/UserController.kt (3 hunks)
src/main/kotlin/dsm/pick2024/domain/user/presentation/dto/response/QueryUserSimpleInfoResponse.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserDetaileInfoService.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserSimpleInfoService.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt (1 hunks)
src/main/kotlin/dsm/pick2024/global/config/security/SecurityConfig.kt (1 hunks)
src/main/kotlin/dsm/pick2024/infrastructure/s3/PathList.kt (1 hunks)

Files skipped from review due to trivial changes (1)

src/main/kotlin/dsm/pick2024/infrastructure/s3/PathList.kt

Additional comments not posted (12)

src/main/kotlin/dsm/pick2024/domain/user/presentation/dto/response/QueryUserSimpleInfoResponse.kt (1)

4-4: 변경 사항 승인됨

QueryUserSimpleInfoResponse 데이터 클래스에 profile 속성을 추가한 것은 유연성을 높이고 사용자 정보를 더 잘 전달할 수 있게 합니다.

src/main/kotlin/dsm/pick2024/domain/application/presentation/dto/response/QueryMyApplicationResponse.kt (1)

15-15: 변경 사항 승인됨

QueryMyApplicationResponse 데이터 클래스에 profile 속성을 추가한 것은 응답 데이터 구조의 유연성을 높이고 추가적인 사용자 정보를 제공할 수 있게 합니다.

src/main/kotlin/dsm/pick2024/domain/user/domain/User.kt (1)

21-23: 새로운 메서드 추가: updateProfileFileName

이 메서드는 User 클래스의 profile 속성을 업데이트하면서 불변성을 유지합니다. 코드가 명확하고 코틀린의 모범 사례를 따릅니다.

src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserSimpleInfoService.kt (3)

6-7: 새로운 의존성 추가: FileUtil

FileUtil을 활용하여 파일 처리를 위한 기능이 추가되었습니다.

13-14: 생성자 업데이트: FileUtil 의존성 주입

FileUtil을 생성자에 추가하여 파일 처리를 위한 의존성을 주입합니다.

20-26: 메서드 업데이트: queryUserSimpleInfo

사용자의 프로필 이미지 URL을 생성하고 응답에 포함시키는 로직이 추가되었습니다. 이는 서비스의 기능을 향상시킵니다.

src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt (1)

1-28: 새로운 서비스 클래스 추가: UploadUserProfileService

이 클래스는 프로필 이미지 업로드를 처리하는 기능을 포함하고 있습니다. 코드 구조가 잘 되어 있으며 모범 사례를 따릅니다.

src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserDetaileInfoService.kt (1)

13-14: 의존성 추가 확인

fileUtil 의존성이 추가되었습니다. 이 변경 사항은 사용자 프로필 이미지를 위한 URL 생성을 가능하게 합니다.
src/main/kotlin/dsm/pick2024/domain/application/service/QueryMyApplicationService.kt (2)
18-19: 의존성 추가 확인

fileUtil 의존성이 추가되었습니다. 이 변경 사항은 사용자 프로필 이미지를 위한 URL 생성을 가능하게 합니다.

39-39: 프로필 URL 생성 로직 확인

fileUtil을 사용하여 프로필 URL을 생성하는 로직이 추가되었습니다. 이 변경 사항은 사용자 프로필 이미지를 더 효율적으로 처리합니다.

그러나, fileUtil의 사용이 올바르게 적용되었는지 확인해 주세요.

Verification successful

프로필 URL 생성 로직 확인 완료

fileUtil.generateObjectUrl 함수가 여러 파일에서 일관되게 사용되고 있습니다. 이는 사용자 프로필 이미지 및 기타 파일을 처리하는 표준 접근 방식을 나타냅니다. 따라서, 해당 함수의 사용이 올바르게 적용되었음을 확인했습니다.

QueryUserSimpleInfoService.kt

QueryUserDetaileInfoService.kt

AddBugService.kt

QueryMyApplicationService.kt
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify all function calls to `fileUtil.generateObjectUrl`.

# Test: Search for the function usage. Expect: Only occurrences of the new usage.
rg --type kotlin -A 5 $'fileUtil.generateObjectUrl'
Length of output: 2598
src/main/kotlin/dsm/pick2024/domain/user/presentation/UserController.kt (2)
32-33: 의존성 추가 확인

uploadUserProfileUseCase 의존성이 추가되었습니다. 이 변경 사항은 사용자 프로필 업로드를 처리하는 기능을 가능하게 합니다.

59-60: 프로필 업로드 엔드포인트 추가 확인

사용자 프로필 이미지를 업로드하는 새로운 엔드포인트가 추가되었습니다. 이 변경 사항은 사용자 프로필 관리를 향상시킵니다.

그러나, uploadUserProfileUseCase의 사용이 올바르게 적용되었는지 확인해 주세요.

Verification successful

프로필 업로드 엔드포인트 추가 확인

사용자 프로필 이미지를 업로드하는 새로운 엔드포인트가 추가되었습니다. 이 변경 사항은 사용자 프로필 관리를 향상시킵니다.

또한, uploadUserProfileUseCase의 사용이 올바르게 적용되었음을 확인했습니다.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify all function calls to `uploadUserProfileUseCase.uploadUserProfile`.

# Test: Search for the function usage. Expect: Only occurrences of the new usage.
rg --type kotlin -A 5 $'uploadUserProfileUseCase.uploadUserProfile'
Length of output: 320

src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (7)

src/main/kotlin/dsm/pick2024/infrastructure/s3/PathList.kt (1)
5-5: LGTM! 프로필 경로 상수가 추가되었습니다.

새로운 PROFILE 상수가 적절하게 추가되었습니다. 이는 기존 상수들과 일관된 명명 규칙과 값 형식을 따르고 있어 좋습니다.

코드의 가독성과 유지보수성을 더욱 향상시키기 위해, 각 상수에 대한 간단한 주석을 추가하는 것을 고려해보시는 것은 어떨까요? 예를 들어:
/** 프로필 이미지 저장 경로 */
const val PROFILE = "PROFILE/"
src/main/kotlin/dsm/pick2024/domain/user/presentation/dto/response/QueryUserSimpleInfoResponse.kt (1)
7-8: 프로필 이미지 URL을 위한 속성 추가 승인

새로운 profile 속성의 추가는 사용자 프로필 이미지 기능 구현을 위한 좋은 접근 방식입니다. nullable 타입과 기본값 null 사용은 이전 버전과의 호환성을 유지하면서 프로필 이미지가 없는 사용자를 처리할 수 있게 해줍니다.

더 명확한 의미 전달을 위해 profile 대신 profileImageUrl과 같은 더 구체적인 이름을 사용하는 것이 어떨까요? 이렇게 하면 이 속성이 정확히 무엇을 나타내는지 더 명확해질 것 같습니다.
data class QueryUserSimpleInfoResponse(
    val userName: String,
    val grade: Int,
    val classNum: Int,
    val num: Int,
-   val profile: String? = null,
+   val profileImageUrl: String? = null,
)
src/main/kotlin/dsm/pick2024/domain/user/domain/User.kt (1)
23-25: 좋은 구현입니다. 약간의 개선 제안이 있습니다.

updateProfileFileName 메서드의 구현이 잘 되었습니다. 불변성을 유지하면서 프로필 파일 이름을 업데이트하는 방식이 적절합니다. 다만, 더 나은 null 안전성을 위해 다음과 같은 작은 개선을 제안합니다:
fun updateProfileFileName(fileName: String?): User {
-    return this.copy(profile = fileName)
+    return this.copy(profile = fileName?.takeIf { it.isNotBlank() })
}
이렇게 하면 빈 문자열이 들어왔을 때도 null로 처리되어 더 안전한 코드가 됩니다.
src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserDetaileInfoService.kt (2)
13-14: 생성자 변경이 적절히 이루어졌습니다.

FileUtil을 의존성으로 추가한 것은 프로필 이미지 URL 생성 기능 구현에 필요한 좋은 변경사항입니다. 이는 의존성 주입 패턴을 따르고 있어 테스트 용이성과 유연성을 높입니다.

가독성을 높이기 위해 각 매개변수를 별도의 줄에 배치하는 것을 고려해 보세요. 예를 들면:
class QueryUserDetaileInfoService(
    private val userFacadeUseCase: UserFacadeUseCase,
    private val fileUtil: FileUtil
) : QueryUserDetailsInfoUseCase {
    // ...
}
21-21: queryUserDetailsInfo 메서드의 변경이 적절히 이루어졌습니다.

프로필 이미지 URL 생성을 위해 fileUtil.generateObjectUrl을 사용한 것은 좋은 변경사항입니다. null 안전 호출을 사용하여 잠재적인 null 값을 처리한 것도 훌륭합니다.

코드의 가독성을 높이기 위해 다음과 같이 변경을 고려해 보세요:
profile = user.profile?.let { profile ->
    fileUtil.generateObjectUrl(profile, PathList.PROFILE)
},
이렇게 하면 it의 의미가 더 명확해지고, 코드의 의도를 더 잘 전달할 수 있습니다.
src/main/kotlin/dsm/pick2024/domain/application/service/QueryMyApplicationService.kt (2)
19-20: 생성자에 새로운 의존성이 적절히 추가되었습니다.

FileUtil을 생성자 매개변수로 추가한 것은 새로운 기능 구현에 필요한 적절한 변경사항입니다. 다만, 의존성 주입의 일관성을 위해 private val 키워드를 사용하는 것이 좋습니다.

다음과 같이 수정하는 것을 고려해보세요:
-private val queryApplicationPort: QueryApplicationPort,
-fileUtil: FileUtil
+private val queryApplicationPort: QueryApplicationPort,
+private val fileUtil: FileUtil
42-42: 프로필 URL 생성 로직이 적절히 추가되었습니다.

사용자 프로필 이미지 URL을 생성하는 로직이 잘 구현되었습니다. null 안전 호출 연산자 ?.를 사용하여 프로필이 존재할 때만 URL을 생성하는 것은 좋은 방식입니다.

코드의 가독성을 높이기 위해 다음과 같이 수정하는 것을 고려해보세요:
-profile = user.profile?.let { fileUtil.generateObjectUrl(it, PathList.PROFILE) }
+profile = user.profile?.let { profile -> fileUtil.generateObjectUrl(profile, PathList.PROFILE) }
이렇게 하면 it의 의미가 더 명확해집니다.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 036b5c3 and 333066d.

📒 Files selected for processing (6)

src/main/kotlin/dsm/pick2024/domain/application/service/QueryMyApplicationService.kt (2 hunks)
src/main/kotlin/dsm/pick2024/domain/user/domain/User.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/presentation/dto/response/QueryUserSimpleInfoResponse.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserDetaileInfoService.kt (1 hunks)
src/main/kotlin/dsm/pick2024/global/config/security/SecurityConfig.kt (1 hunks)
src/main/kotlin/dsm/pick2024/infrastructure/s3/PathList.kt (1 hunks)

🧰 Additional context used

🔇 Additional comments (6)

src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserDetaileInfoService.kt (2)

6-7: 새로운 import 문이 적절히 추가되었습니다.

FileUtil과 PathList의 import가 추가되어 클래스의 새로운 기능을 지원합니다. 이는 프로필 이미지 URL 생성 기능 구현에 필요한 변경사항입니다.

Line range hint 1-30: 전반적인 변경 사항이 PR 목표와 일치합니다.

이 PR의 변경 사항은 사용자 프로필 이미지 업로드 기능 구현이라는 목표를 잘 달성하고 있습니다. FileUtil을 통합하여 프로필 이미지 URL을 생성하는 기능이 추가되었고, 이는 #252 이슈에서 요구하는 사용자 프로필 이미지 기능을 지원합니다.

주요 변경 사항:

FileUtil 의존성 추가

프로필 이미지 URL 생성 로직 구현

이러한 변경으로 사용자 경험이 향상되고 API의 유연성이 높아질 것으로 예상됩니다. 코드는 전반적으로 잘 구조화되어 있으며, 몇 가지 minor한 개선 제안을 제외하면 큰 문제점은 없습니다.
src/main/kotlin/dsm/pick2024/domain/application/service/QueryMyApplicationService.kt (2)
11-12: 새로운 import 문이 적절히 추가되었습니다.

FileUtil과 PathList를 import하는 것은 새로운 기능 구현에 필요한 적절한 변경사항입니다. 이는 코드의 가독성과 구조를 개선하는 데 도움이 됩니다.

Line range hint 1-48: 전반적인 변경사항이 PR의 목적에 부합하며 잘 구현되었습니다.

이 PR은 사용자 프로필 이미지 업로드 API를 구현하는 데 성공적으로 기여했습니다. 코드 변경사항은 명확하고 일관성 있게 적용되었으며, 새로운 기능을 효과적으로 통합했습니다. 제안된 minor 개선사항들을 고려해 보시기 바랍니다.

다음 스크립트를 실행하여 FileUtil과 PathList의 사용이 일관되게 적용되었는지 확인해보세요:

✅ Verification successful

확인 완료: FileUtil 및 PathList 사용 일관성

PR의 변경사항이 코드베이스 전반에 걸쳐 일관되게 적용되었음을 확인했습니다. 추가적인 문제가 발견되지 않았습니다.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# FileUtil과 PathList의 사용을 확인합니다.

echo "Checking FileUtil usage:"
rg --type kotlin "FileUtil" -A 5

echo "\nChecking PathList usage:"
rg --type kotlin "PathList" -A 5
Length of output: 25693
src/main/kotlin/dsm/pick2024/global/config/security/SecurityConfig.kt (2)
Line range hint 121-134: 학생 권한에 대한 GET 엔드포인트 추가 승인

학생 역할(Role.STU)에 대한 GET 요청 엔드포인트 추가가 적절해 보입니다. 이는 학생들이 필요한 정보에 접근할 수 있도록 하는 데 도움이 될 것입니다.

다만, "/notification/**" 엔드포인트는 여전히 너무 광범위할 수 있습니다. 다음과 같이 더 구체적인 엔드포인트를 고려해 보세요:
"/notification/my/**"
이렇게 하면 학생들이 자신의 알림만 볼 수 있도록 제한할 수 있습니다.

Line range hint 135-149: 새로운 엔드포인트 추가에 대한 승인 및 보안 강화 제안

학생(Role.STU)을 위한 DELETE 엔드포인트와 교직원(Role.SCH)을 위한 GET 엔드포인트 추가가 적절해 보입니다.

그러나 "/weekend-meal/excel" 및 "/weekend-meal/excel/grade"와 같은 엔드포인트는 대량의 데이터를 다룰 수 있으므로, 추가적인 보안 조치를 고려해 보시기 바랍니다. 예를 들어:

요청 빈도 제한 (Rate limiting) 구현

데이터 암호화

로깅 강화

또한, 이러한 엔드포인트에 대한 접근을 특정 관리자 역할로 더욱 제한하는 것도 고려해 볼 수 있습니다.

src/main/kotlin/dsm/pick2024/global/config/security/SecurityConfig.kt

coderabbitai

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (4)

src/main/kotlin/dsm/pick2024/domain/user/port/in/ModifyProfileUseCase.kt (1)
1-7: 인터페이스 구조가 잘 설계되었습니다.

Clean Architecture 패턴을 따르는 좋은 인터페이스 설계입니다. 하지만 몇 가지 개선할 점이 있습니다:

modifyProfile 메서드에 반환 타입을 추가하는 것이 좋습니다. 예를 들어, 업데이트된 프로필 URL을 반환하거나 성공/실패 여부를 나타내는 불리언 값을 반환할 수 있습니다.

인터페이스와 메서드에 KDoc 문서를 추가하여 사용 목적과 매개변수에 대한 설명을 제공하는 것이 좋습니다.

다음과 같이 수정하는 것을 제안합니다:
 package dsm.pick2024.domain.user.port.`in`

 import org.springframework.web.multipart.MultipartFile

+/**
+ * 사용자 프로필 수정을 위한 유스케이스 인터페이스
+ */
 interface ModifyProfileUseCase {
+    /**
+     * 사용자 프로필 이미지를 수정합니다.
+     *
+     * @param multipartFile 업로드할 프로필 이미지 파일
+     * @return 업데이트된 프로필 이미지 URL
+     */
-    fun modifyProfile(multipartFile: MultipartFile)
+    fun modifyProfile(multipartFile: MultipartFile): String
 }
src/main/kotlin/dsm/pick2024/domain/user/presentation/UserController.kt (2)
22-22: import 문 추가는 적절하나, 순서 조정이 필요할 수 있습니다.

MultipartFile을 위한 import 문이 올바르게 추가되었습니다. 이는 파일 업로드 처리에 필요합니다. 다만, 기존 import 문의 순서와 일관성을 유지하기 위해 위치를 조정하는 것이 좋을 수 있습니다.

import 문을 알파벳 순서로 정렬하거나, 기존의 그룹화 방식을 따라 적절한 위치로 이동하는 것을 고려해보세요.

59-61: 새로운 메서드가 추가되었지만, 몇 가지 개선이 필요합니다.

프로필 업로드를 위한 새 엔드포인트가 올바르게 추가되었습니다. 그러나 다음 사항들을 고려해 보시기 바랍니다:

메서드 이름: "upload"는 다소 일반적입니다. "uploadUserProfile"과 같이 더 구체적인 이름을 사용하는 것이 좋습니다.

오류 처리: 파일 업로드 실패 시 예외 처리가 필요할 수 있습니다.

입력 유효성 검사: 파일 크기, 형식 등에 대한 검증이 필요할 수 있습니다.

다음과 같이 메서드를 개선해 보세요:
@Operation(summary = "유저 프로필 업로드 API")
@PatchMapping("/profile")
fun uploadUserProfile(@RequestParam("file") file: MultipartFile): ResponseEntity<String> {
    return try {
        // 파일 유효성 검사
        if (file.isEmpty) {
            return ResponseEntity.badRequest().body("파일이 비어 있습니다.")
        }
        if (!file.contentType?.startsWith("image/") == true) {
            return ResponseEntity.badRequest().body("이미지 파일만 업로드 가능합니다.")
        }
        // 최대 파일 크기 검사 (예: 5MB)
        if (file.size > 5 * 1024 * 1024) {
            return ResponseEntity.badRequest().body("파일 크기는 5MB를 초과할 수 없습니다.")
        }

        val result = uploadUserProfileUseCase.uploadUserProfile(file)
        ResponseEntity.ok(result)
    } catch (e: Exception) {
        ResponseEntity.internalServerError().body("프로필 업로드 중 오류가 발생했습니다: ${e.message}")
    }
}
이 개선된 버전은 더 명확한 메서드 이름을 사용하고, 기본적인 파일 유효성 검사와 오류 처리를 포함하고 있습니다.
src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt (1)
19-19: @Transactional 어노테이션의 적용 위치 확인

@Transactional 어노테이션을 클래스 레벨에 적용하면 코드가 더 깔끔해질 수 있습니다. 또는, 읽기 전용 트랜잭션과 쓰기 트랜잭션을 구분하기 위해 메소드별로 세분화할 수도 있습니다.

예시:
+@Transactional
 @Service
 class UploadUserProfileService(
     // 기존 코드 유지
 ) : UploadUserProfileUseCase {

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 333066d and 7635ff9.

📒 Files selected for processing (10)

src/main/kotlin/dsm/pick2024/domain/application/presentation/dto/response/QueryMyApplicationResponse.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/application/service/QueryMyApplicationService.kt (2 hunks)
src/main/kotlin/dsm/pick2024/domain/attendance/service/ChangeAllAttendanceService.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/meal/service/SaveMealService.kt (0 hunks)
src/main/kotlin/dsm/pick2024/domain/user/domain/User.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/port/in/ModifyProfileUseCase.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/presentation/UserController.kt (3 hunks)
src/main/kotlin/dsm/pick2024/domain/user/presentation/dto/response/QueryUserSimpleInfoResponse.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserSimpleInfoService.kt (1 hunks)
src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt (1 hunks)

💤 Files with no reviewable changes (1)

src/main/kotlin/dsm/pick2024/domain/meal/service/SaveMealService.kt

✅ Files skipped from review due to trivial changes (1)

src/main/kotlin/dsm/pick2024/domain/attendance/service/ChangeAllAttendanceService.kt

🚧 Files skipped from review as they are similar to previous changes (3)

src/main/kotlin/dsm/pick2024/domain/application/service/QueryMyApplicationService.kt
src/main/kotlin/dsm/pick2024/domain/user/domain/User.kt
src/main/kotlin/dsm/pick2024/domain/user/presentation/dto/response/QueryUserSimpleInfoResponse.kt

🧰 Additional context used

🔇 Additional comments (7)

src/main/kotlin/dsm/pick2024/domain/application/presentation/dto/response/QueryMyApplicationResponse.kt (1)

13-13: 프로필 속성 추가에 대한 검토

새로운 profile: String? 속성이 QueryMyApplicationResponse 데이터 클래스에 추가되었습니다. 이는 PR의 목적인 사용자 프로필 이미지 업로드 기능 구현과 일치합니다.

고려사항:

속성이 nullable(String?)로 정의된 것은 적절해 보입니다. 모든 사용자가 프로필 이미지를 가지고 있지 않을 수 있기 때문입니다.

이 변경으로 인해 기존 코드에서 QueryMyApplicationResponse를 사용하는 부분에 영향이 있을 수 있습니다. 관련 서비스 및 컨트롤러 코드를 검토하여 필요한 경우 업데이트해야 합니다.

다음 스크립트를 실행하여 QueryMyApplicationResponse를 사용하는 다른 파일들을 확인해주세요:

src/main/kotlin/dsm/pick2024/domain/user/presentation/UserController.kt (2)

7-7: LGTM: 새로운 import 문이 올바르게 추가되었습니다.

UploadUserProfileUseCase를 위한 import 문이 적절히 추가되었습니다. 이는 새로운 프로필 업로드 기능을 위해 필요한 변경사항입니다.

32-33: LGTM: 생성자에 새로운 의존성이 올바르게 추가되었습니다.

UploadUserProfileUseCase가 UserController의 생성자에 적절히 추가되었습니다. 이는 기존의 의존성 주입 패턴을 따르고 있으며, 새로운 프로필 업로드 기능을 위해 필요한 변경사항입니다.

src/main/kotlin/dsm/pick2024/domain/user/service/QueryUserSimpleInfoService.kt (3)

6-7: FileUtil 및 PathList import 추가가 적절합니다

'FileUtil'과 'PathList'를 import하여 파일 관련 기능을 사용할 수 있게 된 점이 좋습니다.

13-14: 생성자에 FileUtil 의존성 주입

'fileUtil'을 생성자에 추가하여 의존성을 주입한 방식이 적절합니다. 이를 통해 파일 유틸리티 기능을 서비스에서 활용할 수 있습니다.

20-26: 사용자 프로필 이미지 URL 생성 로직 추가

'QueryUserSimpleInfoResponse' 생성 시 'user.profile'이 존재할 경우에만 'fileUtil.generateObjectUrl'을 사용하여 프로필 이미지 URL을 생성하는 로직이 적절하게 구현되었습니다. 'user.profile'이 null일 수 있으므로 안전 호출과 'let' 함수를 사용하여 null 안전성을 확보한 점이 좋습니다.

src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt (1)

23-23: 🛠️ Refactor suggestion

if 문을 let으로 변경하여 코드 간결화

기존의 if 문을 Kotlin의 let 함수를 사용하여 더 간결하고 읽기 쉽게 수정할 수 있습니다.

src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt

meltapplee added 2 commits July 31, 2024 08:33

add :: uploadUserProfile

331ec1e

add :: profile at response

036b5c3

meltapplee added the 기능 개발 API 개발 label Jul 30, 2024

meltapplee self-assigned this Jul 30, 2024

meltapplee requested a review from rudeh2926 as a code owner July 30, 2024 23:37

coderabbitai bot reviewed Jul 30, 2024

View reviewed changes

rudeh2926 reviewed Jul 31, 2024

View reviewed changes

src/main/kotlin/dsm/pick2024/domain/user/service/UploadUserProfileService.kt Outdated Show resolved Hide resolved

meltapplee closed this Jul 31, 2024

meltapplee reopened this Oct 16, 2024

Merge branch 'develop' into 252-upload-profile-api

333066d

coderabbitai bot reviewed Oct 16, 2024

View reviewed changes

src/main/kotlin/dsm/pick2024/global/config/security/SecurityConfig.kt Outdated Show resolved Hide resolved

meltapplee added 4 commits October 16, 2024 14:15

add :: uploadUserProfile

b88774b

add :: profile return

67399fc

ktlint

7635ff9

modify :: logic

9ce2c3a

coderabbitai bot reviewed Oct 16, 2024

View reviewed changes

add :: ,

7b5e0c8

rudeh2926 approved these changes Oct 16, 2024

View reviewed changes

meltapplee merged commit d60fa23 into develop Oct 16, 2024
1 check passed

meltapplee deleted the 252-upload-profile-api branch October 16, 2024 07:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🔀 :: (PiCK-252)upload profile api #257

🔀 :: (PiCK-252)upload profile api #257

meltapplee commented Jul 30, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

🔀 :: (PiCK-252)upload profile api #257

🔀 :: (PiCK-252)upload profile api #257

Conversation

meltapplee commented Jul 30, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jul 30, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

meltapplee commented Jul 30, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 30, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)