system tray icons display with black overlay or combined

[fossfreedom]

[Impact]

First raised as part of this fix https://bugs.launchpad.net/ubuntu/+source/budgie-desktop/+bug/1845455. That speculative fix did not resolve matters and had been dropped as part of the 20.04 release.

Upstream (https://github.com/solus-project/budgie-desktop) bug-reports:

    #685 System Tray Icons too far apart on HiDPI
    #1037 Tray Applet Padding Setting
    #1210 artefacts with trays on bar (maybe? hard to tell)
    #1243 System tray blinking when panel transparency is set to "Dynamic"
    #1249 System tray icon backgrounds not refreshing
    #1271 Status icon does not get hidden
    #1419 System tray applet in the top panel doesn't show up after sleep
    #1420 System tray applet doesn't show up when added
    #1932 System tray icons are far apart

 * This is a very noticeable visual issue to users that have the system-tray applet added to their budgie-panel

 * This affects 20.04 users - it has been uploaded to 20.10 for several weeks now.

 * Upstream resolved this by removing the old na-tray system tray applet from their code-base and replacing the applet with "carbontray" i.e. it is a ground up replacement. Over the many years of this issue many attempts have been tried to resolve but upstream decided to a rewrite was needed.

 * this upload backports a series of patches developed to resolve - these are detailed in the dep3 header of the carbontray.patch file in the upload package.

[Test Case]

 * This is actually not an easy bug report to reproduce on demand. In general, add the system tray applet to your panel via budgie-desktop-settings. Certain applications display their icon in the system tray e.g. network manager applet, hexchat, ibus-preferences

 * Suspend for 10 minutes or more and resume. Repeat several times. Observe the system tray in each cycle - sometimes the icons in the system tray will display with a black background. Other times icons can be combined (overlayed) with each other. Sometimes the issue can be observed by first logon after a reboot. It rarely is observed by logging out and logging in

 * Next enable the proposed repository in Update Sources (software-properties-gtk) - choose the reload option when prompted. Then install the following packages to update:

   sudo apt install budgie-desktop budgie-core libbudgie-plugin0 libbudgietheme0 libbudgie-private0 gir1.2-budgie-desktop-1.0

 * Reboot and login. Observe the system tray to ensure icons display correctly. Next repeat the suspend/resume cycle for several times and again observe the system tray displays its icons correctly. Additionally reboot and login - cycle this reboot/login cycle for several times.

[Regression Potential]

 * The largest risk I suppose is introducing potential instability into the budgie-panel i.e. crashes. This could come from some unknown issue not yet captured or found upstream i.e. specific to Ubuntu 20.04 or not capturing the full extent of the applet rewritten code from upstream.

 * This risk has been mitigated by
   - ensuring the patch is identical to upstream code base (diff -r src/applets/tray ../budgie-desktop/src/applets/tray)
   - running with the fix for several weeks and observe if there are any new apport-bug reports (/var/crash) for budgie-desktop. At the time of writing this, I have personally been doing this for 3 weeks now.
   - Additionally - these changes have been tested for several weeks via Debian Testing, 20.10, Solus Project. No adverse reports have been noted.

 * In the advent of regression the user can remove the system tray applet from their panel. It is optional in Ubuntu Budgie 20.04 and not added to a users panel by default.

[Other Info]

 * N/A

[Robie Basak (racb)]

SRU review

Thank you for caring for this package in Focal! This upload looks fine in principle. Please thoroughly test during SRU verification - we don't want to be iterating over multiple fix attempts in a stable release.

The version string you chose (10.5.1-6.1) potentially conflicts with Debian. Convention is to use something like https://wiki.ubuntu.com/SecurityTeam/UpdatePreparation#Update_the_packaging (linked to from the SRU docs page). I appreciate you've been waiting a while for an SRU review so I'll just change this for you rather than making/waiting for you to do it. I trust this is acceptable to you.

[Robie Basak (racb)]

> This affects 20.04 users - it has been uploaded to 20.10 for several weeks now.

[Robie Basak (racb)]

Hello fossfreedom, or anyone else affected,

Accepted budgie-desktop into focal-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/budgie-desktop/10.5.1-6ubuntu0.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-focal to verification-done-focal. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-focal. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[fossfreedom (fossfreedom)]

v10.5.1-6ubuntu0.1 test case run successfully. In addition I've been running this full time for the last week or so - and previously for the last month via PPA.

No regressions noted. So happy to proceed to release.

[Launchpad Janitor (janitor)]

This bug was fixed in the package budgie-desktop - 10.5.1-6ubuntu0.1

---------------
budgie-desktop (10.5.1-6ubuntu0.1) focal; urgency=medium

  * Bug-fix
    Replace system tray with upstream carbontray
    carbontray.patch (LP: #1898427)
    Drop fix_black_tray_backgrounds.patch since it has been replaced
    by carbontray.
    Update show-tray-icon.patch to rename tray schema clash.

 -- David Mohammed <email address hidden> Tue, 15 Sep 2020 10:11:05 +0100

[Łukasz Zemczak (sil2100)]

The verification of the Stable Release Update for budgie-desktop has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.