Our relationship with push notifications has been rather circuitous…

  1. First Andrew (@psychobunny) tried plain desktop notifications via the Notification API (that’s the desktop notifications plugin), but notification delivery stopped when you closed your browser.
  2. Then I wrote the PushBullet plugin, but they went from free to paid and that went out the window
  3. Around that time I wrote the Firebase plugin, which was a dead end because there was no iOS support.
  4. I then wrote the ntfy plugin, which works really well, but does rely on a freemium third-party service and app (written by @binwiederhier@discuss.ntfy.sh)

Thanks to some recent discussion from @crazycells and @bh4-tech, I learned that the Push API had reached general availability across most modern browsers. In fact, this actually happened over a year ago, so compatibility should be even better.

So I set about working on yet another push notifications plugin, hopefully for the last time, and this time using the native Push API on the client-side.

To enable them, simply navigate over to the “Push Notifications” menu item in your user profile, and flip the switch.

6da06989-f902-492b-866f-14c39b34a9ca-image.png

So, let’s dogfood! I de-activated the ntfy plugin on this site and activated the web-push plugin so you can try it out right now.

The plugin is in the proof-of-concept phase, so there might (read: most definitely will be) issues. Please let me know any you find here.

  • Paweł@community.nodebb.org
    1·
    7 months ago

    I checked logs: Sever start with log: info: [plugins/web-push] VAPID keys OK.

    Nodebb: 4.4.3 Plugin: nodebb-plugin-web-push 0.7.4

    it works on: Desktop + Android But I don’t have any permission request popup to enable notifications for Nodebb on Safari Mobile and iOS I tried also with homescreen app in iOS

    Can anyone help me? julian maybe it is worth to check this behavior in Browserstack?

  • crazycells@community.nodebb.org
    1·
    6 months ago

    julian thanks for this great addition julian! :+1: sorry for the late reply and “like” flood, I was not able to be around for a while, still catching up on the topics…

  • julian@community.nodebb.orgOP
    1·
    1 year ago

    If you do not receive any push notifications, it is likely because your browser is using an old, cached copy of the NodeBB service worker. You will have to wait for your browser to download the new service worker, or manually clear it.

    Secondly, there is one specific caveat for this right now. Users on Safari currently do not use the service worker, and thus will not receive push notifications. This was due to a change in 2021 to work around a Safari bug, but I do not know at this time whether Safari has fixed the issue upstream.

    • julian@community.nodebb.orgOP
      2·
      1 year ago

      I’m particularly excited about this new development because it opens the door for richer integration between NodeBB and the push notifications themselves.

      With (probably) every iteration prior, when you clicked on the notification, it likely opened a new window. With direct access to the Push API and service worker, we can now accurately detect whether the site is already open (in another tab), and open it there.

      In the future, we’ll also be able to add in things like icons, pictures, and custom actions, right from the notification itself.

      One particular nice-to-have is the ability to update notifications. Being able to merge notifications (like they already do in NodeBB) or potentially rescind notifications would be a nice step forward in usability as well.

        • julian@community.nodebb.orgOP
          1·
          1 year ago

          phenomlab clearing the browser cache wouldn’t actually remove the service worker, unfortunately.

          It’s proving surprisingly hard to find instructions to teach people how to clear the existing service worker 😝

          Chrome, at least, will check for a new one after 24 hours I think .

    • bh4 tech@community.nodebb.org
      1·
      1 year ago

      julian Although I don’t have an apple device, but I think web push will work properly now. I read in some articles that when apple first introduced service workers and push both were half baked, but things have improved with each new release of safari. Maybe, some iOS/macbook user would like to volunteer, by reversing the committ and then reporting the result on their device here. There is one caveat: On iOS, web push notifications work only on websites which are “Added to Home Screen” .

      • julian@community.nodebb.orgOP
        1·
        1 year ago

        phenomlab glad to hear you found it :smile:

        For those interested in updating, you can just grab the latest commit from activitypub branch or perhaps the more the specific commit:

        git fetch
git checkout activitypub    # if you're not already on activitypub branch
git reset --hard 86f624f8172fb96fbd3c83683affd8814e8b5156`
        • phenomlab@community.nodebb.org
          1·
          1 year ago

          julian I’m using the GIT link you provided to install. Plugin installs fine, but cannot get it to send any notification - even on my mobile device which works fine for NodeBB?

          • julian@community.nodebb.orgOP
            1·
            1 year ago

            phenomlab There’s not terribly much to configure, just make sure that when you start NodeBB, that you see the output info: [plugins/web-push] VAPID keys OK.

            That’s how the messages are encoded to be sent to the corresponding browser push endpoints.

            Other than that make sure the user has toggled push notifications on in their settings and allowed notifications for the site.

            On Windows, you have to specifically also allow your browser access to send notifications to the user.

    • julian@community.nodebb.orgOP
      1·
      1 year ago

      The plugin also successfully removes notifications if they’re no longer relevant (e.g. queued posts that have already been handled), and merges notification content just like it does in-app:

      22b1cb96-3763-48e9-b890-3f8443ace075-image.png

  • Pankaj Soni@community.nodebb.org
    0·
    11 months ago

    This requires me to toggle this on by going to my user’s profile. is there a way this can be made default ‘on’ for all users on platform?

    • julian@community.nodebb.orgOP
      1·
      11 months ago

      @Pankaj-Soni yes and no… the enabling of the push notifications requires a discrete user action — the user has to actually press the switch to enable notifications.

      There are ways we can advertise this to end users, so I will look into adding those soon. For now, users will have to go into their user settings to enable push notifications.