Fix disappearing placeholders (#2309)

* add getNextPlaceholderIdAfter to TimelineDao

* fix disappearing placeholders

* fix disappearing placeholders
This commit is contained in:
Konrad Pozniak 2022-02-03 18:51:15 +01:00 committed by GitHub
parent c3da6f901f
commit 61ba6fe181
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 178 additions and 21 deletions

View File

@ -53,11 +53,19 @@ class CachedTimelineRemoteMediator(
try { try {
var dbEmpty = false var dbEmpty = false
val topPlaceholderId = if (loadType == LoadType.REFRESH) {
timelineDao.getTopPlaceholderId(activeAccount.id)
} else {
null // don't execute the query if it is not needed
}
if (!initialRefresh && loadType == LoadType.REFRESH) { if (!initialRefresh && loadType == LoadType.REFRESH) {
val topId = timelineDao.getTopId(activeAccount.id) val topId = timelineDao.getTopId(activeAccount.id)
topId?.let { cachedTopId -> topId?.let { cachedTopId ->
val statusResponse = api.homeTimeline( val statusResponse = api.homeTimeline(
maxId = cachedTopId, maxId = cachedTopId,
sinceId = topPlaceholderId, // so already existing placeholders don't get accidentally overwritten
limit = state.config.pageSize limit = state.config.pageSize
).await() ).await()
@ -74,7 +82,7 @@ class CachedTimelineRemoteMediator(
val statusResponse = when (loadType) { val statusResponse = when (loadType) {
LoadType.REFRESH -> { LoadType.REFRESH -> {
api.homeTimeline(limit = state.config.pageSize).await() api.homeTimeline(sinceId = topPlaceholderId, limit = state.config.pageSize).await()
} }
LoadType.PREPEND -> { LoadType.PREPEND -> {
return MediatorResult.Success(endOfPaginationReached = true) return MediatorResult.Success(endOfPaginationReached = true)

View File

@ -128,7 +128,9 @@ class CachedTimelineViewModel @Inject constructor(
timelineDao.insertStatus(Placeholder(placeholderId, loading = true).toEntity(activeAccount.id)) timelineDao.insertStatus(Placeholder(placeholderId, loading = true).toEntity(activeAccount.id))
val response = api.homeTimeline(maxId = placeholderId.inc(), limit = 20).await() val nextPlaceholderId = timelineDao.getNextPlaceholderIdAfter(activeAccount.id, placeholderId)
val response = api.homeTimeline(maxId = placeholderId.inc(), sinceId = nextPlaceholderId, limit = 20).await()
val statuses = response.body() val statuses = response.body()
if (!response.isSuccessful || statuses == null) { if (!response.isSuccessful || statuses == null) {

View File

@ -142,4 +142,10 @@ AND timelineUserId = :accountId
@Query("SELECT serverId FROM TimelineStatusEntity WHERE timelineUserId = :accountId ORDER BY LENGTH(serverId) DESC, serverId DESC LIMIT 1") @Query("SELECT serverId FROM TimelineStatusEntity WHERE timelineUserId = :accountId ORDER BY LENGTH(serverId) DESC, serverId DESC LIMIT 1")
abstract suspend fun getTopId(accountId: Long): String? abstract suspend fun getTopId(accountId: Long): String?
@Query("SELECT serverId FROM TimelineStatusEntity WHERE timelineUserId = :accountId AND authorServerId IS NULL ORDER BY LENGTH(serverId) DESC, serverId DESC LIMIT 1")
abstract suspend fun getTopPlaceholderId(accountId: Long): String?
@Query("SELECT serverId FROM TimelineStatusEntity WHERE timelineUserId = :accountId AND authorServerId IS NULL AND (LENGTH(:serverId) > LENGTH(serverId) OR (LENGTH(:serverId) = LENGTH(serverId) AND :serverId > serverId)) ORDER BY LENGTH(serverId) DESC, serverId DESC LIMIT 1")
abstract suspend fun getNextPlaceholderIdAfter(accountId: Long, serverId: String): String?
} }

View File

@ -26,6 +26,7 @@ import kotlinx.coroutines.runBlocking
import okhttp3.ResponseBody.Companion.toResponseBody import okhttp3.ResponseBody.Companion.toResponseBody
import org.junit.After import org.junit.After
import org.junit.Assert.assertEquals import org.junit.Assert.assertEquals
import org.junit.Assert.assertFalse
import org.junit.Assert.assertTrue import org.junit.Assert.assertTrue
import org.junit.Before import org.junit.Before
import org.junit.Test import org.junit.Test
@ -367,6 +368,70 @@ class CachedTimelineRemoteMediatorTest {
) )
} }
@Test
@ExperimentalPagingApi
fun `should not remove placeholder in timeline`() {
val statusesAlreadyInDb = listOf(
mockStatusEntityWithAccount("8"),
mockStatusEntityWithAccount("7"),
mockPlaceholderEntityWithAccount("6"),
mockStatusEntityWithAccount("1"),
)
db.insert(statusesAlreadyInDb)
val remoteMediator = CachedTimelineRemoteMediator(
accountManager = accountManager,
api = mock {
on { homeTimeline(sinceId = "6", limit = 20) } doReturn Single.just(
Response.success(
listOf(
mockStatus("9"),
mockStatus("8"),
mockStatus("7")
)
)
)
on { homeTimeline(maxId = "8", sinceId = "6", limit = 20) } doReturn Single.just(
Response.success(
listOf(
mockStatus("8"),
mockStatus("7")
)
)
)
},
db = db,
gson = Gson()
)
val state = state(
listOf(
PagingSource.LoadResult.Page(
data = statusesAlreadyInDb,
prevKey = null,
nextKey = 0
)
)
)
val result = runBlocking { remoteMediator.load(LoadType.REFRESH, state) }
assertTrue(result is RemoteMediator.MediatorResult.Success)
assertFalse((result as RemoteMediator.MediatorResult.Success).endOfPaginationReached)
db.assertStatuses(
listOf(
mockStatusEntityWithAccount("9"),
mockStatusEntityWithAccount("8"),
mockStatusEntityWithAccount("7"),
mockPlaceholderEntityWithAccount("6"),
mockStatusEntityWithAccount("1"),
)
)
}
@Test @Test
@ExperimentalPagingApi @ExperimentalPagingApi
fun `should append statuses`() { fun `should append statuses`() {
@ -434,7 +499,9 @@ class CachedTimelineRemoteMediatorTest {
private fun AppDatabase.insert(statuses: List<TimelineStatusWithAccount>) { private fun AppDatabase.insert(statuses: List<TimelineStatusWithAccount>) {
runBlocking { runBlocking {
statuses.forEach { statusWithAccount -> statuses.forEach { statusWithAccount ->
if (statusWithAccount.status.authorServerId != null) {
timelineDao().insertAccount(statusWithAccount.account) timelineDao().insertAccount(statusWithAccount.account)
}
statusWithAccount.reblogAccount?.let { account -> statusWithAccount.reblogAccount?.let { account ->
timelineDao().insertAccount(account) timelineDao().insertAccount(account)
} }

View File

@ -77,3 +77,12 @@ fun mockStatusEntityWithAccount(
) )
} }
} }
fun mockPlaceholderEntityWithAccount(
id: String,
userId: Long = 1,
): TimelineStatusWithAccount {
return TimelineStatusWithAccount().apply {
status = Placeholder(id, false).toEntity(userId)
}
}

View File

@ -6,6 +6,8 @@ import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.platform.app.InstrumentationRegistry import androidx.test.platform.app.InstrumentationRegistry
import com.google.gson.Gson import com.google.gson.Gson
import com.keylesspalace.tusky.appstore.CacheUpdater import com.keylesspalace.tusky.appstore.CacheUpdater
import com.keylesspalace.tusky.components.timeline.Placeholder
import com.keylesspalace.tusky.components.timeline.toEntity
import com.keylesspalace.tusky.entity.Status import com.keylesspalace.tusky.entity.Status
import kotlinx.coroutines.runBlocking import kotlinx.coroutines.runBlocking
import org.junit.After import org.junit.After
@ -219,26 +221,28 @@ class TimelineDaoTest {
@Test @Test
fun `should return correct topId`() = runBlocking { fun `should return correct topId`() = runBlocking {
val status1 = makeStatus( val statusData = listOf(
makeStatus(
statusId = 4, statusId = 4,
accountId = 1, accountId = 1,
domain = "mastodon.test", domain = "mastodon.test",
authorServerId = "1" authorServerId = "1"
) ),
val status2 = makeStatus( makeStatus(
statusId = 33, statusId = 33,
accountId = 1, accountId = 1,
domain = "mastodon.test", domain = "mastodon.test",
authorServerId = "2" authorServerId = "2"
) ),
val status3 = makeStatus( makeStatus(
statusId = 22, statusId = 22,
accountId = 1, accountId = 1,
domain = "mastodon.test", domain = "mastodon.test",
authorServerId = "2" authorServerId = "2"
) )
)
for ((status, author, reblogAuthor) in listOf(status1, status2, status3)) { for ((status, author, reblogAuthor) in statusData) {
timelineDao.insertAccount(author) timelineDao.insertAccount(author)
reblogAuthor?.let { reblogAuthor?.let {
timelineDao.insertAccount(it) timelineDao.insertAccount(it)
@ -249,6 +253,59 @@ class TimelineDaoTest {
assertEquals("33", timelineDao.getTopId(1)) assertEquals("33", timelineDao.getTopId(1))
} }
@Test
fun `should return correct placeholderId after other ids`() = runBlocking {
val statusData = listOf(
makeStatus(statusId = 1000),
makePlaceholder(id = 99),
makeStatus(statusId = 97),
makeStatus(statusId = 95),
makePlaceholder(id = 94),
makeStatus(statusId = 90)
)
for ((status, author, reblogAuthor) in statusData) {
author?.let {
timelineDao.insertAccount(it)
}
reblogAuthor?.let {
timelineDao.insertAccount(it)
}
timelineDao.insertStatus(status)
}
assertEquals("99", timelineDao.getNextPlaceholderIdAfter(1, "1000"))
assertEquals("94", timelineDao.getNextPlaceholderIdAfter(1, "97"))
assertNull(timelineDao.getNextPlaceholderIdAfter(1, "90"))
}
@Test
fun `should return correct top placeholderId`() = runBlocking {
val statusData = listOf(
makeStatus(statusId = 1000),
makePlaceholder(id = 99),
makeStatus(statusId = 97),
makePlaceholder(id = 96),
makeStatus(statusId = 90),
makePlaceholder(id = 80),
makeStatus(statusId = 77)
)
for ((status, author, reblogAuthor) in statusData) {
author?.let {
timelineDao.insertAccount(it)
}
reblogAuthor?.let {
timelineDao.insertAccount(it)
}
timelineDao.insertStatus(status)
}
assertEquals("99", timelineDao.getTopPlaceholderId(1))
}
private fun makeStatus( private fun makeStatus(
accountId: Long = 1, accountId: Long = 1,
statusId: Long = 10, statusId: Long = 10,
@ -317,6 +374,14 @@ class TimelineDaoTest {
return Triple(status, author, reblogAuthor) return Triple(status, author, reblogAuthor)
} }
private fun makePlaceholder(
accountId: Long = 1,
id: Long
): Triple<TimelineStatusEntity, TimelineAccountEntity?, TimelineAccountEntity?> {
val placeholder = Placeholder(id.toString(), false).toEntity(accountId)
return Triple(placeholder, null, null)
}
private fun assertStatuses( private fun assertStatuses(
expected: List<Triple<TimelineStatusEntity, TimelineAccountEntity, TimelineAccountEntity?>>, expected: List<Triple<TimelineStatusEntity, TimelineAccountEntity, TimelineAccountEntity?>>,
provided: List<TimelineStatusWithAccount> provided: List<TimelineStatusWithAccount>