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.

Sign up for GitHub

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

Jump to bottom

Replaced greenDAO with androidx.room #506

Draft

JaniruTEC wants to merge 82 commits into develop from feature/dao-migration

Contributor

JaniruTEC commented Oct 18, 2023 •

edited

Summary by CodeRabbit

New Features
- Introduced Room library for enhanced database management.
- Added new tests for database creation, access, and migrations.
- Implemented automatic and manual database migrations for ~~improved~~ data integrity.
- Added new data access objects (DAOs) for Cloud, Update Check, and Vault entities.
Enhancements
- ~~Improved database operation efficiency by utilizing Kotlin's type alias and constructor-based entity creation.~~
- ~~Enhanced database schema with the addition of entities for Cloud, Update Check, and Vault.~~
- Streamlined database access in repository implementations with dependency injection.
Bug Fixes
- Fixed issues related to database migrations and entity mapping for a more stable user experience.
Refactor
- Transitioned from GreenDao to Room for database operations, resulting in cleaner and more maintainable code.
- Refined database migration logic to use Room's built-in migration features.
Documentation
- Updated internal comments to reflect changes in database handling and migration processes.
Chores
- Updated build configurations to include necessary Room library dependencies.

JaniruTEC added 3 commits

October 18, 2023 15:49


          Started Dao Migration

d961136

Replaced greenDAO dependency with androidx.room
Introduced database version 13


          Simplified database schema

c6ba13a

Introduced database version 14


          Merge branch 'develop' into feature/dao-migration

f8bbd54

JaniruTEC requested a review from SailReal

October 18, 2023 13:52

JaniruTEC marked this pull request as draft

October 18, 2023 13:52

JaniruTEC added 14 commits

October 18, 2023 19:58


          Removed unnecessary historic method "clearCache"

1e60faa

The method was a delegate to the "DaoSession#clear" method provided by greenDAO.
Analysis of the generated code indicates that room doesn't cache results internally. Therefore clearing the cache to evict stale entries is unnecessary.

See: https://web.archive.org/web/20230806043911/https://greenrobot.org/greendao/documentation/sessions/


          Added logging/comments to database configuration

10fd468


          Added logging to legacy/manual migrations

068818e


          Reorganized migrations

cde0c78


          Refactored injection of Migration12To13

b2aeef9


          Added logging to auto migrations

4809e4a


          Merge branch 'develop' into feature/dao-migration

4cce1eb


          Reformatted "org.cryptomator.data.db" package

f1421b3

[ci skip]


          Fixed formatting introduced by merge commit 4cce1eb

741212b


          Externalized database version for use in other locations

ab92786


          Started fixing UpgradeDatabaseTest

712194f


          Reformatted UpgradeDatabaseTest

87ab541


          Fixed regression in Sql: Caller is now allowed to omit columns to rec…

af6a691

…eive all


          Added and configured "room-testing"

91d3e80

This comment was marked as resolved.

Sign in to view

JaniruTEC added 10 commits

November 23, 2023 18:56


          Merge branch 'develop' into feature/dao-migration

3057b47


          Added first tests for migrations involving room using "room-testing"

420a1d3


          Changed timing of migrations

a83e968


          Refactored CloudRepositoryImpl to use CloudDao directly

7e84617


          Refactored database to be initialized on demand

bc7f8a2


          Changed configuration to use template db for creation of app db

9423a87

Without this change room will create the app db itself on installation without running the migrations.


          Updated tests to use template db

bfbff57


          Replaced asset-based template with runtime-generated file

f40a147


          Wrapped runtime-generated template with lazy stream

3e619a1


          Added template generation to dagger graph

4091a51

JaniruTEC added 30 commits

April 10, 2024 20:38


          Applied code style to BugTest.kt and SmallBugTest.kt

eb02fc0

*This commit is related to issue #529 [1]*

[1] #529


          Finalized work on BugTest.kt and SmallBugTest.kt

7b78b92

*This commit is related to issue #529 [1]*

[1] #529


          Specified journal mode

95f65c3

Room is designed to choose the journal mode itself if none is specified.
greenDAO's journal mode ("TRUNCATE") will stay for now because the journal mode has influence on the behavior caused by issue #529 [1] and because changing the journal mode complicates the migration further.
This can still be changed later.

*This commit is related to issue #529 [1]*

[1] #529


          Added first implementation of "CacheControlledSupportSQLiteDatabase"

ff67959

*This commit is related to issue #529 [1]*

[1] #529


          Refactored "CacheControlledSupportSQLiteDatabase"

1afa7b7

Replaced particular implementation of "fix" with call to freshly introduced, user-supplied mapping function (and added "RandomUUIDSQLMappingFunction" as new mapping function with that particular implementation)
Replaced "fixCompile" with direct instantiation of "CacheControlledSupportSQLiteStatement"
Updated static elements to be inner members of "CacheControlledSupportSQLiteDatabase" (and removed now unnecessary properties)
Changed computation logic of "sql" property in "CacheControlledSupportSQLiteQuery"

*This commit is related to issue #529 [1]*

[1] #529


          Narrowed visibility for members of "AOP_SQLiteDatabase" class

7d5de82

*This commit is related to issue #529 [1]*

[1] #529


          Renamed parts of cache-control

13261d6

Renamed package "org.cryptomator.data.db.cachecontrol" to "org.cryptomator.data.db.sqlmapping"
Renamed "CacheControlledSupportSQLiteDatabase.kt" to "MappingSupportSQLiteDatabase.kt"
Moved contents to new location

*This commit is related to issue #529 [1]*

[1] #529


          Renamed class "CacheControlledSupportSQLiteDatabase" and its members

42f572a

Renamed class "CacheControlledSupportSQLiteDatabase" to "MappingSupportSQLiteDatabase"
Renamed class "CacheControlledSupportSQLiteOpenHelper" to "MappingSupportSQLiteOpenHelper"
Renamed class "CacheControlledSupportSQLiteOpenHelperFactory" to "MappingSupportSQLiteOpenHelperFactory"
Renamed inner class "CacheControlledSupportSQLiteStatement" to "MappingSupportSQLiteStatement"
Renamed inner class "CacheControlledSupportSQLiteQuery" to "MappingSupportSQLiteQuery"
Renamed method "fix" to "map" in "MappingSupportSQLiteDatabase"
Renamed method "fixWhereClause" to "mapWhereClause" in "MappingSupportSQLiteDatabase"
Renamed property "identifiers" to "mappedQueries" in "MappingSupportSQLiteQuery"
Renamed extension method "SupportSQLiteOpenHelper.Factory.asCacheControlled" to "SupportSQLiteOpenHelper.Factory.asMapped" in "MappingSupportSQLiteDatabase.kt"

*This commit is related to issue #529 [1]*

[1] #529


          Reorganized cache-control to improve abstraction

db2edda

Moved "RandomUUIDSQLMappingFunction" from "MappingSupportSQLiteDatabase.kt" to new file "SQLiteCacheControl.kt"
Added extension function "SupportSQLiteOpenHelper.Factory.asCacheControlled" in "SQLiteCacheControl.kt" as wrapper for "asMapped" with "RandomUUIDSQLMappingFunction" as mapping function
Removed "RandomUUIDSQLMappingFunction" as default mapping function from extension function "SupportSQLiteOpenHelper.Factory.asMapped" in "MappingSupportSQLiteDatabase.kt"
Replaced call to "asMapped" with call to "asCacheControlled" in "DatabaseModule"

*This commit is related to issue #529 [1]*

[1] #529


          Renamed "RandomUUIDSQLMappingFunction" to "RandomUUIDMapping"

eae6c03

*This commit is related to issue #529 [1]*

[1] #529


          Refactored "SQLMappingFunction"

35b4e00

*This commit is related to issue #529 [1]*

[1] #529


          Redefined logic of "MappingSupportSQLiteQuery"

95eede5

*This commit is related to issue #529 [1]*

[1] #529


          Re-enabled tests

b3449f0

See: c13b12f

*This commit is related to issue #529 [1]*

[1] #529


          Added first tests for "MappingSupportSQLiteDatabase"

6b1a9b5

*This commit is related to issue #529 [1]*

[1] #529


          Added support for mapping cursors

af17db5

Calling "requery" on a cursor may cause the driver to re-use queries, which is unwanted behavior.

*This commit is related to issue #529 [1]*

[1] #529


          Renamed "DataForTestQueryCancelable"

34f75af

*This commit is related to issue #529 [1]*

[1] #529


          Extracted methods "cartesianProduct" and "toArgumentsStream"

ed0fe82

*This commit is related to issue #529 [1]*

[1] #529


          Added test for "update"

c89f4b1

*This commit is related to issue #529 [1]*

[1] #529


          Specified contract for "SupportSQLiteDatabase.insert"

d98ce8b

Also moved compat method for "ContentValues.isEmpty"

*This commit is related to issue #529 [1]*

[1] #529


          Added tests for "insert"

bfcca43

*This commit is related to issue #529 [1]*

[1] #529


          Refactored "Sql" to follow the API contract of "SupportSQLiteDatabase"

6af9811

This also makes the class compatible with "MappingSupportSQLiteDatabase"

*This commit is related to issue #529 [1]*

[1] #529


          Fixed "migrate12To14IndexSideEffects"

abf19e2

This also makes the test method compatible with "MappingSupportSQLiteDatabase"
Also added "assertIsUUID"

*This commit is related to issue #529 [1]*

[1] #529


          Applied fix for #529 [1] to re-enabled tests

0e63cad

See: b3449f0
Also See: c13b12f

*This commit is related to issue #529 [1]*

[1] #529


          Moved logic for handling extra calls to dedicated class "OneOffDelegate"

9f70454

*This commit is related to issue #529 [1]*

[1] #529


          Implemented "MappingSupportSQLiteQuery.bindTo" with "OneOffDelegate"

b691766

*This commit is related to issue #529 [1]*

[1] #529


          Added "ValueExtractor" as argument type of "pseudo equality" methods

77fa76f

Added "ValueExtractor<T>" as type alias for "(T) -> Any?"
Changed argument declarations of "pseudo equality" methods and underlying implementations
Added "ValueExtractor<T>" as type declaration for existing value extractor sets

*This commit is related to issue #529 [1]*

[1] #529


          Enforced single call convention for parts of "MappingSupportSQLiteQuery"

cfde324

Also added workaround for tests

*This commit is related to issue #529 [1]*

[1] #529


          Refactored "insert" and "compileStatement"

40a4ed5

Changed "insert" to directly compile the mapped sql instead of creating a "MappingSupportSQLiteStatement"
Added check if the database is open to "compileStatement"

*This commit is related to issue #529 [1]*

[1] #529


          Merge remote-tracking branch 'origin/develop' into feature/dao-migration

7eb386f


          Merge remote-tracking branch 'origin/develop' into feature/dao-migration

01d43ff

# Conflicts:
#	build.gradle

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment