Skip to content

feat: Simplify QT-based tray implementation#121

Draft
Kishi85 wants to merge 17 commits into
LizardByte:masterfrom
Kishi85:simplify-qt-tray
Draft

feat: Simplify QT-based tray implementation#121
Kishi85 wants to merge 17 commits into
LizardByte:masterfrom
Kishi85:simplify-qt-tray

Conversation

@Kishi85
Copy link
Copy Markdown

@Kishi85 Kishi85 commented May 8, 2026

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

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

@Kishi85 Kishi85 changed the title Simplify QT-based tray implementaion fix: Simplify QT-based tray implementaion May 8, 2026
@Kishi85 Kishi85 changed the title fix: Simplify QT-based tray implementaion feat: Simplify QT-based tray implementaion May 8, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 9, 2026

Codecov Report

❌ Patch coverage is 59.23077% with 106 lines in your changes missing coverage. Please review.
✅ Project coverage is 52.54%. Comparing base (4595d07) to head (97fd4bf).
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
src/QtTrayMenu.cpp 52.54% 55 Missing and 29 partials ⚠️
src/tray_linux.cpp 73.49% 7 Missing and 15 partials ⚠️

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

HEAD has 2 uploads less than BASE
Flag BASE (4595d07) HEAD (97fd4bf)
macOS 1 0
Windows 1 0
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           master     #121       +/-   ##
===========================================
- Coverage   63.51%   52.54%   -10.98%     
===========================================
  Files           4        3        -1     
  Lines         858      314      -544     
  Branches      313      141      -172     
===========================================
- Hits          545      165      -380     
+ Misses        207      105      -102     
+ Partials      106       44       -62     
Flag Coverage Δ
Linux-qt5 52.54% <59.23%> (-4.58%) ⬇️
Linux-qt6 52.54% <59.23%> (-4.58%) ⬇️
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 52.54% <52.54%> (ø)

... 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...97fd4bf. Read the comment docs.

@Kishi85 Kishi85 force-pushed the simplify-qt-tray branch 11 times, most recently from 275be0f to c552bda Compare May 11, 2026 11:31
@Kishi85
Copy link
Copy Markdown
Author

Kishi85 commented May 11, 2026

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
Copy link
Copy Markdown
Member

@Kishi85 have a look at #123

Comment thread src/QtTrayMenu.cpp Outdated
Comment thread src/tray_linux.cpp
@Kishi85
Copy link
Copy Markdown
Author

Kishi85 commented May 12, 2026

@Kishi85 have a look at #123

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

@Kishi85
Copy link
Copy Markdown
Author

Kishi85 commented May 12, 2026

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 Kishi85 force-pushed the simplify-qt-tray branch from c552bda to 329b911 Compare May 12, 2026 06:18
@Kishi85
Copy link
Copy Markdown
Author

Kishi85 commented May 12, 2026

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.

@Kishi85 Kishi85 force-pushed the simplify-qt-tray branch from e74329c to 8ebf071 Compare May 12, 2026 11:04
@Kishi85 Kishi85 changed the title feat: Simplify QT-based tray implementaion feat: Simplify QT-based tray implementation May 12, 2026
@Kishi85 Kishi85 force-pushed the simplify-qt-tray branch 5 times, most recently from b747b99 to 26d15e6 Compare May 15, 2026 09:40
@ReenigneArcher
Copy link
Copy Markdown
Member

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

@Kishi85 Kishi85 force-pushed the simplify-qt-tray branch from 26d15e6 to e091443 Compare May 16, 2026 08:25
@Kishi85 Kishi85 marked this pull request as ready for review May 16, 2026 14:25
@Kishi85
Copy link
Copy Markdown
Author

Kishi85 commented May 16, 2026

Looks like I've jinxed it... unit tests don't fail locally but in CI they do it again ...

@ReenigneArcher
Copy link
Copy Markdown
Member

qt5 passed though, interesting

Comment thread src/tray_linux.cpp Outdated
@Kishi85 Kishi85 force-pushed the simplify-qt-tray branch from 02acae4 to c4bce6b Compare May 16, 2026 15:24
Kishi85 and others added 16 commits May 16, 2026 17:26
Add a persistent default argv (anonymous namespace) and include QCursor, then construct QApplication with the default argv when original argc/argv are missing to avoid using a short-lived stack array. Hide trayTopMenu before clearing tray references to prevent lingering UI. Replace menu->show() with menu->popup(QCursor::pos()) to work around QTBUG-139921 on Linux/Wayland. NOSONAR comments for QApplication allocation are preserved.
@Kishi85 Kishi85 force-pushed the simplify-qt-tray branch from c4bce6b to 013564c Compare May 16, 2026 15:26
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 16, 2026

Last Updated 2026-05-16 16:03:50 UTC
Source Run CI Run #588
Commit 97fd4bfee8486ff94d0342b2d87a49410ae34d78

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
Copy link
Copy Markdown
Member

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

@sonarqubecloud
Copy link
Copy Markdown

@Kishi85
Copy link
Copy Markdown
Author

Kishi85 commented May 16, 2026

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 Kishi85 marked this pull request as draft May 16, 2026 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants