MSC4174: add support for WebPush pusher kind #17987

MatMaul · 2024-12-02T22:55:59Z

matrix-org/matrix-spec-proposals#4174

It has been tested using the hydrogen implementation.

Most of the code and doc is inspired from the sygnal implementation.

Pull Request Checklist

Pull request is based on the develop branch
Pull request includes a changelog file.
Code style is correct
(run the linters)

synapse/push/webpushpusher.py

synapse/config/experimental.py

MadLittleMods

Here is a review of the code itself. I haven't inspected if this is actually a valid and good enough implementation of the WebPush spec itself.

MadLittleMods · 2025-01-24T19:52:02Z

docs/webpush.md

+so it can be used to pass identifiers specific to your client
+(like which account the notification is for).
+
+### events_only


Suggested change

### events_only

### `events_only`

MadLittleMods · 2025-01-24T19:52:08Z

docs/webpush.md

+any push message without a event id. This prevents your service worker being
+forced to show a notification to push messages that clear the unread count.
+
+### only_last_per_room


Suggested change

### only_last_per_room

### `only_last_per_room`

MadLittleMods · 2025-01-24T19:55:31Z

docs/webpush.md

+In the synapse virtualenv, generate the server key pair by running
+`vapid --gen --applicationServerKey`. This will generate a `private_key.pem`
+(which you'll refer to in the config file with `vapid_private_key`) 
+and `public_key.pem` file, and also a string labeled `Application Server Key`.
+
+You'll copy the Application Server Key to `vapid_app_server_key` so that
+web applications can fetch it through `/capabilities` and use it to subscribe
+to the push manager:


This seems like a hassle. Any way to improve this?

Is it possible to make it generate if the file does not exist like we do for signing_key_path?

synapse/docs/usage/configuration/config_documentation.md

Lines 3128 to 3138 in 90a6bd0

### `signing_key_path`

Path to the signing key to sign events and federation requests with.

*New in Synapse 1.67*: If this file does not exist, Synapse will create a new signing

key on startup and store it in this file.

Example configuration:

```yaml

signing_key_path: "CONFDIR/SERVERNAME.signing.key"

```

Does it matter if this key changes from time to time?

It matters if the client isn't aware of this change

MadLittleMods · 2025-01-24T20:00:51Z

synapse/config/experimental.py

@@ -38,6 +38,14 @@
 except ImportError:
    HAS_AUTHLIB = False

+# Determine whether pywebpush is installed.
+try:
+    import pywebpush  # noqa: F401


Comment why we noqa.

Suggested change

import pywebpush # noqa: F401

# This module is imported simply to detect whether the `pywebpush` is installed and

# is not used here; flake8 needn't warn that it's unused.

import pywebpush # noqa: F401

For example:

synapse/synapse/metrics/__init__.py

Lines 53 to 54 in 9c5d08f

# This module is imported for its side effects; flake8 needn't warn that it's unused.

import synapse.metrics._reactor_metrics # noqa: F401

It looks like this is copying the pattern just above which should also have a note.

MadLittleMods · 2025-01-24T20:01:11Z

synapse/config/experimental.py

@@ -256,6 +264,28 @@ class MSC3866Config:
    require_approval_for_new_accounts: bool = False


+@attr.s(auto_attribs=True, frozen=True, slots=True)
+class MSC4174Config:
+    """Configuration for MSC4174"""


Suggested change

"""Configuration for MSC4174"""

"""Configuration for MSC4174: webpush push kind"""

MadLittleMods · 2025-01-24T20:58:38Z

synapse/push/webpushpusher.py

+            # ask for a 22 byte hash, so the base64 of it is 32,
+            # the limit webpush allows for the topic


Suggested change

# ask for a 22 byte hash, so the base64 of it is 32,

# the limit webpush allows for the topic

# Ask for a 22-byte hash, so that when base64 the value, it ends up as 32-characters,

# which is the limit that webpush allows for the `topic`

MadLittleMods · 2025-01-24T20:59:02Z

synapse/push/webpushpusher.py

+
+    async def send_webpush(self, content: JsonDict) -> Union[bool, List[str]]:
+        # web push only supports normal and low priority, so assume normal if absent
+        low_priority = content.get("prio") == "low"


"low" should be a constant PushPriority.LOW

MadLittleMods · 2025-01-24T21:01:06Z

synapse/push/webpushpusher.py

+            topic = urlsafe_b64encode(
+                blake2s(room_id.encode(), digest_size=22).digest()
+            )


Sanity check our implementation

Suggested change

topic = urlsafe_b64encode(

blake2s(room_id.encode(), digest_size=22).digest()

)

topic = urlsafe_b64encode(

blake2s(room_id.encode(), digest_size=22).digest()

)

assert len(topic) == 32, "The max topic length that webpush allows is 32 characters"

MadLittleMods · 2025-01-24T21:09:52Z

synapse/push/webpushpusher.py

+    def execute(
+        self, http_client: SimpleHttpClient, low_priority: bool, topic: bytes
+    ) -> defer.Deferred[IResponse]:
+        # Convert the headers to the camelcase version.


Why is this necessary?

The Headers type already does the canonicalization for you

MadLittleMods · 2025-01-24T21:12:11Z

synapse/push/webpushpusher.py

+MAX_CIPHERTEXT_LENGTH = 2000
+
+
+class WebPushPusher(HttpPusher):


Any good tests we could add in tests/push/?

Just something that sanity checks that a push can be sent out so this continues to work into the future.

MatMaul mentioned this pull request Dec 2, 2024

MSC4174: webpush push kind matrix-org/matrix-spec-proposals#4174

Open

MatMaul force-pushed the msc4174 branch 7 times, most recently from a561f07 to 09ba9c3 Compare December 7, 2024 14:38

github-actions bot deployed to PR Documentation Preview December 7, 2024 14:39 Active

MatMaul changed the title ~~Add support of MSC4174~~ MSC4174: add support for WebPush pusher kind Dec 7, 2024

MatMaul force-pushed the msc4174 branch from 09ba9c3 to c464d9e Compare December 7, 2024 14:41

github-actions bot deployed to PR Documentation Preview December 7, 2024 14:42 Active

MatMaul force-pushed the msc4174 branch from c464d9e to 3c6cbdd Compare December 7, 2024 14:53

github-actions bot deployed to PR Documentation Preview December 7, 2024 14:54 Active

MatMaul force-pushed the msc4174 branch from 3c6cbdd to a745870 Compare December 7, 2024 14:56

github-actions bot deployed to PR Documentation Preview December 7, 2024 14:57 Active

MSC4174: add support for WebPush pusher kind

a3f58ad

MatMaul force-pushed the msc4174 branch from a745870 to a3f58ad Compare December 7, 2024 17:38

github-actions bot deployed to PR Documentation Preview December 7, 2024 17:39 Active

MatMaul marked this pull request as ready for review December 7, 2024 20:37

MatMaul requested a review from a team as a code owner December 7, 2024 20:37

p1gp1g reviewed Dec 9, 2024

View reviewed changes

synapse/push/webpushpusher.py Outdated Show resolved Hide resolved

p1gp1g reviewed Dec 9, 2024

View reviewed changes

synapse/config/experimental.py Outdated Show resolved Hide resolved

Address comments

920a3f1

github-actions bot deployed to PR Documentation Preview December 9, 2024 16:04 Active

lint

5515c37

github-actions bot deployed to PR Documentation Preview December 9, 2024 16:06 Active

Merge branch 'develop' into msc4174

c029e9a

github-actions bot deployed to PR Documentation Preview December 9, 2024 16:39 Active

Merge branch 'develop' into msc4174

20f4a31

github-actions bot deployed to PR Documentation Preview December 10, 2024 15:53 Active

Merge branch 'develop' into msc4174

e2fe3b1

github-actions bot deployed to PR Documentation Preview December 13, 2024 11:43 Active

MadLittleMods requested changes Jan 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MSC4174: add support for WebPush pusher kind #17987

MSC4174: add support for WebPush pusher kind #17987

MatMaul commented Dec 2, 2024 •

edited

Loading

MadLittleMods left a comment

MadLittleMods Jan 24, 2025

MadLittleMods Jan 24, 2025

MadLittleMods Jan 24, 2025

p1gp1g Jan 25, 2025

MadLittleMods Jan 24, 2025

MadLittleMods Jan 24, 2025

MadLittleMods Jan 24, 2025

MadLittleMods Jan 24, 2025

MadLittleMods Jan 24, 2025

MadLittleMods Jan 24, 2025

MadLittleMods Jan 24, 2025

	### `signing_key_path`

	Path to the signing key to sign events and federation requests with.

	New in Synapse 1.67: If this file does not exist, Synapse will create a new signing
	key on startup and store it in this file.

	Example configuration:
	```yaml
	signing_key_path: "CONFDIR/SERVERNAME.signing.key"
	```

	# This module is imported for its side effects; flake8 needn't warn that it's unused.
	import synapse.metrics._reactor_metrics # noqa: F401

	"""Configuration for MSC4174"""
	"""Configuration for MSC4174: webpush push kind"""

		# ask for a 22 byte hash, so the base64 of it is 32,
		# the limit webpush allows for the topic

		MAX_CIPHERTEXT_LENGTH = 2000


		class WebPushPusher(HttpPusher):

MSC4174: add support for WebPush pusher kind #17987

Are you sure you want to change the base?

MSC4174: add support for WebPush pusher kind #17987

Conversation

MatMaul commented Dec 2, 2024 • edited Loading

Pull Request Checklist

MadLittleMods left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MatMaul commented Dec 2, 2024 •

edited

Loading