Implement v2 notification spec #1298

jsparber · 2024-03-08T16:07:32Z

After lot of consideration I started implementing parts of the proposed and discussed notification API

For now this includes:

Set icon additionally via file descriptor
Set sound via bytes, file descriptor
desktop-file-id property
markup-body property
display-hint property
~~new actions, similar to buttons (the name may be a little confusing, open for suggestions)~~ Part of buttons now
~~content-type~~ category property
Button purpose
Supported options for ~~content-type~~ category, ~~action purpose~~ and button purpose API

This needs changes in libportal flatpak/libportal#147 for tests.

I also started writing the changes needed in xdg-desktop-portal-gtk: https://github.com/jsparber/xdg-desktop-portal-gtk/tree/implement_notification_v2 and other portal backends need to do the same thing.

Parts that didn't made it from #1304 into this MR may be added it a later revision of the portal.

Fixes: #485

Mikenux · 2024-03-08T18:11:28Z

What is the case for letting an app play a sound freely? In the discussion there was talk of linking sound playback to specific cases, e.g. alarm, new message, new email. Also, it seems to me that the question of custom sounds versus system sounds still needs to be resolved for these example cases, unless there is a valid case to allow an app to play sound freely.

jsparber · 2024-03-08T18:34:01Z

What is the case for letting an app play a sound freely?

It's not that apps are allowed to play sound freely, they are allowed to set it. The server may decided whether to play the sound. In GNOME Shell we have a policy system that controls whether a notification can have a sound or not.

In the discussion there was talk of linking sound playback to specific cases, e.g. alarm, new message, new email.

I think this doesn't need to be exclusive and I don't see how it would conflict with class specific sounds.

Also, it seems to me that the question of custom sounds versus system sounds still needs to be resolved for these example cases, unless there is a valid case to allow an app to play sound freely.

Apps already can play any sound if they have the correct sandbox permission. So we prefer that apps use the notification sound so that the system policy can be respected e.g. do-not-disturb. Although, we may want to restrict the type and length of the sound a notification can have.

ilya-fedin · 2024-03-09T00:09:38Z

What is driving me nuts in the freedesktop notification spec is that there's no way to know that system sounds are supported and which music formats are supported for custom sounds. This made the sound spec part just unusable when I attempted to play sound with it:

First I tried to set .mp3 files via sound-file. No notification daemon has played it. The .mp3 file may come from embedded resources of the application or from the cloud uploaded by the user (so pre-converting the embedded one won't really help). The application has no transcoding capabilities and there's no manpower to implement it in the application.
Then I tried to set sound-name to message-new-instant. To my surprise this worked only on GNOME and Pantheon. KDE, MATE, Xfce, LXQt, Budgie, Cinnamon, Deepin: none of them were able to play it. Deepin was always playing its own sound, even with disable-sound = true. Although, KDE and Deepin don't support the sound capability at all so their behavior is quite expected.
Ok, let's set sound-name only when it's supported and only when the user has chosen the default sound embedded in the application resources (so the user choice is still respected yet most users will get sound via notification daemon). No, you can't, there's only sound capability that says "sound-file must be supported and sound-name may be supported".

This resulted in application always playing the notification sound on its own. I really hope these problems will be solved in the new API.

data/org.freedesktop.portal.Notification.xml

Mikenux · 2024-04-13T13:57:57Z

Apps already can play any sound if they have the correct sandbox permission. So we prefer that apps use the notification sound so that the system policy can be respected e.g. do-not-disturb.

I think one thing to check is if there are static permissions that can help apps guess what mode the device is in (sound, vibration, silent, DND). For example, alarms will certainly be allowed by users, because they are logically important to them. In fact, apps that will use alarm notifications will be able to play sound (because in any mode you cannot completely mute the sound, unless it can be done selectively without dynamic permission), but especially to present a notification (even more so if this is also not constrained by specific experience and actions).

data/org.freedesktop.impl.portal.Notification.xml

data/org.freedesktop.portal.Notification.xml

jsparber · 2024-04-19T15:30:45Z

@pwithnall thanks for the review :)

src/notification.c

src/xdp-utils.c

src/notification.c

tests/notification.c

src/notification.c

tests/notification.c

data/org.freedesktop.portal.Notification.xml

src/notification.c

swick · 2024-04-22T14:46:42Z

Still have to look at the sound validator but I'm through with everything else.

Icons could potentially be really big in size. Instead of passing the data via GBytesIcon (as part of the D-Bus message) allow passing a sealed fd created with `memfd_create()`

This property allows applications to specify a sound to be played whenever the notification is displayed. The format used is inspired by the serialized from of GIcons.

The `markup-body` property allows applications to set markup on the body. The used markup is a subset of html limted to <b>, <i> and <a>.

This property allows apps to specify how the notification is displayed.

We need to hand out the activation token for XDG Activation in some way. I think it's pretty nice that we can just add the same platform data as used for DBus Activation to the ActionInvoked signal.

The category allows the notification server to handle specific notification different. E.g. calls notifications.

The purpose for a button allows the notification server to style the button specially and know the purpose of the button.

Let applications query supported options for category and button purpose.

We need to make sure that the backend supports new features introduced to the frontend. This ensure backwards compatibility with older backend versions.

We want to support old backends ensure we filter out properties that were introduced in never versions. In the case of the file-descriptor icon we can translate it to a bytes icon to increase compatibility.

Since we now have the option to give a file-descriptor there is no need for moving binary data across D-Bus. This also ensures backwards compatibility by converting the icon property's `bytes` option to the `file-descriptor` option.

pwithnall · 2024-10-17T11:42:04Z

🥳

ilya-fedin · 2024-10-18T02:42:44Z

When will the API be available in backends (such as xdg-desktop-portal-gtk/-kde) and libraries (KNotification/GNotification)?

Mikenux mentioned this pull request Mar 8, 2024

Notifications Portal v2 proposal #983

Closed

jsparber changed the title ~~Implement v2 notification spec~~ Start to implement v2 notification spec Mar 9, 2024

jsparber force-pushed the implement_v2_notification_spec branch from eae298c to 6cb0d0b Compare March 22, 2024 17:28

ilya-fedin reviewed Mar 22, 2024

View reviewed changes

jsparber force-pushed the implement_v2_notification_spec branch 2 times, most recently from 1c893d7 to 9c11013 Compare March 26, 2024 17:08

ilya-fedin mentioned this pull request Mar 30, 2024

Add an option to display notification content even if screen is locked telegramdesktop/tdesktop#27666

Open

bertob reviewed Apr 3, 2024

View reviewed changes

data/org.freedesktop.portal.Notification.xml Outdated Show resolved Hide resolved

jsparber force-pushed the implement_v2_notification_spec branch from 9c11013 to 60db472 Compare April 5, 2024 17:59

jsparber force-pushed the implement_v2_notification_spec branch 8 times, most recently from 5705ffc to 049806c Compare April 16, 2024 11:14

jsparber marked this pull request as ready for review April 16, 2024 12:50

jsparber changed the title ~~Start to implement v2 notification spec~~ Implement v2 notification spec Apr 16, 2024

jsparber mentioned this pull request Apr 16, 2024

notification: Implement version2 of the interface flatpak/libportal#147

Merged

pwithnall reviewed Apr 19, 2024

View reviewed changes

jsparber force-pushed the implement_v2_notification_spec branch from 049806c to fc2483f Compare April 19, 2024 16:05

swick reviewed Apr 22, 2024

View reviewed changes

jsparber added 18 commits October 16, 2024 18:42

notification: Accept icons as file descriptor

a43693a

Icons could potentially be really big in size. Instead of passing the data via GBytesIcon (as part of the D-Bus message) allow passing a sealed fd created with `memfd_create()`

tests: Implement tests for file-descriptor notification icons

40770d2

notification: Add new sound property

eafe091

This property allows applications to specify a sound to be played whenever the notification is displayed. The format used is inspired by the serialized from of GIcons.

test: Implement tests for notification sound property

0932ee7

notification: Add new property markup-body to support markup

19774be

The `markup-body` property allows applications to set markup on the body. The used markup is a subset of html limted to <b>, <i> and <a>.

notification: Improve description of title and body

297b5a8

test: Implement test for notification property markup-body

20a2e63

notification: Add display-hint property

9c617f1

This property allows apps to specify how the notification is displayed.

test: Implement tests for display-hint notification property

6a4b280

notification: Improve wording around DBus Activation

6e895bc

notification: Add platform-data to ActionInvoked signal

077ff6e

We need to hand out the activation token for XDG Activation in some way. I think it's pretty nice that we can just add the same platform data as used for DBus Activation to the ActionInvoked signal.

notification: Add category property

eb8c1f4

The category allows the notification server to handle specific notification different. E.g. calls notifications.

notification: Add purpose property for buttons

a5fac9b

The purpose for a button allows the notification server to style the button specially and know the purpose of the button.

test: Implement tests for category notification property

c2ae443

notification: Add supported-options property

2baa5b8

Let applications query supported options for category and button purpose.

test: Implement tests for supported-options property in notification

cb08bd3

notification: Introduce version property for backend impl interface

4b1a2e3

We need to make sure that the backend supports new features introduced to the frontend. This ensure backwards compatibility with older backend versions.

notification: Ensure backwards compatibility with old backends

2e8860a

We want to support old backends ensure we filter out properties that were introduced in never versions. In the case of the file-descriptor icon we can translate it to a bytes icon to increase compatibility.

jsparber force-pushed the implement_v2_notification_spec branch from b59b265 to 8c3832b Compare October 16, 2024 16:43

notification: Deprecate bytes option for icons

1e65575

Since we now have the option to give a file-descriptor there is no need for moving binary data across D-Bus. This also ensures backwards compatibility by converting the icon property's `bytes` option to the `file-descriptor` option.

jsparber force-pushed the implement_v2_notification_spec branch from 8c3832b to 1e65575 Compare October 17, 2024 07:58

GeorgesStavracas approved these changes Oct 17, 2024

View reviewed changes

GeorgesStavracas added this pull request to the merge queue Oct 17, 2024

Merged via the queue into flatpak:main with commit 5663bff Oct 17, 2024
5 checks passed

This was referenced Oct 30, 2024

libportal: Add activation-token to notification-action-invoked flatpak/libportal#88

Open

notification: Add platform-data (with activation_token) to ActionInvoked #791

Closed

Add Persistence notification flags #786

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement v2 notification spec #1298

Implement v2 notification spec #1298

jsparber commented Mar 8, 2024 •

edited

Loading

Mikenux commented Mar 8, 2024

jsparber commented Mar 8, 2024

ilya-fedin commented Mar 9, 2024 •

edited

Loading

Mikenux commented Apr 13, 2024 •

edited

Loading

jsparber commented Apr 19, 2024

swick commented Apr 22, 2024

pwithnall commented Oct 17, 2024

ilya-fedin commented Oct 18, 2024

Implement v2 notification spec #1298

Implement v2 notification spec #1298

Conversation

jsparber commented Mar 8, 2024 • edited Loading

Mikenux commented Mar 8, 2024

jsparber commented Mar 8, 2024

ilya-fedin commented Mar 9, 2024 • edited Loading

Mikenux commented Apr 13, 2024 • edited Loading

jsparber commented Apr 19, 2024

swick commented Apr 22, 2024

pwithnall commented Oct 17, 2024

ilya-fedin commented Oct 18, 2024

jsparber commented Mar 8, 2024 •

edited

Loading

ilya-fedin commented Mar 9, 2024 •

edited

Loading

Mikenux commented Apr 13, 2024 •

edited

Loading