Belangrijk

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.

Bug-rapportgids

Deze handleiding bevat stapsgewijze instructies voor het melden van bugs en problemen die u in Jami tegenkomt.

Maak je omgeving op

  • Maak je klaar voor gegevensverlies. Maak een back-up van je account en koppel je account aan zoveel mogelijk apparaten.

  • Installeer de nieuwste versie (of zelfs een betaversie) van Jami. Het rapporteren van bugs/problemen tegen oudere versies is minder nuttig en er is een kans dat deze reeds is opgelost in nieuwere versies.

Hoe een bug te melden

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

  2. Kies het juiste project om uw nummer in te plaatsen:

  3. Als u meerdere problemen heeft, kunt u apart bug-rapporten indienen.

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

  5. Ontdek de stappen om de fout te reproduceren:

    • 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. Beschrijf uw omgeving (s) door het volgende te vermelden:

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

Een duidelijke samenvatting schrijven

Hoe zou je de bug met ongeveer 10 woorden beschrijven? Dit is het eerste deel van je bug-rapport dat een ontwikkelaar zal zien.

Een goede samenvatting moet een foutrapport snel en uniek identificeren en het probleem uitleggen, niet de suggereerde oplossing.

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"

Het schrijven van nauwkeurige stappen om te reproduceren

  • Hoe kan een ontwikkelaar de fout op zijn of haar eigen apparaat reproduceren?

    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.

  • Wat moet je in een foutrapport vermelden?

    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

Ik kan me altijd voortbrengen door deze stappen te volgen:

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

Voeg hieronder in:

  • De Jami daemon (jamid of libjami of libring) en de client debugg logs.

  • The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

Aanvullende informatie verstrekken

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

Borden

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. Je hebt nu een bestand met het log van de cliënt

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

Klassieke logs (bij standaard worden alleen >= waarschuwingslogs geregistreerd):

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. Zorg ervoor dat geen Jami-client of daemon instances worden uitgevoerd: controleer door `ps aux ̶ grep jami̶̶ in een terminal te draaien.

    • Jami kan nog steeds werken, zelfs als er geen ramen open zijn, afhankelijk van je voorkeuren.

    • Als een client of een daemon wordt uitgevoerd, beëindig ze met behulp van kill PID.

  2. In één terminal, start de daemon met jamid -d -c

    • Deze uitvoerbaar is normaal gesproken niet in de PATH, en in de Debian/Trisquel/Ubuntu pakketten, is het gelegen op /usr/lib/x86_64-linux-gnu/jamid -d -c of /usr/libexec/jamid -d -c.

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

Om een achtergrond te krijgen, kun je het programma in GDB uitvoeren:

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

Wanneer het afvalt, kunt u bt (of nog beter, thread alle bt toepassen) typen en vervolgens op Enter drukken.

macOS

  1. Ga naar /Applications/Jami.app/Contents/MacOS/.

  2. Dubbel klik op Jami, dan start het Jami en prints het log naar de terminal.

  3. Kopieer het log van de terminal naar een bestand.

Als alternatief kunt u /<path naar Jami>/Jami.app/Contents/MacOS/Jami -d vanaf de terminal uitvoeren.

Windows

  1. Open the command prompt (cmd.exe)

  2. Run Jami.exe with the following options:

    • -d om een apart consolevenster te openen om logs te ontvangen

    • -f logs te schrijven naar %localappdata%\jami\jami.log