Display only valid emojis in recent emoji list (#5612)

* Create `:libraries:recentemojis` and move `AddRecentEmoji` and `GetRecentEmojis` there

- Make sure `GetRecentEmojis` won't return duplicate or invalid emojis.
- `ActionListPresenter` now handles merging suggested and recent emojis, not `ActionListView`.
This commit is contained in:
Jorge Martin Espinosa 2025-10-30 16:27:51 +01:00 committed by GitHub
parent eb08639776
commit 353c00e032
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
24 changed files with 351 additions and 111 deletions

View file

@ -0,0 +1,19 @@
/*
* Copyright 2025 New Vector Ltd.
*
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
* Please see LICENSE files in the repository root for full details.
*/
package io.element.android.libraries.recentemojis.impl
import android.content.Context
import io.element.android.emojibasebindings.EmojibaseDatasource
import io.element.android.emojibasebindings.EmojibaseStore
import io.element.android.libraries.recentemojis.api.EmojibaseProvider
class DefaultEmojibaseProvider(val context: Context) : EmojibaseProvider {
override val emojibaseStore: EmojibaseStore by lazy {
EmojibaseDatasource().load(context)
}
}

View file

@ -0,0 +1,37 @@
/*
* Copyright 2025 New Vector Ltd.
*
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
* Please see LICENSE files in the repository root for full details.
*/
package io.element.android.libraries.recentemojis.impl
import dev.zacsweers.metro.ContributesBinding
import io.element.android.libraries.core.coroutine.CoroutineDispatchers
import io.element.android.libraries.di.SessionScope
import io.element.android.libraries.matrix.api.MatrixClient
import io.element.android.libraries.recentemojis.api.EmojibaseProvider
import io.element.android.libraries.recentemojis.api.GetRecentEmojis
import kotlinx.collections.immutable.ImmutableList
import kotlinx.collections.immutable.toImmutableList
import kotlinx.coroutines.withContext
@ContributesBinding(SessionScope::class)
class DefaultGetRecentEmojis(
private val client: MatrixClient,
private val dispatchers: CoroutineDispatchers,
private val emojibaseProvider: EmojibaseProvider,
) : GetRecentEmojis {
override suspend operator fun invoke(): Result<ImmutableList<String>> = withContext(dispatchers.io) {
val allEmojis = emojibaseProvider.emojibaseStore.allEmojis
client.getRecentEmojis()
.map { emojis ->
// Remove any possible duplicates
emojis.distinct()
// Return only those emojis that are valid
.filter { recent -> allEmojis.any { recent == it.unicode } }
.toImmutableList()
}
}
}

View file

@ -0,0 +1,68 @@
/*
* Copyright 2025 New Vector Ltd.
*
* SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
* Please see LICENSE files in the repository root for full details.
*/
package io.element.android.libraries.recentemojis.impl
import com.google.common.truth.Truth.assertThat
import io.element.android.emojibasebindings.Emoji
import io.element.android.emojibasebindings.EmojibaseCategory
import io.element.android.emojibasebindings.EmojibaseCategory.People
import io.element.android.libraries.matrix.test.FakeMatrixClient
import io.element.android.libraries.recentemojis.test.FakeEmojibaseProvider
import io.element.android.tests.testutils.testCoroutineDispatchers
import kotlinx.collections.immutable.ImmutableList
import kotlinx.collections.immutable.ImmutableMap
import kotlinx.collections.immutable.persistentListOf
import kotlinx.collections.immutable.persistentMapOf
import kotlinx.collections.immutable.toImmutableList
import kotlinx.coroutines.test.TestScope
import kotlinx.coroutines.test.runTest
import org.junit.Test
class DefaultGetRecentEmojisTest {
@Test
fun `invoke - deduplicates results`() = runTest {
val recentEmojiResult = persistentListOf(":)", ":D", ":)")
val getRecentEmojis = createDefaultGetRecentEmojis(
recentEmojis = { Result.success(recentEmojiResult) },
emojibaseContents = persistentMapOf(People to recentEmojiResult.map { emoji(it) }.toImmutableList())
)
assertThat(getRecentEmojis()).isEqualTo(Result.success(persistentListOf(":)", ":D")))
}
@Test
fun `invoke - removes non-standard emojis`() = runTest {
val recentEmojiResult = persistentListOf(":)", ":D", "Custom reaction")
val getRecentEmojis = createDefaultGetRecentEmojis(
recentEmojis = { Result.success(recentEmojiResult) },
emojibaseContents = persistentMapOf(
People to persistentListOf(emoji(":)"), emoji(":D"))
)
)
assertThat(getRecentEmojis()).isEqualTo(Result.success(persistentListOf(":)", ":D")))
}
private fun emoji(unicode: String) = Emoji(
hexcode = "",
label = "",
tags = null,
shortcodes = persistentListOf(),
unicode = unicode,
skins = null,
)
private fun TestScope.createDefaultGetRecentEmojis(
recentEmojis: () -> Result<List<String>> = { Result.success(emptyList()) },
emojibaseContents: ImmutableMap<EmojibaseCategory, ImmutableList<Emoji>> = persistentMapOf(People to persistentListOf(emoji(":)"))),
) = DefaultGetRecentEmojis(
client = FakeMatrixClient(getRecentEmojisLambda = recentEmojis),
dispatchers = testCoroutineDispatchers(),
emojibaseProvider = FakeEmojibaseProvider(emojibaseContents),
)
}