Wayland server side decorations #3425

tarek-y-ismail · 2024-06-14T09:39:05Z

…its code

Had to move `XdgTopLevelStable` to its header file so I can include it, and moved `from()` to be public.

codecov · 2024-06-14T09:52:38Z

Codecov Report

Attention: Patch coverage is 13.20755% with 46 lines in your changes missing coverage. Please review.

Project coverage is 77.40%. Comparing base (1398638) to head (faa1e16).
Report is 467 commits behind head on main.

Files with missing lines	Patch %	Lines
...er/frontend_wayland/xdg_decoration_unstable_v1.cpp	8.00%	46 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3425      +/-   ##
==========================================
+ Coverage   77.31%   77.40%   +0.08%     
==========================================
  Files        1068     1074       +6     
  Lines       68284    68834     +550     
==========================================
+ Hits        52797    53282     +485     
- Misses      15487    15552      +65

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

AlanGriffiths

There's a style guide at https://mir-server.io/doc/cppguide/

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp

src/server/frontend_wayland/xdg_decoration_unstable_v1.h

src/server/frontend_wayland/xdg_shell_stable.h

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp

AlanGriffiths

Checking the WAYLAND_DEBUG log, we're never sending a toplevel_decoration_v1.configure() event. The client needs this to know whether or not to draw decorations

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp

Removed superfluous `configure` method, as well as unwrapping `mode` to a normal uint32_t.

AlanGriffiths

This looks like the basics are working. Once you're satisfied with "error handling" etc please mark the PR "ready"

As discussed, there should be some corresponding tests in wlcs.

Comments addressed

AlanGriffiths · 2024-06-17T09:02:09Z

Not needed for this PR

We should discuss a follow on PR that allows the decoration decision strategy to be customised by shells built with Mir.

There are eight possible strategies: the client has three requests (ssd, csd and unset) to which we can respond in two ways. But half of the "legal" strategies are perverse. What remains are:

always-csd - whatever the client requests, send "csd"
prefer-csd - if the client requests ssd then send "ssd", otherwise send "csd"
prefer-ssd - if the client requests csd then send "csd", otherwise send "ssd"
always-ssd - whatever the client requests, send "ssd"

get_toplevel_decoration

AlanGriffiths

We need to manage toplevels_with_decorations better. Stale entries are problematic for two reasons:

decoration objects can be destroyed, leaving the corresponding toplevel incorrectly classified
toplevel objects can be destroyed leaving an invalid pointer

Comparisons (during lookup) with invalid pointers are undefined behaviour

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp

AlanGriffiths

Some nits pending side-channel discussion

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp

AlanGriffiths

There are also unresolved comments from an earlier review

tests/acceptance-tests/wayland/CMakeLists.txt

…terToplevel`

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp

…able copying. Co-authored-by: Alan Griffiths <[email protected]>

Also fixed a sneaky bug caused by checking if one toplevel was registered instead of zero. toplevels should be already unregistered by their decorations by the time they're destroyed, otherwise it's a protocol error.

AlanGriffiths

Getting there...

AlanGriffiths · 2024-07-01T15:11:12Z

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp

+            const auto orphaned_decoration = !toplevels_with_decorations->unregister_toplevel(toplevel);
+            if (!client->is_being_destroyed() && orphaned_decoration)


Suggested change

const auto orphaned_decoration = !toplevels_with_decorations->unregister_toplevel(toplevel);

if (!client->is_being_destroyed() && orphaned_decoration)

if (!toplevels_with_decorations->unregister_toplevel(toplevel) && !client->is_being_destroyed())

I can't see what is achieved here other than saving a variable declaration (which the compiler likely optimizes anyway). I think the original might be a bit more readable.

AlanGriffiths · 2024-07-02T08:09:58Z

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp

+    /// \return true if the toplevel didn't exist in the set, false otherwise.
+    /// The return value is used in the destroy callback of the toplevel to
+    /// check if the toplevel is destroyed before the decoration (orphaned
+    /// decoration).


This is a very weird semantic: returning false on success.

It is normal to document the preconditions, action, and postconditions of a function. Not where its result happens to be used

I agree. I myself was a bit confused while using this method.

I've moved the explanation to where the mentioned case is actually handled. I might've detailed things too much, but I think this will save the next person (likely me :)) that works on this code some time.

orphaning

AlanGriffiths

LGTM

…re_decoration_throws_orphaned`

tarek-y-ismail added 2 commits June 14, 2024 12:08

Add xdg-decoration-unstable-v1 and modify CMakeLists.txt to generate …

e80daf5

…its code

Add first prototype of xdg-decoration-unstable-v1.

feca272

Had to move `XdgTopLevelStable` to its header file so I can include it, and moved `from()` to be public.

tarek-y-ismail self-assigned this Jun 14, 2024

tarek-y-ismail requested a review from a team as a code owner June 14, 2024 09:39

tarek-y-ismail marked this pull request as draft June 14, 2024 11:07

AlanGriffiths requested changes Jun 14, 2024

View reviewed changes

Apply formatting

cc04d24

AlanGriffiths previously requested changes Jun 14, 2024

View reviewed changes

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Show resolved Hide resolved

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Outdated Show resolved Hide resolved

AlanGriffiths reviewed Jun 14, 2024

View reviewed changes

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Outdated Show resolved Hide resolved

tarek-y-ismail added 5 commits June 14, 2024 19:43

Add missing configure event call.

5b8027c

Removed superfluous `configure` method, as well as unwrapping `mode` to a normal uint32_t.

Apply formatting.

68aad57

Remove mir::wayland alias in header.

59c8c08

Add missing copyright notice to xdg_decoration_unstable_v1.cpp

826096a

Strip logs from xdg_decoration_unstable_v1.cpp

7e75976

AlanGriffiths reviewed Jun 17, 2024

View reviewed changes

tarek-y-ismail and others added 3 commits June 24, 2024 15:36

Add basic error handling for xdg decoration

ba4db7c

Apply formatting to xdg_decoration_unstable_v1.cpp

9d89052

Convert the wayland error check to a sanity check in

b8f0b2c

get_toplevel_decoration

tarek-y-ismail marked this pull request as ready for review June 25, 2024 09:07

AlanGriffiths requested changes Jun 25, 2024

View reviewed changes

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Outdated Show resolved Hide resolved

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Outdated Show resolved Hide resolved

Add listeners for decoration and toplevel destruction

0741868

AlanGriffiths requested changes Jun 26, 2024

View reviewed changes

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Outdated Show resolved Hide resolved

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Outdated Show resolved Hide resolved

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Outdated Show resolved Hide resolved

tarek-y-ismail force-pushed the wayland-server-side-decorations branch from eeaf76b to 0741868 Compare June 28, 2024 09:11

Tarek Yasser added 2 commits June 28, 2024 12:12

Log instead of throwing orphaned when toplevels are destroyed.

2a42cf4

Add destroy_toplevel_before_decoration to expected failure list.

f52391e

AlanGriffiths requested changes Jun 28, 2024

View reviewed changes

tests/acceptance-tests/wayland/CMakeLists.txt Outdated Show resolved Hide resolved

tarek-y-ismail mentioned this pull request Jun 28, 2024

Add command line option to control the behavior of xdg_decoration_unstable_v1 #3453

Closed

Tarek Yasser added 3 commits July 1, 2024 12:41

Wrap toplevels_with_decorations in a class.

6632601

Fix comment typo in `mir::frontend::ToplevelsWithDecorations::unregis…

f240d13

…terToplevel`

Make comment in acceptance-tests/wayland/CMakeLists.txt clearer.

27d1207

AlanGriffiths requested changes Jul 1, 2024

View reviewed changes

Tarek Yasser added 2 commits July 1, 2024 16:34

Fix lifetime issues related to toplevels_with_decorations.

e0ca81e

Fix naming convention of {register,unregister}Toplevel.

2012b20

AlanGriffiths requested changes Jul 1, 2024

View reviewed changes

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Outdated Show resolved Hide resolved

src/server/frontend_wayland/xdg_decoration_unstable_v1.cpp Outdated Show resolved Hide resolved

tarek-y-ismail and others added 2 commits July 1, 2024 17:33

Remove redundant ToplevelsWithDecorations construction code and dis…

6faabb4

…able copying. Co-authored-by: Alan Griffiths <[email protected]>

Always unregister toplevel on destruction.

e69e676

Also fixed a sneaky bug caused by checking if one toplevel was registered instead of zero. toplevels should be already unregistered by their decorations by the time they're destroyed, otherwise it's a protocol error.

AlanGriffiths requested changes Jul 2, 2024

View reviewed changes

Improve semantics of unregister_toplevel and explain decoration

1af2a26

orphaning

AlanGriffiths approved these changes Jul 2, 2024

View reviewed changes

AlanGriffiths enabled auto-merge July 2, 2024 10:46

Rename destroy_toplevel_before_decoration to `destroy_toplevel_befo…

faa1e16

…re_decoration_throws_orphaned`

AlanGriffiths added this pull request to the merge queue Jul 2, 2024

Merged via the queue into main with commit 6f465ad Jul 2, 2024
32 of 36 checks passed

AlanGriffiths deleted the wayland-server-side-decorations branch July 2, 2024 16:42

AlanGriffiths mentioned this pull request Jul 15, 2024

XDG-Decoration support #664

Closed

Saviq mentioned this pull request Aug 23, 2024

Shell-customized server-side decorations #3372

Open

AlanGriffiths mentioned this pull request Sep 9, 2024

Release 2.18.0 #3532

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wayland server side decorations #3425

Wayland server side decorations #3425

tarek-y-ismail commented Jun 14, 2024 •

edited

Loading

codecov bot commented Jun 14, 2024 •

edited

Loading

AlanGriffiths left a comment

AlanGriffiths left a comment

AlanGriffiths left a comment

AlanGriffiths commented Jun 17, 2024

AlanGriffiths left a comment

AlanGriffiths left a comment

AlanGriffiths left a comment

AlanGriffiths left a comment

AlanGriffiths Jul 1, 2024

tarek-y-ismail Jul 2, 2024

AlanGriffiths Jul 2, 2024

tarek-y-ismail Jul 2, 2024

AlanGriffiths left a comment

		const auto orphaned_decoration = !toplevels_with_decorations->unregister_toplevel(toplevel);
		if (!client->is_being_destroyed() && orphaned_decoration)

	const auto orphaned_decoration = !toplevels_with_decorations->unregister_toplevel(toplevel);
	if (!client->is_being_destroyed() && orphaned_decoration)
	if (!toplevels_with_decorations->unregister_toplevel(toplevel) && !client->is_being_destroyed())

Wayland server side decorations #3425

Wayland server side decorations #3425

Conversation

tarek-y-ismail commented Jun 14, 2024 • edited Loading

codecov bot commented Jun 14, 2024 • edited Loading

Codecov Report

AlanGriffiths left a comment

Choose a reason for hiding this comment

AlanGriffiths left a comment

Choose a reason for hiding this comment

AlanGriffiths left a comment

Choose a reason for hiding this comment

AlanGriffiths commented Jun 17, 2024

AlanGriffiths left a comment

Choose a reason for hiding this comment

AlanGriffiths left a comment

Choose a reason for hiding this comment

AlanGriffiths left a comment

Choose a reason for hiding this comment

AlanGriffiths left a comment

Choose a reason for hiding this comment

AlanGriffiths Jul 1, 2024

Choose a reason for hiding this comment

tarek-y-ismail Jul 2, 2024

Choose a reason for hiding this comment

AlanGriffiths Jul 2, 2024

Choose a reason for hiding this comment

tarek-y-ismail Jul 2, 2024

Choose a reason for hiding this comment

AlanGriffiths left a comment

Choose a reason for hiding this comment

tarek-y-ismail commented Jun 14, 2024 •

edited

Loading

codecov bot commented Jun 14, 2024 •

edited

Loading