Add WebPush support for Safari #674

blighj · 2022-11-20T12:13:20Z

PR for #673
Stores the full endpoint url for web push given by the browser, in the registration_id of the model, instead of just the token, and use exactly what the browser gave us when we send the message. Still supports existing registration_id/browser combo's but rasies a warning.

Also:

Adds tests for web push
Update docs for configuring web push
Handle 404/410 when regeistering and deactivate device
Remove pywebpush from APNS' options.extras_require in setup.cfg

The new docs address issues/questions raised in #647, #658, #665
The PR was inspired/informed by #487, #558, #602, #603, #604, #605

simonkern · 2023-01-18T20:04:33Z

tores the full endpoint url for web push given by the browser, in the registration_id of the model, instead of just the token, and use exactly what the browser gave us when we send the message.

I also thought about this aspect some time ago when I added push support and think this is a really good idea. This could also remove the need to extract the browser type via javascript, because we then already have the url of the endpoint we need to send the push to stored in the WebPushDevice object.

simonkern · 2023-03-27T19:49:28Z

iOS 16.4 just landed. What's the current status here? Are there still things that need to be done?

blighj · 2023-03-28T06:23:08Z

From my prespective, as a first time contributor, this is ready to go.
I assume the next step is a code review.

simonkern · 2023-03-29T07:56:19Z

I am not a maintainer, but I could take this for a test spin. Do you know who could do a release? Maybe @alenzeinolov or @jamaalscarlett can help out?

martinrlilja · 2023-04-18T09:22:00Z

push_notifications/webpush.py

 		return results
 	except WebPushException as e:
+		if e.response is not None and e.response.status_code in [404, 410]:
+			results["failure"] = 1


I get an error here because the exception comes from line 34, but results is defined on line 41. It should be enough to just switch them around.

Excellent point, commit added to address it.

Could you add a comment explaining the two status codes and why you are disabling the device

how about?

Suggested change

results["failure"] = 1

# if we find that the status from the vendor was 404 (invalide url) or 410 (Gone) we should no

# longer try to send messages to this device.

# https://web.dev/push-notifications-common-issues-and-reporting-bugs/#http-status-codes

results["failure"] = 1

ammarjmhor10 · 2023-04-19T07:57:14Z

Hi, is there any update please?

mamal72 · 2023-04-28T03:27:55Z

Hey guys. Any updates on this? Can we do one more push and have it released? Thanks in advance.

push_notifications/webpush.py

jamaalscarlett · 2023-08-16T13:05:35Z

README.rst

 - ``WP_PRIVATE_KEY``: Absolute path to your private certificate file: os.path.join(BASE_DIR, "private_key.pem")
 - ``WP_CLAIMS``: Dictionary with the same sub info like claims file: {'sub': "mailto: development@example.com"}
 - ``WP_ERROR_TIMEOUT``: The timeout on WebPush POSTs. (Optional)
- ``WP_POST_URL``: A dictionary (key per browser supported) with the full url that webpush notifications will be POSTed to. (Optional)


Why was this line removed?

This MR is essentially deprectating the old approach. Instead the full endpoint that the browser returns is stored in the registration_id of the model, instead of just the token, and the code uses exactly what the browser gave us when we send the message. Rather than composing a url based on what is in WP_POST_URL.

As a result I thought it was sensible to remove the WP_POST_URL from the docs as it would confuse new users.

jamaalscarlett · 2023-08-16T13:07:06Z

docs/WebPush.rst

+
+.. code-block:: python
+
+	pip install py-vapid  (Only for generating key)


You are missing the

pip install pywebpush

line

This part of the docs is explaining how to generate the keys needed. It's my undestanding that you only need py-vapid for that part.
You could essentially do that part on your local machine, and then deploy your keys to production where the library is used in your application.

push_notifications/webpush.py

setup.cfg

docs/WebPush.rst

azmeuk · 2023-08-25T14:22:56Z

I tested this branch on several browsers, including Safari on iOS and I confirm this works!

azmeuk · 2023-08-25T15:03:18Z

For what it worth, instead of manually using py-vapid, I could do the key generation dynamically with:

from py_vapid import b64urlencode
from py_vapid import Vapid02 as Vapid
from cryptography.hazmat.primitives import serialization
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives.asymmetric import ec


def vapid_public_key(path):
    vapid = Vapid.from_file(path)
    pk = vapid.public_key.public_bytes(
        serialization.Encoding.X962, serialization.PublicFormat.UncompressedPoint
    )
    return b64urlencode(pk)


def generate_private_key(path):
    private_key = ec.generate_private_key(ec.SECP256R1, default_backend())
    private_pem = private_key.private_bytes(
        encoding=serialization.Encoding.PEM,
        format=serialization.PrivateFormat.PKCS8,
        encryption_algorithm=serialization.NoEncryption()
    )
    with open(path, "wb") as file:
        file.write(private_pem)
        file.close()

generate_private_key can be used if the private key does not exist, vapid_public_key can be used to get the base64 export of the public key and insert it dynamically in the templates.

README.rst

jamaalscarlett · 2023-08-25T15:38:31Z

@blighj once you address @azmeuk I think this is good to merge. Nice work!

jamaalscarlett · 2023-09-01T17:01:05Z

@blighj looks like there are some newly failing tests

Declare results variable at the start of the block

Co-authored-by: Cuyler Stuwe <salembeats@gmail.com>

Co-authored-by: James Bligh <618250+blighj@users.noreply.github.com>

• Added example code to register WP device • Fixed issue where call to extract UserAgent didn't include UA • Added examples on how to send a Web Push message

for more information, see https://pre-commit.ci

README.rst

codecov · 2023-09-30T20:09:35Z

Codecov Report

Merging #674 (99fca51) into master (53525ca) will increase coverage by 0.84%.
Report is 4 commits behind head on master.
The diff coverage is 84.61%.

@@            Coverage Diff             @@
##           master     #674      +/-   ##
==========================================
+ Coverage   68.67%   69.51%   +0.84%     
==========================================
  Files          26       26              
  Lines        1111     1122      +11     
  Branches      243      245       +2     
==========================================
+ Hits          763      780      +17     
+ Misses        310      304       -6     
  Partials       38       38

Files	Coverage Δ
push_notifications/conf/app.py	`75.15% <100.00%> (ø)`
push_notifications/migrations/0001_initial.py	`100.00% <ø> (ø)`
...otifications/migrations/0002_auto_20160106_0850.py	`100.00% <ø> (ø)`
push_notifications/migrations/0003_wnsdevice.py	`100.00% <ø> (ø)`
push_notifications/migrations/0004_fcm.py	`100.00% <ø> (ø)`
...ush_notifications/migrations/0005_applicationid.py	`100.00% <ø> (ø)`
...ush_notifications/migrations/0006_webpushdevice.py	`100.00% <ø> (ø)`
push_notifications/webpush.py	`100.00% <100.00%> (+33.33%)`	⬆️
push_notifications/fields.py	`64.06% <50.00%> (ø)`
push_notifications/models.py	`78.04% <0.00%> (ø)`
... and 1 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

blighj · 2023-09-30T20:14:50Z

tests/test_rest_framework.py

@blighj looks like there are some newly failing tests

The tests are passing now, this file was failing, it is really outside the scope of this PR. My diagnosis is that a string is more bytes in py3 than the tests were expecting.

I've done more digging and I see clearly now why the test was failing, the serilaizer is tied to the model, the registration_id in the APNSDevice has a max_length of 200, and the test was creating a string of lenght 400 ("aE"*200).

So the update I did is appropriate.
@jamaalscarlett This MR is good to go now.

I'm going to re-review and hopefully get this merged today. Great work.

blighj · 2023-10-08T06:41:48Z

:) Thank you kindly
I think you could now safely close PR #487
And the issues #457, #526, #629, #647, #657, and #665

a release to version 3.1.0 would be much appreciated too

* Add WebPush support for Safari * Update webpush.py based on review Declare results variable at the start of the block * Fix typo in warning Co-authored-by: Cuyler Stuwe <salembeats@gmail.com> * Update README.rst Co-authored-by: James Bligh <618250+blighj@users.noreply.github.com> * Fix mailto: space * Expanded documentation for Web Push (#558) • Added example code to register WP device • Fixed issue where call to extract UserAgent didn't include UA • Added examples on how to send a Web Push message * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Attempt to fix tests * Update README.rst --------- Co-authored-by: James Bligh <james.bligh@silvercloudhealth.com> Co-authored-by: Cuyler Stuwe <salembeats@gmail.com> Co-authored-by: Éloi Rivard <eloi.rivard@nubla.fr> Co-authored-by: Neil Littlejohns <n.littlejohns@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

blighj marked this pull request as draft November 20, 2022 12:17

blighj force-pushed the webpush_safari branch from c91730c to e1234f9 Compare November 20, 2022 19:47

blighj marked this pull request as ready for review November 20, 2022 19:49

blighj force-pushed the webpush_safari branch from f01b5b3 to 4fb64be Compare November 20, 2022 22:18

This was referenced Nov 21, 2022

How to setup properly just for web? #665

Closed

requestPOSTToServer is not defined #658

Closed

How to register for webpush? #647

Closed

martinrlilja reviewed Apr 18, 2023

View reviewed changes

cuylerstuwe reviewed May 17, 2023

View reviewed changes

push_notifications/webpush.py Outdated Show resolved Hide resolved

azmeuk mentioned this pull request Jul 24, 2023

State of the maintenance #685

Closed

azmeuk mentioned this pull request Aug 3, 2023

PWA EsupPortail/Esup-Pod#912

Closed

jamaalscarlett reviewed Aug 16, 2023

View reviewed changes

azmeuk reviewed Aug 18, 2023

View reviewed changes

docs/WebPush.rst Show resolved Hide resolved

azmeuk added the webpush label Aug 18, 2023

azmeuk reviewed Aug 18, 2023

View reviewed changes

docs/WebPush.rst Show resolved Hide resolved

This was referenced Aug 18, 2023

Missing documentation for WebPush using the new config #610

Closed

Added Safari browser to web-push #687

Closed

blighj commented Aug 19, 2023

View reviewed changes

docs/WebPush.rst Show resolved Hide resolved

This was referenced Aug 21, 2023

A valid push subscription endpoint should be specified in the URL #686

Closed

getting error when run JS client side #629

Closed

azmeuk reviewed Aug 25, 2023

View reviewed changes

README.rst Outdated Show resolved Hide resolved

blighj force-pushed the webpush_safari branch from ee269cd to e1cb61b Compare September 30, 2023 18:05

James Bligh and others added 7 commits September 30, 2023 19:26

Add WebPush support for Safari

6654088

Update webpush.py based on review

7f75220

Declare results variable at the start of the block

Fix typo in warning

8482a53

Co-authored-by: Cuyler Stuwe <salembeats@gmail.com>

Update README.rst

8e9fa74

Co-authored-by: James Bligh <618250+blighj@users.noreply.github.com>

Fix mailto: space

a06ee41

Expanded documentation for Web Push (jazzband#558)

017eb6e

• Added example code to register WP device • Fixed issue where call to extract UserAgent didn't include UA • Added examples on how to send a Web Push message

[pre-commit.ci] auto fixes from pre-commit.com hooks

a37d1f8

for more information, see https://pre-commit.ci

blighj force-pushed the webpush_safari branch from e1cb61b to b1e43f6 Compare September 30, 2023 18:26

Attempt to fix tests

df6998f

blighj force-pushed the webpush_safari branch from b1e43f6 to df6998f Compare September 30, 2023 18:44

blighj commented Sep 30, 2023

View reviewed changes

README.rst Outdated Show resolved Hide resolved

Update README.rst

99fca51

blighj commented Sep 30, 2023

View reviewed changes

jamaalscarlett approved these changes Oct 8, 2023

View reviewed changes

jamaalscarlett merged commit b719521 into jazzband:master Oct 8, 2023
6 checks passed

This was referenced Oct 8, 2023

[WebPush] Support for Safari #673

Closed

Cannot send push notification to Firefox (on Android) #657

Closed

blighj deleted the webpush_safari branch October 8, 2023 06:42

This was referenced Oct 29, 2023

Improve Webpush, registration id unique configurable and details #487

Closed

WebPushError not being raised correctly #457

Closed

I got exception KeyError when send_message() #526

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add WebPush support for Safari #674

Add WebPush support for Safari #674

blighj commented Nov 20, 2022 •

edited

Loading

simonkern commented Jan 18, 2023

simonkern commented Mar 27, 2023

blighj commented Mar 28, 2023

simonkern commented Mar 29, 2023 •

edited

Loading

martinrlilja Apr 18, 2023

blighj Apr 19, 2023

jamaalscarlett Aug 23, 2023

blighj Aug 26, 2023

ammarjmhor10 commented Apr 19, 2023

mamal72 commented Apr 28, 2023

jamaalscarlett Aug 16, 2023

blighj Aug 19, 2023

jamaalscarlett Aug 16, 2023

blighj Aug 19, 2023

azmeuk commented Aug 25, 2023

azmeuk commented Aug 25, 2023

jamaalscarlett commented Aug 25, 2023

jamaalscarlett commented Sep 1, 2023

codecov bot commented Sep 30, 2023 •

edited

Loading

blighj Sep 30, 2023 •

edited

Loading

blighj Oct 2, 2023

jamaalscarlett Oct 3, 2023

blighj commented Oct 8, 2023

-			results["failure"] = 1
+			# if we find that the status from the vendor was 404 (invalide url) or 410 (Gone) we should no
+			# longer try to send messages to this device.
+			# https://web.dev/push-notifications-common-issues-and-reporting-bugs/#http-status-codes
+			results["failure"] = 1


		.. code-block:: python

		pip install py-vapid (Only for generating key)

Add WebPush support for Safari #674

Add WebPush support for Safari #674

Conversation

blighj commented Nov 20, 2022 • edited Loading

simonkern commented Jan 18, 2023

simonkern commented Mar 27, 2023

blighj commented Mar 28, 2023

simonkern commented Mar 29, 2023 • edited Loading

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

ammarjmhor10 commented Apr 19, 2023

mamal72 commented Apr 28, 2023

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

azmeuk commented Aug 25, 2023

azmeuk commented Aug 25, 2023

jamaalscarlett commented Aug 25, 2023

jamaalscarlett commented Sep 1, 2023

codecov bot commented Sep 30, 2023 • edited Loading

Codecov Report

blighj Sep 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blighj commented Oct 8, 2023

blighj commented Nov 20, 2022 •

edited

Loading

simonkern commented Mar 29, 2023 •

edited

Loading

codecov bot commented Sep 30, 2023 •

edited

Loading

blighj Sep 30, 2023 •

edited

Loading