Optimize fts-database

core/data/build.gradle.kts

@@ -17,11 +17,18 @@ plugins {
     alias(libs.plugins.nowinandroid.android.library)
     alias(libs.plugins.nowinandroid.android.library.jacoco)
     alias(libs.plugins.nowinandroid.android.hilt)
+    alias(libs.plugins.nowinandroid.android.room)
     id("kotlinx-serialization")
 }
 
 android {
     namespace = "com.google.samples.apps.nowinandroid.core.data"
+
+    defaultConfig {
+        testInstrumentationRunner =
+            "com.google.samples.apps.nowinandroid.core.testing.NiaTestRunner"
+    }
+
     testOptions {
         unitTests {
             isIncludeAndroidResources = true
@@ -43,4 +50,6 @@ dependencies {
     testImplementation(libs.kotlinx.serialization.json)
     testImplementation(projects.core.datastoreTest)
     testImplementation(projects.core.testing)
+
+    androidTestImplementation(projects.core.testing)
 }

core/data/src/androidTest/kotlin/com/google/samples/apps/nowinandroid/core/data/SearchContentsRepositoryTest.kt

@@ -0,0 +1,113 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.samples.apps.nowinandroid.core.data
+
+import android.content.Context
+import androidx.room.Room
+import androidx.test.core.app.ApplicationProvider
+import com.google.samples.apps.nowinandroid.core.data.repository.DefaultSearchContentsRepository
+import com.google.samples.apps.nowinandroid.core.data.repository.SearchContentsRepository
+import com.google.samples.apps.nowinandroid.core.database.NiaDatabase
+import com.google.samples.apps.nowinandroid.core.database.dao.NewsResourceDao
+import com.google.samples.apps.nowinandroid.core.database.dao.NewsResourceFtsDao
+import com.google.samples.apps.nowinandroid.core.database.dao.TopicDao
+import com.google.samples.apps.nowinandroid.core.database.dao.TopicFtsDao
+import com.google.samples.apps.nowinandroid.core.testing.database.newsResourceEntitiesTestData
+import com.google.samples.apps.nowinandroid.core.testing.database.topicEntitiesTestData
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.test.advanceUntilIdle
+import kotlinx.coroutines.test.runTest
+import org.junit.After
+import org.junit.Before
+import org.junit.Test
+import kotlin.test.assertEquals
+
+class SearchContentsRepositoryTest {
+
+    private lateinit var newsResourceDao: NewsResourceDao
+    private lateinit var topicDao: TopicDao
+    private lateinit var newsResourceFtsDao: NewsResourceFtsDao
+    private lateinit var topicFtsDao: TopicFtsDao
+    private lateinit var db: NiaDatabase
+    private lateinit var searchContentsRepository: SearchContentsRepository
+
+    @Before
+    fun setUp() {
+        val context = ApplicationProvider.getApplicationContext<Context>()
+        db = Room.inMemoryDatabaseBuilder(
+            context,
+            NiaDatabase::class.java,
+        ).build()
+        newsResourceDao = db.newsResourceDao()
+        topicDao = db.topicDao()
+        newsResourceFtsDao = db.newsResourceFtsDao()
+        topicFtsDao = db.topicFtsDao()
+
+        searchContentsRepository = DefaultSearchContentsRepository(
+            newsResourceDao = newsResourceDao,
+            newsResourceFtsDao = newsResourceFtsDao,
+            topicDao = topicDao,
+            topicFtsDao = topicFtsDao,
+            ioDispatcher = Dispatchers.IO,
+        )
+    }
+
+    @After
+    fun closeDb() = db.close()
+
+    @Test
+    fun whenPopulateFtsDataTwice_PopulateFtsOnce() = runTest {
+        allDataPreSetting()
+        repeat(2) {
+            searchContentsRepository.populateFtsData()
+        }
+        advanceUntilIdle()
+        assertEquals(7, searchContentsRepository.getSearchContentsCount().first())
+    }
+
+    @Test
+    fun whenSearchAndroid_ReturnResult() = runTest {
+        allDataPreSetting()
+        searchContentsRepository.populateFtsData()
+
+        val searchQuery = "Android"
+        val topicIds = listOf("2")
+        val newsResourceIds = listOf("1", "2")
+        assertEquals(
+            topicIds,
+            searchContentsRepository
+                .searchContents(searchQuery = searchQuery)
+                .first()
+                .topics
+                .map { it.id },
+        )
+        assertEquals(
+            newsResourceIds,
+            searchContentsRepository
+                .searchContents(searchQuery = searchQuery)
+                .first()
+                .newsResources
+                .map { it.id },
+        )
+    }
+
+    private suspend fun allDataPreSetting() {
+        newsResourceDao.upsertNewsResources(newsResourceEntities = newsResourceEntitiesTestData)
+        topicDao.upsertTopics(entities = topicEntitiesTestData)
+    }
+}

core/data/src/main/kotlin/com/google/samples/apps/nowinandroid/core/data/repository/DefaultSearchContentsRepository.kt

@@ -46,15 +46,15 @@ internal class DefaultSearchContentsRepository @Inject constructor(
 
     override suspend fun populateFtsData() {
         withContext(ioDispatcher) {
-            newsResourceFtsDao.insertAll(
+            newsResourceFtsDao.deleteAllAndInsertAll(
                 newsResourceDao.getNewsResources(
                     useFilterTopicIds = false,
                     useFilterNewsIds = false,
                 )
                     .first()
                     .map(PopulatedNewsResource::asFtsEntity),
             )
-            topicFtsDao.insertAll(topicDao.getOneOffTopicEntities().map { it.asFtsEntity() })
+            topicFtsDao.deleteAllAndInsertAll(topicDao.getOneOffTopicEntities().map { it.asFtsEntity() })
         }
     }
 

core/database/src/androidTest/kotlin/com/google/samples/apps/nowinandroid/core/database/dao/NewsResourceFtsDaoTest.kt

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.samples.apps.nowinandroid.core.database.dao
+
+import android.content.Context
+import androidx.room.Room
+import androidx.test.core.app.ApplicationProvider
+import com.google.samples.apps.nowinandroid.core.database.NiaDatabase
+import com.google.samples.apps.nowinandroid.core.database.model.NewsResourceFtsEntity
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.test.runTest
+import org.junit.After
+import org.junit.Before
+import org.junit.Test
+import kotlin.test.assertEquals
+
+class NewsResourceFtsDaoTest {
+
+    private lateinit var newsResourceFtsDao: NewsResourceFtsDao
+    private lateinit var db: NiaDatabase
+
+    private val newsResourceFtsEntities = listOf(
+        testNewsResourceFtsEntity(number = "0"),
+        testNewsResourceFtsEntity(number = "1"),
+        testNewsResourceFtsEntity(number = "2"),
+        testNewsResourceFtsEntity(number = "3"),
+    )
+
+    @Before
+    fun createDb() {
+        val context = ApplicationProvider.getApplicationContext<Context>()
+        db = Room.inMemoryDatabaseBuilder(
+            context,
+            NiaDatabase::class.java,
+        ).build()
+        newsResourceFtsDao = db.newsResourceFtsDao()
+    }
+
+    @After
+    fun closeDb() {
+        db.close()
+    }
+
+    @Test
+    fun whenInsertOnce_InsertedNewsResourceEntityOnce() = runTest {
+        insertAllNewsResourceFtsEntities()
+        assertEquals(newsResourceFtsEntities.size, newsResourceFtsDao.getCount().first())
+    }
+
+    @Test
+    fun whenInsertTwice_InsertedNewsResourceEntityTwice() = runTest {
+        repeat(2) {
+            newsResourceFtsDao.insertAll(newsResources = newsResourceFtsEntities)
+        }
+        assertEquals(newsResourceFtsEntities.size * 2, newsResourceFtsDao.getCount().first())
+    }
+
+    @Test
+    fun whenDeleteAndInsertAllThreeTimes_InsertedOnce() = runTest {
+        repeat(3) {
+            newsResourceFtsDao.deleteAllAndInsertAll(newsResources = newsResourceFtsEntities)
+        }
+        assertEquals(newsResourceFtsEntities.size, newsResourceFtsDao.getCount().first())
+    }
+
+    private suspend fun insertAllNewsResourceFtsEntities() =
+        newsResourceFtsDao.insertAll(newsResources = newsResourceFtsEntities)
+
+    private fun testNewsResourceFtsEntity(
+        number: String,
+    ) = NewsResourceFtsEntity(
+        newsResourceId = number,
+        title = "title$number",
+        content = "content$number",
+    )
+}

core/database/src/androidTest/kotlin/com/google/samples/apps/nowinandroid/core/database/dao/TopicFtsDaoTest.kt

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2024 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.samples.apps.nowinandroid.core.database.dao
+
+import android.content.Context
+import androidx.room.Room
+import androidx.test.core.app.ApplicationProvider
+import com.google.samples.apps.nowinandroid.core.database.NiaDatabase
+import com.google.samples.apps.nowinandroid.core.database.model.TopicFtsEntity
+import com.google.samples.apps.nowinandroid.core.database.model.asFtsEntity
+import com.google.samples.apps.nowinandroid.core.testing.database.topicEntitiesTestData
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.test.runTest
+import org.junit.After
+import org.junit.Before
+import org.junit.Test
+import kotlin.test.assertEquals
+
+class TopicFtsDaoTest {
+
+    private lateinit var topicFtsDao: TopicFtsDao
+    private lateinit var db: NiaDatabase
+
+    private lateinit var topicFtsEntities: List<TopicFtsEntity>
+
+    @Before
+    fun setUp() {
+        val context = ApplicationProvider.getApplicationContext<Context>()
+        db = Room.inMemoryDatabaseBuilder(
+            context,
+            NiaDatabase::class.java,
+        ).build()
+        topicFtsDao = db.topicFtsDao()
+
+        topicFtsEntities = topicEntitiesTestData.map {
+            it.asFtsEntity()
+        }
+    }
+
+    @After
+    fun closeDb() {
+        db.close()
+    }
+
+    @Test
+    fun whenInsertOnce_InsertedTopicsFtsEntityOnce() = runTest {
+        insertAllNewsResourceFtsEntities()
+        assertEquals(topicFtsEntities.size, topicFtsDao.getCount().first())
+    }
+
+    @Test
+    fun whenInsertTwice_InsertedNewsResourceEntityTwice() = runTest {
+        repeat(2) {
+            topicFtsDao.insertAll(topics = topicFtsEntities)
+        }
+        assertEquals(topicFtsEntities.size * 2, topicFtsDao.getCount().first())
+    }
+
+    @Test
+    fun whenDeleteAndInsertAllThreeTimes_InsertedOnce() = runTest {
+        repeat(3) {
+            topicFtsDao.deleteAllAndInsertAll(topics = topicFtsEntities)
+        }
+        assertEquals(topicFtsEntities.size, topicFtsDao.getCount().first())
+    }
+
+    private suspend fun insertAllNewsResourceFtsEntities() =
+        topicFtsDao.insertAll(topics = topicFtsEntities)
+}

core/database/src/main/kotlin/com/google/samples/apps/nowinandroid/core/database/NiaDatabase.kt

@@ -63,7 +63,7 @@ import com.google.samples.apps.nowinandroid.core.database.util.InstantConverter
 @TypeConverters(
     InstantConverter::class,
 )
-internal abstract class NiaDatabase : RoomDatabase() {
+abstract class NiaDatabase : RoomDatabase() {
     abstract fun topicDao(): TopicDao
     abstract fun newsResourceDao(): NewsResourceDao
     abstract fun topicFtsDao(): TopicFtsDao

core/database/src/main/kotlin/com/google/samples/apps/nowinandroid/core/database/dao/NewsResourceFtsDao.kt

@@ -20,6 +20,7 @@ import androidx.room.Dao
 import androidx.room.Insert
 import androidx.room.OnConflictStrategy
 import androidx.room.Query
+import androidx.room.Transaction
 import com.google.samples.apps.nowinandroid.core.database.model.NewsResourceFtsEntity
 import kotlinx.coroutines.flow.Flow
 
@@ -36,4 +37,17 @@ interface NewsResourceFtsDao {
 
     @Query("SELECT count(*) FROM newsResourcesFts")
     fun getCount(): Flow<Int>
+
+    @Query(
+        """
+            DELETE FROM newsResourcesFts
+        """,
+    )
+    suspend fun deleteAll()
+
+    @Transaction
+    suspend fun deleteAllAndInsertAll(newsResources: List<NewsResourceFtsEntity>) {
+        deleteAll()
+        insertAll(newsResources = newsResources)
+    }
 }

core/database/src/main/kotlin/com/google/samples/apps/nowinandroid/core/database/dao/TopicFtsDao.kt

@@ -20,6 +20,7 @@ import androidx.room.Dao
 import androidx.room.Insert
 import androidx.room.OnConflictStrategy
 import androidx.room.Query
+import androidx.room.Transaction
 import com.google.samples.apps.nowinandroid.core.database.model.TopicFtsEntity
 import kotlinx.coroutines.flow.Flow
 
@@ -36,4 +37,17 @@ interface TopicFtsDao {
 
     @Query("SELECT count(*) FROM topicsFts")
     fun getCount(): Flow<Int>
+
+    @Query(
+        """
+            DELETE FROM topicsFts
+        """,
+    )
+    suspend fun deleteAll()
+
+    @Transaction
+    suspend fun deleteAllAndInsertAll(topics: List<TopicFtsEntity>) {
+        deleteAll()
+        insertAll(topics = topics)
+    }
 }