Migrated bookmarks locations to Kotlin and adapt room database #6148

Saifuddin53 · 2025-01-20T12:31:16Z

Part of: #6017
Part of: #5928

This commit migrates the bookmark location logic to Kotlin, enhancing code maintainability and readability. - Removes the `BookmarkLocationsContentProvider`, `BookmarkLocationsController`, and `BookmarkLocationsDao` Java classes. - Creates `BookmarkLocationsDao.kt` and `BookmarkLocationsContentProvider.kt` in Kotlin. - Migrates the logic from `BookmarkLocationsFragment.java` to `BookmarkLocationsFragment.kt`. - Updates test files to reflect these changes. - Addresses associated code review comments.

This commit migrates the bookmark locations functionality from a custom content provider to Room database. Key changes: * **Removal of `BookmarkLocationsContentProvider`:** This class, which previously handled data storage, has been removed. * **Introduction of `BookmarksLocations`:** This data class now represents a bookmarked location, serving as the Room entity. * **Creation of `BookmarkLocationsDao`:** This Room DAO handles database interactions for bookmark locations, including: * Adding, deleting, and querying bookmarked locations. * Checking if a location is already bookmarked. * Updating the bookmark status of a location. * Retrieving all bookmarked locations as `Place` objects. * **`BookmarkLocationsViewModel`:** Added to manage the data layer for bookmark locations * **`NearbyUtil`:** Created a Util class for Nearby to manage the bookmark locations. * **Updates in `PlaceAdapter` and `PlaceAdapterDelegate`:** These classes have been modified to work with the new Room-based data layer. * **Updates in `AppDatabase`:** The database now includes `BookmarksLocations` as an entity and exposes the `bookmarkLocationsDao`. * **Updates in `FragmentBuilderModule` and `CommonsApplicationModule`**: for DI * **Removal of `DBOpenHelper` upgrade for locations**: as it is no longer needed * **Updates in `NearbyParentFragmentPresenter`**: refactored the logic to use the dao functions * **Updates in `NearbyParentFragment`**: refactored the logic to use the util and dao functions * **Update in `BookmarkLocationsController`**: removed as its no longer needed * **Add `toPlace` and `toBookmarksLocations`**: extension functions to map between data class and entities * **Update in `CommonsApplication`**: to remove old db table.

This commit includes the following changes: - Updates the database version to 20. - Refactors bookmark location handling within `NearbyParentFragment` to improve logic and efficiency. - Introduces `getBookmarkLocationExists` in `NearbyUtil` to directly update bookmark icons in the bottom sheet adapter. - Removes unused provider. - Adjusts `BookmarkLocationsFragment`'s `PlaceAdapter` to use `lifecycleScope` for better coroutine management. - Refactors `updateBookmarkLocation` in `NearbyParentFragmentPresenter`.

…ation each time in the bookmark * Update bookmark button image in `BottomSheetAdapter` * Add new toggle function to `BottomSheetAdapter` * Call the toggle function in `NearbyParentFragment`

* `BookmarkLocationsController`: Changed to use `Flow` to load bookmarked locations. * `BookmarkLocationsDao`: Changed to return `Flow` of bookmark location instead of a list. * `BookmarkLocationsFragment`: Used `LifecycleScope` to collect data from flow and display it. * Removed unused `getAllBookmarkLocations()` from `BookmarkLocationsViewModel`. * Used `map` in `BookmarkLocationsDao` to convert from `BookmarksLocations` to `Place` list.

* BookmarkLocationsController: Changed `loadFavoritesLocations` to be a suspend function. * BookmarkLocationsFragment: Updated the `initList` function to call the controller's suspend function. * BookmarkLocationsDao: Changed `getAllBookmarksLocations` and `getAllBookmarksLocationsPlace` to be suspend functions.

…utines * Migrated `bookmarkDao!!.getAllBookmarksLocations()` to `bookmarkDao!!.getAllBookmarksLocationsPlace()` and added `runBlocking` * Added `runBlocking` for `loadBookmarkedLocations()` and `testInitNonEmpty()` * Added `runBlocking` for `getAllBookmarksLocations()` and update `updateMapMarkers` These changes improve the test structure by ensuring the database functions are executed within a coroutine context.

…sDao * Moved `initList` to `BookmarkLocationsFragment` for better lifecycle handling. * Added test case for `BookmarkLocationsFragment`'s onResume. * Added test cases for `BookmarkLocationsDao` operations like adding, retrieving, finding, deleting and updating bookmarks.

…s not null * BookmarkLocationsFragment: load favorites locations only when view is not null. * BookmarkLocationsFragmentTest: added spy and verify to test onResume() call initList() method.

* `AppDatabase`: Updated to use room migration. * `CommonsApplicationModule`: added migration from version 19 to 20 to `appDatabase`

nicolas-raoul · 2025-01-30T07:21:51Z

Is this still a draft? :-)

Saifuddin53 · 2025-01-30T16:30:18Z

Hii @nicolas-raoul, the migration for both Kotlin and Room is complete, but I’m encountering an issue: during the migration to Room, the existing data in the SQL database is being deleted. Is it necessary to preserve that data as well? :-)

nicolas-raoul · 2025-01-31T02:46:24Z

Data migration would be ideal. Is it difficult?

Saifuddin53 · 2025-02-04T04:46:46Z

Not too difficult @nicolas-raoul , just have to insert entries of SQL based table to room based table, but when we do so both the databases should be initialized but the migration logic of our room database runs before the SQL database is initialized so it gives a runtime error.

Saifuddin53 · 2025-02-04T04:49:23Z

@psh can you please help me here ? context: I have successfully migrated to room database for bookmark locations but am not able to find a way to insert all the entries of SQL based bookmark locations table to our new room table

psh · 2025-02-04T15:23:53Z

The old content provider stored data in a table called bookmarksLocations but your new Room entity is declared with a different name -

@Entity(tableName = "bookmarks_locations")

Try using the old name, and lining up the correct data types from the old DAO and Room should just read the existing data as-is without needing a migration (assuming that Room and the content provider are talking to the same DB file).

You can actually unit-test this to ensure the migration goes well - in the test create and populate a database using test code that looks like the old Java DAO. Then, point your new Room entity at that database and verify with assertions that the data is read correctly.

Saifuddin53 · 2025-02-21T12:21:41Z

But @psh we do not have the same DB file for our room and sqlite based database