Migrate DailyGameHistory to use LocalDate

Author: Isira-Seneviratne

app/schemas/org.wikipedia.database.AppDatabase/31.json

@@ -2,7 +2,7 @@
   "formatVersion": 1,
   "database": {
     "version": 31,
-    "identityHash": "d99be9ecca43c23bc048ef363e1a06c1",
+    "identityHash": "aa09f2aa65c69b2e843a5c9d15d51895",
     "entities": [
       {
         "tableName": "HistoryEntry",
@@ -598,7 +598,7 @@
       },
       {
         "tableName": "DailyGameHistory",
-        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `gameName` INTEGER NOT NULL, `language` TEXT NOT NULL, `year` INTEGER NOT NULL, `month` INTEGER NOT NULL, `day` INTEGER NOT NULL, `score` INTEGER NOT NULL, `playType` INTEGER NOT NULL, `gameData` TEXT)",
+        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `gameName` INTEGER NOT NULL, `language` TEXT NOT NULL, `date` TEXT NOT NULL, `score` INTEGER NOT NULL, `playType` INTEGER NOT NULL, `gameData` TEXT)",
         "fields": [
           {
             "fieldPath": "id",
@@ -619,21 +619,9 @@
             "notNull": true
           },
           {
-            "fieldPath": "year",
-            "columnName": "year",
-            "affinity": "INTEGER",
-            "notNull": true
-          },
-          {
-            "fieldPath": "month",
-            "columnName": "month",
-            "affinity": "INTEGER",
-            "notNull": true
-          },
-          {
-            "fieldPath": "day",
-            "columnName": "day",
-            "affinity": "INTEGER",
+            "fieldPath": "date",
+            "columnName": "date",
+            "affinity": "TEXT",
             "notNull": true
           },
           {
@@ -734,7 +722,7 @@
     ],
     "setupQueries": [
       "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
-      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'd99be9ecca43c23bc048ef363e1a06c1')"
+      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'aa09f2aa65c69b2e843a5c9d15d51895')"
     ]
   }
 }

app/src/main/java/org/wikipedia/database/AppDatabase.kt

@@ -62,7 +62,8 @@ const val DATABASE_VERSION = 31
     DateTypeConverter::class,
     WikiSiteTypeConverter::class,
     NamespaceTypeConverter::class,
-    NotificationTypeConverters::class
+    NotificationTypeConverters::class,
+    LocalDateTypeConverter::class
 )
 abstract class AppDatabase : RoomDatabase() {
 
@@ -347,13 +348,45 @@ abstract class AppDatabase : RoomDatabase() {
                 db.execSQL("ALTER TABLE Category_temp RENAME TO Category")
             }
         }
+        val MIGRATION_31_32 = object : Migration(31, 32) {
+            override fun migrate(db: SupportSQLiteDatabase) {
+                // Step 1: Create a temporary table
+                db.execSQL("""
+                    CREATE TABLE DailyGameHistory_temp (
+                        id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+                        gameName INTEGER NOT NULL,
+                        language TEXT NOT NULL,
+                        date STRING NOT NULL,
+                        score INTEGER NOT NULL,
+                        playType INTEGER NOT NULL,
+                        gameData TEXT
+                    )
+                """.trimIndent())
+
+                // Step 2: Populate the new table with the transformed data from the old table
+                db.execSQL("""
+                    INSERT INTO DailyGameHistory_temp (
+                        id, gameName, language, 
+                        year || '-' || printf('%02d', month) || '-' || printf('%02d', day), 
+                        score, playType, gameData
+                    )
+                    FROM DailyGameHistory
+                """.trimIndent())
+
+                // Step 3: Drop the old table
+                db.execSQL("DROP TABLE DailyGameHistory")
+
+                // Step 4: Rename the temporary table to the original table name
+                db.execSQL("ALTER TABLE DailyGameHistory_temp RENAME TO DailyGameHistory")
+            }
+        }
 
         val instance: AppDatabase by lazy(LazyThreadSafetyMode.SYNCHRONIZED) {
             Room.databaseBuilder(WikipediaApp.instance, AppDatabase::class.java, DATABASE_NAME)
                 .addMigrations(MIGRATION_19_20, MIGRATION_20_21, MIGRATION_21_22, MIGRATION_22_23,
                     MIGRATION_23_24, MIGRATION_24_25, MIGRATION_25_26, MIGRATION_26_27,
                     MIGRATION_26_28, MIGRATION_27_28, MIGRATION_28_29, MIGRATION_29_30,
-                    MIGRATION_30_31)
+                    MIGRATION_30_31, MIGRATION_31_32)
                 .fallbackToDestructiveMigration(false)
                 .build()
         }

app/src/main/java/org/wikipedia/database/LocalDateTimeTypeConverter.kt

@@ -0,0 +1,12 @@
+package org.wikipedia.database
+
+import androidx.room.TypeConverter
+import java.time.LocalDate
+
+object LocalDateTypeConverter {
+    @TypeConverter
+    fun dateToString(date: LocalDate) = date.toString()
+
+    @TypeConverter
+    fun stringToDate(dateString: String): LocalDate = LocalDate.parse(dateString)
+}

app/src/main/java/org/wikipedia/database/LocalDateTypeConverter.kt

@@ -1,7 +1,6 @@
 package org.wikipedia.games.db
 
 import androidx.room.Entity
-import androidx.room.Ignore
 import androidx.room.PrimaryKey
 import java.time.LocalDate
 
@@ -10,13 +9,8 @@ data class DailyGameHistory(
     @PrimaryKey(autoGenerate = true) val id: Int = 0,
     val gameName: Int,
     val language: String,
-    val year: Int,
-    var month: Int,
-    var day: Int,
+    val date: LocalDate,
     var score: Int,
     var playType: Int,
     var gameData: String?
-) {
-    @Ignore
-    val date: LocalDate = LocalDate.of(year, month, day)
-}
+)

app/src/main/java/org/wikipedia/games/db/DailyGameHistory.kt

@@ -8,7 +8,6 @@ import androidx.room.Query
 import androidx.room.Update
 import org.wikipedia.games.PlayTypes
 import java.time.LocalDate
-import java.time.Month
 
 @Dao
 interface DailyGameHistoryDao {
@@ -18,20 +17,19 @@ interface DailyGameHistoryDao {
     @Insert(onConflict = OnConflictStrategy.REPLACE)
     suspend fun insertAll(dailyGameHistories: List<DailyGameHistory>)
 
-    @Query("SELECT * FROM DailyGameHistory ORDER BY year DESC, month DESC, day DESC, id DESC LIMIT 1")
+    @Query("SELECT * FROM DailyGameHistory ORDER BY date DESC, id DESC LIMIT 1")
     suspend fun findLastGameHistory(): DailyGameHistory?
 
-    @Query("SELECT * FROM DailyGameHistory WHERE gameName = :gameName AND language = :language " +
-            "AND year = :year AND month = :month AND day = :day")
-    suspend fun findGameHistoryByDate(gameName: Int, language: String, year: Int, month: Int, day: Int): DailyGameHistory?
+    @Query("SELECT * FROM DailyGameHistory WHERE gameName = :gameName AND language = :language AND date = :date")
+    suspend fun findGameHistoryByDate(gameName: Int, language: String, date: LocalDate): DailyGameHistory?
 
     @Query("SELECT COUNT(*) FROM DailyGameHistory WHERE gameName = :gameName AND language = :language")
     suspend fun getTotalGamesPlayed(gameName: Int, language: String): Int
 
     @Query("SELECT AVG(score) FROM DailyGameHistory WHERE gameName = :gameName AND language = :language")
     suspend fun getAverageScore(gameName: Int, language: String): Double?
 
-    @Query("SELECT * FROM DailyGameHistory WHERE gameName = :gameName AND language = :language ORDER BY year DESC, month DESC, day DESC")
+    @Query("SELECT * FROM DailyGameHistory WHERE gameName = :gameName AND language = :language ORDER BY date DESC")
     suspend fun getGameHistory(gameName: Int, language: String): List<DailyGameHistory>
 
     @Update
@@ -50,12 +48,10 @@ interface DailyGameHistoryDao {
         var expectedDate = LocalDate.now() // Start with today's date
 
         for (record in history) {
-            val recordDate = LocalDate.of(record.year, Month.of(record.month), record.day)
-
-            if (recordDate == expectedDate) {
+            if (record.date == expectedDate) {
                 currentStreak++
                 expectedDate = expectedDate.minusDays(1) // Move to the previous day
-            } else if (recordDate.isBefore(expectedDate)) {
+            } else if (record.date < expectedDate) {
                 break
             }
         }
@@ -74,15 +70,13 @@ interface DailyGameHistoryDao {
         var expectedDate = LocalDate.now() // Start with today's date
 
         for (record in history) {
-            val recordDate = LocalDate.of(record.year, Month.of(record.month), record.day)
-
-            if (recordDate == expectedDate) {
+            if (record.date == expectedDate) {
                 currentStreak++
                 expectedDate = expectedDate.minusDays(1) // Move to the previous day
-            } else if (recordDate.isBefore(expectedDate)) {
+            } else if (record.date < expectedDate) {
                 bestStreak = maxOf(bestStreak, currentStreak)
                 currentStreak = 0
-                expectedDate = recordDate.minusDays(1) // Reset to the day before the record date
+                expectedDate = record.date.minusDays(1) // Reset to the day before the record date
             }
         }
 

app/src/main/java/org/wikipedia/games/db/DailyGameHistoryDao.kt

@@ -25,7 +25,7 @@ import java.time.ZoneId
 import java.time.temporal.ChronoUnit
 
 abstract class OnThisDayGameBaseFragment : Fragment() {
-    private var scoreData = emptyMap<LocalDate, Int>()
+    private var scoreData: Map<LocalDate, Int> = emptyMap()
 
     private val fragmentLifecycleCallbacks = object : FragmentManager.FragmentLifecycleCallbacks() {
         @SuppressLint("RestrictedApi")

app/src/main/java/org/wikipedia/games/onthisday/OnThisDayGameBaseFragment.kt

@@ -102,9 +102,7 @@ class OnThisDayGameViewModel(savedStateHandle: SavedStateHandle) : ViewModel() {
             val dbGameResults = AppDatabase.instance.dailyGameHistoryDao().findGameHistoryByDate(
                 gameName = WikiGames.WHICH_CAME_FIRST.ordinal,
                 language = wikiSite.languageCode,
-                year = currentDate.year,
-                month = currentMonth,
-                day = currentDay
+                date = currentDate
             )
 
             val eventsFromApi = ServiceFactory.getRest(wikiSite).getOnThisDay(currentMonth, currentDay).events
@@ -212,17 +210,13 @@ class OnThisDayGameViewModel(savedStateHandle: SavedStateHandle) : ViewModel() {
                         AppDatabase.instance.dailyGameHistoryDao().findGameHistoryByDate(
                             gameName = WikiGames.WHICH_CAME_FIRST.ordinal,
                             language = wikiSite.languageCode,
-                            year = currentDate.year,
-                            month = currentDate.monthValue,
-                            day = currentDate.dayOfMonth
+                            date = currentDate
                         ) ?: run {
                             shouldInsert = true
                             DailyGameHistory(
                                 gameName = WikiGames.WHICH_CAME_FIRST.ordinal,
                                 language = wikiSite.languageCode,
-                                year = currentDate.year,
-                                month = currentDate.monthValue,
-                                day = currentDate.dayOfMonth,
+                                date = currentDate,
                                 score = 0,
                                 playType = if (isArchiveGame) PlayTypes.PLAYED_ON_ARCHIVE.ordinal else PlayTypes.PLAYED_ON_SAME_DAY.ordinal,
                                 gameData = null
@@ -360,10 +354,8 @@ class OnThisDayGameViewModel(savedStateHandle: SavedStateHandle) : ViewModel() {
                         val gameHistory = DailyGameHistory(
                             gameName = WikiGames.WHICH_CAME_FIRST.ordinal,
                             language = lang,
-                            year = year,
-                            month = month,
-                            day = day,
-                            score = answers.count { it }.toInt(),
+                            date = LocalDate.of(year, month, day),
+                            score = answers.count { it },
                             playType = PlayTypes.PLAYED_ON_SAME_DAY.ordinal,
                             gameData = JsonUtil.encodeToString(answers)
                         )