Multilingual typing: main locale is not guaranteed to be dictionaryGroups[0] (HashSet in getUsedLocales)

Fechada
#762 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
Meio dia
Facilidade para iniciantes
62/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
android, kotlin

Direção de pesquisa

Start in DictionaryFacilitatorImpl.getUsedLocales(), where hashSetOf(mainLocale) is built, and in getNewDictGroupsAndDictsToCleanup(), which creates the groups in that set's iteration order. Then check the dictionaryGroups[0] call sites the issue lists: mainLocale, currentlyPreferredDictionaryGroup, getSuggestionResults(), isActive() and LatinIME.resetSuggestMainDict(). Done when the main locale is always group 0 regardless of Locale.hashCode(), for example with a linkedSetOf change, and a test or debug output confirms the order for en_US with de.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Describe the bug
With a secondary language (multilingual typing), the main locale of the layout is not guaranteed to be the first dictionary group. DictionaryFacilitatorImpl.getUsedLocales() collects the locales in a HashSet:

val locales = hashSetOf(mainLocale)
locales.addAll(getSecondaryLocales(selectedSubtype.extraValue))

getNewDictGroupsAndDictsToCleanup() creates the groups in the iteration order of that set, and a HashSet doesn't keep insertion order. But a lot of code assumes dictionaryGroups[0] is the main locale:

  • mainLocale = dictionaryGroups[0].locale, also used by LatinIME.resetSuggestMainDict(), which calls resetDictionaries(this, dictionaryFacilitator.mainLocale, ...). If that is the secondary locale, getUsedLocales() goes into the "called from the spell checker" branch, and as far as I can see the keyboard can end up with only the secondary language.
  • currentlyPreferredDictionaryGroup = maxBy { it.confidence } returns the first group on a tie. At the start all groups have confidence 1, so the tie goes to whichever locale the HashSet put first.
  • getSuggestionResults() queries only group 0 synchronously and waits at most 120 ms for the others.
  • isActive(), isValidSuggestionWord(), the personal-dictionary check in addToUserHistory() and dumpDictionaryForDebug() also use group 0.

Which pairs are affected depends on Locale.hashCode(). A quick check on a desktop JVM (Java 21) shows the secondary locale first for 7 of 12 common pairs, e.g. main en_US + secondary de, fr or es, and main nl or pl + secondary en_US. On our devices (Android 15/17), de_DE + en_US happened to come out in the right order, so Android's order differs from the JVM, but it is still not defined.

Possible fix
Keep the insertion order (that's what we did):

val locales = linkedSetOf(mainLocale)

To Reproduce

  1. Set up a layout with a secondary language via Multilingual typing, e.g. English (US) with German.
  2. Depending on the pair, the secondary locale becomes dictionaryGroups[0]. With debug mode on, the space bar shows the order of the locales (localesAndConfidences()).

Expected behavior
The layout's main locale is always the first dictionary group.

App version & Flavor
Found in GlassType, my fork, now based on LeanType 4.3.1 (0e673e1). The code is unchanged in current main.

Device Info

  • Model: Samsung Galaxy Z Fold 3 (SM-F926B) and Galaxy S23 Ultra (SM-S918B)
  • OS version: Android 15 / Android 17
Linguagem predominante
Kotlin
Estrelas
1k
Forks
59
Merge médio
14h 9min
PRs com merge (30d)
56

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de LeanBitLab/LeanType

Todas as issues de LeanBitLab/LeanType

Issues semelhantes

Mais issues de Kotlin

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.