Clean up reminder schedule after completing the job if the recurrence is once and update the object to the next scheduled date if recurrence is otherwise and add list_reminders button

Author: ahmedxgouda

backend/apps/nest/schedulers/calendar_events/base.py

@@ -2,6 +2,7 @@
 
 from django_rq import get_scheduler
 
+from django.utils import timezone
 from apps.nest.models.reminder_schedule import ReminderSchedule
 
 
@@ -22,30 +23,44 @@ def schedule(self):
                 message=self.reminder_schedule.reminder.message,
                 channel_id=self.reminder_schedule.reminder.channel_id,
             ).get_id()
-            self.reminder_schedule.save()
-            return
-
-        self.reminder_schedule.job_id = self.scheduler.cron(
-            self.reminder_schedule.cron_expression,
-            func=self.__class__.send_message,
-            args=(
-                self.reminder_schedule.reminder.message,
-                self.reminder_schedule.reminder.channel_id,
-            ),
-            queue_name="default",
-            use_local_timezone=True,
-            result_ttl=500,
-        ).get_id()
-        self.reminder_schedule.save()
+
+            # Schedule deletion of the reminder after sending the message
+            self.scheduler.enqueue_at(
+                self.reminder_schedule.scheduled_time + timezone.timedelta(minutes=1),
+                self.reminder_schedule.reminder.delete,
+            )
+        else:
+            self.reminder_schedule.job_id = self.scheduler.cron(
+                self.reminder_schedule.cron_expression,
+                func=self.__class__.send_message_and_update,
+                args=(
+                    self.reminder_schedule.reminder.message,
+                    self.reminder_schedule.reminder.channel_id,
+                    self.reminder_schedule,
+                ),
+                queue_name="default",
+                use_local_timezone=True,
+                result_ttl=500,
+            ).get_id()
+
+        self.reminder_schedule.save(update_fields=["job_id"])
 
     def cancel(self):
         """Cancel the scheduled reminder."""
         if self.reminder_schedule.job_id:
             self.scheduler.cancel(self.reminder_schedule.job_id)
-            self.reminder_schedule.delete()
+            self.reminder_schedule.reminder.delete()
 
     @staticmethod
     def send_message(message: str, channel_id: str):
         """Send message to the specified channel. To be implemented by subclasses."""
         error_message = "Subclasses must implement this method."
         raise NotImplementedError(error_message)
+
+    @staticmethod
+    def send_message_and_update(
+        message: str, channel_id: str, reminder_schedule: ReminderSchedule
+    ):
+        """Send message and update the reminder schedule."""
+        error_message = "Subclasses must implement this method."
+        raise NotImplementedError(error_message)

backend/apps/nest/schedulers/calendar_events/slack.py

@@ -1,6 +1,7 @@
 """Slack Scheduler for Nest Calendar Events."""
 
 from apps.nest.schedulers.calendar_events.base import BaseScheduler
+from apps.nest.utils.calendar_events import update_reminder_schedule_date
 from apps.slack.apps import SlackConfig
 
 
@@ -15,3 +16,9 @@ def send_message(message: str, channel_id: str):
                 channel=channel_id,
                 text=message,
             )
+
+    @staticmethod
+    def send_message_and_update(message: str, channel_id: str, reminder_schedule):
+        """Send message and update the reminder schedule."""
+        SlackScheduler.send_message(message, channel_id)
+        update_reminder_schedule_date(reminder_schedule)

backend/apps/nest/utils/calendar_events.py

@@ -2,6 +2,12 @@
 
 import shlex
 from argparse import ArgumentParser
+from datetime import timedelta
+
+from dateutil.relativedelta import relativedelta
+from django.utils import timezone
+
+from apps.nest.models.reminder_schedule import ReminderSchedule
 
 
 def parse_reminder_args(text: str):
@@ -43,3 +49,29 @@ def parse_reminder_args(text: str):
     )
 
     return parser.parse_args(shlex.split(text or ""))
+
+
+def update_reminder_schedule_date(reminder_schedule: ReminderSchedule) -> None:
+    """Update the scheduled_time of a ReminderSchedule based on its recurrence pattern.
+
+    Args:
+        reminder_schedule (ReminderSchedule): The ReminderSchedule instance to update.
+
+    Returns:
+        None: The function updates the instance in place and saves it.
+
+    """
+    if reminder_schedule.scheduled_time > timezone.now():
+        return  # No update needed if the scheduled time is in the future
+
+    match reminder_schedule.recurrence:
+        case ReminderSchedule.Recurrence.DAILY:
+            reminder_schedule.scheduled_time += timedelta(days=1)
+        case ReminderSchedule.Recurrence.WEEKLY:
+            reminder_schedule.scheduled_time += timedelta(weeks=1)
+        case ReminderSchedule.Recurrence.MONTHLY:
+            reminder_schedule.scheduled_time += relativedelta(months=1)
+        case _:
+            return  # No update for 'once' or unrecognized recurrence
+
+    reminder_schedule.save(update_fields=["scheduled_time"])

backend/apps/slack/actions/home.py

@@ -34,6 +34,7 @@
     VIEW_PROJECTS_ACTION,
     VIEW_PROJECTS_ACTION_NEXT,
     VIEW_PROJECTS_ACTION_PREV,
+    VIEW_REMINDERS_ACTION,
 )
 
 logger: logging.Logger = logging.getLogger(__name__)
@@ -95,7 +96,7 @@ def handle_home_actions(ack, body, client: WebClient) -> None:
                 VIEW_CALENDAR_EVENTS_ACTION_PREV,
                 VIEW_CALENDAR_EVENTS_ACTION_NEXT,
             }:
-                blocks = calendar_events.get_blocks(
+                blocks = calendar_events.get_events_blocks(
                     slack_user_id=user_id,
                     page=page,
                     presentation=home_presentation,
@@ -107,6 +108,8 @@ def handle_home_actions(ack, body, client: WebClient) -> None:
                     blocks = [markdown("Error signing in with Google")]
                     logger.exception("Google authentication error for user {user_id}")
 
+            case action if action == VIEW_REMINDERS_ACTION:
+                blocks = calendar_events.get_reminders_blocks(slack_user_id=user_id)
             case _:
                 blocks = [markdown("Invalid action, please try again.")]
 
@@ -143,6 +146,7 @@ def handle_home_actions(ack, body, client: WebClient) -> None:
         VIEW_PROJECTS_ACTION_NEXT,
         VIEW_PROJECTS_ACTION_PREV,
         VIEW_PROJECTS_ACTION,
+        VIEW_REMINDERS_ACTION,
     )
     for action in actions:
         SlackConfig.app.action(action)(handle_home_actions)

backend/apps/slack/blocks.py

@@ -99,12 +99,22 @@ def get_header() -> list[dict[str, Any]]:
                     "type": "button",
                     "text": {
                         "type": "plain_text",
-                        "text": "View Calendar Events",
+                        "text": "Calendar Events",
                         "emoji": True,
                     },
                     "value": "view_calendar_events",
                     "action_id": "view_calendar_events_action",
                 },
+                {
+                    "type": "button",
+                    "text": {
+                        "type": "plain_text",
+                        "text": "Reminders",
+                        "emoji": True,
+                    },
+                    "value": "view_reminders",
+                    "action_id": "view_reminders_action",
+                },
             ],
         },
     ]

backend/apps/slack/commands/set_reminder.py

@@ -1,9 +1,8 @@
 """Slack Set Reminder Command."""
 
-from apps.nest.utils.calendar_events import parse_reminder_args
 from apps.slack.blocks import markdown
 from apps.slack.commands.command import CommandBase
-from apps.slack.common.handlers.calendar_events import get_reminder_blocks
+from apps.slack.common.handlers.calendar_events import get_setting_reminder_blocks
 
 
 class SetReminder(CommandBase):
@@ -16,9 +15,11 @@ def command_name(self):
 
     def render_blocks(self, command):
         """Render the blocks for the command."""
+        from apps.nest.utils.calendar_events import parse_reminder_args
+
         try:
             args = parse_reminder_args(command["text"])
         except SystemExit:
             return [markdown("*Invalid command format. Please check your input and try again.*")]
         else:
-            return get_reminder_blocks(args, self.get_user_id(command))
+            return get_setting_reminder_blocks(args, self.get_user_id(command))

backend/apps/slack/common/handlers/calendar_events.py

@@ -9,7 +9,7 @@
 from apps.slack.blocks import get_pagination_buttons, markdown
 
 
-def get_blocks(slack_user_id: str, presentation, page: int = 1) -> list[dict]:
+def get_events_blocks(slack_user_id: str, presentation, page: int = 1) -> list[dict]:
     """Get Google Calendar events blocks for Slack home view."""
     from apps.nest.clients.google_calendar import GoogleCalendarClient
     from apps.nest.models.google_account_authorization import GoogleAccountAuthorization
@@ -60,7 +60,31 @@ def get_blocks(slack_user_id: str, presentation, page: int = 1) -> list[dict]:
     return blocks
 
 
-def get_reminder_blocks(args, slack_user_id: str) -> list[dict]:
+def get_reminders_blocks(slack_user_id: str) -> list[dict]:
+    """Get reminders blocks for Slack home view."""
+    from apps.nest.models.reminder_schedule import ReminderSchedule
+
+    reminders_schedules = ReminderSchedule.objects.filter(
+        reminder__member__slack_user_id=slack_user_id,
+    ).order_by("scheduled_time")
+    if not reminders_schedules:
+        return [markdown("*No reminders found. You can set one with `/set-reminder`*")]
+    blocks = [markdown("*Your upcoming reminders:*")]
+    blocks.extend(
+        markdown(
+            f"{NL}- Reminder Number: {reminder_schedule.pk}"
+            f"{NL}- Channel: {reminder_schedule.reminder.channel_id}"
+            f"{NL}- Scheduled Time: "
+            f"{reminder_schedule.scheduled_time.strftime('%Y-%m-%d, %H:%M %Z')}"
+            f"{NL}- Recurrence: {reminder_schedule.recurrence}"
+            f"{NL}- Message: {reminder_schedule.reminder.message or 'No message'}"
+        )
+        for reminder_schedule in reminders_schedules
+    )
+    return blocks
+
+
+def get_setting_reminder_blocks(args, slack_user_id: str) -> list[dict]:
     """Get the blocks for setting a reminder."""
     from apps.nest.controllers.calendar_events import set_reminder
     from apps.nest.schedulers.calendar_events.slack import SlackScheduler

backend/apps/slack/constants.py

@@ -34,6 +34,8 @@
 VIEW_PROJECTS_ACTION_NEXT = "view_projects_action_next"
 VIEW_PROJECTS_ACTION_PREV = "view_projects_action_prev"
 
+VIEW_REMINDERS_ACTION = "view_reminders_action"
+
 VIEW_COMMITTEES_ACTION = "view_committees_action"
 VIEW_COMMITTEES_ACTION_NEXT = "view_committees_action_next"
 VIEW_COMMITTEES_ACTION_PREV = "view_committees_action_prev"