Важно

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.

Руководство по отчету о насекомых

В этом руководстве приведены инструкции по сообщению о ошибках и проблемах, с которыми вы столкнулись в Jami.

Создать свое окружение

  • Будьте готовы к потере данных, запишите свой аккаунт и свяжите его с как можно большей частью устройств.

  • Установка новейшей версии Jami (или даже бета-версии) - сообщение об ошибках/проблем по сравнению с старыми версиями менее полезно, и есть вероятность того, что они уже исправлены в более новых версиях.

Как сообщить об ошибке

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

  2. Выберите подходящий проект для размещения выпуска:

  3. Если у вас есть несколько проблем, пожалуйста, подавайте отдельные отчеты об ошибках.

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

  5. Выясните шаги воспроизведения ошибки:

    • 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. Опишите свое окружение, указав следующее:

    • 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,

      • и т. д.

Написать четкое резюме

Как бы вы описали ошибку, используя примерно 10 слов? Это первая часть вашего отчета ошибок, которую увидит разработчик.

Хорошее обобщение должно быстро и уникально идентифицировать сообщение об ошибках.

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"

Написание точных шагов воспроизводства

  • Как разработчик может воспроизвести эту ошибку на своем устройстве?

    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.

  • Что нужно включить в отчет о ошибках?

    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.

Хорошо

Я всегда могу воспроизводить следуя этим шагам:

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.

Плохо

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

Obtained result

Пожалуйста, включите:

  • Дэймон Jami (jamid или libjami или либринг) и клиент дебгуруют журналы.

  • The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

Предоставление дополнительной информации

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

Логографические

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. У вас теперь есть файл, содержащий дневник клиента.

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

Классические журналы (по умолчанию записываются только >= предупреждения):

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. Убедитесь, что никаких клиента Jami или демонов не работает: проверьте, запуская ps aux ̶, загружая jami в терминале.

    • Джами может все еще работать, даже если окна не открыты, в зависимости от ваших предпочтений.

    • Если клиент или демона работают, прекратите их с использованием kill PID.

  2. В одном терминале, запустите демона с jamid -d -c

    • Этот исполняемый файл обычно не находится в PATH, а в пакетах Debian/Trisquel/Ubuntu он находится на /usr/lib/x86_64-linux-gnu/jamid -d -c или /usr/libexec/jamid -d -c.

  3. In another terminal, start the client, using jami -d.

Чтобы получить обратную связь, можно запустить программу внутри GDB:

gdb -ex run --args jami -d, or gdb -ex run --args /usr/libexec/jamid -cd, depending on the component you need to debug.

Когда он падает, вы можете напечатать bt (или даже лучше, thread применить все bt) затем нажмите Enter. Затем скопируйте обратный след и вставьте его в выпуск.

macOS

  1. Перейти к /Applications/Jami.app/Contents/MacOS/.

  2. Двойной нажмите Jami, и он запустит Jami и отпечатает журнал на терминал.

  3. Копируйте журнал из терминала в файл.

В качестве альтернативы, вы можете запустить /<path к Jami>/Jami.app/Contents/MacOS/Jami -d с терминала.

Окна

  1. Open the command prompt (cmd.exe)

  2. Run Jami.exe with the following options:

    • -d открыть отдельное окно консоли для получения журналов

    • -f для записи журналов в % локальных данных%\jami\jami.log