Scheduled job to notify of upcoming favourites

Author: jellybob

apps/notifications/jobs.py

@@ -1,9 +1,13 @@
+from sqlalchemy import and_
 from main import db
-from datetime import datetime
+from datetime import datetime, timedelta
 from flask import current_app as app
 
 from models import scheduled_task
+from models.cfp import FavouriteProposal, Proposal
+from models.user import User
 from models.web_push import PushNotificationJob
+from models.notifications import UserNotificationPreference
 from pywebpush import webpush, WebPushException
 
 
@@ -36,14 +40,49 @@ def deliver_notification(job: PushNotificationJob):
 def send_queued_notifications():
     jobs = PushNotificationJob.query.where(
         PushNotificationJob.state == "queued"
-        and (
-            PushNotificationJob.not_before is None
-            or PushNotificationJob.not_before <= datetime.now()
-        )
+        and (PushNotificationJob.not_before is None or PushNotificationJob.not_before <= datetime.now())
     ).all()
 
     for job in jobs:
         deliver_notification(job)
         db.session.add(job)
 
     db.session.commit()
+
+
+@scheduled_task(minutes=15)
+def queue_content_notifications(time=None) -> None:
+    if time is None:
+        time = datetime.now()
+
+    users = User.query.join(
+        UserNotificationPreference,
+        User.notification_preferences.and_(UserNotificationPreference.favourited_content),
+    )
+
+    upcoming_content = Proposal.query.filter(
+        and_(Proposal.scheduled_time >= time, Proposal.scheduled_time <= time + timedelta(minutes=16))
+    ).all()
+
+    for user in users:
+        user_favourites = [f.id for f in user.favourites]
+        favourites = [p for p in upcoming_content if p.id in user_favourites]
+        for proposal in favourites:
+            for target in user.web_push_targets:
+                related_to = f"favourite,user:{user.id},proposal:{proposal.id},target:{target.id}"
+                if (
+                    PushNotificationJob.query.where(
+                        PushNotificationJob.related_to == related_to
+                    ).one_or_none()
+                    is None
+                ):
+                    job = PushNotificationJob(
+                        target=target,
+                        title=f"{proposal.title} is happening soon at {proposal.scheduled_venue.name}",
+                        related_to=related_to,
+                        not_before=proposal.scheduled_time - timedelta(minutes=15),
+                    )
+                    print(f"Queued notification for {job.related_to}")
+                    db.session.add(job)
+
+    db.session.commit()

migrations/versions/91cd34a04a10_add_unique_index_to_related_to.py

@@ -0,0 +1,26 @@
+"""add_unique_index_to_related_to
+
+Revision ID: 91cd34a04a10
+Revises: be0934972583
+Create Date: 2024-04-21 20:46:28.014878
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '91cd34a04a10'
+down_revision = 'be0934972583'
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_unique_constraint(op.f('uq_push_notification_job_related_to'), 'push_notification_job', ['related_to'])
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint(op.f('uq_push_notification_job_related_to'), 'push_notification_job', type_='unique')
+    # ### end Alembic commands ###

migrations/versions/be0934972583_add_indexes_to_notification_preferences.py

@@ -0,0 +1,34 @@
+"""add_indexes_to_notification_preferences
+
+Revision ID: be0934972583
+Revises: cd825d16072a
+Create Date: 2024-04-21 09:53:36.317560
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = 'be0934972583'
+down_revision = 'cd825d16072a'
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_index(op.f('ix_user_notification_preference_announcements'), 'user_notification_preference', ['announcements'], unique=False)
+    op.create_index(op.f('ix_user_notification_preference_favourited_content'), 'user_notification_preference', ['favourited_content'], unique=False)
+    op.create_index(op.f('ix_user_notification_preference_volunteer_shifts'), 'user_notification_preference', ['volunteer_shifts'], unique=False)
+    op.drop_index('ix_web_push_target_user_id', table_name='web_push_target')
+    op.drop_index('ix_web_push_target_user_id_endpoint', table_name='web_push_target')
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_index('ix_web_push_target_user_id_endpoint', 'web_push_target', ['user_id', 'endpoint'], unique=False)
+    op.create_index('ix_web_push_target_user_id', 'web_push_target', ['user_id'], unique=False)
+    op.drop_index(op.f('ix_user_notification_preference_volunteer_shifts'), table_name='user_notification_preference')
+    op.drop_index(op.f('ix_user_notification_preference_favourited_content'), table_name='user_notification_preference')
+    op.drop_index(op.f('ix_user_notification_preference_announcements'), table_name='user_notification_preference')
+    # ### end Alembic commands ###

models/notifications.py

@@ -8,9 +8,9 @@ class UserNotificationPreference(BaseModel):
     id = db.Column(db.Integer, primary_key=True)
     user_id = db.Column(db.Integer, db.ForeignKey("user.id"), nullable=False)
     created = db.Column(db.DateTime, default=datetime.utcnow, nullable=False)
-    volunteer_shifts = db.Column(db.Boolean, default=False, nullable=False)
-    favourited_content = db.Column(db.Boolean, default=False, nullable=False)
-    announcements = db.Column(db.Boolean, default=False, nullable=False)
+    volunteer_shifts = db.Column(db.Boolean, default=False, nullable=False, index=True)
+    favourited_content = db.Column(db.Boolean, default=False, nullable=False, index=True)
+    announcements = db.Column(db.Boolean, default=False, nullable=False, index=True)
 
     user = db.relationship("User")
 

models/web_push.py

@@ -48,15 +48,11 @@ def __init__(self, user, endpoint, subscription_info, expires=None):
 class PushNotificationJob(BaseModel):
     __table_name__ = "web_push_notification_job"
     id: int = db.Column(db.Integer, primary_key=True)
-    target_id: int = db.Column(
-        db.Integer, db.ForeignKey("web_push_target.id"), nullable=False
-    )
+    target_id: int = db.Column(db.Integer, db.ForeignKey("web_push_target.id"), nullable=False)
     created: datetime = db.Column(db.DateTime, default=datetime.utcnow, nullable=False)
-    state: Literal["queued", "delivered", "failed"] = db.Column(
-        db.String, default="queued", nullable=False
-    )
+    state: Literal["queued", "delivered", "failed"] = db.Column(db.String, default="queued", nullable=False)
     not_before: datetime | None = db.Column(db.DateTime, nullable=True)
-    related_to: str | None = db.Column(db.String, nullable=True)
+    related_to: str | None = db.Column(db.String, nullable=True, unique=True)
     title: str = db.Column(db.String, nullable=False)
     body: str | None = db.Column(db.String, nullable=True)
     error: str | None = db.Column(db.String, nullable=True)