🔧 Improve error handling and logging for Gitmoji translations

Patrice de Saint Steban · Patrice de Saint Steban · commit 2bef928f134e · 2025-12-01T17:59:47.000+01:00
diff --git a/src/main/kotlin/com/github/patou/gitmoji/GitCommitAction.kt b/src/main/kotlin/com/github/patou/gitmoji/GitCommitAction.kt
@@ -1,12 +1,9 @@
 package com.github.patou.gitmoji
 
-import com.intellij.ide.TextCopyProvider
 import com.intellij.ide.util.PropertiesComponent
 import com.intellij.openapi.actionSystem.ActionUpdateThread
 import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
-import com.intellij.openapi.actionSystem.PlatformCoreDataKeys
-import com.intellij.openapi.actionSystem.PlatformDataKeys
 import com.intellij.openapi.application.ApplicationManager.getApplication
 import com.intellij.openapi.command.CommandProcessor
 import com.intellij.openapi.command.undo.UndoManager
@@ -27,7 +24,6 @@ import com.intellij.ui.SimpleTextAttributes
 import com.intellij.ui.awt.RelativePoint
 import com.intellij.ui.speedSearch.SpeedSearchUtil.applySpeedSearchHighlighting
 import com.intellij.util.ObjectUtils.sentinel
-import com.intellij.util.containers.nullize
 import com.intellij.util.ui.JBUI.scale
 import com.intellij.vcs.commit.message.CommitMessageInspectionProfile.getSubjectRightMargin
 import java.awt.Point
@@ -57,14 +53,12 @@ class GitCommitAction : AnAction() {
         }
     }
 
-    @Suppress("MissingActionUpdateThread")
     private fun createPopup(
         project: Project,
         commitMessage: CommitMessage,
         listGitmoji: List<GitmojiData>
     ): JBPopup {
-        var chosenMessage: GitmojiData? = null
-        var selectedMessage: GitmojiData? = null
+        var wasChosen = false
         val rightMargin = getSubjectRightMargin(project)
         val previewCommandGroup = sentinel("Preview Commit Message")
         val projectInstance = PropertiesComponent.getInstance(project)
@@ -77,11 +71,10 @@ class GitCommitAction : AnAction() {
             .setFont(commitMessage.editorField.editor?.colorsScheme?.getFont(EditorFontType.PLAIN))
             .setVisibleRowCount(7)
             .setSelectionMode(ListSelectionModel.SINGLE_SELECTION)
-            .setItemSelectedCallback {
-                selectedMessage = it
-                it?.let { preview(project, commitMessage, it, currentCommitMessage, currentOffset, previewCommandGroup) }
+            .setItemSelectedCallback { gitmoji ->
+                gitmoji?.let { preview(project, commitMessage, it, currentCommitMessage, currentOffset, previewCommandGroup) }
             }
-            .setItemChosenCallback { chosenMessage = it }
+            .setItemChosenCallback { wasChosen = true }
             .setRenderer(object : ColoredListCellRenderer<GitmojiData>() {
                 override fun customizeCellRenderer(
                     list: JList<out GitmojiData>,
@@ -123,10 +116,7 @@ class GitCommitAction : AnAction() {
                     commitMessage.editorField.requestFocusInWindow()
                     // Use invokeLater() as onClosed() is called before callback from setItemChosenCallback
                     getApplication().invokeLater {
-                        chosenMessage ?: cancelPreview(
-                            project,
-                            commitMessage
-                        )
+                        if (!wasChosen) cancelPreview(project, commitMessage)
                     }
                 }
             })
diff --git a/src/main/kotlin/com/github/patou/gitmoji/GitmojiLocale.kt b/src/main/kotlin/com/github/patou/gitmoji/GitmojiLocale.kt
@@ -1,13 +1,15 @@
 package com.github.patou.gitmoji
 
 import com.intellij.ide.util.PropertiesComponent
+import com.intellij.openapi.diagnostic.Logger
 import okhttp3.*
 import org.yaml.snakeyaml.Yaml
 import java.io.IOException
 import java.util.*
 
 object GitmojiLocale {
 
+    private val logger = Logger.getInstance(GitmojiLocale::class.java)
     private var translations: MutableMap<String, String> = HashMap()
 
     val LANGUAGE_CONFIG_LIST = arrayOf("auto", "en_US", "zh_CN", "fr_FR", "ru_RU", "pt_BR")
@@ -35,19 +37,38 @@ object GitmojiLocale {
         }
         val client = OkHttpClient().newBuilder().addInterceptor(SafeGuardInterceptor()).build()
         val request: Request = Request.Builder()
-            .url("https://raw.githubusercontent.com/patou/gitmoji-intellij-plugin/master/src/main/resources/gitmojis-${language}.yaml")
+            .url("https://raw.githubusercontent.com/patou/gitmoji-intellij-plugin/master/src/main/resources/R")
             .build()
         client.newCall(request).enqueue(object : Callback {
             override fun onFailure(call: Call, e: IOException) {
+                logger.warn("Failed to download translations for $language, falling back to local", e)
                 loadLocalYaml(language)
             }
 
             override fun onResponse(call: Call, response: Response) {
                 response.use {
                     if (!response.isSuccessful) {
+                        logger.warn("Unsuccessful response (${response.code}) when downloading translations for $language, falling back to local")
                         loadLocalYaml(language)
                     } else {
-                        loadYaml(response.body!!.string())
+                        val bodyText = try {
+                            response.body?.string()
+                        } catch (e: Exception) {
+                            logger.warn("Failed to read response body for translations ($language), falling back to local", e)
+                            null
+                        }
+
+                        if (bodyText.isNullOrEmpty()) {
+                            loadLocalYaml(language)
+                        } else {
+                            try {
+                                loadYaml(bodyText)
+                            } catch (e: Exception) {
+                                // parsing failed (malformed YAML) -> fallback local
+                                logger.warn("Failed to parse remote YAML translations for $language, falling back to local", e)
+                                loadLocalYaml(language)
+                            }
+                        }
                     }
                 }
             }
@@ -57,23 +78,38 @@ object GitmojiLocale {
     // load local yaml
     private fun loadLocalYaml(language: String) {
         val yaml = Yaml()
-        javaClass.getResourceAsStream("/gitmojis-${language}.yaml").use { inputStream ->
-            if (inputStream != null) {
-                addTranslation(yaml.loadAs(inputStream, HashMap::class.java))
+        try {
+            javaClass.getResourceAsStream("/gitmojis-${language}.yaml").use { inputStream ->
+                if (inputStream != null) {
+                    try {
+                        addTranslation(yaml.loadAs(inputStream, HashMap::class.java))
+                    } catch (e: Exception) {
+                        logger.error("Failed to parse local YAML translations for $language", e)
+                    }
+                } else {
+                    logger.warn("Local translations resource not found for $language")
+                }
             }
+        } catch (e: Exception) {
+            logger.error("Unexpected error while loading local translations for $language", e)
         }
     }
 
     // load remote yaml
     private fun loadYaml(text: String) {
         val yaml = Yaml()
-        addTranslation(yaml.loadAs(text, HashMap::class.java))
+        try {
+            addTranslation(yaml.loadAs(text, HashMap::class.java))
+        } catch (e: Exception) {
+            logger.error("Failed to parse YAML translations from text", e)
+            throw e
+        }
     }
 
     private fun addTranslation(loadedTranslation : HashMap<*, *>) {
-        loadedTranslation["gitmojis"]?.let { it ->
-            if (it is Map<*, *>) {
-                it.forEach { (key, value) ->
+        loadedTranslation["gitmojis"]?.let { gitmojis ->
+            if (gitmojis is Map<*, *>) {
+                gitmojis.forEach { (key, value) ->
                     translations[key.toString()] = value.toString()
                 }
             }
diff --git a/src/main/resources/gitmojis-pt_BR.yaml b/src/main/resources/gitmojis-pt_BR.yaml
@@ -1,74 +1,74 @@
 gitmojis:
-  art: Melhorar a estrutura ou formatação do código.
-  zap: Melhorar a performance.
-  fire: Remover código ou arquivos.
-  bug: Corrigir um bug.
-  ambulance: Correção crítica.
-  sparkles: Adicionar novas funcionalidades.
-  memo: Adicionar ou atualizar a documentação.
-  rocket: Realizar deploy.
-  lipstick: Adicionar ou atualizar a interface e os arquivos de estilo.
-  tada: Iniciar um projeto.
-  white-check-mark: Adicionar, atualizar ou passar testes.
-  lock: Corrigir problemas de segurança ou privacidade.
-  closed-lock-with-key: Adicionar ou atualizar segredos.
-  bookmark: Tags de versão/release.
-  rotating-light: Corrigir alertas do compilador ou linter.
-  construction: Trabalho em andamento.
-  green-heart: Corrigir compilação do build (CI).
-  arrow-down: Fazer downgrade de dependências.
-  arrow-up: Atualizar dependências.
-  pushpin: Fixar dependências em versões específicas.
-  construction-worker: Adicionar ou atualizar o sistema de build (CI).
-  chart-with-upwards-trend: Adicionar ou atualizar códigos de analytics ou rastreamento.
-  recycle: Refatorar código.
-  heavy-plus-sign: Adicionar uma dependência.
-  heavy-minus-sign: Remover uma dependência.
-  wrench: Adicionar ou atualizar arquivos de configuração.
-  hammer: Adicionar ou atualizar scripts de desenvolvimento.
-  globe-with-meridians: Internacionalização e localização.
-  pencil2: Corrigir erros de digitação.
-  poop: Escrever código ruim que precisa ser melhorado.
-  rewind: Reverter mudanças.
-  twisted-rightwards-arrows: Mesclar branches.
-  package: Adicionar ou atualizar arquivos compilados ou pacotes.
-  alien: Atualizar código devido a mudanças em APIs externas.
-  truck: Mover ou renomear recursos (ex.: arquivos, caminhos, rotas).
-  page-facing-up: Adicionar ou atualizar licença.
-  boom: Introduzir mudanças que quebram a retrocompatibilidade.
-  bento: Adicionar ou atualizar recursos gráficos.
-  wheelchair: Melhorar a acessibilidade.
-  bulb: Adicionar ou atualizar comentários no código.
-  beers: Escrever código sob influência (brincadeira).
-  speech-balloon: Adicionar ou atualizar textos e literais.
-  card-file-box: Realizar alterações relacionadas a banco de dados.
-  loud-sound: Adicionar ou atualizar logs.
-  mute: Remover logs.
-  busts-in-silhouette: Adicionar ou atualizar colaboradores.
-  children-crossing: Melhorar a experiência ou usabilidade do usuário.
-  building-construction: Fazer mudanças arquiteturais.
-  iphone: Trabalhar em design responsivo.
-  clown-face: Criar mocks ou simulações.
-  egg: Adicionar ou atualizar um easter egg.
-  see-no-evil: Adicionar ou atualizar o arquivo .gitignore.
-  camera-flash: Adicionar ou atualizar snapshots (ex.: testes visuais).
-  alembic: Realizar experimentos.
-  mag: Melhorar SEO.
-  label: Adicionar ou atualizar tipos.
-  seedling: Adicionar ou atualizar dados de seed (inicialização).
-  triangular-flag-on-post: Adicionar, atualizar ou remover feature flags.
-  goal-net: Capturar erros.
-  dizzy: Adicionar ou atualizar animações e transições.
-  wastebasket: Deprecar código que será removido futuramente.
-  passport-control: Trabalhar com autorização, permissões e papéis.
-  adhesive-bandage: Correção simples para um problema não crítico.
-  monocle-face: Exploração ou inspeção de dados.
-  coffin: Remover código morto.
-  test-tube: Adicionar um teste que deve falhar.
-  necktie: Adicionar ou atualizar regras de negócio.
-  stethoscope: Adicionar ou atualizar verificação de integridade (healthcheck).
-  bricks: Alterações relacionadas à infraestrutura.
-  technologist: Melhorar a experiência do desenvolvedor.
-  money-with-wings: Adicionar patrocínios ou estrutura relacionada a dinheiro.
-  thread: Adicionar ou atualizar código relacionado a multithreading ou concorrência.
-  safety-vest: Adicionar ou atualizar código relacionado a validações.
+  art: "Melhorar a estrutura ou formatação do código."
+  zap: "Melhorar a performance."
+  fire: "Remover código ou arquivos."
+  bug: "Corrigir um bug."
+  ambulance: "Correção crítica."
+  sparkles: "Adicionar novas funcionalidades."
+  memo: "Adicionar ou atualizar a documentação."
+  rocket: "Realizar deploy."
+  lipstick: "Adicionar ou atualizar a interface e os arquivos de estilo."
+  tada: "Iniciar um projeto."
+  white-check-mark: "Adicionar, atualizar ou passar testes."
+  lock: "Corrigir problemas de segurança ou privacidade."
+  closed-lock-with-key: "Adicionar ou atualizar segredos."
+  bookmark: "Tags de versão/release."
+  rotating-light: "Corrigir alertas do compilador ou linter."
+  construction: "Trabalho em andamento."
+  green-heart: "Corrigir compilação do build (CI)."
+  arrow-down: "Fazer downgrade de dependências."
+  arrow-up: "Atualizar dependências."
+  pushpin: "Fixar dependências em versões específicas."
+  construction-worker: "Adicionar ou atualizar o sistema de build (CI)."
+  chart-with-upwards-trend: "Adicionar ou atualizar códigos de analytics ou rastreamento."
+  recycle: "Refatorar código."
+  heavy-plus-sign: "Adicionar uma dependência."
+  heavy-minus-sign: "Remover uma dependência."
+  wrench: "Adicionar ou atualizar arquivos de configuração."
+  hammer: "Adicionar ou atualizar scripts de desenvolvimento."
+  globe-with-meridians: "Internacionalização e localização."
+  pencil2: "Corrigir erros de digitação."
+  poop: "Escrever código ruim que precisa ser melhorado."
+  rewind: "Reverter mudanças."
+  twisted-rightwards-arrows: "Mesclar branches."
+  package: "Adicionar ou atualizar arquivos compilados ou pacotes."
+  alien: "Atualizar código devido a mudanças em APIs externas."
+  truck: "Mover ou renomear recursos (ex.: arquivos, caminhos, rotas)."
+  page-facing-up: "Adicionar ou atualizar licença."
+  boom: "Introduzir mudanças que quebram a retrocompatibilidade."
+  bento: "Adicionar ou atualizar recursos gráficos."
+  wheelchair: "Melhorar a acessibilidade."
+  bulb: "Adicionar ou atualizar comentários no código."
+  beers: "Escrever código sob influência (brincadeira)."
+  speech-balloon: "Adicionar ou atualizar textos e literais."
+  card-file-box: "Realizar alterações relacionadas a banco de dados."
+  loud-sound: "Adicionar ou atualizar logs."
+  mute: "Remover logs."
+  busts-in-silhouette: "Adicionar ou atualizar colaboradores."
+  children-crossing: "Melhorar a experiência ou usabilidade do usuário."
+  building-construction: "Fazer mudanças arquiteturais."
+  iphone: "Trabalhar em design responsivo."
+  clown-face: "Criar mocks ou simulações."
+  egg: "Adicionar ou atualizar um easter egg."
+  see-no-evil: "Adicionar ou atualizar o arquivo .gitignore."
+  camera-flash: "Adicionar ou atualizar snapshots (ex.: testes visuais)."
+  alembic: "Realizar experimentos."
+  mag: "Melhorar SEO."
+  label: "Adicionar ou atualizar tipos."
+  seedling: "Adicionar ou atualizar dados de seed (inicialização)."
+  triangular-flag-on-post: "Adicionar, atualizar ou remover feature flags."
+  goal-net: "Capturar erros."
+  dizzy: "Adicionar ou atualizar animações e transições."
+  wastebasket: "Deprecar código que será removido futuramente."
+  passport-control: "Trabalhar com autorização, permissões e papéis."
+  adhesive-bandage: "Correção simples para um problema não crítico."
+  monocle-face: "Exploração ou inspeção de dados."
+  coffin: "Remover código morto."
+  test-tube: "Adicionar um teste que deve falhar."
+  necktie: "Adicionar ou atualizar regras de negócio."
+  stethoscope: "Adicionar ou atualizar verificação de integridade (healthcheck)."
+  bricks: "Alterações relacionadas à infraestrutura."
+  technologist: "Melhorar a experiência do desenvolvedor."
+  money-with-wings: "Adicionar patrocínios ou estrutura relacionada a dinheiro."
+  thread: "Adicionar ou atualizar código relacionado a multithreading ou concorrência."
+  safety-vest: "Adicionar ou atualizar código relacionado a validações."
