Add true push notification support (particularly iOS and Android) and simple service worker <-> client communication by GigiaJ · Pull Request #2356 · cinnyapp/cinny

GigiaJ · 2025-06-09T14:52:43Z

Description

Adds true push notification support alongside a Sygnal server to target. This provides a straightforward push notification implementation for iOS users as well as Android.

Redesigns the current service worker implementation and provides a simplistic message system between the client and service worker. Adds a toggle to enable webpush notifs in addition to the current in app notif toggle in the settings menu. Adds config options for a push gateway to be set.
Provides an easy future avenue for just adding the app APN info and FCM info to the Sygnal instance should the release move from PWA on mobile to a full app release.

Currently I'm hosting a stock Sygnal instance in a docker container and a caddy instance in a docker container on a Vultr IPv6 only VPS. It is proxied through Cloudflare so no egress or ingress fees (should make the price extremely stable for bandwidth billing). Can read more here: https://blogs.vultr.com/vultr--cloudflare-bandwidth-alliance--win-win
https://www.cloudflare.com/bandwidth-alliance/
Currently happy to pay for the hosting fees for the domain included (cinny.cc) and the VPS which comes out to $3.50/mo.

I'm also happy to work some sort of transfer or change in ownership out as well if that is preferred.

I'll be including docs to reproduce for those who want to privately host instead. (I'd also be willing to write some Pulumi IaC for it at some point.)

Fixes #
#17 (Partially)

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings

GigiaJ · 2025-06-09T14:59:45Z

The internal update check will likely not live to the end, but is convenient to make sure the service workers are refreshed on mobile.

Left to do (not inclusive as I might be forgetting something):

~~Currently sending muted chat notifs while app is open because our code no longer filters them~~
~~Add a check to see if a pusher already exists for the device on start~~
~~Add a way for notifs badge to be cleared~~
~~Organize notes for Sygnal deployment and include them~~

…o publicly host it unless it becomes irrational in cost which should never happen)

…lient

…g the user of them)

… (for token auth atm)

…s or app notifs

…rmine which should be used

williamkray · 2025-06-30T16:55:59Z

FYI there's currently an open issue to add support for Unified Push, which feels very related to this PR. not sure if it's something you would consider building into this, or if you'd prefer to keep it separate. This would enable more comprehensive push notifications.

GigiaJ · 2025-06-30T17:24:41Z

FYI there's currently an open issue to add support for Unified Push, which feels very related to this PR. not sure if it's something you would consider building into this, or if you'd prefer to keep it separate. This would enable more comprehensive push notifications.

This change should support UnifiedPush provided you are the individual hosting Cinny.
You can set the pushNotificationDetails in config.json and point to your pushNotifyUrl, vapidPublicKey, and webPushAppId.
Right now it is implicitly designed with Sygnal in mind and I've provided docs on hosting your own instance of Sygnal too.
UnifiedPush or Sygnal, the flow is Homeserver -> Push Gateway -> Device. If the app is in background then our code toggles on the pusher which has been registered with the web push endpoint (so like fcm.googleapis.com, fcm.mozilla.com, apn.apple.com) and the stored push gateway endpoint. Sygnal facilitates the distribution of notifications.

The TLDR is that this is that change with the more Matrix centered implementation. In fact you likely can use ntfy (UnifiedPush) since it expects the pushkey, matrix gateway endpoint, and app_id in the same way even.

krishukr · 2025-09-26T03:17:15Z

Hi there, I recently made some changes to your PR to make webpush usable. My PWA on iPhone has been getting push notifications for months even after system reboot. I'd love to continue this PR and merge it into the upstream with you. I'd really appreciate it if you could review my code and give me your thoughts. It would be even better if we could solve any issues together. Please do contact me on Matrix at @kris:krishu.moe.

if event_id is not available, jump to inbox i haven't check app notification, this is for push notification for now

still need to handle invitation notification

…notification isn't enabled

currenttly all browser requrire a `push` produces a notification, if not, push subscription may be revoked. see: firebase/firebase-js-sdk#8010 (comment) in this case, sygnal, the push gateway will send unread count, and create a `push` event, when messages are read on other clients. Therefore we have no choice but to stop sygnal from pushing data that won't be presented as notifications see: https://github.com/element-hq/sygnal/blob/da48ba7457409391c1d12140ce2ea3d49d377ff3/sygnal/webpushpushkin.py#L142-L145

…ing the pwa

so that a notification will always be generated from a push event, avoiding being killed for privacy policies from browser and os

Sygnal already adds `mailto:` by itself. When added manually, apple will error out with `403: BadJwtToken`. Hence the mailto should be removed :) (cherry picked from commit 0d66762) Signed-off-by: Kris Hu <i@krishu.moe>

github-actions · 2026-02-16T01:16:04Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

OE1KHZ · 2026-02-16T06:07:49Z

I have read the CLA Document and I hereby sign the CLA

kfiven · 2026-03-14T07:46:44Z

We do not have this in roadmap yet. Will revisit once we move over to new SDK.

GigiaJ marked this pull request as draft June 9, 2025 14:52

GigiaJ changed the title ~~Add true push notification support (super nice on mobile) and simple service worker <-> client communication~~ Add true push notification support (particularly mobile) and simple service worker <-> client communication Jun 9, 2025

GigiaJ changed the title ~~Add true push notification support (particularly mobile) and simple service worker <-> client communication~~ Add true push notification support (particularly iOS/Android) and simple service worker <-> client communication Jun 9, 2025

GigiaJ changed the title ~~Add true push notification support (particularly iOS/Android) and simple service worker <-> client communication~~ Add true push notification support (particularly iOS and Android) and simple service worker <-> client communication Jun 9, 2025

GigiaJ marked this pull request as ready for review June 11, 2025 00:25

GigiaJ marked this pull request as draft June 11, 2025 01:21

GigiaJ force-pushed the add-push-notifs branch from 8f8b88f to 78a5dd1 Compare June 11, 2025 01:22

GigiaJ marked this pull request as ready for review June 11, 2025 01:25

GigiaJ mentioned this pull request Jun 19, 2025

Mobile UI context menus and slide to reply and edit (relies on #2335 #2345 #2356) #2366

Closed

8 tasks

GigiaJ added 20 commits June 20, 2025 17:03

Add a public key for VAPID, push ID, and push endpoint (I'm willing t…

b45290d

…o publicly host it unless it becomes irrational in cost which should never happen)

add workbox precaching (for SW caching)

5f52e93

Add claim and install events

4cc1179

Convert to a more generic implementation for communicating with the c…

14085c7

…lient

add precaching from workbox import

5029ea0

actually set the path (should fix android blank icon issue)

4968e23

add param type

3b62bea

Clean up fetch code

1d48645

Add push notif handling (clicks and push events)

c77ba1b

Add SW update prompt (useful for rolling out new changes and informin…

ca026bf

…g the user of them)

Add isProduction to determine the behavior to use for the SW

f6acd72

Embed a very simple message handler between the SW and client for now…

1db4685

… (for token auth atm)

Move MapSet position

36227ef

clean up imports

4af5462

remove disable import

8a3eee3

Adds the client state listener for toggling whether to use push notif…

a883963

…s or app notifs

Add a check for our custom tweak in the in-app notif handling to dete…

ac5925f

…rmine which should be used

Add WebPush separate toggle

e2fbf9e

Add render changes

a271a56

update imports

b801f07

GigiaJ force-pushed the add-push-notifs branch from 6c2ab1c to 9440e63 Compare June 30, 2025 05:43

krishukr and others added 19 commits February 15, 2026 19:01

format push notification

bc54389

direct to inbox when notification is clicked

bb14a04

when a notification is clicked, jump to corresponding event

8b55ffa

if event_id is not available, jump to inbox i haven't check app notification, this is for push notification for now

avoid duplicated notification from push and in-app

6d962a6

still need to handle invitation notification

close push notifications when all have been read

10ef89e

feature(sw): add invitation support for push notification

7083bff

fix(notification): allow in-app notification in background when push …

7151597

…notification isn't enabled

fix(push): use unique tag for push notifications

25d77d5

fix(to): load space list first

6abd8ff

fix(sw): only import matrix sdk types

75816cf

fix(push): prevent sliding back after clicking push notification kill…

6a9fe21

…ing the pwa

fix(noti): try-catch all badge API calls

b56e793

wait for sync for to room event navigation

3ee4985

add a fallback push notification

f66545b

so that a notification will always be generated from a push event, avoiding being killed for privacy policies from browser and os

lint code

ad723f6

lint: minor error during merging

3d792f3

add m.sticker support in push notification

09bd903

fix misleading email format (#32)

37c76c7

Sygnal already adds `mailto:` by itself. When added manually, apple will error out with `403: BadJwtToken`. Hence the mailto should be removed :) (cherry picked from commit 0d66762) Signed-off-by: Kris Hu <i@krishu.moe>

GigiaJ force-pushed the add-push-notifs branch from 7419d52 to 37c76c7 Compare February 16, 2026 03:33

ajbura added a commit to cinnyapp/cla that referenced this pull request Feb 16, 2026

@OE1KHZ has signed the CLA in cinnyapp/cinny#2356

e8594d4

kfiven closed this Mar 14, 2026

github-actions bot locked and limited conversation to collaborators Mar 14, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add true push notification support (particularly iOS and Android) and simple service worker <-> client communication#2356

Add true push notification support (particularly iOS and Android) and simple service worker <-> client communication#2356
GigiaJ wants to merge 85 commits intocinnyapp:devfrom
GigiaJ:add-push-notifs

GigiaJ commented Jun 9, 2025 •

edited

Loading

Uh oh!

GigiaJ commented Jun 9, 2025 •

edited

Loading

Uh oh!

williamkray commented Jun 30, 2025

Uh oh!

GigiaJ commented Jun 30, 2025

Uh oh!

krishukr commented Sep 26, 2025

Uh oh!

github-actions bot commented Feb 16, 2026 •

edited

Loading

Uh oh!

OE1KHZ commented Feb 16, 2026

Uh oh!

kfiven commented Mar 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

GigiaJ commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

Checklist:

Uh oh!

GigiaJ commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

williamkray commented Jun 30, 2025

Uh oh!

GigiaJ commented Jun 30, 2025

Uh oh!

krishukr commented Sep 26, 2025

Uh oh!

github-actions bot commented Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OE1KHZ commented Feb 16, 2026

Uh oh!

kfiven commented Mar 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

GigiaJ commented Jun 9, 2025 •

edited

Loading

GigiaJ commented Jun 9, 2025 •

edited

Loading

github-actions bot commented Feb 16, 2026 •

edited

Loading