Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 이미지 업로드 오브젝트 배열로 변경 (#24) #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

love1ace
Copy link
Member

@love1ace love1ace commented Nov 18, 2024

Summary by CodeRabbit

  • 새로운 기능

    • 이미지 업로드 기능이 개선되어 여러 필드를 지원하게 됨. 각 필드는 최대 이미지 수를 설정할 수 있음.
    • 업로드된 이미지 URL을 필드별로 구분하여 반환하는 새로운 응답 구조 도입.
  • 버그 수정

    • 요청 처리 로직이 간소화되어 파일 존재 여부만 확인하도록 변경됨.
  • 문서화

    • API 사용 패턴 및 응답 형식에 대한 주석 업데이트.

@love1ace love1ace added the feat New features or functionality label Nov 18, 2024
@love1ace love1ace self-assigned this Nov 18, 2024
@love1ace love1ace linked an issue Nov 18, 2024 that may be closed by this pull request
Copy link

coderabbitai bot commented Nov 18, 2024

Walkthrough

이 변경 사항은 이미지 업로드 기능을 수정하여 단일 이미지 배열 처리에서 여러 필드를 지원하도록 전환합니다. upload.array('images', 10) 메서드는 upload.fields([...])로 대체되어, 각각 최대 개수가 지정된 thumbnail, meetingSpace, introSrcs의 세 가지 필드를 정의합니다. 요청 처리 로직은 req.files의 존재 여부를 확인하도록 업데이트되었으며, 응답 구조는 각 필드별로 URL을 분류하는 객체로 변경되었습니다.

Changes

파일 경로 변경 요약
src/api/imageUpload/image.routes.ts 이미지 업로드 기능을 수정하여 여러 필드를 지원하도록 변경. upload.array에서 upload.fields로 전환하고, 요청 처리 및 응답 구조를 업데이트.

Possibly related issues

  • resistance2/travely-server#24: 기존 스트링 배열 형식에서 오브젝트 배열로 변경하는 작업이 포함되어 있어, 이 PR의 변경 사항과 관련이 있음.

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.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
src/api/imageUpload/image.routes.ts (1)

30-36: 이미지 업로드 처리 로직이 깔끔합니다.

카테고리별 처리가 효율적으로 구현되어 있습니다. 다만, 업로드 실패 시의 부분 성공 상태 처리가 필요할 수 있습니다.

다음과 같이 개별 파일 업로드 실패를 처리하는 것을 고려해보세요:

      for (const [category, categoryFiles] of Object.entries(files)) {
        if (categoryFiles && categoryFiles.length > 0) {
-         const urls = await uploadImages(categoryFiles);
-         result[category as keyof typeof result] = urls;
+         try {
+           const urls = await uploadImages(categoryFiles);
+           result[category as keyof typeof result] = urls;
+         } catch (error) {
+           console.error(`${category} 이미지 업로드 실패:`, error);
+           result[category as keyof typeof result] = [];
+         }
        }
      }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 00691e9 and 37d16ad.

📒 Files selected for processing (1)
  • src/api/imageUpload/image.routes.ts (2 hunks)
🔇 Additional comments (3)
src/api/imageUpload/image.routes.ts (3)

10-14: 필드 구성이 명확하고 적절합니다!

각 이미지 카테고리별로 최대 개수가 잘 정의되어 있습니다.


24-28: 응답 구조가 잘 정의되어 있습니다!

각 카테고리별 배열이 명확하게 초기화되어 있어 좋습니다.


48-67: API 사용 예시가 명확합니다!

curl 명령어와 응답 예시가 잘 문서화되어 있습니다.

Comment on lines +17 to 19
if (!req.files) {
res.status(400).json({ message: '이미지 파일이 없습니다.' });
return;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

입력값 검증을 강화하는 것이 좋겠습니다.

현재는 req.files의 존재 여부만 확인하고 있습니다. 각 필드별로 필수값 여부와 파일 형식을 검증하는 것이 좋겠습니다.

다음과 같이 검증 로직을 추가하는 것을 제안드립니다:

      if (!req.files) {
        res.status(400).json({ message: '이미지 파일이 없습니다.' });
        return;
      }
+     
+     const files = req.files as { [fieldname: string]: Express.Multer.File[] };
+     
+     // thumbnail은 필수값으로 처리
+     if (!files.thumbnail || files.thumbnail.length === 0) {
+       res.status(400).json({ message: '썸네일 이미지는 필수입니다.' });
+       return;
+     }
+     
+     // 이미지 형식 검증
+     const allowedMimeTypes = ['image/jpeg', 'image/png', 'image/gif'];
+     for (const [category, categoryFiles] of Object.entries(files)) {
+       for (const file of categoryFiles) {
+         if (!allowedMimeTypes.includes(file.mimetype)) {
+           res.status(400).json({ 
+             message: `지원하지 않는 파일 형식입니다: ${file.originalname}` 
+           });
+           return;
+         }
+       }
+     }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (!req.files) {
res.status(400).json({ message: '이미지 파일이 없습니다.' });
return;
if (!req.files) {
res.status(400).json({ message: '이미지 파일이 없습니다.' });
return;
}
const files = req.files as { [fieldname: string]: Express.Multer.File[] };
// thumbnail은 필수값으로 처리
if (!files.thumbnail || files.thumbnail.length === 0) {
res.status(400).json({ message: '썸네일 이미지는 필수입니다.' });
return;
}
// 이미지 형식 검증
const allowedMimeTypes = ['image/jpeg', 'image/png', 'image/gif'];
for (const [category, categoryFiles] of Object.entries(files)) {
for (const file of categoryFiles) {
if (!allowedMimeTypes.includes(file.mimetype)) {
res.status(400).json({
message: `지원하지 않는 파일 형식입니다: ${file.originalname}`
});
return;
}
}
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat New features or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[feat] AWS S3 이미지 업로드 변경
1 participant