Viktigt

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.

Användare av en förpackning

Denna guide innehåller stegvis instruktioner för att rapportera fel och problem du möter i Jami.

Ställ in din miljö

• Var beredd på att data går förlorade.

• Installa den senaste versionen (eller till och med en beta-version) av Jami. Att rapportera fel/problem mot äldre versioner är mindre användbart och det finns en sannolikhet att det redan har åtgärdats i nyare versioner.

Hur man rapporterar en bugg

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

1. Välj rätt projekt för att lägga ut ditt nummer i:

   • The Jami client for Android (Jami client for Android and Android TV devices)

   • The Jami client for iOS (Jami client for iPhone and iPad devices)

   • The desktop Jami client (Jami client, based on the Qt framework, for GNU/Linux, macOS, and Windows platforms)

   • If you know what you are doing, you may choose one of the other projects

2. Om du har flera problem, kan du skicka separat felrapporter. Det blir mycket lättare att hålla reda på dem på det sättet.

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

4. Ta reda på hur man kan reproducera buggen:

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

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

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

7. Beskriv din miljö (s) genom att ange följande:

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

Skriva en tydlig sammanfattning

Hur skulle du beskriva buggen med ungefär 10 ord?

En bra sammanfattning bör snabbt och unikt identifiera en felrapport. Den bör förklara problemet, inte din föreslagna lösning.

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"

Skriv exakta steg för att reproducera

• Hur kan en utvecklare reproducera buggen på sin egen enhet?

  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.

• Vad bör du innehålla i en buggrapport?

  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

Jag kan alltid reproducera genom att följa dessa steg:

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

Vänligen inkludera:

• Jami-daemon (jamid eller libjami eller libring) och klientdebug loggar.

• The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

Tillhandahållande av ytterligare information

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

Lågar

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. Du har nu en fil som innehåller loggen av kunden

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

Klassiska loggar (avsnittet är endast >= varning loggar):

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. Se till att ingen Jami-klient eller daemon instanser körs: kontrollera genom att köra `ps aux ̊ grep jami ̊ i en terminal.

   • Jami kan fortfarande vara på gång även om inga fönster är öppna, beroende på dina preferenser.

   • Om någon av klienterna eller demonen körs, avsluta dem med kill PID.

2. I en terminal, starta daemon med jamid -d -c

   • Denna verkställighetsbarhet finns normalt inte i PATH, och i Debian/Trisquel/Ubuntu-paketterna finns den på /usr/lib/x86_64-linux-gnu/jamid -d -c eller /usr/libexec/jamid -d -c.

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

För att få en bakspårning kan du köra programmet inuti GDB:

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

När den kraschar kan du skriva bt (eller ännu bättre, thread applicera alla bt) och trycka på Enter.

macOS

1. Navigera till /Applications/Jami.app/Contents/MacOS/.

2. Dubbelklicka på Jami och det startar Jami och trycker loggen till terminalen.

3. Kopiera loggen från terminal till en fil.

Alternativt kan du köra /<vägen till Jami>/Jami.app/Contents/MacOS/Jami -d från terminalen.

Fönster

1. Open the command prompt (cmd.exe)

2. Run Jami.exe with the following options:

   • -d att öppna ett separat konsolfönster för att ta emot loggar

   • -f att skriva loggar till % lokalt data%\jami\jami.log