Configured project to use django-q to send email reminder

Author: adamspd

appointment/services.py

@@ -26,7 +26,7 @@
     day_off_exists_for_date_range, exclude_booked_slots, get_all_appointments, get_all_staff_members,
     get_appointment_by_id, get_appointments_for_date_and_time, get_staff_member_appointment_list,
     get_staff_member_from_user_id_or_logged_in, get_times_from_config, get_user_by_email,
-    get_working_hours_for_staff_and_day, parse_name, working_hours_exist)
+    get_working_hours_for_staff_and_day, parse_name, update_appointment_reminder, working_hours_exist)
 from appointment.utils.error_codes import ErrorCode
 from appointment.utils.json_context import convert_appointment_to_json, get_generic_context, json_response
 from appointment.utils.permissions import check_entity_ownership
@@ -326,6 +326,11 @@ def save_appointment(appt, client_name, client_email, start_time, phone_number,
 
     # Modify and save appointment request details
     appt_request = appt.appointment_request
+
+    # Update reminder here
+    update_appointment_reminder(appointment=appt, new_date=appt_request.date, new_start_time=start_time,
+                                want_reminder=want_reminder)
+
     appt_request.service = service
     appt_request.start_time = start_time
     appt_request.end_time = end_time
@@ -367,6 +372,9 @@ def save_appt_date_time(appt_start_time, appt_date, appt_id):
     else:
         appt_date_obj = appt_date
 
+    # Update reminder here
+    update_appointment_reminder(appointment=appt, new_date=appt_date_obj, new_start_time=appt_start_time_obj)
+
     # Modify and save appointment request details
     appt_request = appt.appointment_request
     appt_request.date = appt_date_obj

appointment/settings.py

@@ -9,6 +9,8 @@
 from django.conf import settings
 from django.conf.global_settings import DEFAULT_FROM_EMAIL
 
+from appointment.logger_config import logger
+
 APPOINTMENT_BASE_TEMPLATE = getattr(settings, 'APPOINTMENT_BASE_TEMPLATE', 'base_templates/base.html')
 APPOINTMENT_ADMIN_BASE_TEMPLATE = getattr(settings, 'APPOINTMENT_ADMIN_BASE_TEMPLATE', 'base_templates/base.html')
 APPOINTMENT_WEBSITE_NAME = getattr(settings, 'APPOINTMENT_WEBSITE_NAME', 'Website')
@@ -20,3 +22,49 @@
 APPOINTMENT_FINISH_TIME = getattr(settings, 'APPOINTMENT_FINISH_TIME', (18, 30))
 APP_DEFAULT_FROM_EMAIL = getattr(settings, 'DEFAULT_FROM_EMAIL', DEFAULT_FROM_EMAIL)
 APP_TIME_ZONE = getattr(settings, 'TIME_ZONE', 'America/New_York')
+
+
+def check_q_cluster():
+    """
+    Checks if Django Q is properly installed and configured in the Django settings.
+    If 'django_q' is not in INSTALLED_APPS, it warns about both 'django_q' not being installed
+    and 'Q_CLUSTER' likely not being configured.
+    If 'django_q' is installed but 'Q_CLUSTER' is not configured, it only warns about 'Q_CLUSTER'.
+    Returns True if configurations are correct, otherwise False.
+    """
+    missing_conf = []
+
+    # Check if Django Q is installed
+    if 'django_q' not in settings.INSTALLED_APPS:
+        missing_conf.append("Django Q is not in settings.INSTALLED_APPS. Please add it to the list.\n"
+                            "Example: \n\n"
+                            "INSTALLED_APPS = [\n"
+                            "    ...\n"
+                            "    'appointment',\n"
+                            "    'django_q',\n"
+                            "]\n")
+
+    # Check if Q_CLUSTER configuration is defined
+    if not hasattr(settings, 'Q_CLUSTER'):
+        missing_conf.append("Q_CLUSTER is not defined in settings. Please define it.\n"
+                            "Example: \n\n"
+                            "Q_CLUSTER = {\n"
+                            "    'name': 'DjangORM',\n"
+                            "    'workers': 4,\n"
+                            "    'timeout': 90,\n"
+                            "    'retry': 120,\n"
+                            "    'queue_limit': 50,\n"
+                            "    'bulk': 10,\n"
+                            "    'orm': 'default',\n"
+                            "}\n"
+                            "Then run 'python manage.py qcluster' to start the worker.\n"
+                            "See https://django-q.readthedocs.io/en/latest/configure.html for more information.")
+
+    # Log warnings if any configurations are missing
+    if missing_conf:
+        for warning in missing_conf:
+            logger.warning(warning)
+        return False
+
+    # Both 'django_q' is installed and 'Q_CLUSTER' is configured
+    return True

appointment/tasks.py

@@ -0,0 +1,40 @@
+# tasks.py
+# Path: appointment/tasks.py
+
+"""
+Author: Adams Pierre David
+Since: 3.1.0
+"""
+from django.utils.translation import gettext as _
+
+from appointment.email_sender import notify_admin, send_email
+from appointment.models import Appointment
+from appointment.logger_config import logger
+
+
+def send_email_reminder(to_email, first_name, appointment_id):
+    """
+    Send a reminder email to the client about the upcoming appointment.
+
+    :param to_email: The email address of the client.
+    :param first_name: The first name of the client.
+    :param appointment_id: The appointment ID.
+    :return: None
+    """
+
+    # Fetch the appointment using appointment_id
+    logger.info(f"Sending reminder to {to_email} for appointment {appointment_id}")
+    appointment = Appointment.objects.get(id=appointment_id)
+    email_context = {
+        'first_name': first_name,
+        'appointment': appointment,
+    }
+    send_email(
+        recipient_list=[to_email], subject=_("Reminder: Upcoming Appointment"),
+        template_url='email_sender/reminder_email.html', context=email_context
+    )
+    # Notify the admin
+    notify_admin(
+        subject=_("Admin Reminder: Upcoming Appointment"),
+        template_url='email_sender/reminder_email.html', context=email_context
+    )

appointment/templates/email_sender/reminder_email.html

@@ -0,0 +1,19 @@
+{% load i18n %}
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>{% translate 'Appointment Reminder' %}</title>
+</head>
+<body>
+    <h1>{% translate 'Appointment Reminder' %}</h1>
+    <p>{% translate 'Dear' %} {{ first_name }},</p>
+    <p>{% translate 'This is a reminder for your upcoming appointment' %}.</p>
+    <p>{% translate 'Service' %}: {{ appointment.get_service_name }}</p>
+    <p>{% translate 'Date' %}: {{ appointment.appointment_request.date }}</p>
+    <p>{% translate 'Time' %}: {{ appointment.appointment_request.start_time }}</p>
+    <p>{% translate 'Location' %}: {{ appointment.address }}</p>
+    <p>{% translate 'If you have any questions or need to reschedule, please contact us' %}.</p>
+    <p>{% translate 'Thank you for choosing us' %}!</p>
+</body>
+</html>

appointment/utils/date_time.py

@@ -14,6 +14,16 @@
 from appointment.settings import APP_TIME_ZONE
 
 
+def combine_date_and_time(date, time) -> datetime.datetime:
+    """Combine a date and a time into a datetime object.
+
+    :param date: The date.
+    :param time: The time.
+    :return: A datetime object.
+    """
+    return datetime.datetime.combine(date, time)
+
+
 def convert_12_hour_time_to_24_hour_time(time_to_convert) -> str:
     """Convert a 12-hour time to a 24-hour time.
 
@@ -95,7 +105,7 @@ def convert_str_to_time(time_str: str) -> datetime.time:
     :param time_str: A string representation of time.
     :return: A Python `time` object.
     """
-    formats = ["%I:%M %p", "%H:%M:%S",  "%H:%M"]
+    formats = ["%I:%M %p", "%H:%M:%S", "%H:%M"]
 
     for fmt in formats:
         try:

appointment/utils/db_helpers.py

@@ -12,15 +12,17 @@
 
 from django.apps import apps
 from django.conf import settings
-from django.contrib.auth.hashers import make_password
 from django.core.cache import cache
 from django.core.exceptions import FieldDoesNotExist
 from django.urls import reverse
+from django.utils import timezone
+from django_q.models import Schedule
+from django_q.tasks import schedule
 
 from appointment.logger_config import logger
-from appointment.settings import APPOINTMENT_SLOT_DURATION, APPOINTMENT_LEAD_TIME, APPOINTMENT_FINISH_TIME, \
-    APPOINTMENT_BUFFER_TIME, APPOINTMENT_WEBSITE_NAME, APPOINTMENT_PAYMENT_URL
-from appointment.utils.date_time import get_weekday_num, get_current_year
+from appointment.settings import (APPOINTMENT_BUFFER_TIME, APPOINTMENT_FINISH_TIME, APPOINTMENT_LEAD_TIME,
+                                  APPOINTMENT_PAYMENT_URL, APPOINTMENT_SLOT_DURATION, APPOINTMENT_WEBSITE_NAME)
+from appointment.utils.date_time import combine_date_and_time, get_current_year, get_weekday_num
 
 Appointment = apps.get_model('appointment', 'Appointment')
 AppointmentRequest = apps.get_model('appointment', 'AppointmentRequest')
@@ -100,10 +102,96 @@ def create_and_save_appointment(ar, client_data: dict, appointment_data: dict):
         **appointment_data
     )
     appointment.save()
-    logger.info(f"New appointment created: {appointment}")
+    logger.info(f"New appointment created: {appointment.to_dict()}")
+    schedule_email_reminder(appointment)
     return appointment
 
 
+def schedule_email_reminder(appointment, appointment_datetime=None):
+    """Schedule an email reminder for the given appointment."""
+    # Check if the Django-Q cluster is running
+    from appointment.settings import check_q_cluster
+    if not check_q_cluster():
+        logger.warning("Django-Q cluster is not running. Email reminder will not be scheduled.")
+        return
+
+    # Calculate reminder datetime if not provided
+    if appointment_datetime is None:
+        appointment_datetime = combine_date_and_time(appointment.appointment_request.date,
+                                                     appointment.appointment_request.start_time)
+    if timezone.is_naive(appointment_datetime):
+        appointment_datetime = timezone.make_aware(appointment_datetime)
+
+    reminder_datetime = appointment_datetime - datetime.timedelta(days=1)
+
+    logger.info(f"Scheduling email reminder for appointment {appointment.id} at {reminder_datetime}")
+
+    # Schedule the email reminder task with Django-Q
+    schedule('appointment.tasks.send_email_reminder',
+             to_email=appointment.client.email,
+             name=f"reminder_{appointment.id_request}",
+             first_name=appointment.client.first_name,
+             appointment_id=appointment.id,
+             schedule_type=Schedule.ONCE,  # Use Schedule.ONCE for a one-time task
+             next_run=reminder_datetime)
+
+
+def update_appointment_reminder(appointment, new_date, new_start_time, want_reminder=None):
+    """
+    Updates or cancels the appointment reminder based on changes to the start time or date,
+    and the user's preference for receiving a reminder.
+
+    :param appointment: The Appointment instance being updated.
+    :param new_date: The new date as a string (format: "YYYY-MM-DD").
+    :param new_start_time: The new start time as a string (format: "HH:MM").
+    :param want_reminder: Boolean indicating if a reminder is desired.
+    """
+    # Convert new date and time strings to datetime objects for comparison
+    new_datetime = combine_date_and_time(new_date, new_start_time)
+
+    existing_datetime = combine_date_and_time(appointment.appointment_request.date,
+                                              appointment.appointment_request.start_time)
+
+    # Ensure new_datetime is timezone-aware
+    if timezone.is_naive(new_datetime):
+        new_datetime = timezone.make_aware(new_datetime)
+
+    # Ensure existing_datetime is timezone-aware
+    if timezone.is_naive(existing_datetime):
+        existing_datetime = timezone.make_aware(existing_datetime)
+
+    # Determine if there's been a change in the datetime or the reminder preference
+    want_reminder = want_reminder if want_reminder is not None else appointment.want_reminder
+    datetime_changed = new_datetime != existing_datetime
+    reminder_preference_changed = appointment.want_reminder != want_reminder
+
+    if datetime_changed or reminder_preference_changed:
+        # Cancel any existing reminder
+        cancel_existing_reminder(appointment.id_request)
+
+        # If a reminder is still desired and the appointment is in the future, schedule a new one
+        if want_reminder and new_datetime > timezone.now():
+            schedule_email_reminder(appointment, new_datetime)
+        else:
+            logger.info(
+                f"Reminder for appointment {appointment.id} is not scheduled per user's preference or past datetime.")
+
+    # Update the appointment's reminder preference
+    appointment.want_reminder = want_reminder
+    appointment.save()
+
+
+def cancel_existing_reminder(appointment_id_request):
+    """
+    Cancels any existing reminder for the appointment.
+    Placeholder function - implement based on your scheduling mechanism.
+    """
+    # Example: Delete existing scheduled tasks for this appointment
+    # This is highly dependent on how reminders are implemented and stored
+    task_name = f"reminder_{appointment_id_request}"
+    Schedule.objects.filter(name=task_name).delete()
+
+
 def generate_unique_username_from_email(email: str) -> str:
     username_base = email.split('@')[0]
     username = username_base