Add service worker for push notifications #5805

Cyperghost · 2024-02-16T11:58:55Z

Closes #3960

com.woltlab.wcf/templates/headIncludeJavaScript.tpl

ts/WoltLabSuite/Core/BootstrapFrontend.ts

ts/WoltLabSuite/Core/Notification/ServiceWorker.ts

wcfsetup/install/files/lib/action/RegisterServiceWorkerAction.class.php

wcfsetup/install/files/lib/data/service/worker/ServiceWorker.class.php

wcfsetup/setup/db/install.sql

wcfsetup/install/files/lib/system/acp/dashboard/box/event/PHPExtensionCollecting.class.php

wcfsetup/install/files/lib/system/service/worker/Util.class.php

wcfsetup/install/files/lib/system/service/worker/ServiceWorkerHandler.class.php

wcfsetup/install/files/lib/system/service/worker/Encryption.class.php

TimWolla · 2024-02-18T16:29:04Z

wcfsetup/install/files/lib/system/service/worker/VAPID.class.php

+        $payload = JSON::encode([
+            'aud' => $serviceWorker->getEndpoint(),
+            'exp' => TIME_NOW + 43200, // 12h
+            'sub' => "mailto:" . MAIL_ADMIN_ADDRESS,


Should the email address be rawurlencoded? Thinking about email addresses such as admin+myforum@example.com.

This is not needed. The value mailto:admin+myforum@example.com works fine.

TimWolla

It also might make sense to drop the reverted dependency-related commits entirely, for two reasons:

Less bloat for the repository, because they will not be part of master after being merged.
Less garbage for the fileDelete.xml generation script to work through. See 04f17cd. That script will add anything to fileDelete.xml that was previously part of the master branch, but no longer is part of it.

Update the register of new service worker Add objectID for ServiceWorker

… aes128gcm

Better exception handling

Add `notificationclick` event to open new window with the given url

TimWolla

Some more remarks regarding the cryptography. I did not test any of the code snippets, so please disregard the stuff that does not make sense to you / that you disagree with. It's already much better with the hex2bin/bin2hex gone.

wcfsetup/install/files/lib/system/service/worker/ServiceWorkerHandler.class.php

wcfsetup/install/files/lib/system/service/worker/VAPID.class.php

wcfsetup/install/files/lib/system/service/worker/Encryption.class.php

wcfsetup/install/files/lib/system/service/worker/Util.class.php

wcfsetup/install/files/lib/system/user/notification/UserNotificationHandler.class.php

ts/WoltLabSuite/Core/Notification/Handler.ts

TimWolla

I still don't quite follow the entire cryptographic flow, but that might be because I didn't actually read the underlying specification. That said, it looks reasonable to me now.

You might want to consider running phpcbf and php-cs-fixer on lib/system/service/. Some of the spacing (with regard to empty lines) doesn't match the code style that is generally used and made it a little jarring while attempting to grok the code.

wcfsetup/install/files/lib/system/background/job/ServiceWorkerDeliveryBackgroundJob.class.php

wcfsetup/install/files/lib/system/service/worker/Encoding.class.php

wcfsetup/install/files/lib/system/service/worker/Util.class.php

…vice worker

# Conflicts: # wcfsetup/install/files/acp/database/update_com.woltlab.wcf_6.1.php

wcfsetup/install/files/lib/system/api/composer/installed.php

…-mbstring`

Cyperghost · 2024-04-15T17:04:26Z

Waiting for composer packages

minishlink/web-push version 9.0.0
~~web-token/jwt-library version 4.0.0~~

…fications # Conflicts: # ts/WoltLabSuite/Core/Notification/Handler.ts # wcfsetup/install/files/js/WoltLabSuite/Core/Notification/Handler.js # wcfsetup/install/files/lib/system/api/composer.json # wcfsetup/install/files/lib/system/api/composer.lock # wcfsetup/install/files/lib/system/api/composer/installed.json # wcfsetup/install/files/lib/system/api/composer/installed.php

dtdesign · 2024-06-22T11:56:06Z

minishlink/web-push

https://github.com/web-push-libs/web-push-php/releases has v9.0.0-rc2 out for a few days already and we can possibly expect a release to arrive in July.

web-token/jwt-library

The version 4.0 appears to be still under development as of now. However, its composer.json requires a minimum PHP version of 8.3 which exceeds our current minimum version of PHP 8.1. @Cyperghost can we somehow backport the necessary changes in the v3.4 tree to work around this?

# Conflicts: # wcfsetup/install/files/acp/database/update_com.woltlab.wcf_6.1.php

# Conflicts: # wcfsetup/install/files/lib/system/api/composer.json # wcfsetup/install/files/lib/system/api/composer.lock # wcfsetup/install/files/lib/system/api/composer/installed.php

`web-token/jwt-library` to `3.3.50` `spomky-labs/pki-framework` to `1.2.1`

Cyperghost added 5 commits February 9, 2024 12:05

Create default database for service workers

2c0793e

Insert basic options for public/private keys

1dceaac

Implement basic service worker registration

ceab568

Register service worker

c88370a

Check if user is logged in

7515d99

Cyperghost requested a review from dtdesign February 16, 2024 11:58

Cyperghost linked an issue Feb 16, 2024 that may be closed by this pull request

Use service workers for push notifications #3960

Closed

dtdesign requested changes Feb 16, 2024

View reviewed changes

TimWolla reviewed Feb 18, 2024

View reviewed changes

Cyperghost added 12 commits February 19, 2024 14:38

Insert new option

f028133

Update the register of new service worker Add objectID for ServiceWorker

Set aes128gcm as min es encoding

29d9af5

Create service worker handler to send web push with the encryption of…

7b9334b

… aes128gcm

Support encryption aesgcm

e8e6fb5

Create function to generate the ikm for different encodings

25fe6d7

Remove time query from service worker

562b388

Insert new background job to send push messages to service worker

8869743

Simple check if service worker exists

e6c321e

Better exception handling

Rename link to url

a62b299

Add `notificationclick` event to open new window with the given url

Update the service worker

89f2cd2

Remove TODO, not needed to change

c76a5ea

Check if the application server key(public key) changed

d263d71

Cyperghost force-pushed the service-worker-notifications branch from 4ef9fec to d0963eb Compare February 19, 2024 13:42

Cyperghost marked this pull request as ready for review February 19, 2024 14:27

Cyperghost requested review from dtdesign and TimWolla February 19, 2024 14:27

TimWolla reviewed Feb 19, 2024

View reviewed changes

Cyperghost requested a review from TimWolla February 20, 2024 13:23

dtdesign reviewed Feb 22, 2024

View reviewed changes

ts/WoltLabSuite/Core/Notification/Handler.ts Outdated Show resolved Hide resolved

TimWolla reviewed Feb 22, 2024

View reviewed changes

Cyperghost added 5 commits February 23, 2024 14:44

Use JWK objects as parameter

97a1919

Run php-cs-fixer

9446899

By creating new public/private key clear database with registered ser…

4ee8e76

…vice worker

Add web-token/jwt-library and minishlink/web-push composer packages

725550d

Use web-push framework

02f380a

Cyperghost force-pushed the service-worker-notifications branch from 8ce4cc4 to 02f380a Compare February 23, 2024 14:00

Cyperghost added 4 commits February 23, 2024 15:03

Run php-cs-fixer

633a2e7

Merge branch 'master' into service-worker-notifications

83716df

# Conflicts: # wcfsetup/install/files/acp/database/update_com.woltlab.wcf_6.1.php

Code cleanup

ac55fc0

Use correct file ident

149f17c

TimWolla reviewed Feb 25, 2024

View reviewed changes

wcfsetup/install/files/lib/system/api/composer/installed.php Outdated Show resolved Hide resolved

wcfsetup/install/files/lib/system/api/composer/installed.php Outdated Show resolved Hide resolved

Remove composer packages paragonie/random_compat, `symfony/polyfill…

5154cc2

…-mbstring`

Cyperghost marked this pull request as draft April 15, 2024 17:00

Cyperghost added 3 commits May 13, 2024 15:15

Run tsc

6f6461b

Update composer lock file

45f8ea4

dtdesign mentioned this pull request May 19, 2024

Make HTTPS a hard requirement #5919

Closed

10 tasks

Cyperghost added 2 commits June 24, 2024 10:25

Merge branch 'refs/heads/master' into service-worker-notifications

dafe4e4

# Conflicts: # wcfsetup/install/files/acp/database/update_com.woltlab.wcf_6.1.php

Update minishlink/web-push to v9.0.0-rc2

313072d

Cyperghost marked this pull request as ready for review June 24, 2024 09:18

Cyperghost and others added 3 commits June 24, 2024 14:57

Merge branch 'refs/heads/master' into service-worker-notifications

b923428

# Conflicts: # wcfsetup/install/files/lib/system/api/composer.json # wcfsetup/install/files/lib/system/api/composer.lock # wcfsetup/install/files/lib/system/api/composer/installed.php

New indent composer.json

61419dc

Upgrade composer packages

743612e

`web-token/jwt-library` to `3.3.50` `spomky-labs/pki-framework` to `1.2.1`

Cyperghost requested a review from dtdesign June 25, 2024 10:19

dtdesign approved these changes Jun 25, 2024

View reviewed changes

Upgrade composer packages

2f7ab0d

`web-token/jwt-library` to `3.3.50` `spomky-labs/pki-framework` to `1.2.1`

Cyperghost merged commit 4af43aa into master Jun 25, 2024
8 checks passed

Cyperghost deleted the service-worker-notifications branch June 25, 2024 11:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add service worker for push notifications #5805

Add service worker for push notifications #5805

Cyperghost commented Feb 16, 2024

TimWolla Feb 18, 2024

Cyperghost Feb 19, 2024

TimWolla left a comment

TimWolla left a comment

TimWolla left a comment

Cyperghost commented Apr 15, 2024 •

edited

Loading

dtdesign commented Jun 22, 2024

Add service worker for push notifications #5805

Add service worker for push notifications #5805

Conversation

Cyperghost commented Feb 16, 2024

TimWolla Feb 18, 2024

Choose a reason for hiding this comment

Cyperghost Feb 19, 2024

Choose a reason for hiding this comment

TimWolla left a comment

Choose a reason for hiding this comment

TimWolla left a comment

Choose a reason for hiding this comment

TimWolla left a comment

Choose a reason for hiding this comment

Cyperghost commented Apr 15, 2024 • edited Loading

dtdesign commented Jun 22, 2024

Cyperghost commented Apr 15, 2024 •

edited

Loading