feat: add push notifications by aarushtools · Pull Request #1704 · tjcsl/ion

aarushtools · 2024-07-30T19:52:12Z

Proposed changes

add the ability to send push notifications via webpush
tests for notifications and pages to view notification logs and send a custom one
adds user push notification preferences and implements sending push notifications on announcements, absences, glance, etc. (eighth waitlist push notification option is implemented in the preferences model but unused)

Brief description of rationale

Many of Ion's current notification features rely on sending emails but people check push notifications more often. This makes the PWA experience more intuitive especially on mobile

Notes

In production, the VAPID keys (generated via create_vapid_keys.py) should be generated once and never changed, otherwise all push subscriptions will be invalidated and users will have to manually subscribe to push notifications again

Video of it working on windows

Video of it working on iOS

alanzhu0 · 2024-07-30T21:14:11Z

This is great!!! Are you all done or still working on stuff?
One useful notification option to add is when your bus arrives you get sent a notif, and also maybe some text description of where it's parked (e.g. "in front of the curb," "right front row", "left back row"). Maybe those notifs have to be delayed so they aren't sent until the end of the day (4 pm most days, but dynamically calculated for early release). And also maybe a notif that sends at 4 pm "your bus isn't here yet" if it hasn't arrived.

great work!!

aarushtools · 2024-07-30T21:46:10Z

Everything is done, I'll try adding that feature 👍

aarushtools · 2024-07-31T01:43:54Z

I added it, here's what it looks like:

and the bus spot id -> string translations:

coveralls · 2024-07-31T02:26:27Z

coverage: 79.119% (-0.2%) from 79.361%
when pulling 9ca0850 on aarushtools:webpush
into e5e51f2 on tjcsl:dev.

alanzhu0 · 2024-08-27T21:57:53Z

On mobile, on preferences the subscribe page looks too transparent, can you decrease the opacity there?
It doesn't work on Edge, right? I can subscribe now actually, but I don't get notified. If that's right, please include a note to the user about that, and also a decent number of people use Edge so getting support for it would be good.
There's a notification sound on mobile - can you turn off the sound? I don't think people will like that.
Can you make Django admin interfaces for the webpush-related models?
Does the bus notification only check at 4 pm right now? Can you do something where if the bus hasn't arrived at 4 pm, send the bus delayed notification you're already doing, then when the bus does arrive send another notification saying so?

aarushtools · 2024-08-28T23:08:52Z

@alanzhu0 everythings done 👍

aarushtools · 2024-08-28T23:30:25Z

Idk why it's failing I ran build_docs like 20 times

aarushtools · 2024-08-30T17:02:32Z

aarushtools

To do

aarushtools · 2025-05-04T16:43:35Z

intranet/apps/polls/forms.py

            "is_election": "Enable election formatting and results features.",
        }
+
+    # We need to make sure the send_notification field doesn't look out of place on the form


out of order

aarushtools · 2025-05-04T16:44:02Z

intranet/apps/polls/notifications.py

+def send_poll_notification(obj: Poll) -> None:
+    """Send a (Web)push notification asking all users who can see the poll to vote
+
+    obj: The poll object


improve type annotation :Poll:

rename function to send poll push notification

aarushtools · 2025-05-04T16:46:15Z

intranet/apps/polls/notifications.py

+        devices = WebPushDevice.objects.filter(user__in=users)
+    else:
+        users = User.objects.filter(Q(groups__in=obj.groups.all()) & Q(push_notification_preferences__poll_notifications=True))
+        devices = WebPushDevice.objects.filter(user__in=users)


move devices out since it's shared in both code blocks
also

user_filter = Q(push_notification_preferences__poll_notifications=True) else: user_filter = Q(groups__in=obj.groups.all(), push_notification_preferences__poll_notifications=True) users = User.objects.filter(user_filter).distinct() # if users are in multiple groups??

aarushtools · 2025-05-04T16:50:06Z

intranet/apps/preferences/views.py

+        "eighth_waitlist_notifications": user.push_notification_preferences.eighth_waitlist_notifications,
+        "glance_notifications": user.push_notification_preferences.glance_notifications,
+        "announcement_notifications": user.push_notification_preferences.announcement_notifications,
+        "poll_notifications": user.push_notification_preferences.poll_notifications,


use a for loop and getattr
additionally, maybe prefs._meta.get_fields()?
to auto update this function when a new field is added to push notification user preferences

notification_fields = [ field.name for field in prefs._meta.get_fields() if field.name.endswith('_notifications') and not field.is_relation ]

aarushtools · 2025-05-04T16:54:41Z

intranet/apps/preferences/views.py


-        return redirect("preferences")
+        elif request.POST.get("updatepushprefs").lower() == "true":
+            push_notifications_options_form = save_push_notifications_options(request, user)


put this as the if statement first, and if updatepushprefs == "" as the else
also save request.POST.get("updatepushprefs", "").lower() as a variable and check that way

aarushtools · 2025-05-04T17:42:40Z

intranet/apps/bus/tasks.py

+
+
+@shared_task
+def push_delayed_bus_notifications(bus_number: str) -> None:


send delayed bus push notifications

aarushtools · 2025-05-04T17:44:39Z

intranet/apps/bus/tasks.py

+
+    Returns:
+        None, or the datetime indicating when the task is scheduled if return_result is true
+    """


see below for how schedule should be a separate function

aarushtools · 2025-05-04T17:45:08Z

intranet/apps/announcements/notifications.py

+    obj: The announcement object
+
+    """
+


send_announcement_posted_push_notification

aarushtools · 2025-05-04T17:45:25Z

intranet/apps/announcements/notifications.py

+    else:
+        users = User.objects.filter(Q(groups__in=obj.groups.all()) & Q(push_notification_preferences__announcement_notifications=True))
+        devices = WebPushDevice.objects.filter(user__in=users)
+


can be optimized per below (see .distinct() comment)

aarushtools · 2025-05-04T17:46:04Z

intranet/apps/announcements/forms.py

+            "notify_post": (
+                "If this box is checked, students who have signed up for email "
+                "notifications will receive an email "
+                "and those who have signed up for push notifications will receive a "


separate email and push notifs out into two separate functions/arguments

aarushtools force-pushed the webpush branch 6 times, most recently from 986c2f5 to 19100ed Compare July 30, 2024 21:08

aarushtools force-pushed the webpush branch from 19100ed to 18ef62d Compare July 30, 2024 21:42

aarushtools force-pushed the webpush branch 2 times, most recently from 51736f7 to 27ee277 Compare July 31, 2024 01:43

aarushtools force-pushed the webpush branch from 27ee277 to d344290 Compare July 31, 2024 02:05

aarushtools marked this pull request as ready for review July 31, 2024 02:41

aarushtools requested a review from a team as a code owner July 31, 2024 02:41

aarushtools force-pushed the webpush branch 3 times, most recently from 73f2fd1 to fa19346 Compare August 8, 2024 00:12

aarushtools force-pushed the webpush branch 9 times, most recently from cc9af14 to 6129d74 Compare August 19, 2024 21:52

aarushtools force-pushed the webpush branch 2 times, most recently from 7df9991 to f212a96 Compare August 26, 2024 21:29

aarushtools force-pushed the webpush branch 3 times, most recently from f219e26 to 9ca0850 Compare August 27, 2024 21:45

aarushtools force-pushed the webpush branch 2 times, most recently from 848cc66 to c134c08 Compare August 28, 2024 23:03

aarushtools force-pushed the webpush branch from c134c08 to 50a91cb Compare August 28, 2024 23:17

aarushtools force-pushed the webpush branch from 50a91cb to 16b7d68 Compare August 30, 2024 17:01

aarushtools force-pushed the webpush branch 4 times, most recently from 7d829ab to d655102 Compare September 7, 2024 00:17

aarushtools force-pushed the webpush branch from d655102 to f1b0bf8 Compare September 12, 2024 01:21

aarushtools force-pushed the webpush branch 8 times, most recently from 4909092 to 852be7e Compare October 16, 2024 18:50

aarushtools force-pushed the webpush branch 2 times, most recently from 813a811 to 93640c4 Compare December 13, 2024 19:48

aarushtools force-pushed the webpush branch from 93640c4 to 9841b6c Compare January 19, 2025 18:42

feat: add push notifications

8013452

aarushtools force-pushed the webpush branch from 9841b6c to 8013452 Compare January 19, 2025 18:46

aarushtools commented May 4, 2025

View reviewed changes



		@shared_task
		def push_delayed_bus_notifications(bus_number: str) -> None:

Conversation

aarushtools commented Jul 30, 2024

Proposed changes

Brief description of rationale

Notes

Uh oh!

alanzhu0 commented Jul 30, 2024

Uh oh!

aarushtools commented Jul 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aarushtools commented Jul 31, 2024

Uh oh!

coveralls commented Jul 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alanzhu0 commented Aug 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aarushtools commented Aug 28, 2024

Uh oh!

aarushtools commented Aug 28, 2024

Uh oh!

aarushtools commented Aug 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

to test:

Uh oh!

aarushtools left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aarushtools commented Jul 30, 2024 •

edited

Loading

coveralls commented Jul 31, 2024 •

edited

Loading

alanzhu0 commented Aug 27, 2024 •

edited

Loading

aarushtools commented Aug 30, 2024 •

edited

Loading