Importante

We are currently a small number of developers active on the project. As such, we cannot answer and tag all of the opened issues immediately, but we do notice and read them. Good bug reports provide us important feedback, which we thank you for and always appreciate.

Guia de relatório de erros

Este guia inclui instruções passo a passo para comunicar erros e problemas encontrados no Jami.

Configure o seu ambiente

  • Esteja preparado para a perda de dados. Faça uma cópia de segurança da sua conta e vincule-a ao maior número possível de dispositivos.

  • Instale a versão mais recente (ou mesmo uma versão beta) do Jami. Comunicar erros/problemas relativamente a versões mais antigas é menos útil e existe a probabilidade de já terem sido corrigidos em versões mais recentes.

Como comunicar um erro

  1. Only required once: Create a Jami GitLab account.

  2. Escolha o projeto certo para publicar o seu problema:

  3. Se tiver vários problemas, envie relatórios de erros separados. Será muito mais fácil manter o controlo sobre eles dessa forma.

  4. The title is an explicit summary of the bug (for example, the header bar is too big due to icon size).

  5. Descobrir os passos para reproduzir o erro:

    • If you have precise steps to reproduce it (great!), you’re on your way to creating a helpful bug report.

    • If you can reproduce it occasionally but not after following specific steps, please provide additional information about the issue to help others understand and try to reproduce it.

    • If you can not reproduce the problem, there may be little chance of it being reasonably fixable. If you do report it, please provide as much information/clues about its occurrence as possible.

  6. Ensure your software is up to date. Ideally, test an in-development version to see whether your bug has already been fixed.

  7. Attempt to isolate from the environment and reproduce (that is, test on multiple devices).

  8. Descreva o seu ambiente especificando o seguinte:

    • Operating system and version

    • Precise device model (important for mobile devices)

    • Stable or beta version of Jami

    • What build you are using (F-Droid, Google Play, App Store, dl.jami.net, your own build, etc.). If you have built your own version of Jami, please specify the exact Jami Daemon version and client version (you can obtain it using jamid -v and jami -v; but note that our packages are updated quite often) and the Git commit.

    • Network conditions:

      • Are both devices on the same local network?

      • Different networks?

      • Is one or both behind NAT?

      • Are you using LTE?

      • Are you using WiFi?

    • Other details if required:

      • SIP provider,

      • Hardware,

      • etc.

Escrever um resumo claro

Como descreveria o erro utilizando aproximadamente 10 palavras? Esta é a primeira parte do seu relatório de erro que um programador verá.

Um bom resumo deve identificar rápida e exclusivamente um relatório de bug. Ele deve explicar o problema, não a solução sugerida.

Good: "Cancelling a file transfer crashes Jami"
Bad: "Software crashes"

Good: "All calls hang up after 32 seconds"
Bad: "Not able to call my friends"

Escrever passos precisos para reproduzir

  • Como é que um programador pode reproduzir o erro no seu próprio dispositivo?

    Steps to reproduce are the most important part of any bug report. If a developer is able to reproduce the bug, the bug is very likely to be fixed. If the steps are unclear, it might not even be possible to know whether the bug has been fixed. We are totally aware that some bugs may look obvious to you, but they are probably related to your environment. The more precise you are, the quicker the bug can be fixed.

  • O que deve ser incluído num relatório de erros?

    Indicate whether you can reproduce the bug at will, occasionally, or not at all. Describe your method of interacting with Jami in addition to the intent of each step. After your steps, precisely describe the observed (actual) result and the expected result. Clearly separate facts (observations) from speculations.

Good

Posso sempre reproduzir seguindo estes passos:

1. Start Jami by clicking on the desktop icon.
2. Start a new conversation with anyone.
3. Click the file transfer button.

Expected results: A window opens and asks me to choose a file to send.
Actual results: When I click the file transfer button, nothing happens.

Bad

Attempt to transfer a file.
It doesn't work.

Obtained result

Por favor, inclua:

  • O daemon Jami (jamid ou libjami ou libring) e o log debug do cliente.

  • The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

Fornecer informações adicionais

The following information is requested for most bug reports. You can save time by providing this information below the expected results.

Registos

Android

To gather logs via the Android device using Jami:

  1. Tap Conversations.

  2. Tap the ⋮ (three-dot) menu on the top right.

  3. Tap Settings.

  4. Tap Diagnostic logs.

To gather logs via a computer using the Android Debug Bridge (adb):

  1. The adb is required to be set up on your computer.

  2. Launch Jami on your smartphone and then execute adb logcat *:D | grep `adb shell ps | egrep 'cx.ring' | cut -c10-15` > logring.txt

  3. Agora tem um ficheiro que contém o registo do cliente

Desktop Jami client based on the Qt framework (GNU/Linux, macOS, Windows)

  1. Open the General tab in the settings.

  2. In the Troubleshoot section, click the Open logs button.

  3. Turn on the View logs switch.

  4. Click the Copy button.

  5. Paste the result and explain the scenario in the issue.

GNU/Linux

Registos clássicos (por defeito, apenas são registados os registos >= aviso):

journalctl --since "24h ago" | grep jami

Full log: The Jami client (GUI) and daemon are separate processes. To obtain logs from both processes, start each process manually, one at a time.

  1. Certifique-se de que não estão a ser executadas instâncias do cliente ou daemon Jami: verifique executando ps aux | grep jami num terminal.

    • O Jami pode continuar a ser executado mesmo que não haja janelas abertas, dependendo das suas preferências.

    • Se o cliente ou o daemon estiverem em execução, encerre-os usando kill PID.

  2. Num terminal, inicie o daemon com jamid -d -c

    • Este executável normalmente não está no PATH, e nos pacotes Debian/Trisquel/Ubuntu, ele está localizado em /usr/lib/x86_64-linux-gnu/jamid -d -c ou /usr/libexec/jamid -d -c.

  3. Noutro terminal, inicie o cliente, utilizando jami -d.

Para obter um backtrace, é possível executar o programa dentro do GDB:

gdb -ex run --args jami -d ou gdb -ex run --args /usr/libexec/jamid -cd, dependendo do componente que precisa de depurar.

Quando bloquear, pode digitar bt (ou melhor ainda, thread apply all bt) e pressionar Enter. Em seguida, copie o backtrace e cole-o no problema reportado.

macOS

  1. Navegue para /Applications/Jami.app/Contents/MacOS/.

  2. Faça duplo clique em Jami. O Jami será iniciado e o registo será impresso no terminal.

  3. Copie o registo do terminal para um ficheiro.

Alternativamente, pode executar /<path para Jami>/Jami.app/Contents/MacOS/Jami -d do terminal.

Janela

  1. Open the command prompt (cmd.exe)

  2. Run Jami.exe with the following options:

    • -d para abrir uma janela de consola separada para receber os registos

    • -f para gravar os registos em %localappdata%\jami\jami.log