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

🚸 Prevent redundant image upload api call #406

Conversation

dohyun-ko
Copy link
Member

@dohyun-ko dohyun-ko commented Jan 8, 2025

업로드 이미지가 없을 경우 api를 호출하지 않는 간단한 로직변경을 하였습니다.

Summary by CodeRabbit

  • 새로운 기능

    • 이미지 업로드 프로세스의 안정성 개선
    • 이미지 업로드 시 빈 배열 처리 로직 추가
  • 버그 수정

    • 이미지 없는 경우의 잠재적 오류 방지
    • API 응답 데이터 타입 명확화

@dohyun-ko dohyun-ko self-assigned this Jan 8, 2025
@dohyun-ko dohyun-ko linked an issue Jan 8, 2025 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

📝 Walkthrough

워크스루

이 변경사항은 이미지 업로드 및 공지 제출 프로세스와 관련된 두 파일의 수정 사항을 포함합니다. image.ts에서는 API 호출의 응답 타입을 명시적으로 string[]으로 지정하고, handle-notice-submit.ts에서는 이미지 업로드 로직의 조건부 처리 방식을 개선했습니다.

변경 사항

파일 변경 요약
src/api/image/image.ts ziggleApi.post() 메서드 호출 시 응답 타입을 <string[]>로 명시적 지정
src/app/[lng]/write/handle-notice-submit.ts imageKeys 할당 로직 조건부 처리, 이미지 배열 존재 여부에 따라 처리

시퀀스 다이어그램

sequenceDiagram
    participant User
    participant UploadComponent
    participant ImageAPI
    participant NoticeSubmission

    User->>UploadComponent: 이미지 선택
    alt 이미지 있음
        UploadComponent->>ImageAPI: 이미지 업로드 요청
        ImageAPI-->>UploadComponent: 이미지 키 배열 반환
        UploadComponent->>NoticeSubmission: 이미지 키와 함께 공지 제출
    else 이미지 없음
        UploadComponent->>NoticeSubmission: 빈 이미지 키 배열로 공지 제출
    end
Loading

시 (토끼의 노래)

🐰 코드의 물결, 타입의 춤
이미지 키 반짝이는 꿈
조건부 로직, 우아한 손길
안전하고 깔끔한 코드의 미소
개발의 토끼, 앞으로 뛰어요! 🚀


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

github-actions bot commented Jan 8, 2025

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
src/app/[lng]/write/handle-notice-submit.ts (1)

185-186: 불필요한 API 호출 방지 로직이 잘 구현되었습니다!

이미지가 있을 때만 uploadImages를 호출하고, 없을 경우 빈 배열을 반환하도록 최적화가 잘 되었습니다. 이는 불필요한 네트워크 요청을 줄이는 좋은 개선사항입니다.

다만, 한 가지 제안드리고 싶은 점이 있습니다:

-  const imageKeys =
-    images.length > 0 ? await uploadImages(images).catch(() => null) : [];
+  const imageKeys = images.length === 0
+    ? []
+    : await uploadImages(images).catch(() => null);

위와 같이 조건문을 재구성하면 로직의 의도가 더 명확해질 것 같습니다. 이미지가 없는 경우를 먼저 처리함으로써 주요 로직의 가독성이 개선될 수 있습니다.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 34d589c and 599c4a2.

📒 Files selected for processing (2)
  • src/api/image/image.ts (1 hunks)
  • src/app/[lng]/write/handle-notice-submit.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: preview-deploy
🔇 Additional comments (1)
src/api/image/image.ts (1)

6-6: API 응답 타입 명시 추가가 잘 되었습니다!

post 메서드에 <string[]> 타입 파라미터를 추가하여 타입 안정성이 향상되었습니다.

@dohyun-ko dohyun-ko merged commit 0e02ee7 into master Jan 8, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] call upload image api when there is no image in a notice
1 participant