use a form for available slots

Author: deronnax

appointment/forms.py

@@ -16,6 +16,12 @@
     WorkingHours
 )
 from .utils.db_helpers import get_user_model
+from .utils.validators import not_in_the_past
+
+
+class SlotForm(forms.Form):
+    selected_date = forms.DateField(validators=[not_in_the_past])
+    staff_member = forms.ModelChoiceField(StaffMember.objects.all(), error_messages={'invalid_choice': 'Staff member does not exist'})
 
 
 class AppointmentRequestForm(forms.ModelForm):

appointment/static/js/appointments.js

@@ -158,7 +158,7 @@ function fetchNonWorkingDays(staffId, callback) {
         return;  // Exit the function early
     }
     let ajaxData = {
-        'staff_id': staffId,
+        'staff_member': staffId,
     };
 
     $.ajax({
@@ -231,7 +231,7 @@ function getAvailableSlots(selectedDate, staffId = null) {
 
     let ajaxData = {
         'selected_date': selectedDate,
-        'staff_id': staffId,
+        'staff_member': staffId,
     };
     fetchNonWorkingDays(staffId, function (nonWorkingDays) {
         // Check if nonWorkingDays is an array
@@ -325,7 +325,7 @@ function requestNextAvailableSlot(serviceId) {
         return;
     }
     let ajaxData = {
-        'staff_id': staffId,
+        'staff_member': staffId,
     };
     $.ajax({
         url: requestNextAvailableSlotURL,

appointment/tests/test_views.py

@@ -43,21 +43,23 @@ def setUp(self):
 
     def test_get_available_slots_ajax(self):
         """get_available_slots_ajax view should return a JSON response with available slots for the selected date."""
-        response = self.client.get(self.url, {'selected_date': date.today().isoformat()},
+        response = self.client.get(self.url, {'selected_date': date.today().isoformat(), 'staff_member': self.staff_member1.id},
                                    HTTP_X_REQUESTED_WITH='XMLHttpRequest')
-        self.assertEqual(response.status_code, 403)
         response_data = response.json()
         self.assertIn('date_chosen', response_data)
         self.assertIn('available_slots', response_data)
         self.assertFalse(response_data.get('error'))
 
-    def test_get_available_slots_ajax_past_date(self):
+    def test_get_available_slots_ajax_invalid_form(self):
         """get_available_slots_ajax view should return an error if the selected date is in the past."""
         past_date = (date.today() - timedelta(days=1)).isoformat()
         response = self.client.get(self.url, {'selected_date': past_date}, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
-        self.assertEqual(response.status_code, 200)
         self.assertEqual(response.json()['error'], True)
         self.assertEqual(response.json()['message'], 'Date is in the past')
+        # invalid staff id
+        response = self.client.get(self.url, {'selected_date': date.today(), 'staff_member': 999}, HTTP_X_REQUESTED_WITH='XMLHttpRequest')
+        self.assertEqual(response.json()['error'], True)
+        self.assertEqual(response.json()['message'], 'Staff member does not exist')
 
 
 class AppointmentRequestTestCase(BaseTest):

appointment/utils/validators.py

@@ -0,0 +1,7 @@
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+
+def not_in_the_past(date):
+    if date < date.today():
+        raise ValidationError(_('Date is in the past'))

appointment/views.py

@@ -21,7 +21,7 @@
 from django.utils.timezone import get_current_timezone_name
 from django.utils.translation import gettext as _
 
-from appointment.forms import AppointmentForm, AppointmentRequestForm
+from appointment.forms import AppointmentForm, AppointmentRequestForm, SlotForm
 from appointment.logger_config import logger
 from appointment.models import (
     Appointment, AppointmentRequest, AppointmentRescheduleHistory, Config, DayOff, EmailVerificationCode,
@@ -57,28 +57,23 @@ def get_available_slots_ajax(request):
     :param request: The request instance.
     :return: A JSON response containing available slots, selected date, an error flag, and an optional error message.
     """
-    selected_date = convert_str_to_date(request.GET.get('selected_date'))
-    staff_id = request.GET.get('staff_id')
 
-    if selected_date < date.today():
+    slot_form = SlotForm(request.GET)
+    if not slot_form.is_valid():
         custom_data = {'error': True, 'available_slots': [], 'date_chosen': ''}
-        message = _('Date is in the past')
+        if 'selected_date' in slot_form.errors:
+            error_code = ErrorCode.PAST_DATE
+        elif 'staff_member' in slot_form.errors:
+            error_code = ErrorCode.STAFF_ID_REQUIRED
+        message = list(slot_form.errors.as_data().items())[0][1][0].messages[0]  # dirty way to keep existing behavior
         return json_response(message=message, custom_data=custom_data, success=False,
-                             error_code=ErrorCode.PAST_DATE)
+                             error_code=error_code)
 
+    selected_date = slot_form.cleaned_data['selected_date']
+    sm = slot_form.cleaned_data['staff_member']
     date_chosen = selected_date.strftime("%a, %B %d, %Y")
     custom_data = {'date_chosen': date_chosen}
 
-    # If no staff_id provided, return an empty list of slots
-    if not staff_id or staff_id == 'none':
-        custom_data['available_slots'] = []
-        custom_data['error'] = False
-        message = _('No staff member selected')
-        return json_response(message=message, custom_data=custom_data, success=False,
-                             error_code=ErrorCode.STAFF_ID_REQUIRED, status=403)
-
-    sm = get_object_or_404(StaffMember, pk=staff_id)
-    custom_data['staff_member'] = sm.get_staff_member_name()
     days_off_exist = check_day_off_for_staff(staff_member=sm, date=selected_date)
     if days_off_exist:
         message = _("Day off. Please select another date!")
@@ -87,6 +82,8 @@ def get_available_slots_ajax(request):
     # if selected_date is not a working day for the staff, return an empty list of slots and 'message' is Day Off
     weekday_num = get_weekday_num_from_date(selected_date)
     is_working_day_ = is_working_day(staff_member=sm, day=weekday_num)
+
+    custom_data['staff_member'] = sm.get_staff_member_name()
     if not is_working_day_:
         message = _("Not a working day for {staff_member}. Please select another date!").format(
             staff_member=sm.get_staff_member_first_name())
@@ -108,6 +105,7 @@ def get_available_slots_ajax(request):
     return json_response(message='Successfully retrieved available slots', custom_data=custom_data, success=True)
 
 
+# TODO: service id and staff id are not checked
 @require_ajax
 def get_next_available_date_ajax(request, service_id):
     """This view function handles AJAX requests to get the next available date for a service.