Implement search feature (#685)
Implement search feature - Add a feature module named "search" - Add a SearchScreen that is navigated by tapping the search icon at the top left corner - Add a data layer that takes care of populating the *Fts tables and querying them by a search query - Add a SearchViewModel that wires up the data layer of the Fts tables with the SearchScreen The SearchScreen has following features: - The user is able to type the search query in the TextField - The search result is displayed as the user types - When the search result is clicked, it navigates to: - The InterestsScreen when a topic is clicked - Chrome custom tab with the URL of the clicked news resource - When the search result is clicked or the IME is explicitly closed by the user, the current search query in the TextField is saved as recent searches - Latest recent searches are displayed in the SearchScreenpull/689/head
Takeshi Hagikura
2 years ago
committed by
GitHub
parent
73a38720d8
commit
b3cdc172cd
@ -0,0 +1,31 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.model
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.database.model.RecentSearchQueryEntity
|
||||||
|
import kotlinx.datetime.Clock
|
||||||
|
import kotlinx.datetime.Instant
|
||||||
|
|
||||||
|
data class RecentSearchQuery(
|
||||||
|
val query: String,
|
||||||
|
val queriedDate: Instant = Clock.System.now(),
|
||||||
|
)
|
||||||
|
|
||||||
|
fun RecentSearchQueryEntity.asExternalModel() = RecentSearchQuery(
|
||||||
|
query = query,
|
||||||
|
queriedDate = queriedDate,
|
||||||
|
)
|
||||||
@ -0,0 +1,55 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.repository
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.model.RecentSearchQuery
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.model.asExternalModel
|
||||||
|
import com.google.samples.apps.nowinandroid.core.database.dao.RecentSearchQueryDao
|
||||||
|
import com.google.samples.apps.nowinandroid.core.database.model.RecentSearchQueryEntity
|
||||||
|
import com.google.samples.apps.nowinandroid.core.network.Dispatcher
|
||||||
|
import com.google.samples.apps.nowinandroid.core.network.NiaDispatchers.IO
|
||||||
|
import kotlinx.coroutines.CoroutineDispatcher
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import kotlinx.coroutines.flow.map
|
||||||
|
import kotlinx.coroutines.withContext
|
||||||
|
import kotlinx.datetime.Clock
|
||||||
|
import javax.inject.Inject
|
||||||
|
|
||||||
|
class DefaultRecentSearchRepository @Inject constructor(
|
||||||
|
private val recentSearchQueryDao: RecentSearchQueryDao,
|
||||||
|
@Dispatcher(IO) private val ioDispatcher: CoroutineDispatcher,
|
||||||
|
) : RecentSearchRepository {
|
||||||
|
override suspend fun insertOrReplaceRecentSearch(searchQuery: String) {
|
||||||
|
withContext(ioDispatcher) {
|
||||||
|
recentSearchQueryDao.insertOrReplaceRecentSearchQuery(
|
||||||
|
RecentSearchQueryEntity(
|
||||||
|
query = searchQuery,
|
||||||
|
queriedDate = Clock.System.now(),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getRecentSearchQueries(limit: Int): Flow<List<RecentSearchQuery>> =
|
||||||
|
recentSearchQueryDao.getRecentSearchQueryEntities(limit).map { searchQueries ->
|
||||||
|
searchQueries.map {
|
||||||
|
it.asExternalModel()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override suspend fun clearRecentSearches() = recentSearchQueryDao.clearRecentSearchQueries()
|
||||||
|
}
|
||||||
@ -0,0 +1,85 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.repository
|
||||||
|
|
||||||
|
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.database.model.asExternalModel
|
||||||
|
import com.google.samples.apps.nowinandroid.core.database.model.asFtsEntity
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.SearchResult
|
||||||
|
import com.google.samples.apps.nowinandroid.core.network.Dispatcher
|
||||||
|
import com.google.samples.apps.nowinandroid.core.network.NiaDispatchers.IO
|
||||||
|
import kotlinx.coroutines.CoroutineDispatcher
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import kotlinx.coroutines.flow.combine
|
||||||
|
import kotlinx.coroutines.flow.distinctUntilChanged
|
||||||
|
import kotlinx.coroutines.flow.flatMapLatest
|
||||||
|
import kotlinx.coroutines.flow.mapLatest
|
||||||
|
import kotlinx.coroutines.withContext
|
||||||
|
import javax.inject.Inject
|
||||||
|
|
||||||
|
class DefaultSearchContentsRepository @Inject constructor(
|
||||||
|
private val newsResourceDao: NewsResourceDao,
|
||||||
|
private val newsResourceFtsDao: NewsResourceFtsDao,
|
||||||
|
private val topicDao: TopicDao,
|
||||||
|
private val topicFtsDao: TopicFtsDao,
|
||||||
|
@Dispatcher(IO) private val ioDispatcher: CoroutineDispatcher,
|
||||||
|
) : SearchContentsRepository {
|
||||||
|
|
||||||
|
override suspend fun populateFtsData() {
|
||||||
|
withContext(ioDispatcher) {
|
||||||
|
newsResourceFtsDao.insertAll(
|
||||||
|
newsResourceDao.getOneOffNewsResources().map { it.asFtsEntity() },
|
||||||
|
)
|
||||||
|
topicFtsDao.insertAll(topicDao.getOneOffTopicEntities().map { it.asFtsEntity() })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun searchContents(searchQuery: String): Flow<SearchResult> {
|
||||||
|
// Surround the query by asterisks to match the query when it's in the middle of
|
||||||
|
// a word
|
||||||
|
val newsResourceIds = newsResourceFtsDao.searchAllNewsResources("*$searchQuery*")
|
||||||
|
val topicIds = topicFtsDao.searchAllTopics("*$searchQuery*")
|
||||||
|
|
||||||
|
val newsResourcesFlow = newsResourceIds
|
||||||
|
.mapLatest { it.toSet() }
|
||||||
|
.distinctUntilChanged()
|
||||||
|
.flatMapLatest {
|
||||||
|
newsResourceDao.getNewsResources(useFilterNewsIds = true, filterNewsIds = it)
|
||||||
|
}
|
||||||
|
val topicsFlow = topicIds
|
||||||
|
.mapLatest { it.toSet() }
|
||||||
|
.distinctUntilChanged()
|
||||||
|
.flatMapLatest(topicDao::getTopicEntities)
|
||||||
|
return combine(newsResourcesFlow, topicsFlow) { newsResources, topics ->
|
||||||
|
SearchResult(
|
||||||
|
topics = topics.map { it.asExternalModel() },
|
||||||
|
newsResources = newsResources.map { it.asExternalModel() },
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun getSearchContentsCount(): Flow<Int> =
|
||||||
|
combine(
|
||||||
|
newsResourceFtsDao.getCount(),
|
||||||
|
topicFtsDao.getCount(),
|
||||||
|
) { newsResourceCount, topicsCount ->
|
||||||
|
newsResourceCount + topicsCount
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,41 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.repository
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.model.RecentSearchQuery
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data layer interface for the recent searches.
|
||||||
|
*/
|
||||||
|
interface RecentSearchRepository {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the recent search queries up to the number of queries specified as [limit].
|
||||||
|
*/
|
||||||
|
fun getRecentSearchQueries(limit: Int): Flow<List<RecentSearchQuery>>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Insert or replace the [searchQuery] as part of the recent searches.
|
||||||
|
*/
|
||||||
|
suspend fun insertOrReplaceRecentSearch(searchQuery: String)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clear the recent searches.
|
||||||
|
*/
|
||||||
|
suspend fun clearRecentSearches()
|
||||||
|
}
|
||||||
@ -0,0 +1,38 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.repository
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.SearchResult
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data layer interface for the search feature.
|
||||||
|
*/
|
||||||
|
interface SearchContentsRepository {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Populate the fts tables for the search contents.
|
||||||
|
*/
|
||||||
|
suspend fun populateFtsData()
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Query the contents matched with the [searchQuery] and returns it as a [Flow] of [SearchResult]
|
||||||
|
*/
|
||||||
|
fun searchContents(searchQuery: String): Flow<SearchResult>
|
||||||
|
|
||||||
|
fun getSearchContentsCount(): Flow<Int>
|
||||||
|
}
|
||||||
@ -0,0 +1,35 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.repository.fake
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.model.RecentSearchQuery
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.repository.RecentSearchRepository
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import kotlinx.coroutines.flow.flowOf
|
||||||
|
import javax.inject.Inject
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fake implementation of the [RecentSearchRepository]
|
||||||
|
*/
|
||||||
|
class FakeRecentSearchRepository @Inject constructor() : RecentSearchRepository {
|
||||||
|
override suspend fun insertOrReplaceRecentSearch(searchQuery: String) { /* no-op */ }
|
||||||
|
|
||||||
|
override fun getRecentSearchQueries(limit: Int): Flow<List<RecentSearchQuery>> =
|
||||||
|
flowOf(emptyList())
|
||||||
|
|
||||||
|
override suspend fun clearRecentSearches() { /* no-op */ }
|
||||||
|
}
|
||||||
@ -0,0 +1,33 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.repository.fake
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.repository.SearchContentsRepository
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.SearchResult
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import kotlinx.coroutines.flow.flowOf
|
||||||
|
import javax.inject.Inject
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fake implementation of the [SearchContentsRepository]
|
||||||
|
*/
|
||||||
|
class FakeSearchContentsRepository @Inject constructor() : SearchContentsRepository {
|
||||||
|
|
||||||
|
override suspend fun populateFtsData() { /* no-op */ }
|
||||||
|
override fun searchContents(searchQuery: String): Flow<SearchResult> = flowOf()
|
||||||
|
override fun getSearchContentsCount(): Flow<Int> = flowOf(1)
|
||||||
|
}
|
||||||
@ -0,0 +1,282 @@
|
|||||||
|
{
|
||||||
|
"formatVersion": 1,
|
||||||
|
"database": {
|
||||||
|
"version": 13,
|
||||||
|
"identityHash": "b6b299e53da623b16360975581ebfcfe",
|
||||||
|
"entities": [
|
||||||
|
{
|
||||||
|
"tableName": "news_resources",
|
||||||
|
"createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` TEXT NOT NULL, `title` TEXT NOT NULL, `content` TEXT NOT NULL, `url` TEXT NOT NULL, `header_image_url` TEXT, `publish_date` INTEGER NOT NULL, `type` TEXT NOT NULL, PRIMARY KEY(`id`))",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "id",
|
||||||
|
"columnName": "id",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "title",
|
||||||
|
"columnName": "title",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "content",
|
||||||
|
"columnName": "content",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "url",
|
||||||
|
"columnName": "url",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "headerImageUrl",
|
||||||
|
"columnName": "header_image_url",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "publishDate",
|
||||||
|
"columnName": "publish_date",
|
||||||
|
"affinity": "INTEGER",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "type",
|
||||||
|
"columnName": "type",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": [
|
||||||
|
"id"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"indices": [],
|
||||||
|
"foreignKeys": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tableName": "news_resources_topics",
|
||||||
|
"createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`news_resource_id` TEXT NOT NULL, `topic_id` TEXT NOT NULL, PRIMARY KEY(`news_resource_id`, `topic_id`), FOREIGN KEY(`news_resource_id`) REFERENCES `news_resources`(`id`) ON UPDATE NO ACTION ON DELETE CASCADE , FOREIGN KEY(`topic_id`) REFERENCES `topics`(`id`) ON UPDATE NO ACTION ON DELETE CASCADE )",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "newsResourceId",
|
||||||
|
"columnName": "news_resource_id",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "topicId",
|
||||||
|
"columnName": "topic_id",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": [
|
||||||
|
"news_resource_id",
|
||||||
|
"topic_id"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"indices": [
|
||||||
|
{
|
||||||
|
"name": "index_news_resources_topics_news_resource_id",
|
||||||
|
"unique": false,
|
||||||
|
"columnNames": [
|
||||||
|
"news_resource_id"
|
||||||
|
],
|
||||||
|
"orders": [],
|
||||||
|
"createSql": "CREATE INDEX IF NOT EXISTS `index_news_resources_topics_news_resource_id` ON `${TABLE_NAME}` (`news_resource_id`)"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "index_news_resources_topics_topic_id",
|
||||||
|
"unique": false,
|
||||||
|
"columnNames": [
|
||||||
|
"topic_id"
|
||||||
|
],
|
||||||
|
"orders": [],
|
||||||
|
"createSql": "CREATE INDEX IF NOT EXISTS `index_news_resources_topics_topic_id` ON `${TABLE_NAME}` (`topic_id`)"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"foreignKeys": [
|
||||||
|
{
|
||||||
|
"table": "news_resources",
|
||||||
|
"onDelete": "CASCADE",
|
||||||
|
"onUpdate": "NO ACTION",
|
||||||
|
"columns": [
|
||||||
|
"news_resource_id"
|
||||||
|
],
|
||||||
|
"referencedColumns": [
|
||||||
|
"id"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"table": "topics",
|
||||||
|
"onDelete": "CASCADE",
|
||||||
|
"onUpdate": "NO ACTION",
|
||||||
|
"columns": [
|
||||||
|
"topic_id"
|
||||||
|
],
|
||||||
|
"referencedColumns": [
|
||||||
|
"id"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"ftsVersion": "FTS4",
|
||||||
|
"ftsOptions": {
|
||||||
|
"tokenizer": "simple",
|
||||||
|
"tokenizerArgs": [],
|
||||||
|
"contentTable": "",
|
||||||
|
"languageIdColumnName": "",
|
||||||
|
"matchInfo": "FTS4",
|
||||||
|
"notIndexedColumns": [],
|
||||||
|
"prefixSizes": [],
|
||||||
|
"preferredOrder": "ASC"
|
||||||
|
},
|
||||||
|
"contentSyncTriggers": [],
|
||||||
|
"tableName": "newsResourcesFts",
|
||||||
|
"createSql": "CREATE VIRTUAL TABLE IF NOT EXISTS `${TABLE_NAME}` USING FTS4(`newsResourceId` TEXT NOT NULL, `title` TEXT NOT NULL, `content` TEXT NOT NULL)",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "newsResourceId",
|
||||||
|
"columnName": "newsResourceId",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "title",
|
||||||
|
"columnName": "title",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "content",
|
||||||
|
"columnName": "content",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": []
|
||||||
|
},
|
||||||
|
"indices": [],
|
||||||
|
"foreignKeys": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tableName": "topics",
|
||||||
|
"createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` TEXT NOT NULL, `name` TEXT NOT NULL, `shortDescription` TEXT NOT NULL, `longDescription` TEXT NOT NULL DEFAULT '', `url` TEXT NOT NULL DEFAULT '', `imageUrl` TEXT NOT NULL DEFAULT '', PRIMARY KEY(`id`))",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "id",
|
||||||
|
"columnName": "id",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "name",
|
||||||
|
"columnName": "name",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "shortDescription",
|
||||||
|
"columnName": "shortDescription",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "longDescription",
|
||||||
|
"columnName": "longDescription",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true,
|
||||||
|
"defaultValue": "''"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "url",
|
||||||
|
"columnName": "url",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true,
|
||||||
|
"defaultValue": "''"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "imageUrl",
|
||||||
|
"columnName": "imageUrl",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true,
|
||||||
|
"defaultValue": "''"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": [
|
||||||
|
"id"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"indices": [],
|
||||||
|
"foreignKeys": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"ftsVersion": "FTS4",
|
||||||
|
"ftsOptions": {
|
||||||
|
"tokenizer": "simple",
|
||||||
|
"tokenizerArgs": [],
|
||||||
|
"contentTable": "",
|
||||||
|
"languageIdColumnName": "",
|
||||||
|
"matchInfo": "FTS4",
|
||||||
|
"notIndexedColumns": [],
|
||||||
|
"prefixSizes": [],
|
||||||
|
"preferredOrder": "ASC"
|
||||||
|
},
|
||||||
|
"contentSyncTriggers": [],
|
||||||
|
"tableName": "topicsFts",
|
||||||
|
"createSql": "CREATE VIRTUAL TABLE IF NOT EXISTS `${TABLE_NAME}` USING FTS4(`topicId` TEXT NOT NULL, `name` TEXT NOT NULL, `shortDescription` TEXT NOT NULL, `longDescription` TEXT NOT NULL)",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "topicId",
|
||||||
|
"columnName": "topicId",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "name",
|
||||||
|
"columnName": "name",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "shortDescription",
|
||||||
|
"columnName": "shortDescription",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "longDescription",
|
||||||
|
"columnName": "longDescription",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": []
|
||||||
|
},
|
||||||
|
"indices": [],
|
||||||
|
"foreignKeys": []
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"views": [],
|
||||||
|
"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, 'b6b299e53da623b16360975581ebfcfe')"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,308 @@
|
|||||||
|
{
|
||||||
|
"formatVersion": 1,
|
||||||
|
"database": {
|
||||||
|
"version": 14,
|
||||||
|
"identityHash": "51271b81bde7c7997d67fb23c8f31780",
|
||||||
|
"entities": [
|
||||||
|
{
|
||||||
|
"tableName": "news_resources",
|
||||||
|
"createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` TEXT NOT NULL, `title` TEXT NOT NULL, `content` TEXT NOT NULL, `url` TEXT NOT NULL, `header_image_url` TEXT, `publish_date` INTEGER NOT NULL, `type` TEXT NOT NULL, PRIMARY KEY(`id`))",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "id",
|
||||||
|
"columnName": "id",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "title",
|
||||||
|
"columnName": "title",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "content",
|
||||||
|
"columnName": "content",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "url",
|
||||||
|
"columnName": "url",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "headerImageUrl",
|
||||||
|
"columnName": "header_image_url",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "publishDate",
|
||||||
|
"columnName": "publish_date",
|
||||||
|
"affinity": "INTEGER",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "type",
|
||||||
|
"columnName": "type",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": [
|
||||||
|
"id"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"indices": [],
|
||||||
|
"foreignKeys": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tableName": "news_resources_topics",
|
||||||
|
"createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`news_resource_id` TEXT NOT NULL, `topic_id` TEXT NOT NULL, PRIMARY KEY(`news_resource_id`, `topic_id`), FOREIGN KEY(`news_resource_id`) REFERENCES `news_resources`(`id`) ON UPDATE NO ACTION ON DELETE CASCADE , FOREIGN KEY(`topic_id`) REFERENCES `topics`(`id`) ON UPDATE NO ACTION ON DELETE CASCADE )",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "newsResourceId",
|
||||||
|
"columnName": "news_resource_id",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "topicId",
|
||||||
|
"columnName": "topic_id",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": [
|
||||||
|
"news_resource_id",
|
||||||
|
"topic_id"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"indices": [
|
||||||
|
{
|
||||||
|
"name": "index_news_resources_topics_news_resource_id",
|
||||||
|
"unique": false,
|
||||||
|
"columnNames": [
|
||||||
|
"news_resource_id"
|
||||||
|
],
|
||||||
|
"orders": [],
|
||||||
|
"createSql": "CREATE INDEX IF NOT EXISTS `index_news_resources_topics_news_resource_id` ON `${TABLE_NAME}` (`news_resource_id`)"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "index_news_resources_topics_topic_id",
|
||||||
|
"unique": false,
|
||||||
|
"columnNames": [
|
||||||
|
"topic_id"
|
||||||
|
],
|
||||||
|
"orders": [],
|
||||||
|
"createSql": "CREATE INDEX IF NOT EXISTS `index_news_resources_topics_topic_id` ON `${TABLE_NAME}` (`topic_id`)"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"foreignKeys": [
|
||||||
|
{
|
||||||
|
"table": "news_resources",
|
||||||
|
"onDelete": "CASCADE",
|
||||||
|
"onUpdate": "NO ACTION",
|
||||||
|
"columns": [
|
||||||
|
"news_resource_id"
|
||||||
|
],
|
||||||
|
"referencedColumns": [
|
||||||
|
"id"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"table": "topics",
|
||||||
|
"onDelete": "CASCADE",
|
||||||
|
"onUpdate": "NO ACTION",
|
||||||
|
"columns": [
|
||||||
|
"topic_id"
|
||||||
|
],
|
||||||
|
"referencedColumns": [
|
||||||
|
"id"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"ftsVersion": "FTS4",
|
||||||
|
"ftsOptions": {
|
||||||
|
"tokenizer": "simple",
|
||||||
|
"tokenizerArgs": [],
|
||||||
|
"contentTable": "",
|
||||||
|
"languageIdColumnName": "",
|
||||||
|
"matchInfo": "FTS4",
|
||||||
|
"notIndexedColumns": [],
|
||||||
|
"prefixSizes": [],
|
||||||
|
"preferredOrder": "ASC"
|
||||||
|
},
|
||||||
|
"contentSyncTriggers": [],
|
||||||
|
"tableName": "newsResourcesFts",
|
||||||
|
"createSql": "CREATE VIRTUAL TABLE IF NOT EXISTS `${TABLE_NAME}` USING FTS4(`newsResourceId` TEXT NOT NULL, `title` TEXT NOT NULL, `content` TEXT NOT NULL)",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "newsResourceId",
|
||||||
|
"columnName": "newsResourceId",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "title",
|
||||||
|
"columnName": "title",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "content",
|
||||||
|
"columnName": "content",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": []
|
||||||
|
},
|
||||||
|
"indices": [],
|
||||||
|
"foreignKeys": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tableName": "topics",
|
||||||
|
"createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` TEXT NOT NULL, `name` TEXT NOT NULL, `shortDescription` TEXT NOT NULL, `longDescription` TEXT NOT NULL DEFAULT '', `url` TEXT NOT NULL DEFAULT '', `imageUrl` TEXT NOT NULL DEFAULT '', PRIMARY KEY(`id`))",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "id",
|
||||||
|
"columnName": "id",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "name",
|
||||||
|
"columnName": "name",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "shortDescription",
|
||||||
|
"columnName": "shortDescription",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "longDescription",
|
||||||
|
"columnName": "longDescription",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true,
|
||||||
|
"defaultValue": "''"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "url",
|
||||||
|
"columnName": "url",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true,
|
||||||
|
"defaultValue": "''"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "imageUrl",
|
||||||
|
"columnName": "imageUrl",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true,
|
||||||
|
"defaultValue": "''"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": [
|
||||||
|
"id"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"indices": [],
|
||||||
|
"foreignKeys": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"ftsVersion": "FTS4",
|
||||||
|
"ftsOptions": {
|
||||||
|
"tokenizer": "simple",
|
||||||
|
"tokenizerArgs": [],
|
||||||
|
"contentTable": "",
|
||||||
|
"languageIdColumnName": "",
|
||||||
|
"matchInfo": "FTS4",
|
||||||
|
"notIndexedColumns": [],
|
||||||
|
"prefixSizes": [],
|
||||||
|
"preferredOrder": "ASC"
|
||||||
|
},
|
||||||
|
"contentSyncTriggers": [],
|
||||||
|
"tableName": "topicsFts",
|
||||||
|
"createSql": "CREATE VIRTUAL TABLE IF NOT EXISTS `${TABLE_NAME}` USING FTS4(`topicId` TEXT NOT NULL, `name` TEXT NOT NULL, `shortDescription` TEXT NOT NULL, `longDescription` TEXT NOT NULL)",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "topicId",
|
||||||
|
"columnName": "topicId",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "name",
|
||||||
|
"columnName": "name",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "shortDescription",
|
||||||
|
"columnName": "shortDescription",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "longDescription",
|
||||||
|
"columnName": "longDescription",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": []
|
||||||
|
},
|
||||||
|
"indices": [],
|
||||||
|
"foreignKeys": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tableName": "recentSearchQueries",
|
||||||
|
"createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`query` TEXT NOT NULL, `queriedDate` INTEGER NOT NULL, PRIMARY KEY(`query`))",
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"fieldPath": "query",
|
||||||
|
"columnName": "query",
|
||||||
|
"affinity": "TEXT",
|
||||||
|
"notNull": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"fieldPath": "queriedDate",
|
||||||
|
"columnName": "queriedDate",
|
||||||
|
"affinity": "INTEGER",
|
||||||
|
"notNull": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"primaryKey": {
|
||||||
|
"autoGenerate": false,
|
||||||
|
"columnNames": [
|
||||||
|
"query"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"indices": [],
|
||||||
|
"foreignKeys": []
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"views": [],
|
||||||
|
"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, '51271b81bde7c7997d67fb23c8f31780')"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,39 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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 androidx.room.Dao
|
||||||
|
import androidx.room.Insert
|
||||||
|
import androidx.room.OnConflictStrategy
|
||||||
|
import androidx.room.Query
|
||||||
|
import com.google.samples.apps.nowinandroid.core.database.model.NewsResourceFtsEntity
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DAO for [NewsResourceFtsEntity] access.
|
||||||
|
*/
|
||||||
|
@Dao
|
||||||
|
interface NewsResourceFtsDao {
|
||||||
|
@Insert(onConflict = OnConflictStrategy.REPLACE)
|
||||||
|
suspend fun insertAll(newsResources: List<NewsResourceFtsEntity>)
|
||||||
|
|
||||||
|
@Query("SELECT newsResourceId FROM newsResourcesFts WHERE newsResourcesFts MATCH :query")
|
||||||
|
fun searchAllNewsResources(query: String): Flow<List<String>>
|
||||||
|
|
||||||
|
@Query("SELECT count(*) FROM newsResourcesFts")
|
||||||
|
fun getCount(): Flow<Int>
|
||||||
|
}
|
||||||
@ -0,0 +1,38 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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 androidx.room.Dao
|
||||||
|
import androidx.room.Query
|
||||||
|
import androidx.room.Upsert
|
||||||
|
import com.google.samples.apps.nowinandroid.core.database.model.RecentSearchQueryEntity
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DAO for [RecentSearchQueryEntity] access
|
||||||
|
*/
|
||||||
|
@Dao
|
||||||
|
interface RecentSearchQueryDao {
|
||||||
|
@Query(value = "SELECT * FROM recentSearchQueries ORDER BY queriedDate DESC LIMIT :limit")
|
||||||
|
fun getRecentSearchQueryEntities(limit: Int): Flow<List<RecentSearchQueryEntity>>
|
||||||
|
|
||||||
|
@Upsert
|
||||||
|
suspend fun insertOrReplaceRecentSearchQuery(recentSearchQuery: RecentSearchQueryEntity)
|
||||||
|
|
||||||
|
@Query(value = "DELETE FROM recentSearchQueries")
|
||||||
|
suspend fun clearRecentSearchQueries()
|
||||||
|
}
|
||||||
@ -0,0 +1,39 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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 androidx.room.Dao
|
||||||
|
import androidx.room.Insert
|
||||||
|
import androidx.room.OnConflictStrategy
|
||||||
|
import androidx.room.Query
|
||||||
|
import com.google.samples.apps.nowinandroid.core.database.model.TopicFtsEntity
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DAO for [TopicFtsEntity] access.
|
||||||
|
*/
|
||||||
|
@Dao
|
||||||
|
interface TopicFtsDao {
|
||||||
|
@Insert(onConflict = OnConflictStrategy.REPLACE)
|
||||||
|
suspend fun insertAll(topics: List<TopicFtsEntity>)
|
||||||
|
|
||||||
|
@Query("SELECT topicId FROM topicsFts WHERE topicsFts MATCH :query")
|
||||||
|
fun searchAllTopics(query: String): Flow<List<String>>
|
||||||
|
|
||||||
|
@Query("SELECT count(*) FROM topicsFts")
|
||||||
|
fun getCount(): Flow<Int>
|
||||||
|
}
|
||||||
@ -0,0 +1,44 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.model
|
||||||
|
|
||||||
|
import androidx.room.ColumnInfo
|
||||||
|
import androidx.room.Entity
|
||||||
|
import androidx.room.Fts4
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fts entity for the news resources. See https://developer.android.com/reference/androidx/room/Fts4.
|
||||||
|
*/
|
||||||
|
@Entity(tableName = "newsResourcesFts")
|
||||||
|
@Fts4
|
||||||
|
data class NewsResourceFtsEntity(
|
||||||
|
|
||||||
|
@ColumnInfo(name = "newsResourceId")
|
||||||
|
val newsResourceId: String,
|
||||||
|
|
||||||
|
@ColumnInfo(name = "title")
|
||||||
|
val title: String,
|
||||||
|
|
||||||
|
@ColumnInfo(name = "content")
|
||||||
|
val content: String,
|
||||||
|
)
|
||||||
|
|
||||||
|
fun NewsResourceEntity.asFtsEntity() = NewsResourceFtsEntity(
|
||||||
|
newsResourceId = id,
|
||||||
|
title = title,
|
||||||
|
content = content,
|
||||||
|
)
|
||||||
@ -0,0 +1,35 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.model
|
||||||
|
|
||||||
|
import androidx.room.ColumnInfo
|
||||||
|
import androidx.room.Entity
|
||||||
|
import androidx.room.PrimaryKey
|
||||||
|
import kotlinx.datetime.Instant
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Defines an database entity that stored recent search queries.
|
||||||
|
*/
|
||||||
|
@Entity(
|
||||||
|
tableName = "recentSearchQueries",
|
||||||
|
)
|
||||||
|
data class RecentSearchQueryEntity(
|
||||||
|
@PrimaryKey
|
||||||
|
val query: String,
|
||||||
|
@ColumnInfo
|
||||||
|
val queriedDate: Instant,
|
||||||
|
)
|
||||||
@ -0,0 +1,48 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.model
|
||||||
|
|
||||||
|
import androidx.room.ColumnInfo
|
||||||
|
import androidx.room.Entity
|
||||||
|
import androidx.room.Fts4
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fts entity for the topic. See https://developer.android.com/reference/androidx/room/Fts4.
|
||||||
|
*/
|
||||||
|
@Entity(tableName = "topicsFts")
|
||||||
|
@Fts4
|
||||||
|
data class TopicFtsEntity(
|
||||||
|
|
||||||
|
@ColumnInfo(name = "topicId")
|
||||||
|
val topicId: String,
|
||||||
|
|
||||||
|
@ColumnInfo(name = "name")
|
||||||
|
val name: String,
|
||||||
|
|
||||||
|
@ColumnInfo(name = "shortDescription")
|
||||||
|
val shortDescription: String,
|
||||||
|
|
||||||
|
@ColumnInfo(name = "longDescription")
|
||||||
|
val longDescription: String,
|
||||||
|
)
|
||||||
|
|
||||||
|
fun TopicEntity.asFtsEntity() = TopicFtsEntity(
|
||||||
|
topicId = id,
|
||||||
|
name = name,
|
||||||
|
shortDescription = shortDescription,
|
||||||
|
longDescription = longDescription,
|
||||||
|
)
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.domain
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.model.RecentSearchQuery
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.repository.RecentSearchRepository
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import javax.inject.Inject
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A use case which returns the recent search queries.
|
||||||
|
*/
|
||||||
|
class GetRecentSearchQueriesUseCase @Inject constructor(
|
||||||
|
private val recentSearchRepository: RecentSearchRepository,
|
||||||
|
) {
|
||||||
|
operator fun invoke(limit: Int = 10): Flow<List<RecentSearchQuery>> =
|
||||||
|
recentSearchRepository.getRecentSearchQueries(limit)
|
||||||
|
}
|
||||||
@ -0,0 +1,31 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.domain
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.repository.SearchContentsRepository
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import javax.inject.Inject
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A use case which returns total count of *Fts tables
|
||||||
|
*/
|
||||||
|
class GetSearchContentsCountUseCase @Inject constructor(
|
||||||
|
private val searchContentsRepository: SearchContentsRepository,
|
||||||
|
) {
|
||||||
|
operator fun invoke(): Flow<Int> =
|
||||||
|
searchContentsRepository.getSearchContentsCount()
|
||||||
|
}
|
||||||
@ -0,0 +1,61 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.domain
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.repository.SearchContentsRepository
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.repository.UserDataRepository
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.FollowableTopic
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.SearchResult
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.UserData
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.UserNewsResource
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.UserSearchResult
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import kotlinx.coroutines.flow.combine
|
||||||
|
import javax.inject.Inject
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A use case which returns the searched contents matched with the search query.
|
||||||
|
*/
|
||||||
|
class GetSearchContentsUseCase @Inject constructor(
|
||||||
|
private val searchContentsRepository: SearchContentsRepository,
|
||||||
|
private val userDataRepository: UserDataRepository,
|
||||||
|
) {
|
||||||
|
|
||||||
|
operator fun invoke(
|
||||||
|
searchQuery: String,
|
||||||
|
): Flow<UserSearchResult> =
|
||||||
|
searchContentsRepository.searchContents(searchQuery)
|
||||||
|
.mapToUserSearchResult(userDataRepository.userData)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun Flow<SearchResult>.mapToUserSearchResult(userDataStream: Flow<UserData>): Flow<UserSearchResult> =
|
||||||
|
combine(userDataStream) { searchResult, userData ->
|
||||||
|
UserSearchResult(
|
||||||
|
topics = searchResult.topics.map { topic ->
|
||||||
|
FollowableTopic(
|
||||||
|
topic = topic,
|
||||||
|
isFollowed = topic.id in userData.followedTopics,
|
||||||
|
)
|
||||||
|
},
|
||||||
|
newsResources = searchResult.newsResources.map { news ->
|
||||||
|
UserNewsResource(
|
||||||
|
newsResource = news,
|
||||||
|
userData = userData,
|
||||||
|
)
|
||||||
|
},
|
||||||
|
)
|
||||||
|
}
|
||||||
@ -0,0 +1,23 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.model.data
|
||||||
|
|
||||||
|
/** An entity that holds the search result */
|
||||||
|
data class SearchResult(
|
||||||
|
val topics: List<Topic> = emptyList(),
|
||||||
|
val newsResources: List<NewsResource> = emptyList(),
|
||||||
|
)
|
||||||
@ -0,0 +1,26 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.model.data
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An entity of [SearchResult] with additional user information such as whether the user is
|
||||||
|
* following a topic.
|
||||||
|
*/
|
||||||
|
data class UserSearchResult(
|
||||||
|
val topics: List<FollowableTopic> = emptyList(),
|
||||||
|
val newsResources: List<UserNewsResource> = emptyList(),
|
||||||
|
)
|
||||||
@ -0,0 +1,38 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.testing.repository
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.model.RecentSearchQuery
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.repository.RecentSearchRepository
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import kotlinx.coroutines.flow.flowOf
|
||||||
|
|
||||||
|
class TestRecentSearchRepository : RecentSearchRepository {
|
||||||
|
|
||||||
|
private val cachedRecentSearches: MutableList<RecentSearchQuery> = mutableListOf()
|
||||||
|
|
||||||
|
override fun getRecentSearchQueries(limit: Int): Flow<List<RecentSearchQuery>> =
|
||||||
|
flowOf(cachedRecentSearches.sortedByDescending { it.queriedDate }.take(limit))
|
||||||
|
|
||||||
|
override suspend fun insertOrReplaceRecentSearch(searchQuery: String) {
|
||||||
|
cachedRecentSearches.add(RecentSearchQuery(searchQuery))
|
||||||
|
}
|
||||||
|
|
||||||
|
override suspend fun clearRecentSearches() {
|
||||||
|
cachedRecentSearches.clear()
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,65 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.testing.repository
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.repository.SearchContentsRepository
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.NewsResource
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.SearchResult
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.Topic
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import kotlinx.coroutines.flow.flow
|
||||||
|
import kotlinx.coroutines.flow.flowOf
|
||||||
|
|
||||||
|
class TestSearchContentsRepository : SearchContentsRepository {
|
||||||
|
|
||||||
|
private val cachedTopics: MutableList<Topic> = mutableListOf()
|
||||||
|
private val cachedNewsResources: MutableList<NewsResource> = mutableListOf()
|
||||||
|
|
||||||
|
override suspend fun populateFtsData() { /* no-op */ }
|
||||||
|
|
||||||
|
override fun searchContents(searchQuery: String): Flow<SearchResult> = flowOf(
|
||||||
|
SearchResult(
|
||||||
|
topics = cachedTopics.filter {
|
||||||
|
it.name.contains(searchQuery) ||
|
||||||
|
it.shortDescription.contains(searchQuery) ||
|
||||||
|
it.longDescription.contains(searchQuery)
|
||||||
|
},
|
||||||
|
newsResources = cachedNewsResources.filter {
|
||||||
|
it.content.contains(searchQuery) ||
|
||||||
|
it.title.contains(searchQuery)
|
||||||
|
},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
override fun getSearchContentsCount(): Flow<Int> = flow {
|
||||||
|
emit(cachedTopics.size + cachedNewsResources.size)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test only method to add the topics to the stored list in memory
|
||||||
|
*/
|
||||||
|
fun addTopics(topics: List<Topic>) {
|
||||||
|
cachedTopics.addAll(topics)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test only method to add the news resources to the stored list in memory
|
||||||
|
*/
|
||||||
|
fun addNewsResources(newsResources: List<NewsResource>) {
|
||||||
|
cachedNewsResources.addAll(newsResources)
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1 @@
|
|||||||
|
/build
|
||||||
@ -0,0 +1,33 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
id("nowinandroid.android.feature")
|
||||||
|
id("nowinandroid.android.library.compose")
|
||||||
|
id("nowinandroid.android.library.jacoco")
|
||||||
|
}
|
||||||
|
|
||||||
|
android {
|
||||||
|
namespace = "com.google.samples.apps.nowinandroid.feature.search"
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation(project(":feature:bookmarks"))
|
||||||
|
implementation(project(":feature:foryou"))
|
||||||
|
implementation(project(":feature:interests"))
|
||||||
|
implementation(libs.kotlinx.datetime)
|
||||||
|
}
|
||||||
|
|
||||||
@ -0,0 +1,218 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.feature.search
|
||||||
|
|
||||||
|
import androidx.activity.ComponentActivity
|
||||||
|
import androidx.compose.ui.test.assertCountEquals
|
||||||
|
import androidx.compose.ui.test.assertIsDisplayed
|
||||||
|
import androidx.compose.ui.test.assertIsFocused
|
||||||
|
import androidx.compose.ui.test.junit4.createAndroidComposeRule
|
||||||
|
import androidx.compose.ui.test.onAllNodesWithContentDescription
|
||||||
|
import androidx.compose.ui.test.onNodeWithContentDescription
|
||||||
|
import androidx.compose.ui.test.onNodeWithTag
|
||||||
|
import androidx.compose.ui.test.onNodeWithText
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.model.RecentSearchQuery
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.DarkThemeConfig.DARK
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.ThemeBrand.ANDROID
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.UserData
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.UserNewsResource
|
||||||
|
import com.google.samples.apps.nowinandroid.core.testing.data.followableTopicTestData
|
||||||
|
import com.google.samples.apps.nowinandroid.core.testing.data.newsResourcesTestData
|
||||||
|
import org.junit.Before
|
||||||
|
import org.junit.Rule
|
||||||
|
import org.junit.Test
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.interests.R as interestsR
|
||||||
|
|
||||||
|
/**
|
||||||
|
* UI test for checking the correct behaviour of the Search screen.
|
||||||
|
*/
|
||||||
|
class SearchScreenTest {
|
||||||
|
|
||||||
|
@get:Rule
|
||||||
|
val composeTestRule = createAndroidComposeRule<ComponentActivity>()
|
||||||
|
|
||||||
|
private lateinit var clearSearchContentDesc: String
|
||||||
|
private lateinit var followButtonContentDesc: String
|
||||||
|
private lateinit var unfollowButtonContentDesc: String
|
||||||
|
private lateinit var clearRecentSearchesContentDesc: String
|
||||||
|
private lateinit var topicsString: String
|
||||||
|
private lateinit var updatesString: String
|
||||||
|
private lateinit var tryAnotherSearchString: String
|
||||||
|
private lateinit var searchNotReadyString: String
|
||||||
|
|
||||||
|
private val userData: UserData = UserData(
|
||||||
|
bookmarkedNewsResources = setOf("1", "3"),
|
||||||
|
viewedNewsResources = setOf("1", "2", "4"),
|
||||||
|
followedTopics = emptySet(),
|
||||||
|
themeBrand = ANDROID,
|
||||||
|
darkThemeConfig = DARK,
|
||||||
|
shouldHideOnboarding = true,
|
||||||
|
useDynamicColor = false,
|
||||||
|
)
|
||||||
|
|
||||||
|
@Before
|
||||||
|
fun setup() {
|
||||||
|
composeTestRule.activity.apply {
|
||||||
|
clearSearchContentDesc = getString(R.string.clear_search_text_content_desc)
|
||||||
|
clearRecentSearchesContentDesc = getString(R.string.clear_recent_searches_content_desc)
|
||||||
|
followButtonContentDesc =
|
||||||
|
getString(interestsR.string.card_follow_button_content_desc)
|
||||||
|
unfollowButtonContentDesc =
|
||||||
|
getString(interestsR.string.card_unfollow_button_content_desc)
|
||||||
|
topicsString = getString(R.string.topics)
|
||||||
|
updatesString = getString(R.string.updates)
|
||||||
|
tryAnotherSearchString = getString(R.string.try_another_search) +
|
||||||
|
" " + getString(R.string.interests) + " " + getString(R.string.to_browse_topics)
|
||||||
|
searchNotReadyString = getString(R.string.search_not_ready)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun searchTextField_isFocused() {
|
||||||
|
composeTestRule.setContent {
|
||||||
|
SearchScreen()
|
||||||
|
}
|
||||||
|
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithTag("searchTextField")
|
||||||
|
.assertIsFocused()
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun emptySearchResult_emptyScreenIsDisplayed() {
|
||||||
|
composeTestRule.setContent {
|
||||||
|
SearchScreen(
|
||||||
|
searchResultUiState = SearchResultUiState.Success(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText(tryAnotherSearchString)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun emptySearchResult_nonEmptyRecentSearches_emptySearchScreenAndRecentSearchesAreDisplayed() {
|
||||||
|
val recentSearches = listOf("kotlin")
|
||||||
|
composeTestRule.setContent {
|
||||||
|
SearchScreen(
|
||||||
|
searchResultUiState = SearchResultUiState.Success(),
|
||||||
|
recentSearchesUiState = RecentSearchQueriesUiState.Success(
|
||||||
|
recentQueries = recentSearches.map(::RecentSearchQuery),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText(tryAnotherSearchString)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithContentDescription(clearRecentSearchesContentDesc)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText("kotlin")
|
||||||
|
.assertIsDisplayed()
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun searchResultWithTopics_allTopicsAreVisible_followButtonsVisibleForTheNumOfFollowedTopics() {
|
||||||
|
composeTestRule.setContent {
|
||||||
|
SearchScreen(
|
||||||
|
searchResultUiState = SearchResultUiState.Success(topics = followableTopicTestData),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText(topicsString)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText(followableTopicTestData[0].topic.name)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText(followableTopicTestData[1].topic.name)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText(followableTopicTestData[2].topic.name)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
|
||||||
|
composeTestRule
|
||||||
|
.onAllNodesWithContentDescription(followButtonContentDesc)
|
||||||
|
.assertCountEquals(2)
|
||||||
|
composeTestRule
|
||||||
|
.onAllNodesWithContentDescription(unfollowButtonContentDesc)
|
||||||
|
.assertCountEquals(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun searchResultWithNewsResources_firstNewsResourcesIsVisible() {
|
||||||
|
composeTestRule.setContent {
|
||||||
|
SearchScreen(
|
||||||
|
searchResultUiState = SearchResultUiState.Success(
|
||||||
|
newsResources = newsResourcesTestData.map {
|
||||||
|
UserNewsResource(
|
||||||
|
newsResource = it,
|
||||||
|
userData = userData,
|
||||||
|
)
|
||||||
|
},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText(updatesString)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText(newsResourcesTestData[0].title)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun emptyQuery_notEmptyRecentSearches_verifyClearSearchesButton_displayed() {
|
||||||
|
val recentSearches = listOf("kotlin", "testing")
|
||||||
|
composeTestRule.setContent {
|
||||||
|
SearchScreen(
|
||||||
|
searchResultUiState = SearchResultUiState.EmptyQuery,
|
||||||
|
recentSearchesUiState = RecentSearchQueriesUiState.Success(
|
||||||
|
recentQueries = recentSearches.map(::RecentSearchQuery),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithContentDescription(clearRecentSearchesContentDesc)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText("kotlin")
|
||||||
|
.assertIsDisplayed()
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText("testing")
|
||||||
|
.assertIsDisplayed()
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun searchNotReady_verifySearchNotReadyMessageIsVisible() {
|
||||||
|
composeTestRule.setContent {
|
||||||
|
SearchScreen(
|
||||||
|
searchResultUiState = SearchResultUiState.SearchNotReady,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
composeTestRule
|
||||||
|
.onNodeWithText(searchNotReadyString)
|
||||||
|
.assertIsDisplayed()
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!--
|
||||||
|
Copyright 2023 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
|
||||||
|
|
||||||
|
http://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.
|
||||||
|
-->
|
||||||
|
<manifest xmlns:android="http://schemas.android.com/apk/res/android" />
|
||||||
@ -0,0 +1,27 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.feature.search
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.model.RecentSearchQuery
|
||||||
|
|
||||||
|
sealed interface RecentSearchQueriesUiState {
|
||||||
|
object Loading : RecentSearchQueriesUiState
|
||||||
|
|
||||||
|
data class Success(
|
||||||
|
val recentQueries: List<RecentSearchQuery> = emptyList(),
|
||||||
|
) : RecentSearchQueriesUiState
|
||||||
|
}
|
||||||
@ -0,0 +1,46 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.feature.search
|
||||||
|
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.FollowableTopic
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.UserNewsResource
|
||||||
|
|
||||||
|
sealed interface SearchResultUiState {
|
||||||
|
object Loading : SearchResultUiState
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The state query is empty or too short. To distinguish the state between the
|
||||||
|
* (initial state or when the search query is cleared) vs the state where no search
|
||||||
|
* result is returned, explicitly define the empty query state.
|
||||||
|
*/
|
||||||
|
object EmptyQuery : SearchResultUiState
|
||||||
|
|
||||||
|
object LoadFailed : SearchResultUiState
|
||||||
|
|
||||||
|
data class Success(
|
||||||
|
val topics: List<FollowableTopic> = emptyList(),
|
||||||
|
val newsResources: List<UserNewsResource> = emptyList(),
|
||||||
|
) : SearchResultUiState {
|
||||||
|
fun isEmpty(): Boolean = topics.isEmpty() && newsResources.isEmpty()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A state where the search contents are not ready. This happens when the *Fts tables are not
|
||||||
|
* populated yet.
|
||||||
|
*/
|
||||||
|
object SearchNotReady : SearchResultUiState
|
||||||
|
}
|
||||||
@ -0,0 +1,565 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.feature.search
|
||||||
|
|
||||||
|
import androidx.compose.foundation.clickable
|
||||||
|
import androidx.compose.foundation.layout.Arrangement
|
||||||
|
import androidx.compose.foundation.layout.Column
|
||||||
|
import androidx.compose.foundation.layout.PaddingValues
|
||||||
|
import androidx.compose.foundation.layout.Row
|
||||||
|
import androidx.compose.foundation.layout.Spacer
|
||||||
|
import androidx.compose.foundation.layout.WindowInsets
|
||||||
|
import androidx.compose.foundation.layout.fillMaxSize
|
||||||
|
import androidx.compose.foundation.layout.fillMaxWidth
|
||||||
|
import androidx.compose.foundation.layout.padding
|
||||||
|
import androidx.compose.foundation.layout.safeDrawing
|
||||||
|
import androidx.compose.foundation.layout.windowInsetsBottomHeight
|
||||||
|
import androidx.compose.foundation.layout.windowInsetsTopHeight
|
||||||
|
import androidx.compose.foundation.lazy.LazyColumn
|
||||||
|
import androidx.compose.foundation.lazy.grid.GridCells.Adaptive
|
||||||
|
import androidx.compose.foundation.lazy.grid.LazyVerticalGrid
|
||||||
|
import androidx.compose.foundation.lazy.grid.rememberLazyGridState
|
||||||
|
import androidx.compose.foundation.lazy.items
|
||||||
|
import androidx.compose.foundation.shape.RoundedCornerShape
|
||||||
|
import androidx.compose.foundation.text.ClickableText
|
||||||
|
import androidx.compose.foundation.text.KeyboardActions
|
||||||
|
import androidx.compose.foundation.text.KeyboardOptions
|
||||||
|
import androidx.compose.material3.ExperimentalMaterial3Api
|
||||||
|
import androidx.compose.material3.Icon
|
||||||
|
import androidx.compose.material3.IconButton
|
||||||
|
import androidx.compose.material3.MaterialTheme
|
||||||
|
import androidx.compose.material3.Text
|
||||||
|
import androidx.compose.material3.TextField
|
||||||
|
import androidx.compose.material3.TextFieldDefaults
|
||||||
|
import androidx.compose.runtime.Composable
|
||||||
|
import androidx.compose.runtime.LaunchedEffect
|
||||||
|
import androidx.compose.runtime.getValue
|
||||||
|
import androidx.compose.runtime.remember
|
||||||
|
import androidx.compose.ui.Alignment
|
||||||
|
import androidx.compose.ui.ExperimentalComposeUiApi
|
||||||
|
import androidx.compose.ui.Modifier
|
||||||
|
import androidx.compose.ui.focus.FocusRequester
|
||||||
|
import androidx.compose.ui.focus.focusRequester
|
||||||
|
import androidx.compose.ui.graphics.Color
|
||||||
|
import androidx.compose.ui.input.key.Key
|
||||||
|
import androidx.compose.ui.input.key.key
|
||||||
|
import androidx.compose.ui.input.key.onKeyEvent
|
||||||
|
import androidx.compose.ui.platform.LocalSoftwareKeyboardController
|
||||||
|
import androidx.compose.ui.platform.testTag
|
||||||
|
import androidx.compose.ui.res.stringResource
|
||||||
|
import androidx.compose.ui.text.AnnotatedString
|
||||||
|
import androidx.compose.ui.text.SpanStyle
|
||||||
|
import androidx.compose.ui.text.TextStyle
|
||||||
|
import androidx.compose.ui.text.buildAnnotatedString
|
||||||
|
import androidx.compose.ui.text.font.FontWeight
|
||||||
|
import androidx.compose.ui.text.input.ImeAction
|
||||||
|
import androidx.compose.ui.text.style.TextAlign
|
||||||
|
import androidx.compose.ui.text.style.TextDecoration
|
||||||
|
import androidx.compose.ui.text.withStyle
|
||||||
|
import androidx.compose.ui.tooling.preview.Preview
|
||||||
|
import androidx.compose.ui.tooling.preview.PreviewParameter
|
||||||
|
import androidx.compose.ui.unit.dp
|
||||||
|
import androidx.hilt.navigation.compose.hiltViewModel
|
||||||
|
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||||
|
import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
|
||||||
|
import com.google.samples.apps.nowinandroid.core.designsystem.theme.NiaTheme
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.FollowableTopic
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.UserNewsResource
|
||||||
|
import com.google.samples.apps.nowinandroid.core.ui.DevicePreviews
|
||||||
|
import com.google.samples.apps.nowinandroid.core.ui.NewsFeedUiState
|
||||||
|
import com.google.samples.apps.nowinandroid.core.ui.R.string
|
||||||
|
import com.google.samples.apps.nowinandroid.core.ui.TrackScreenViewEvent
|
||||||
|
import com.google.samples.apps.nowinandroid.core.ui.TrackScrollJank
|
||||||
|
import com.google.samples.apps.nowinandroid.core.ui.newsFeed
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.bookmarks.BookmarksViewModel
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.foryou.ForYouViewModel
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.interests.InterestsViewModel
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.interests.TopicsTabContent
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.search.R as searchR
|
||||||
|
|
||||||
|
@Composable
|
||||||
|
internal fun SearchRoute(
|
||||||
|
modifier: Modifier = Modifier,
|
||||||
|
onBackClick: () -> Unit,
|
||||||
|
onInterestsClick: () -> Unit,
|
||||||
|
onTopicClick: (String) -> Unit,
|
||||||
|
bookmarksViewModel: BookmarksViewModel = hiltViewModel(),
|
||||||
|
interestsViewModel: InterestsViewModel = hiltViewModel(),
|
||||||
|
searchViewModel: SearchViewModel = hiltViewModel(),
|
||||||
|
forYouViewModel: ForYouViewModel = hiltViewModel(),
|
||||||
|
) {
|
||||||
|
val recentSearchQueriesUiState by searchViewModel.recentSearchQueriesUiState.collectAsStateWithLifecycle()
|
||||||
|
val searchResultUiState by searchViewModel.searchResultUiState.collectAsStateWithLifecycle()
|
||||||
|
val searchQuery by searchViewModel.searchQuery.collectAsStateWithLifecycle()
|
||||||
|
SearchScreen(
|
||||||
|
modifier = modifier,
|
||||||
|
onBackClick = onBackClick,
|
||||||
|
onClearRecentSearches = searchViewModel::clearRecentSearches,
|
||||||
|
onFollowButtonClick = interestsViewModel::followTopic,
|
||||||
|
onInterestsClick = onInterestsClick,
|
||||||
|
onSearchQueryChanged = searchViewModel::onSearchQueryChanged,
|
||||||
|
onSearchTriggered = searchViewModel::onSearchTriggered,
|
||||||
|
onTopicClick = onTopicClick,
|
||||||
|
onNewsResourcesCheckedChanged = forYouViewModel::updateNewsResourceSaved,
|
||||||
|
onNewsResourceViewed = { bookmarksViewModel.setNewsResourceViewed(it, true) },
|
||||||
|
recentSearchesUiState = recentSearchQueriesUiState,
|
||||||
|
searchQuery = searchQuery,
|
||||||
|
searchResultUiState = searchResultUiState,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Composable
|
||||||
|
internal fun SearchScreen(
|
||||||
|
modifier: Modifier = Modifier,
|
||||||
|
onBackClick: () -> Unit = {},
|
||||||
|
onClearRecentSearches: () -> Unit = {},
|
||||||
|
onFollowButtonClick: (String, Boolean) -> Unit = { _, _ -> },
|
||||||
|
onInterestsClick: () -> Unit = {},
|
||||||
|
onNewsResourcesCheckedChanged: (String, Boolean) -> Unit = { _, _ -> },
|
||||||
|
onNewsResourceViewed: (String) -> Unit = {},
|
||||||
|
onSearchQueryChanged: (String) -> Unit = {},
|
||||||
|
onSearchTriggered: (String) -> Unit = {},
|
||||||
|
onTopicClick: (String) -> Unit = {},
|
||||||
|
searchQuery: String = "",
|
||||||
|
recentSearchesUiState: RecentSearchQueriesUiState = RecentSearchQueriesUiState.Loading,
|
||||||
|
searchResultUiState: SearchResultUiState = SearchResultUiState.Loading,
|
||||||
|
) {
|
||||||
|
TrackScreenViewEvent(screenName = "Search")
|
||||||
|
Column(modifier = modifier) {
|
||||||
|
Spacer(Modifier.windowInsetsTopHeight(WindowInsets.safeDrawing))
|
||||||
|
SearchToolbar(
|
||||||
|
onBackClick = onBackClick,
|
||||||
|
onSearchQueryChanged = onSearchQueryChanged,
|
||||||
|
onSearchTriggered = onSearchTriggered,
|
||||||
|
searchQuery = searchQuery,
|
||||||
|
)
|
||||||
|
when (searchResultUiState) {
|
||||||
|
SearchResultUiState.Loading,
|
||||||
|
SearchResultUiState.LoadFailed,
|
||||||
|
-> Unit
|
||||||
|
|
||||||
|
SearchResultUiState.SearchNotReady -> SearchNotReadyBody()
|
||||||
|
SearchResultUiState.EmptyQuery,
|
||||||
|
-> {
|
||||||
|
if (recentSearchesUiState is RecentSearchQueriesUiState.Success) {
|
||||||
|
RecentSearchesBody(
|
||||||
|
onClearRecentSearches = onClearRecentSearches,
|
||||||
|
onRecentSearchClicked = {
|
||||||
|
onSearchQueryChanged(it)
|
||||||
|
onSearchTriggered(it)
|
||||||
|
},
|
||||||
|
recentSearchQueries = recentSearchesUiState.recentQueries.map { it.query },
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
is SearchResultUiState.Success -> {
|
||||||
|
if (searchResultUiState.isEmpty()) {
|
||||||
|
EmptySearchResultBody(
|
||||||
|
onInterestsClick = onInterestsClick,
|
||||||
|
searchQuery = searchQuery,
|
||||||
|
)
|
||||||
|
if (recentSearchesUiState is RecentSearchQueriesUiState.Success) {
|
||||||
|
RecentSearchesBody(
|
||||||
|
onClearRecentSearches = onClearRecentSearches,
|
||||||
|
onRecentSearchClicked = {
|
||||||
|
onSearchQueryChanged(it)
|
||||||
|
onSearchTriggered(it)
|
||||||
|
},
|
||||||
|
recentSearchQueries = recentSearchesUiState.recentQueries.map { it.query },
|
||||||
|
)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
SearchResultBody(
|
||||||
|
topics = searchResultUiState.topics,
|
||||||
|
onFollowButtonClick = onFollowButtonClick,
|
||||||
|
onNewsResourcesCheckedChanged = onNewsResourcesCheckedChanged,
|
||||||
|
onNewsResourceViewed = onNewsResourceViewed,
|
||||||
|
onSearchTriggered = onSearchTriggered,
|
||||||
|
onTopicClick = onTopicClick,
|
||||||
|
newsResources = searchResultUiState.newsResources,
|
||||||
|
searchQuery = searchQuery,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Spacer(Modifier.windowInsetsBottomHeight(WindowInsets.safeDrawing))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Composable
|
||||||
|
fun EmptySearchResultBody(
|
||||||
|
onInterestsClick: () -> Unit,
|
||||||
|
searchQuery: String,
|
||||||
|
) {
|
||||||
|
Column(
|
||||||
|
horizontalAlignment = Alignment.CenterHorizontally,
|
||||||
|
modifier = Modifier.padding(horizontal = 48.dp),
|
||||||
|
) {
|
||||||
|
val message = stringResource(id = searchR.string.search_result_not_found, searchQuery)
|
||||||
|
val start = message.indexOf(searchQuery)
|
||||||
|
Text(
|
||||||
|
text = AnnotatedString(
|
||||||
|
text = message,
|
||||||
|
spanStyles = listOf(
|
||||||
|
AnnotatedString.Range(
|
||||||
|
SpanStyle(fontWeight = FontWeight.Bold),
|
||||||
|
start = start,
|
||||||
|
end = start + searchQuery.length,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
style = MaterialTheme.typography.bodyLarge,
|
||||||
|
textAlign = TextAlign.Center,
|
||||||
|
modifier = Modifier.padding(vertical = 24.dp),
|
||||||
|
)
|
||||||
|
val interests = stringResource(id = searchR.string.interests)
|
||||||
|
val tryAnotherSearchString = buildAnnotatedString {
|
||||||
|
append(stringResource(id = searchR.string.try_another_search))
|
||||||
|
append(" ")
|
||||||
|
withStyle(
|
||||||
|
style = SpanStyle(
|
||||||
|
textDecoration = TextDecoration.Underline,
|
||||||
|
fontWeight = FontWeight.Bold,
|
||||||
|
),
|
||||||
|
) {
|
||||||
|
pushStringAnnotation(tag = interests, annotation = interests)
|
||||||
|
append(interests)
|
||||||
|
}
|
||||||
|
append(" ")
|
||||||
|
append(stringResource(id = searchR.string.to_browse_topics))
|
||||||
|
}
|
||||||
|
ClickableText(
|
||||||
|
text = tryAnotherSearchString,
|
||||||
|
style = MaterialTheme.typography.bodyLarge.merge(
|
||||||
|
TextStyle(
|
||||||
|
textAlign = TextAlign.Center,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
modifier = Modifier
|
||||||
|
.padding(start = 36.dp, end = 36.dp, bottom = 24.dp)
|
||||||
|
.clickable {},
|
||||||
|
) { offset ->
|
||||||
|
tryAnotherSearchString.getStringAnnotations(start = offset, end = offset)
|
||||||
|
.firstOrNull()
|
||||||
|
?.let {
|
||||||
|
onInterestsClick()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Composable
|
||||||
|
private fun SearchNotReadyBody() {
|
||||||
|
Column(
|
||||||
|
horizontalAlignment = Alignment.CenterHorizontally,
|
||||||
|
modifier = Modifier.padding(horizontal = 48.dp),
|
||||||
|
) {
|
||||||
|
Text(
|
||||||
|
text = stringResource(id = searchR.string.search_not_ready),
|
||||||
|
style = MaterialTheme.typography.bodyLarge,
|
||||||
|
textAlign = TextAlign.Center,
|
||||||
|
modifier = Modifier.padding(vertical = 24.dp),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Composable
|
||||||
|
private fun SearchResultBody(
|
||||||
|
topics: List<FollowableTopic>,
|
||||||
|
newsResources: List<UserNewsResource>,
|
||||||
|
onFollowButtonClick: (String, Boolean) -> Unit,
|
||||||
|
onNewsResourcesCheckedChanged: (String, Boolean) -> Unit,
|
||||||
|
onNewsResourceViewed: (String) -> Unit,
|
||||||
|
onSearchTriggered: (String) -> Unit,
|
||||||
|
onTopicClick: (String) -> Unit,
|
||||||
|
searchQuery: String = "",
|
||||||
|
) {
|
||||||
|
if (topics.isNotEmpty()) {
|
||||||
|
Text(
|
||||||
|
text = buildAnnotatedString {
|
||||||
|
withStyle(style = SpanStyle(fontWeight = FontWeight.Bold)) {
|
||||||
|
append(stringResource(id = searchR.string.topics))
|
||||||
|
}
|
||||||
|
},
|
||||||
|
modifier = Modifier.padding(horizontal = 16.dp, vertical = 8.dp),
|
||||||
|
)
|
||||||
|
TopicsTabContent(
|
||||||
|
topics = topics,
|
||||||
|
onTopicClick = {
|
||||||
|
// Pass the current search query to ViewModel to save it as recent searches
|
||||||
|
onSearchTriggered(searchQuery)
|
||||||
|
onTopicClick(it)
|
||||||
|
},
|
||||||
|
onFollowButtonClick = onFollowButtonClick,
|
||||||
|
withBottomSpacer = false,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (newsResources.isNotEmpty()) {
|
||||||
|
Text(
|
||||||
|
text = buildAnnotatedString {
|
||||||
|
withStyle(style = SpanStyle(fontWeight = FontWeight.Bold)) {
|
||||||
|
append(stringResource(id = searchR.string.updates))
|
||||||
|
}
|
||||||
|
},
|
||||||
|
modifier = Modifier.padding(horizontal = 16.dp, vertical = 8.dp),
|
||||||
|
)
|
||||||
|
|
||||||
|
val state = rememberLazyGridState()
|
||||||
|
TrackScrollJank(scrollableState = state, stateName = "search:newsResource")
|
||||||
|
LazyVerticalGrid(
|
||||||
|
columns = Adaptive(300.dp),
|
||||||
|
contentPadding = PaddingValues(16.dp),
|
||||||
|
horizontalArrangement = Arrangement.spacedBy(16.dp),
|
||||||
|
verticalArrangement = Arrangement.spacedBy(24.dp),
|
||||||
|
modifier = Modifier
|
||||||
|
.fillMaxSize()
|
||||||
|
.testTag("search:newsResources"),
|
||||||
|
state = state,
|
||||||
|
) {
|
||||||
|
newsFeed(
|
||||||
|
feedState = NewsFeedUiState.Success(feed = newsResources),
|
||||||
|
onNewsResourcesCheckedChanged = onNewsResourcesCheckedChanged,
|
||||||
|
onNewsResourceViewed = onNewsResourceViewed,
|
||||||
|
onTopicClick = onTopicClick,
|
||||||
|
onExpandedCardClick = {
|
||||||
|
onSearchTriggered(searchQuery)
|
||||||
|
},
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Composable
|
||||||
|
private fun RecentSearchesBody(
|
||||||
|
onClearRecentSearches: () -> Unit,
|
||||||
|
onRecentSearchClicked: (String) -> Unit,
|
||||||
|
recentSearchQueries: List<String>,
|
||||||
|
) {
|
||||||
|
Column {
|
||||||
|
Row(
|
||||||
|
horizontalArrangement = Arrangement.SpaceBetween,
|
||||||
|
verticalAlignment = Alignment.CenterVertically,
|
||||||
|
modifier = Modifier.fillMaxWidth(),
|
||||||
|
) {
|
||||||
|
Text(
|
||||||
|
text = buildAnnotatedString {
|
||||||
|
withStyle(style = SpanStyle(fontWeight = FontWeight.Bold)) {
|
||||||
|
append(stringResource(id = searchR.string.recent_searches))
|
||||||
|
}
|
||||||
|
},
|
||||||
|
modifier = Modifier.padding(horizontal = 16.dp, vertical = 8.dp),
|
||||||
|
)
|
||||||
|
if (recentSearchQueries.isNotEmpty()) {
|
||||||
|
IconButton(
|
||||||
|
onClick = {
|
||||||
|
onClearRecentSearches()
|
||||||
|
},
|
||||||
|
modifier = Modifier.padding(horizontal = 16.dp),
|
||||||
|
) {
|
||||||
|
Icon(
|
||||||
|
imageVector = NiaIcons.Close,
|
||||||
|
contentDescription = stringResource(
|
||||||
|
id = searchR.string.clear_recent_searches_content_desc,
|
||||||
|
),
|
||||||
|
tint = MaterialTheme.colorScheme.onSurface,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
LazyColumn(modifier = Modifier.padding(horizontal = 16.dp)) {
|
||||||
|
items(recentSearchQueries) { recentSearch ->
|
||||||
|
Text(
|
||||||
|
text = recentSearch,
|
||||||
|
style = MaterialTheme.typography.headlineSmall,
|
||||||
|
modifier = Modifier
|
||||||
|
.padding(vertical = 16.dp)
|
||||||
|
.clickable {
|
||||||
|
onRecentSearchClicked(recentSearch)
|
||||||
|
}
|
||||||
|
.fillMaxWidth(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Composable
|
||||||
|
private fun SearchToolbar(
|
||||||
|
modifier: Modifier = Modifier,
|
||||||
|
onBackClick: () -> Unit,
|
||||||
|
onSearchQueryChanged: (String) -> Unit,
|
||||||
|
searchQuery: String = "",
|
||||||
|
onSearchTriggered: (String) -> Unit,
|
||||||
|
) {
|
||||||
|
Row(
|
||||||
|
verticalAlignment = Alignment.CenterVertically,
|
||||||
|
modifier = modifier.fillMaxWidth(),
|
||||||
|
) {
|
||||||
|
IconButton(onClick = { onBackClick() }) {
|
||||||
|
Icon(
|
||||||
|
imageVector = NiaIcons.ArrowBack,
|
||||||
|
contentDescription = stringResource(
|
||||||
|
id = string.back,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
SearchTextField(
|
||||||
|
onSearchQueryChanged = onSearchQueryChanged,
|
||||||
|
onSearchTriggered = onSearchTriggered,
|
||||||
|
searchQuery = searchQuery,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@OptIn(ExperimentalMaterial3Api::class, ExperimentalComposeUiApi::class)
|
||||||
|
@Composable
|
||||||
|
private fun SearchTextField(
|
||||||
|
onSearchQueryChanged: (String) -> Unit,
|
||||||
|
searchQuery: String,
|
||||||
|
onSearchTriggered: (String) -> Unit,
|
||||||
|
) {
|
||||||
|
val focusRequester = remember { FocusRequester() }
|
||||||
|
val keyboardController = LocalSoftwareKeyboardController.current
|
||||||
|
|
||||||
|
val onSearchExplicitlyTriggered = {
|
||||||
|
keyboardController?.hide()
|
||||||
|
onSearchTriggered(searchQuery)
|
||||||
|
}
|
||||||
|
|
||||||
|
TextField(
|
||||||
|
colors = TextFieldDefaults.textFieldColors(
|
||||||
|
focusedIndicatorColor = Color.Transparent,
|
||||||
|
unfocusedIndicatorColor = Color.Transparent,
|
||||||
|
disabledIndicatorColor = Color.Transparent,
|
||||||
|
),
|
||||||
|
leadingIcon = {
|
||||||
|
Icon(
|
||||||
|
imageVector = NiaIcons.Search,
|
||||||
|
contentDescription = stringResource(
|
||||||
|
id = searchR.string.search,
|
||||||
|
),
|
||||||
|
tint = MaterialTheme.colorScheme.onSurface,
|
||||||
|
)
|
||||||
|
},
|
||||||
|
trailingIcon = {
|
||||||
|
if (searchQuery.isNotEmpty()) {
|
||||||
|
IconButton(
|
||||||
|
onClick = {
|
||||||
|
onSearchQueryChanged("")
|
||||||
|
},
|
||||||
|
) {
|
||||||
|
Icon(
|
||||||
|
imageVector = NiaIcons.Close,
|
||||||
|
contentDescription = stringResource(
|
||||||
|
id = searchR.string.clear_search_text_content_desc,
|
||||||
|
),
|
||||||
|
tint = MaterialTheme.colorScheme.onSurface,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
onValueChange = {
|
||||||
|
if (!it.contains("\n")) {
|
||||||
|
onSearchQueryChanged(it)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
modifier = Modifier
|
||||||
|
.fillMaxWidth()
|
||||||
|
.padding(16.dp)
|
||||||
|
.focusRequester(focusRequester)
|
||||||
|
.onKeyEvent {
|
||||||
|
if (it.key == Key.Enter) {
|
||||||
|
onSearchExplicitlyTriggered()
|
||||||
|
true
|
||||||
|
} else {
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.testTag("searchTextField"),
|
||||||
|
shape = RoundedCornerShape(32.dp),
|
||||||
|
value = searchQuery,
|
||||||
|
keyboardOptions = KeyboardOptions(
|
||||||
|
imeAction = ImeAction.Search,
|
||||||
|
),
|
||||||
|
keyboardActions = KeyboardActions(
|
||||||
|
onSearch = {
|
||||||
|
onSearchExplicitlyTriggered()
|
||||||
|
},
|
||||||
|
),
|
||||||
|
maxLines = 1,
|
||||||
|
singleLine = true,
|
||||||
|
)
|
||||||
|
LaunchedEffect(Unit) {
|
||||||
|
focusRequester.requestFocus()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Preview
|
||||||
|
@Composable
|
||||||
|
private fun SearchToolbarPreview() {
|
||||||
|
NiaTheme {
|
||||||
|
SearchToolbar(
|
||||||
|
onBackClick = {},
|
||||||
|
onSearchQueryChanged = {},
|
||||||
|
onSearchTriggered = {},
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Preview
|
||||||
|
@Composable
|
||||||
|
private fun EmptySearchResultColumnPreview() {
|
||||||
|
NiaTheme {
|
||||||
|
EmptySearchResultBody(
|
||||||
|
onInterestsClick = {},
|
||||||
|
searchQuery = "C++",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Preview
|
||||||
|
@Composable
|
||||||
|
private fun RecentSearchesBodyPreview() {
|
||||||
|
NiaTheme {
|
||||||
|
RecentSearchesBody(
|
||||||
|
onClearRecentSearches = {},
|
||||||
|
onRecentSearchClicked = {},
|
||||||
|
recentSearchQueries = listOf("kotlin", "jetpack compose", "testing"),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Preview
|
||||||
|
@Composable
|
||||||
|
private fun SearchNotReadyBodyPreview() {
|
||||||
|
NiaTheme {
|
||||||
|
SearchNotReadyBody()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@DevicePreviews
|
||||||
|
@Composable
|
||||||
|
private fun SearchScreenPreview(
|
||||||
|
@PreviewParameter(SearchUiStatePreviewParameterProvider::class)
|
||||||
|
searchResultUiState: SearchResultUiState,
|
||||||
|
) {
|
||||||
|
NiaTheme {
|
||||||
|
SearchScreen(searchResultUiState = searchResultUiState)
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,38 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.feature.search
|
||||||
|
|
||||||
|
import androidx.compose.ui.tooling.preview.PreviewParameterProvider
|
||||||
|
import com.google.samples.apps.nowinandroid.core.model.data.FollowableTopic
|
||||||
|
import com.google.samples.apps.nowinandroid.core.ui.PreviewParameterData.newsResources
|
||||||
|
import com.google.samples.apps.nowinandroid.core.ui.PreviewParameterData.topics
|
||||||
|
|
||||||
|
/* ktlint-disable max-line-length */
|
||||||
|
/**
|
||||||
|
* This [PreviewParameterProvider](https://developer.android.com/reference/kotlin/androidx/compose/ui/tooling/preview/PreviewParameterProvider)
|
||||||
|
* provides list of [SearchResultUiState] for Composable previews.
|
||||||
|
*/
|
||||||
|
class SearchUiStatePreviewParameterProvider : PreviewParameterProvider<SearchResultUiState> {
|
||||||
|
override val values: Sequence<SearchResultUiState> = sequenceOf(
|
||||||
|
SearchResultUiState.Success(
|
||||||
|
topics = topics.mapIndexed { i, topic ->
|
||||||
|
FollowableTopic(topic = topic, isFollowed = i % 2 == 0)
|
||||||
|
},
|
||||||
|
newsResources = newsResources,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
@ -0,0 +1,122 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.feature.search
|
||||||
|
|
||||||
|
import androidx.lifecycle.SavedStateHandle
|
||||||
|
import androidx.lifecycle.ViewModel
|
||||||
|
import androidx.lifecycle.viewModelScope
|
||||||
|
import com.google.samples.apps.nowinandroid.core.data.repository.RecentSearchRepository
|
||||||
|
import com.google.samples.apps.nowinandroid.core.domain.GetRecentSearchQueriesUseCase
|
||||||
|
import com.google.samples.apps.nowinandroid.core.domain.GetSearchContentsCountUseCase
|
||||||
|
import com.google.samples.apps.nowinandroid.core.domain.GetSearchContentsUseCase
|
||||||
|
import com.google.samples.apps.nowinandroid.core.result.Result
|
||||||
|
import com.google.samples.apps.nowinandroid.core.result.asResult
|
||||||
|
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||||
|
import kotlinx.coroutines.flow.SharingStarted
|
||||||
|
import kotlinx.coroutines.flow.StateFlow
|
||||||
|
import kotlinx.coroutines.flow.flatMapLatest
|
||||||
|
import kotlinx.coroutines.flow.flowOf
|
||||||
|
import kotlinx.coroutines.flow.map
|
||||||
|
import kotlinx.coroutines.flow.stateIn
|
||||||
|
import kotlinx.coroutines.launch
|
||||||
|
import javax.inject.Inject
|
||||||
|
|
||||||
|
@HiltViewModel
|
||||||
|
class SearchViewModel @Inject constructor(
|
||||||
|
getSearchContentsUseCase: GetSearchContentsUseCase,
|
||||||
|
getSearchContentsCountUseCase: GetSearchContentsCountUseCase,
|
||||||
|
recentSearchQueriesUseCase: GetRecentSearchQueriesUseCase,
|
||||||
|
private val recentSearchRepository: RecentSearchRepository,
|
||||||
|
private val savedStateHandle: SavedStateHandle,
|
||||||
|
) : ViewModel() {
|
||||||
|
|
||||||
|
val searchQuery = savedStateHandle.getStateFlow(SEARCH_QUERY, "")
|
||||||
|
|
||||||
|
val searchResultUiState: StateFlow<SearchResultUiState> =
|
||||||
|
getSearchContentsCountUseCase().flatMapLatest { totalCount ->
|
||||||
|
if (totalCount < SEARCH_MIN_FTS_ENTITY_COUNT) {
|
||||||
|
flowOf(SearchResultUiState.SearchNotReady)
|
||||||
|
} else {
|
||||||
|
searchQuery.flatMapLatest { query ->
|
||||||
|
if (query.length < SEARCH_QUERY_MIN_LENGTH) {
|
||||||
|
flowOf(SearchResultUiState.EmptyQuery)
|
||||||
|
} else {
|
||||||
|
getSearchContentsUseCase(query).asResult().map {
|
||||||
|
when (it) {
|
||||||
|
is Result.Success -> {
|
||||||
|
SearchResultUiState.Success(
|
||||||
|
topics = it.data.topics,
|
||||||
|
newsResources = it.data.newsResources,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
is Result.Loading -> {
|
||||||
|
SearchResultUiState.Loading
|
||||||
|
}
|
||||||
|
|
||||||
|
is Result.Error -> {
|
||||||
|
SearchResultUiState.LoadFailed
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}.stateIn(
|
||||||
|
scope = viewModelScope,
|
||||||
|
started = SharingStarted.WhileSubscribed(5_000),
|
||||||
|
initialValue = SearchResultUiState.Loading,
|
||||||
|
)
|
||||||
|
|
||||||
|
val recentSearchQueriesUiState: StateFlow<RecentSearchQueriesUiState> =
|
||||||
|
recentSearchQueriesUseCase().map(RecentSearchQueriesUiState::Success)
|
||||||
|
.stateIn(
|
||||||
|
scope = viewModelScope,
|
||||||
|
started = SharingStarted.WhileSubscribed(5_000),
|
||||||
|
initialValue = RecentSearchQueriesUiState.Loading,
|
||||||
|
)
|
||||||
|
|
||||||
|
fun onSearchQueryChanged(query: String) {
|
||||||
|
savedStateHandle[SEARCH_QUERY] = query
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called when the search action is explicitly triggered by the user. For example, when the
|
||||||
|
* search icon is tapped in the IME or when the enter key is pressed in the search text field.
|
||||||
|
*
|
||||||
|
* The search results are displayed on the fly as the user types, but to explicitly save the
|
||||||
|
* search query in the search text field, defining this method.
|
||||||
|
*/
|
||||||
|
fun onSearchTriggered(query: String) {
|
||||||
|
viewModelScope.launch {
|
||||||
|
recentSearchRepository.insertOrReplaceRecentSearch(query)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fun clearRecentSearches() {
|
||||||
|
viewModelScope.launch {
|
||||||
|
recentSearchRepository.clearRecentSearches()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Minimum length where search query is considered as [SearchResultUiState.EmptyQuery] */
|
||||||
|
private const val SEARCH_QUERY_MIN_LENGTH = 2
|
||||||
|
|
||||||
|
/** Minimum number of the fts table's entity count where it's considered as search is not ready */
|
||||||
|
private const val SEARCH_MIN_FTS_ENTITY_COUNT = 1
|
||||||
|
private const val SEARCH_QUERY = "searchQuery"
|
||||||
@ -0,0 +1,45 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.feature.search.navigation
|
||||||
|
|
||||||
|
import androidx.navigation.NavController
|
||||||
|
import androidx.navigation.NavGraphBuilder
|
||||||
|
import androidx.navigation.NavOptions
|
||||||
|
import androidx.navigation.compose.composable
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.search.SearchRoute
|
||||||
|
|
||||||
|
const val searchRoute = "search_route"
|
||||||
|
|
||||||
|
fun NavController.navigateToSearch(navOptions: NavOptions? = null) {
|
||||||
|
this.navigate(searchRoute, navOptions)
|
||||||
|
}
|
||||||
|
|
||||||
|
fun NavGraphBuilder.searchScreen(
|
||||||
|
onBackClick: () -> Unit,
|
||||||
|
onInterestsClick: () -> Unit,
|
||||||
|
onTopicClick: (String) -> Unit,
|
||||||
|
) {
|
||||||
|
// TODO: Handle back stack for each top-level destination. At the moment each top-level
|
||||||
|
// destination may have own search screen's back stack.
|
||||||
|
composable(route = searchRoute) {
|
||||||
|
SearchRoute(
|
||||||
|
onBackClick = onBackClick,
|
||||||
|
onInterestsClick = onInterestsClick,
|
||||||
|
onTopicClick = onTopicClick,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,29 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!--
|
||||||
|
Copyright 2023 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
|
||||||
|
|
||||||
|
http://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.
|
||||||
|
-->
|
||||||
|
<resources>
|
||||||
|
<string name="search">Search</string>
|
||||||
|
<string name="clear_search_text_content_desc">Clear search text</string>
|
||||||
|
<string name="search_result_not_found">Sorry, there is no content found for your search \"%1$s\"</string>
|
||||||
|
<string name="search_not_ready">Sorry, we are still processing the search index. Please come back later</string>
|
||||||
|
<string name="try_another_search">Try another search or explorer </string>
|
||||||
|
<string name="interests">Interests</string>
|
||||||
|
<string name="to_browse_topics"> to browse topics</string>
|
||||||
|
<string name="topics">Topics</string>
|
||||||
|
<string name="updates">Updates</string>
|
||||||
|
<string name="recent_searches">Recent searches</string>
|
||||||
|
<string name="clear_recent_searches_content_desc">Clear searches</string>
|
||||||
|
</resources>
|
||||||
@ -0,0 +1,128 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2023 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.feature.search
|
||||||
|
|
||||||
|
import androidx.lifecycle.SavedStateHandle
|
||||||
|
import com.google.samples.apps.nowinandroid.core.domain.GetRecentSearchQueriesUseCase
|
||||||
|
import com.google.samples.apps.nowinandroid.core.domain.GetSearchContentsCountUseCase
|
||||||
|
import com.google.samples.apps.nowinandroid.core.domain.GetSearchContentsUseCase
|
||||||
|
import com.google.samples.apps.nowinandroid.core.testing.data.newsResourcesTestData
|
||||||
|
import com.google.samples.apps.nowinandroid.core.testing.data.topicsTestData
|
||||||
|
import com.google.samples.apps.nowinandroid.core.testing.repository.TestRecentSearchRepository
|
||||||
|
import com.google.samples.apps.nowinandroid.core.testing.repository.TestSearchContentsRepository
|
||||||
|
import com.google.samples.apps.nowinandroid.core.testing.repository.TestUserDataRepository
|
||||||
|
import com.google.samples.apps.nowinandroid.core.testing.util.MainDispatcherRule
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.search.RecentSearchQueriesUiState.Success
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.search.SearchResultUiState.EmptyQuery
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.search.SearchResultUiState.Loading
|
||||||
|
import com.google.samples.apps.nowinandroid.feature.search.SearchResultUiState.SearchNotReady
|
||||||
|
import kotlinx.coroutines.flow.collect
|
||||||
|
import kotlinx.coroutines.launch
|
||||||
|
import kotlinx.coroutines.test.UnconfinedTestDispatcher
|
||||||
|
import kotlinx.coroutines.test.runTest
|
||||||
|
import org.junit.Before
|
||||||
|
import org.junit.Rule
|
||||||
|
import org.junit.Test
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
import kotlin.test.assertIs
|
||||||
|
|
||||||
|
/**
|
||||||
|
* To learn more about how this test handles Flows created with stateIn, see
|
||||||
|
* https://developer.android.com/kotlin/flow/test#statein
|
||||||
|
*/
|
||||||
|
class SearchViewModelTest {
|
||||||
|
|
||||||
|
@get:Rule
|
||||||
|
val dispatcherRule = MainDispatcherRule()
|
||||||
|
|
||||||
|
private val userDataRepository = TestUserDataRepository()
|
||||||
|
private val searchContentsRepository = TestSearchContentsRepository()
|
||||||
|
private val getSearchContentsUseCase = GetSearchContentsUseCase(
|
||||||
|
searchContentsRepository = searchContentsRepository,
|
||||||
|
userDataRepository = userDataRepository,
|
||||||
|
)
|
||||||
|
private val recentSearchRepository = TestRecentSearchRepository()
|
||||||
|
private val getRecentQueryUseCase = GetRecentSearchQueriesUseCase(recentSearchRepository)
|
||||||
|
private val getSearchContentsCountUseCase = GetSearchContentsCountUseCase(searchContentsRepository)
|
||||||
|
private lateinit var viewModel: SearchViewModel
|
||||||
|
|
||||||
|
@Before
|
||||||
|
fun setup() {
|
||||||
|
viewModel = SearchViewModel(
|
||||||
|
getSearchContentsUseCase = getSearchContentsUseCase,
|
||||||
|
getSearchContentsCountUseCase = getSearchContentsCountUseCase,
|
||||||
|
recentSearchQueriesUseCase = getRecentQueryUseCase,
|
||||||
|
savedStateHandle = SavedStateHandle(),
|
||||||
|
recentSearchRepository = recentSearchRepository,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun stateIsInitiallyLoading() = runTest {
|
||||||
|
assertEquals(Loading, viewModel.searchResultUiState.value)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun stateIsEmptyQuery_withEmptySearchQuery() = runTest {
|
||||||
|
searchContentsRepository.addNewsResources(newsResourcesTestData)
|
||||||
|
searchContentsRepository.addTopics(topicsTestData)
|
||||||
|
val collectJob = launch(UnconfinedTestDispatcher()) { viewModel.searchResultUiState.collect() }
|
||||||
|
|
||||||
|
viewModel.onSearchQueryChanged("")
|
||||||
|
|
||||||
|
assertEquals(EmptyQuery, viewModel.searchResultUiState.value)
|
||||||
|
|
||||||
|
collectJob.cancel()
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun emptyResultIsReturned_withNotMatchingQuery() = runTest {
|
||||||
|
val collectJob = launch(UnconfinedTestDispatcher()) { viewModel.searchResultUiState.collect() }
|
||||||
|
|
||||||
|
viewModel.onSearchQueryChanged("XXX")
|
||||||
|
searchContentsRepository.addNewsResources(newsResourcesTestData)
|
||||||
|
searchContentsRepository.addTopics(topicsTestData)
|
||||||
|
|
||||||
|
val result = viewModel.searchResultUiState.value
|
||||||
|
// TODO: Figure out to get the latest emitted ui State? The result is emitted as EmptyQuery
|
||||||
|
// assertIs<Success>(result)
|
||||||
|
|
||||||
|
collectJob.cancel()
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun recentSearches_verifyUiStateIsSuccess() = runTest {
|
||||||
|
val collectJob = launch(UnconfinedTestDispatcher()) { viewModel.recentSearchQueriesUiState.collect() }
|
||||||
|
viewModel.onSearchTriggered("kotlin")
|
||||||
|
|
||||||
|
val result = viewModel.recentSearchQueriesUiState.value
|
||||||
|
assertIs<Success>(result)
|
||||||
|
|
||||||
|
collectJob.cancel()
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun searchNotReady_withNoFtsTableEntity() = runTest {
|
||||||
|
val collectJob = launch(UnconfinedTestDispatcher()) { viewModel.searchResultUiState.collect() }
|
||||||
|
|
||||||
|
viewModel.onSearchQueryChanged("")
|
||||||
|
|
||||||
|
assertEquals(SearchNotReady, viewModel.searchResultUiState.value)
|
||||||
|
|
||||||
|
collectJob.cancel()
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in new issue