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

[Fix] Change DTO #246

Merged
merged 3 commits into from
Nov 28, 2024
Merged

[Fix] Change DTO #246

merged 3 commits into from
Nov 28, 2024

Conversation

HI-JIN2
Copy link
Member

@HI-JIN2 HI-JIN2 commented Nov 28, 2024

Summary

백엔드에서 dto를 바꿈으로써 바뀐 DTO에 맞게 수정

Describe your changes

Issue

  • Resolves #

To reviewers

Summary by CodeRabbit

  • 새로운 기능

    • 식사 응답 데이터 구조 변경: mainRatingrating으로, menusInformationListbriefMenus로 변경되었습니다.
    • 메뉴 응답 데이터 구조 변경: menuInformationListmenus로 변경되었습니다.
  • 문서화

    • MealServiceMenuService 인터페이스의 메서드에 대한 문서 주석이 추가되었습니다.
  • 버그 수정

    • 데이터 매핑 로직이 새로운 속성 이름에 맞게 업데이트되었습니다.

@HI-JIN2 HI-JIN2 self-assigned this Nov 28, 2024
Copy link

coderabbitai bot commented Nov 28, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

이 변경 사항은 여러 데이터 클래스와 서비스 인터페이스의 구조를 수정하고 문서화하는 내용을 포함합니다. GetMealResponse, MenuOfMealResponse, 및 MenuResponse 데이터 클래스의 속성이 변경되었으며, JSON 직렬화에 대한 새로운 이름이 적용되었습니다. 또한, 관련 메서드에서 이러한 변경 사항을 반영하도록 로직이 업데이트되었습니다. MealServiceMenuService 인터페이스에는 메서드에 대한 KDoc 주석이 추가되어 각 메서드의 기능을 명확히 설명합니다.

Changes

파일 경로 변경 요약
app/src/main/java/com/eatssu/android/data/dto/response/MealResponse.kt - GetMealResponse 클래스에서 mainRating 속성이 rating으로 변경됨
- menusInformationList 속성이 briefMenus로 변경됨
- mapTodayMenuResponseToMenu 함수가 새로운 속성 이름을 반영하도록 수정됨
app/src/main/java/com/eatssu/android/data/dto/response/MenuOfMealResponse.kt - MenuOfMealResponse 클래스에서 menusInformation 속성이 briefMenus로 변경됨
- toMenuMiniList() 메서드가 새로운 속성 이름을 사용하도록 수정됨
app/src/main/java/com/eatssu/android/data/dto/response/MenuResponse.kt - CategoryMenuListCollection 클래스에서 menuInformationList 속성이 menus로 변경됨
- MenuInformationList 클래스에서 mainRating 속성이 rating으로 변경됨
- mapFixedMenuResponseToMenu 함수가 새로운 속성 이름을 사용하도록 수정됨
app/src/main/java/com/eatssu/android/data/service/MealService.kt - getTodayMealgetMenuInfoByMealId 메서드에 KDoc 주석 추가됨
app/src/main/java/com/eatssu/android/data/service/MenuService.kt - getFixMenu 메서드에 대한 KDoc 주석이 추가됨 (한글로 "고정 메뉴 목록을 검색")

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MealService
    participant MenuService
    participant MealResponse
    participant MenuResponse

    User->>MealService: getTodayMeal()
    MealService->>MealResponse: Retrieve meal data
    MealResponse-->>MealService: Return GetMealResponse
    MealService-->>User: Return meal list

    User->>MenuService: getFixMenu()
    MenuService->>MenuResponse: Retrieve fixed menu data
    MenuResponse-->>MenuService: Return GetFixedMenuResponse
    MenuService-->>User: Return fixed menu list
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 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

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

🧹 Outside diff range and nitpick comments (2)
app/src/main/java/com/eatssu/android/data/dto/response/MealResponse.kt (1)

26-26: 매핑 로직이 올바르게 수정되었습니다.

데이터 클래스의 속성 변경사항이 매핑 함수에 정확하게 반영되었습니다. 다만, 함수의 동작을 설명하는 KDoc 문서를 추가하면 좋을 것 같습니다.

다음과 같이 문서화를 추가해보세요:

+/**
+ * GetMealResponse 리스트를 Menu 도메인 모델 리스트로 변환합니다.
+ * 
+ * @return 변환된 Menu 객체 리스트
+ */
fun ArrayList<GetMealResponse>.mapTodayMenuResponseToMenu(): List<Menu> {

Also applies to: 29-29

app/src/main/java/com/eatssu/android/data/dto/response/MenuResponse.kt (1)

Line range hint 36-46: 매핑 함수가 새로운 DTO 구조를 반영하도록 수정되었습니다.

변경된 필드명(menus)을 사용하도록 잘 수정되었습니다. 하지만 매핑 시 null 안전성을 개선할 수 있습니다.

다음과 같이 Elvis 연산자 대신 안전 호출 연산자를 사용하는 것을 고려해보세요:

-            val menu = Menu(
-                id = menuInfo.menuId ?: 0,
-                name = menuInfo.name ?: "",
-                price = menuInfo.price ?: 0,
-                rate = menuInfo.mainRating ?: 0.0
-            )
+            menuInfo.menuId?.let { id ->
+                Menu(
+                    id = id,
+                    name = menuInfo.name.orEmpty(),
+                    price = menuInfo.price ?: 0,
+                    rate = menuInfo.mainRating ?: 0.0
+                )
+            }?.let { menu ->
+                menus.add(menu)
+            }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1e76c14 and a9ae776.

📒 Files selected for processing (5)
  • app/src/main/java/com/eatssu/android/data/dto/response/MealResponse.kt (2 hunks)
  • app/src/main/java/com/eatssu/android/data/dto/response/MenuOfMealResponse.kt (2 hunks)
  • app/src/main/java/com/eatssu/android/data/dto/response/MenuResponse.kt (4 hunks)
  • app/src/main/java/com/eatssu/android/data/service/MealService.kt (1 hunks)
  • app/src/main/java/com/eatssu/android/data/service/MenuService.kt (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • app/src/main/java/com/eatssu/android/data/service/MealService.kt
  • app/src/main/java/com/eatssu/android/data/service/MenuService.kt
🔇 Additional comments (3)
app/src/main/java/com/eatssu/android/data/dto/response/MenuOfMealResponse.kt (2)

18-18: 메서드 업데이트가 올바르게 되었습니다.

toMenuMiniList() 메서드가 새로운 프로퍼티 이름을 참조하도록 정확하게 수정되었습니다. 기존 로직은 유지되어 있어 기능상의 변화는 없습니다.


7-7: 백엔드 API 응답과 일치하는지 확인이 필요합니다.

프로퍼티 이름이 menusInformation에서 briefMenus로 변경된 것이 확인되었습니다. 이는 백엔드 변경사항과 일치하는 것으로 보입니다.

백엔드 API 응답 구조와 일치하는지 확인하기 위해 다음 스크립트를 실행하세요:

✅ Verification successful

Let me gather more information about the API service and repository implementation to verify the property name change.


Let me try a different approach to check the API service implementation.


프로퍼티 이름 변경이 API 구조와 일치함을 확인했습니다.

  • MealService 인터페이스와 MealRepositoryImpl 구현체에서 MenuOfMealResponse DTO가 일관되게 사용되고 있습니다.
  • 변경된 briefMenus 프로퍼티는 백엔드 API 응답 구조와 정확히 매핑되어 있습니다.
  • 관련 코드베이스 전반에 걸쳐 DTO 사용이 올바르게 구현되어 있습니다.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: API 응답 구조와의 일관성 확인

# API 관련 인터페이스 파일 검색
rg -l "interface.*Service.*getMeal|interface.*Service.*getMenu" --type kotlin

# DTO 사용처 확인
rg "MenuOfMealResponse" --type kotlin

Length of output: 2104


Script:

#!/bin/bash
# Check the MealService interface implementation and repository for API structure
ast-grep --pattern 'interface MealService {
  $$$
  @GET($_)
  suspend fun getMenuInfoByMealId($_): BaseResponse<MenuOfMealResponse>
  $$$
}'

# Check repository implementation
ast-grep --pattern 'class MealRepositoryImpl $_: MealRepository {
  $$$
  override suspend fun getMenuInfoByMealId($_): Flow<BaseResponse<MenuOfMealResponse>> {
    $$$
  }
  $$$
}'

Length of output: 327


Script:

#!/bin/bash
# Check the MealService interface and API endpoint details
rg -A 5 "interface MealService" --type kotlin

# Check the actual implementation in repository
rg -A 5 "getMenuInfoByMealId" --type kotlin

Length of output: 3057

app/src/main/java/com/eatssu/android/data/dto/response/MenuResponse.kt (1)

5-5: Timber 로깅 프레임워크로의 전환이 확인되었습니다.

Timber는 Log 클래스보다 더 강력한 로깅 기능을 제공하므로 좋은 변경사항입니다. 다만, Timber.plant()가 Application 클래스에서 초기화되었는지 확인해주세요.

✅ Verification successful

Timber가 올바르게 초기화되어 있습니다.

App.kt에서 디버그 모드일 때 Timber.DebugTree()를 plant하도록 적절히 구성되어 있어 안전하게 사용 가능합니다.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Application 클래스에서 Timber 초기화 여부 확인
ast-grep --pattern 'class $_ : Application {
  $$$
  Timber.plant($$$)
  $$$
}'

Length of output: 81


Script:

#!/bin/bash
# Application 클래스 파일 찾기
fd "Application.kt|App.kt" --type f

# Timber.plant 호출 검색
rg "Timber\.plant" -l

Length of output: 149


Script:

#!/bin/bash
# App.kt의 내용 확인
cat app/src/main/java/com/eatssu/android/App.kt

Length of output: 689

Comment on lines +10 to +11
@SerializedName("rating") var rating: Double? = null,
@SerializedName("briefMenus") var briefMenus: ArrayList<MenusInformationList> = arrayListOf(),
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

속성명 변경에 따른 일관성 문제가 발견되었습니다.

검색 결과를 통해 다음과 같은 불일치 사항이 확인되었습니다:

  • MealResponse.kt에서 mainRatingrating으로 변경되었으나, 다른 Response 클래스들(MenuReviewInfoResponse, MealReviewInfoResponse, ReviewListResponse 등)에서는 여전히 mainRating을 사용 중입니다.
  • MenuResponse.kt에서는 @SerializedName("rating")을 사용하면서도 변수명은 mainRating을 유지하고 있어 일관성이 없습니다.
  • briefMenus 속성은 MenuOfMealResponseMealResponse에서 서로 다른 타입(MenusInformationMenusInformationList)을 사용하고 있습니다.

이러한 불일치는 API 응답 처리 시 혼란을 야기할 수 있으며, 향후 유지보수에 어려움을 줄 수 있습니다.

🔗 Analysis chain

백엔드 API 스펙과 일치하는지 확인이 필요합니다.

속성 이름이 변경되었습니다:

  • mainRatingrating
  • menusInformationListbriefMenus

이러한 변경사항이 최신 백엔드 API 문서와 일치하는지 확인해주세요.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: API 응답 구조와 일치하는지 확인하기 위해 관련 파일들을 검색합니다.

# API 관련 파일들에서 이전 속성명이 남아있는지 확인
echo "이전 속성명 검색 결과:"
rg "mainRating|menusInformationList" --type kotlin

# 새로운 속성명의 일관된 사용 확인
echo -e "\n새로운 속성명 검색 결과:"
rg "rating|briefMenus" --type kotlin

Length of output: 5624

@@ -14,7 +14,7 @@ data class GetFixedMenuResponse(
data class CategoryMenuListCollection(

@SerializedName("category") var category: String? = null,
@SerializedName("menuInformationList") var menuInformationList: ArrayList<MenuInformationList> = arrayListOf(),
@SerializedName("menus") var menus: ArrayList<MenuInformationList> = arrayListOf(),
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

DTO 필드명이 백엔드 변경사항과 일치하도록 수정되었습니다.

  • menuInformationListmenus
  • mainRating SerializedName이 rating으로 변경

하지만 mainRating 변수명은 여전히 이전 명명규칙을 따르고 있습니다.

다음과 같이 변수명도 일관성 있게 변경하는 것을 추천드립니다:

-    @SerializedName("rating") var mainRating: Double? = null,
+    @SerializedName("rating") var rating: Double? = null,

Also applies to: 26-26

# Conflicts:
#	app/src/main/java/com/eatssu/android/data/dto/response/MenuResponse.kt
@HI-JIN2 HI-JIN2 merged commit ba974ca into develop Nov 28, 2024
1 of 2 checks passed
HI-JIN2 added a commit that referenced this pull request Dec 15, 2024
* chore: change dto

* chore: change dto
HI-JIN2 added a commit that referenced this pull request Dec 15, 2024
* chore: change dto

* chore: change dto
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.

1 participant