feat: Simplify QT-based tray implementation

[Kishi85]

Description

This reworks the Qt-based tray with an adapted version of QtTrayMenu.h/cpp from upstream as suggested in LizardByte/Sunshine#4907.

This currently a very early work-in-progress version of the code with all of Lizardbyte's forks additional functionality (e.g. notifications) implemented but tested only very limited.

There is also still an issue with left clicking the tray icon that is also present in the current AI based implementation which caused by https://qt-project.atlassian.net/browse/QTBUG-139921.

This version is platform-neutral for QtTrayMenu.h/cpp code with Linux platform-specifics restricted to tray_linux.cpp. Special features like XDG desktop notifications (which wouldn't have worked with Sunshine anyway due to elevated privileges) have been replaced with Qt-native equivalents. Positioning is currently also fully reliant on Qt-provided features to maintain platform independence.

Screenshot

Issues Fixed or Closed

• Closes Pr 121 test #123

Roadmap Issues

Type of Change

• feat: New feature (non-breaking change which adds functionality)
• fix: Bug fix (non-breaking change which fixes an issue)
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
• refactor: Code change that neither fixes a bug nor adds a feature
• perf: Code change that improves performance
• test: Adding missing tests or correcting existing tests
• build: Changes that affect the build system or external dependencies
• ci: Changes to CI configuration files and scripts
• chore: Other changes that don't modify src or test files
• revert: Reverts a previous commit
• BREAKING CHANGE: Introduces a breaking change (can be combined with any type above)

Checklist

• Code follows the style guidelines of this project
• Code has been self-reviewed
• Code has been commented, particularly in hard-to-understand areas
• Code docstring/documentation-blocks for new or existing methods/components have been added or updated
• Unit tests have been added or updated for any new or modified functionality

AI Usage

• None: No AI tools were used in creating this PR
• Light: AI provided minor assistance (formatting, simple suggestions)
• Moderate: AI helped with code generation or debugging specific parts
• Heavy: AI generated most or all of the code changes

[codecov]

Codecov Report

❌ Patch coverage is 59.77860% with 109 lines in your changes missing coverage. Please review.
✅ Project coverage is 53.23%. Comparing base (4595d07) to head (0f771e1).
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
src/QtTrayMenu.cpp	53.72%	56 Missing and 31 partials ⚠️
src/tray_linux.cpp	73.49%	6 Missing and 16 partials ⚠️

❗ There is a different number of reports uploaded between BASE (4595d07) and HEAD (0f771e1). Click for more details.

HEAD has 2 uploads less than BASE

Flag	BASE (4595d07)	HEAD (0f771e1)
macOS	1	0
Windows	1	0

Additional details and impacted files

@@             Coverage Diff             @@
##           master     #121       +/-   ##
===========================================
- Coverage   63.51%   53.23%   -10.29%     
===========================================
  Files           4        3        -1     
  Lines         858      325      -533     
  Branches      313      147      -166     
===========================================
- Hits          545      173      -372     
+ Misses        207      105      -102     
+ Partials      106       47       -59     

Flag	Coverage Δ
Linux-qt5	53.23% <59.77%> (-3.89%)	⬇️
Linux-qt6	53.23% <59.77%> (-3.89%)	⬇️
Windows	?
macOS	?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/tray_linux.cpp	63.15% <73.49%> (+3.69%)	⬆️
src/QtTrayMenu.cpp	53.72% <53.72%> (ø)

... and 3 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4595d07...0f771e1. Read the comment docs.

[Kishi85]

I've fixed most of the issues I've found so far (added all the necessary pointer valid checks/etc. and moved the exit() order around so everything gets cleaned up in reverse order (clearing references as necessary on the go). But no matter what I do the CI pipeline segfaults at this one specific test:

[ RUN      ] TrayTest.TestCheckboxStates
/home/runner/work/_temp/d5b937f4-9556-4df2-8f27-571e2cb10ca8.sh: line 1:  8581 Segmentation fault      (core dumped) ./test_tray --gtest_color=yes --gtest_output=xml:test_results.xml
Error: Process completed with exit code 139.

I can run all the tests fine locally after I've added support for spectacle screenshots due to using KDE, tests running both with clang and gcc compiled project. It just wont complete when run on the CI-container with ubuntu-latest. I'm a bit out of ideas here and it looks like I have to test this on a native Ubuntu-latest install at some point to continue this further.

[ReenigneArcher]

@Kishi85 have a look at #123

[Kishi85]

@Kishi85 have a look at #123

I'll pick that test change if you dont mind as it IMHO makes more sense logically

[Kishi85]

Also the change you did for showing the menu on wayland in #123 does not work. Same issue as with show() due to that bug in Qt:
qt.qpa.wayland: Failed to create grabbing popup. Ensure popup QWidgetWindow(0x55c3cc28b8c0, name="QMenuClassWindow") has a transientParent set and that parent window has received input.

Looks like the only way to get left-click to work on Linux/Wayland is for Qt to fix the bug, every other workaround either fails silently or yields above message unfortunately.

[Kishi85]

One main deficit of the QSystemTray::showMessage notification is that it does not hide immediately when you click it even if it triggers the callback. Neither can you programmatically close the message via the trayIcon object hence the screenshots showing multiple balloons due to tests firing in rapid succession.

After looking around for a bit the best thing (in terms of interoperability and functionality) seems to be using libnotify just for the notifications (as the XDG desktop notification path is not really viable due to the process privilege constraints).

Good thing here is that now that most of the Qt Tray Menu stuff is now isolated, it should be easy to do something similar for notifications and have a clean implementation.

[ReenigneArcher]

Seems that the publish screenshots workflow didn't work. I'll have to look into that.

[github-actions]

Last Updated	2026-05-16 16:48:27 UTC
Source Run	CI Run #589
Commit	0f771e13fb43210d7097c2f9fc3334ae407fb488

Screenshot Comparison

PR #121 screenshots vs screenshots baseline.

Matrix: Linux-qt5

Image	Baseline	PR
tray_icon_initial.png
tray_icon_svg.png
tray_icon_themed.png
tray_menu_checkbox_checked.png
tray_menu_checkbox_unchecked.png
tray_menu_left_click.png
tray_menu_shown.png
tray_notification_displayed.png
tray_notification_themed_icon.png

Matrix: Linux-qt6

Image	Baseline	PR
tray_icon_initial.png
tray_icon_svg.png
tray_icon_themed.png
tray_menu_checkbox_checked.png
tray_menu_checkbox_unchecked.png
tray_menu_left_click.png
tray_menu_shown.png
tray_notification_displayed.png
tray_notification_themed_icon.png

Matrix: Windows

Image	Baseline	PR
tray_icon_initial.png
tray_menu_checkbox_checked.png
tray_menu_checkbox_unchecked.png
tray_menu_shown.png
tray_notification_displayed.png

Matrix: macOS

Image	Baseline	PR
tray_icon_initial.png
tray_menu_checkbox_checked.png
tray_menu_checkbox_unchecked.png
tray_menu_shown.png
tray_notification_displayed.png

[ReenigneArcher]

Nice, past the failures now!

I do see a few issues from the screenshots though.

• themed tray icons not working anymore
• notifications do not show custom icons anymore

[Kishi85]

I've noted a few discrepancies during basic testing but I wasn't sure if that was just my setup. I'll have a look at those issues and they should be easily fixable. Putting this back to drafting until I've squashed those bugs.

[Kishi85]

@ReenigneArcher Could it be that the reference image for the themed icon is wrong? That does not look like mail-message-new to me tbh. I've added an adaption of the previous icon lookup code and it's showing correctly for my local tests but still does not match the reference image.

EDIT: nvm... i think it's working now after a bit more refactoring

[ReenigneArcher]

I think there was a default fallback before as I couldn't get it to work in these environments. So maybe we just need to select a more common themed icon as I don't think using a fallback is really needed.

[Kishi85]

I've added that default fallback in my refactor and it's working after that.

[Kishi85]

Now it's just the missing notification icon left but that is set upon notification but it somehow isn't found correctly by libnotify if it's a path.

[Kishi85]

Looks like the missing notification icon issue is just with relative icon paths. I'll just convert them to absolute ones in case the path exists in the filesystem.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[ReenigneArcher]

Looks like the missing notification icon issue is just with relative icon paths. I'll just convert them to absolute ones in case the path exists in the filesystem.

How will we know the absolute path on the system where Sunshine is installed? We would only know on the build system. Like LizardByte/homebrew-homebrew#205