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: 사용자 과제 히스토리 조회 응답 필드에 제출 실패 사유 추가 #667

Merged
merged 1 commit into from
Aug 21, 2024

Conversation

AlmondBreez3
Copy link
Member

@AlmondBreez3 AlmondBreez3 commented Aug 21, 2024

🌱 관련 이슈

📌 작업 내용 및 특이사항

📝 참고사항

📚 기타

Summary by CodeRabbit

  • 신규 기능
    • 제출 실패 유형 정보를 포함하는 새로운 필드를 AssignmentHistoryResponse에 추가하여 API 응답의 데이터 표현력을 향상시켰습니다.

@AlmondBreez3 AlmondBreez3 self-assigned this Aug 21, 2024
@AlmondBreez3 AlmondBreez3 requested a review from a team as a code owner August 21, 2024 13:18
Copy link

coderabbitai bot commented Aug 21, 2024

Walkthrough

사용자 과제 히스토리 조회 API에 submissionFailureType 필드를 추가하여 과제의 제출 실패 사유를 API 응답에 포함시킵니다. 이 변경은 API의 데이터 표현을 향상시키며, 과제 히스토리 객체에서 실패 유형을 효과적으로 전달할 수 있도록 합니다.

Changes

파일 변경 요약
src/main/java/com/gdschongik/gdsc/domain/study/dto/response/AssignmentHistoryResponse.java AssignmentHistoryResponsesubmissionFailureType 필드를 추가하고, 생성자 및 정적 메서드를 업데이트하여 이를 초기화하도록 변경.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant AssignmentHistory

    User->>API: 과제 히스토리 요청
    API->>AssignmentHistory: 과제 데이터 요청
    AssignmentHistory-->>API: 과제 데이터 및 제출 실패 사유 반환
    API-->>User: 과제 히스토리 및 실패 사유 응답
Loading

Assessment against linked issues

Objective Addressed Explanation
응답에 실패 사유도 내려주는 SubmissionFailureType추가 (#664)

Poem

🐰 작고 귀여운 토끼가 말해요,
실패 사유도 함께 전해요.
과제 히스토리, 이제는 완벽해,
API 응답에 기쁨이 넘쳐요!
더 나은 정보를, 모두에게,
우리는 함께 달려갈 거예요! 🌼✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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
Member

@Sangwook02 Sangwook02 left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1827622 and baba34b.

Files selected for processing (1)
  • src/main/java/com/gdschongik/gdsc/domain/study/dto/response/AssignmentHistoryResponse.java (3 hunks)
Additional comments not posted (3)
src/main/java/com/gdschongik/gdsc/domain/study/dto/response/AssignmentHistoryResponse.java (3)

5-5: 필요한 import 추가 확인.

SubmissionFailureType의 import가 적절하게 추가되었습니다. 사용되는 필드에 맞게 잘 반영되었습니다.


16-16: 새로운 필드 추가 확인.

submissionFailureType 필드가 올바르게 추가되었습니다. API 문서화를 위한 @Schema 주석도 적절하게 사용되었습니다.


26-26: from 메서드 업데이트 확인.

from 메서드가 assignmentHistory.getSubmissionFailureType()을 포함하도록 올바르게 업데이트되었습니다. 새로운 필드가 생성자에 잘 전달됩니다.

Copy link
Member

@uwoobeat uwoobeat left a comment

Choose a reason for hiding this comment

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

lgtm

@AlmondBreez3 AlmondBreez3 merged commit 41d96a3 into develop Aug 21, 2024
1 check passed
@AlmondBreez3 AlmondBreez3 deleted the feature/664-add-submission-fail branch August 22, 2024 15:49
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.

✨ 사용자 과제 히스토리 조회 API
3 participants