Layer shell support #53

DemiMarie · 2024-12-01T03:57:37Z

This is almost completely working under Wayland. To test, use a compositor that supports Layer Shell, such as KWin. KWin can be spawned nested inside an X11 window, such as what Qubes OS provides.

Issues:

The window is too short: fixed by explicitly setting the menu size every time the window is opened.
The configuration options that control where the app menu appears did not work: fixed by explicitly checking for them and anchoring the window to the correct corner
Tests code was included in the production script: I moved the test code to my own local branch.
mouse mode is interpreted as bottom-left (KDE) or top-left (otherwise): will be fixed by providing mouse information via IPC.

Fixes QubesOS/qubes-issues#9600

marmarta · 2024-12-01T11:37:27Z

Yay, this looks great! I see you already know about the config options for menu location, so I won't do a review with that :D
BTW, by default, the menu appears not exactly in top-left corner, but next to mouse.

DemiMarie · 2024-12-01T15:51:38Z

Yay, this looks great! I see you already know about the config options for menu location, so I won't do a review with that :D BTW, by default, the menu appears not exactly in top-left corner, but next to mouse.

With this patch, the menu will appear in exactly the corner specified by configuration. Is that okay?

marmarek · 2024-12-02T04:51:48Z

pylint complains, the stuff related to mockups (protected access, wrong import place) you can ignore with a comment, but too long lines want fixing

qubes_menu/appmenu.py

marmarek · 2024-12-02T13:48:34Z

openQA says https://openqa.qubes-os.org/tests/120587#step/simple_gui_apps/6
good: no more border
bad: in the center of the screen, very small

marmarta · 2024-12-02T13:50:11Z

looks like some minimal size, the size-setting seems to have failed

DemiMarie · 2024-12-02T22:59:24Z

As per discussion with @marmarta in Matrix, the current plan is:

Initially, or if no position information is provided, launch the application in a corner. The default will be bottom-left under KDE and top-left otherwise.
In a future PR, the platform-specific plugin will provide the needed information.

qubesos-bot · 2024-12-02T23:21:57Z

OpenQA test summary

Complete test suite and dependencies: https://openqa.qubes-os.org/tests/overview?distri=qubesos&version=4.3&build=2024121602-4.3&flavor=pull-requests

Test run included the following:

New failures, excluding unstable

Compared to: https://openqa.qubes-os.org/tests/overview?distri=qubesos&version=4.3&build=2024111705-4.3&flavor=update

system_tests_basic_vm_qrexec_gui
- TC_30_Gui_daemon: test_002_clipboard_200k (failure)
  AssertionError: '' != 'test123ab\ntest123ab\ntest123ab\ntest123a[21...
system_tests_extra
- TC_00_QVCTest_debian-12-xfce: test_010_screenshare (failure)
  AssertionError: 7.933165427175505 not less than 2.0
system_tests_kde_gui_interactive
- gui_keyboard_layout: wait_serial (wait serial expected)
  # wait_serial expected: "echo -e '[Layout]\nLayoutList=us,de' | sud...

Failed tests

4 failures

system_tests_basic_vm_qrexec_gui
- TC_30_Gui_daemon: test_002_clipboard_200k (failure)
  AssertionError: '' != 'test123ab\ntest123ab\ntest123ab\ntest123a[21...
system_tests_extra
- TC_00_QVCTest_debian-12-xfce: test_010_screenshare (failure)
  AssertionError: 7.933165427175505 not less than 2.0
system_tests_kde_gui_interactive
- gui_keyboard_layout: wait_serial (wait serial expected)
  # wait_serial expected: "echo -e '[Layout]\nLayoutList=us,de' | sud...
- gui_keyboard_layout: Failed (test died)
  # Test died: command 'test "$(cd ~user;ls e1*)" = "$(qvm-run -p wor...

Fixed failures

Compared to: https://openqa.qubes-os.org/tests/119126#dependencies

3 fixed

system_tests_extra
- TC_00_QVCTest_whonix-gateway-17: test_010_screenshare (failure)
  ~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^... AssertionError: 0 == 0
system_tests_basic_vm_qrexec_gui_zfs
- switch_pool: Failed (test died)
  # Test died: command 'dnf install -y ./zfs-release.rpm' failed at /...
system_tests_audio@hw1
- TC_20_AudioVM_PipeWire_whonix-workstation-17: test_260_audio_mic_enabled_switch_audiovm (failure)
  AssertionError: too short audio, expected 10s, got 0.00013605442176...

Unstable tests

system_tests_basic_vm_qrexec_gui_zfs
TC_00_Basic/test_120_start_standalone_with_cdrom_dom0 (1/5 times with errors)
- job 109480 AssertionError: 1 != 0 : b'Timeout waiting for dom0:loop6 device to...
system_tests_audio
TC_20_AudioVM_PipeWire_fedora-40-xfce/test_260_audio_mic_enabled_switch_audiovm (1/5 times with errors)
- job 117586 AssertionError: too short audio, expected 10s, got 0.00013605442176...
system_tests_audio@hw1
TC_20_AudioVM_PipeWire_fedora-40-xfce/test_260_audio_mic_enabled_switch_audiovm (1/5 times with errors)
- job 117586 AssertionError: too short audio, expected 10s, got 0.00013605442176...

marmarek · 2024-12-03T17:20:28Z

Now it opens in the correct corner (at least in KDE), but it's still small: https://openqa.qubes-os.org/tests/120796#step/simple_gui_apps/6

DemiMarie · 2024-12-04T22:06:58Z

Now it opens in the correct corner (at least in KDE), but it's still small: https://openqa.qubes-os.org/tests/120796#step/simple_gui_apps/6

The problem is that when running as a daemon, self.main_window.get_allocated_width() and self.main_window.get_allocated_height() both return 1. Patch coming.

marmarek · 2024-12-06T02:40:29Z

Now it opens in a correct place: https://openqa.qubes-os.org/tests/121008#step/simple_gui_apps/4 :)
(it looks to overlap the panel a bit, but it's only because the mouse is in the right bottom corner, which is a gesture that among other things moves the panel up a bit)

marmarek · 2024-12-06T02:42:50Z

But mypy complains, about None not handled in few places. If it's false positive, AFAIR adding assert ... is not None should do the trick.

codecov · 2024-12-06T05:35:52Z

Codecov Report

Attention: Patch coverage is 34.00000% with 33 lines in your changes missing coverage. Please review.

Project coverage is 81.37%. Comparing base (8c75256) to head (8d2ebd7).
Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
qubes_menu/appmenu.py	34.00%	33 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #53      +/-   ##
==========================================
- Coverage   82.19%   81.37%   -0.83%     
==========================================
  Files          22       22              
  Lines        2342     2378      +36     
==========================================
+ Hits         1925     1935      +10     
- Misses        417      443      +26

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

qubes_menu/appmenu.py

This adds Wayland support on compositors that support the wlr-layer-shell protocol, which includes KWin, Sway, COSMIC, niri, Mir, GameScope, and Jay. The only major compositors without support for wlr-layer-shell are Mutter, which is generally only used by GNOME, and Weston, which is not a general-purpose desktop compositor.

marmarta · 2024-12-11T12:58:24Z

visually this looks good, can we get an OpenQA run? @marmarek

marmarta · 2024-12-11T13:13:41Z

Ok, it looks fine now. Does clicking away from the menu work? (as in, clicking elsewhere - anywhere, hopefully, but I assume wayland has bugs here too)

DemiMarie · 2024-12-11T16:45:26Z

Ok, it looks fine now. Does clicking away from the menu work? (as in, clicking elsewhere - anywhere, hopefully, but I assume wayland has bugs here too)

As discussed on the call: Yes, except for clicking on unused areas of the taskbar, just like the X11 menu.

DemiMarie force-pushed the layer-shell branch 3 times, most recently from 56c9ea8 to 0384b93 Compare December 1, 2024 07:36

DemiMarie force-pushed the layer-shell branch from 0384b93 to 4201a3a Compare December 2, 2024 01:41

marmarek added the openqa-pending label Dec 2, 2024

marmarta reviewed Dec 2, 2024

View reviewed changes

qubes_menu/appmenu.py Outdated Show resolved Hide resolved

marmarta reviewed Dec 2, 2024

View reviewed changes

qubes_menu/appmenu.py Outdated Show resolved Hide resolved

This was referenced Dec 2, 2024

tests: try dracut on Debian too QubesOS/qubes-core-admin#638

Merged

Add dracut config to the Debian package too QubesOS/qubes-core-agent-linux#536

Merged

DemiMarie force-pushed the layer-shell branch from 4201a3a to caf5998 Compare December 3, 2024 05:07

qubesos-bot mentioned this pull request Dec 3, 2024

Try to retrieve exit code of a failed service call QubesOS/qubes-core-qrexec#183

Merged

qubesos-bot mentioned this pull request Dec 4, 2024

audio: fix reacting on mic enable/disable requests QubesOS/qubes-gui-daemon#161

Merged

DemiMarie force-pushed the layer-shell branch from caf5998 to 6eabf75 Compare December 5, 2024 03:52

DemiMarie force-pushed the layer-shell branch from 6eabf75 to c113534 Compare December 6, 2024 05:13

qubesos-bot mentioned this pull request Dec 6, 2024

pipewire: prevent starting in root session QubesOS/qubes-gui-agent-linux#220

Merged

marmarta reviewed Dec 6, 2024

View reviewed changes

qubes_menu/appmenu.py Outdated Show resolved Hide resolved

DemiMarie force-pushed the layer-shell branch from c113534 to 8d2ebd7 Compare December 7, 2024 00:16

qubesos-bot mentioned this pull request Dec 7, 2024

log stdout/err from updates check on Debian QubesOS/qubes-core-agent-linux#537

Merged

DemiMarie requested a review from marmarta December 8, 2024 22:34

marmarta approved these changes Dec 11, 2024

View reviewed changes

marmarta approved these changes Dec 16, 2024

View reviewed changes

marmarek merged commit e5b0adc into QubesOS:main Dec 17, 2024
2 of 4 checks passed

DemiMarie deleted the layer-shell branch December 18, 2024 19:47

Uh oh!

Layer shell support #53

Layer shell support #53

Uh oh!

Conversation

DemiMarie commented Dec 1, 2024 • edited by marmarek Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marmarta commented Dec 1, 2024

Uh oh!

DemiMarie commented Dec 1, 2024

Uh oh!

marmarek commented Dec 2, 2024

Uh oh!

Uh oh!

Uh oh!

marmarek commented Dec 2, 2024

Uh oh!

marmarta commented Dec 2, 2024

Uh oh!

DemiMarie commented Dec 2, 2024

Uh oh!

qubesos-bot commented Dec 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

OpenQA test summary

New failures, excluding unstable

Failed tests

Fixed failures

Unstable tests

Uh oh!

marmarek commented Dec 3, 2024

Uh oh!

DemiMarie commented Dec 4, 2024

Uh oh!

marmarek commented Dec 6, 2024

Uh oh!

marmarek commented Dec 6, 2024

Uh oh!

codecov bot commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

marmarta commented Dec 11, 2024

Uh oh!

marmarta commented Dec 11, 2024

Uh oh!

DemiMarie commented Dec 11, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

DemiMarie commented Dec 1, 2024 •

edited by marmarek

Loading

qubesos-bot commented Dec 2, 2024 •

edited

Loading

codecov bot commented Dec 6, 2024 •

edited

Loading