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

[1.1.1/AN-feat] DB 마이그레이션 (Drop 방식 X) #434

Merged
merged 8 commits into from
Oct 28, 2024

Conversation

murjune
Copy link
Contributor

@murjune murjune commented Oct 27, 2024

데모데이 때 특정 기기에서 오류가 발생한 이유

데모데이 때 Migration_1_to_2 Exception이 문제가 생겼던 이유는 제가 Koin 적용할 때 fallbackToDestructiveMigrationFrom()을 추가를 안해줘서 그렇습니다.. 하하 미안합니다 😢

작업한 내용

  • DB Auto Migration 작업 및 Migration 테스트
  • DB Migration 테스트

fallbackToDestructiveMigration 에서 Auto Migration 으로 변경한 이유

fallbackToDestructiveMigration 은 db가 마이그레이션에 실패하면 Drop하고 다시 만드는 함수입니다.(심지가 저번에도 설명해주었지만)
따라서, DB 마이그레이션한 이력이 남지 않습니다. 과거 DB 버전으로 회귀하고 싶을 경우와 같이 버전 기록이 필요한 경우가 생기면, 과거 PR 이력들을 모두 찾지 않는 이상 불가능합니다.

이제 시간에 쫓겨 작업하지 않아도 되니, Migration 작업이 조금 번거로워도 더 좋은 프로젝트가 되기 위해 제안해봅니다!

DB Migration 테스트

디비 마이그레이션 테스트에 대한 이해를 위해 간단하게 작성해둘게여
테스트 코드를 작성하는 방법은 작성한 코드를 봐주세여~

room-test에서 지원하는 MigrationTestHelper 가 scheme history를 기반으로 마이그레이션 테스트합니다.
따라서, androidTest/schemas/../pokeRogueDatabase/(dbVersion).json 에 이전 디비 버전의 scheme 들이 있어야합니다.

그리고, 마이그레이션 테스트에는 다음과 같이 2가지 종류의 테스트가 있다고 합니다.

1) 단일 마이그레이션 테스트 (데이터 무결성 테스트)

DB 버전을 올려도 이전 데이터가 손상이 일어나지 않는지를 테스트합니다!

// from: db version 1
data class User(
   @PrimaryKey val id: String,
    val name: String,
)

// to: db version 2

data class User(
   @PrimaryKey val id: String,
    val name: String,
    @ColumnInfo(defaultValue = -1)    
    val age: Int,
)

위와 같이 User 에 age 라는 새로운 컬럼이 추가되었으면 2가지 테스트를 합니다.

  1. 기존 데이터가 손상되었는가?
  2. 새로운 컬럼에 default 값이 들어가는가

2) 전체 마이그레이션 테스트

가장 오래된 db 버전이 1이고, 가장 최신 db 버전이 10이라고 가정했을 때
1 에서 10으로 마이그레이션하는데 문제가 없는지 확인하는 테스트입니다!

참고자료

#355 이 큰 도움이 됐어요 땡큐 심지 👍👍

프로젝트 코드에도 남겼지만 작업하면서 참고한 자료들 입니다.

db 마이그레이션 공식문서

ivy 프로젝트 db 마이그레이션 테스트

안드로이드 공식 샘플 코드

🚀Next Feature

  • Instrumentation Test 자동화
  • Robolectric Fragment Test 버그 수정

@github-actions github-actions bot added AN_FEAT ✨ 안드 새로운 기능 v1.1.1 🏷️ labels Oct 27, 2024
@murjune murjune changed the title [1.1.1/AN-feat] DB 마이그레이션 [1.1.1/AN-feat] DB 마이그레이션 (Drop X) Oct 27, 2024
@murjune murjune changed the title [1.1.1/AN-feat] DB 마이그레이션 (Drop X) [1.1.1/AN-feat] DB 마이그레이션 (Drop 방식 X) Oct 28, 2024
@murjune murjune merged commit 734de30 into an/develop Oct 28, 2024
2 checks passed
@murjune murjune deleted the an/fix/db-migration branch October 28, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AN_FEAT ✨ 안드 새로운 기능 v1.1.1 🏷️
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant