Skip to content

feat: Simplify QT-based tray implementation#121

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

feat: Simplify QT-based tray implementation#121
Kishi85 wants to merge 15 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 65.88785% with 73 lines in your changes missing coverage. Please review.
✅ Project coverage is 66.66%. Comparing base (2a638a8) to head (8ebf071).
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
src/QtTrayMenu.cpp 63.63% 32 Missing and 32 partials ⚠️
src/tray_linux.cpp 76.31% 2 Missing and 7 partials ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #121      +/-   ##
==========================================
+ Coverage   63.75%   66.66%   +2.91%     
==========================================
  Files           4        5       +1     
  Lines         858      537     -321     
  Branches      313      153     -160     
==========================================
- Hits          547      358     -189     
+ Misses        208      115      -93     
+ Partials      103       64      -39     
Flag Coverage Δ
Linux-qt5 54.96% <65.88%> (-2.16%) ⬇️
Linux-qt6 54.96% <65.88%> (-2.16%) ⬇️
Windows 70.67% <ø> (ø)
macOS 59.29% <ø> (ø)

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

Files with missing lines Coverage Δ
src/tray_linux.cpp 50.79% <76.31%> (-8.68%) ⬇️
src/QtTrayMenu.cpp 63.63% <63.63%> (ø)

... and 1 file 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 2a638a8...8ebf071. 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 and others added 10 commits May 12, 2026 08:04
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
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
@sonarqubecloud
Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
2 New issues
2 New Code Smells (required ≤ 0)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

@Kishi85 Kishi85 changed the title feat: Simplify QT-based tray implementaion feat: Simplify QT-based tray implementation May 12, 2026
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