Merge pull request #152 from NHSDigital/dtos-9252-extract-appointment-status

[DTOS-9252] Extract appointment status to an append only log

Author: MatMoore

manage_breast_screening/clinics/tests/factories.py

@@ -37,6 +37,7 @@ class ClinicFactory(DjangoModelFactory):
     class Meta:
         model = models.Clinic
         django_get_or_create = ("starts_at", "ends_at")
+        skip_postgeneration_save = True
 
     type = FuzzyChoice(models.Clinic.TYPE_CHOICES)
     risk_type = FuzzyChoice(models.Clinic.RISK_TYPE_CHOICES)

manage_breast_screening/clinics/tests/system/test_user_views_clinic_show_page.py

@@ -1,19 +1,19 @@
 import re
-import pytest
-
 from datetime import datetime, timezone
+
+import pytest
 from django.urls import reverse
 from playwright.sync_api import expect
 
-from manage_breast_screening.core.utils.date_formatting import format_time, format_date
+from manage_breast_screening.clinics.tests.factories import ClinicFactory
+from manage_breast_screening.core.system_test_setup import SystemTestCase
+from manage_breast_screening.core.utils.date_formatting import format_date, format_time
 from manage_breast_screening.core.utils.string_formatting import (
     format_age,
     format_nhs_number,
 )
-from manage_breast_screening.participants.models import Appointment
-from manage_breast_screening.core.system_test_setup import SystemTestCase
+from manage_breast_screening.participants.models import AppointmentStatus
 from manage_breast_screening.participants.tests.factories import AppointmentFactory
-from manage_breast_screening.clinics.tests.factories import ClinicFactory
 
 
 class TestUserViewsClinicShowPage(SystemTestCase):
@@ -44,7 +44,7 @@ def given_there_are_appointments(self):
         self.confirmed_appointment = AppointmentFactory(
             clinic_slot__clinic=self.clinic,
             clinic_slot__starts_at=datetime.now(timezone.utc).replace(hour=9, minute=0),
-            status=Appointment.Status.CONFIRMED,
+            current_status=AppointmentStatus.CONFIRMED,
             screening_episode__participant__first_name="Janet",
             screening_episode__participant__last_name="Confirmed",
         )
@@ -53,14 +53,14 @@ def given_there_are_appointments(self):
             clinic_slot__starts_at=datetime.now(timezone.utc).replace(
                 hour=9, minute=30
             ),
-            status=Appointment.Status.CHECKED_IN,
+            current_status=AppointmentStatus.CHECKED_IN,
         )
         self.screened_appointment = AppointmentFactory(
             clinic_slot__clinic=self.clinic,
             clinic_slot__starts_at=datetime.now(timezone.utc).replace(
                 hour=10, minute=45
             ),
-            status=Appointment.Status.SCREENED,
+            current_status=AppointmentStatus.SCREENED,
         )
 
     def given_i_am_on_the_clinic_list(self):
@@ -158,5 +158,5 @@ def _expect_rows_to_match_appointments(self, rows, appointments):
                 format_age(appointment.screening_episode.participant.age())
             )
             expect(row.locator("td").nth(3)).to_contain_text(
-                appointment.get_status_display()
+                appointment.current_status.get_state_display()
             )

manage_breast_screening/clinics/views.py

@@ -1,11 +1,9 @@
-from django.shortcuts import render, get_object_or_404, redirect
+from django.shortcuts import get_object_or_404, redirect, render
 from django.views.decorators.http import require_http_methods
 
-from .presenters import ClinicsPresenter, ClinicPresenter
-from .presenters import AppointmentListPresenter
-
+from ..participants.models import Appointment, AppointmentStatus
 from .models import Clinic
-from ..participants.models import Appointment
+from .presenters import AppointmentListPresenter, ClinicPresenter, ClinicsPresenter
 
 
 def clinic_list(request, filter="today"):
@@ -44,7 +42,6 @@ def clinic(request, id, filter="remaining"):
 @require_http_methods(["POST"])
 def check_in(_request, id, appointment_id):
     appointment = get_object_or_404(Appointment, pk=appointment_id)
-    appointment.status = Appointment.Status.CHECKED_IN
-    appointment.save()
+    appointment.statuses.create(state=AppointmentStatus.CHECKED_IN)
 
     return redirect("clinics:show", id=id)

manage_breast_screening/core/jinja2/components/appointment-status/template.jinja

@@ -1,29 +1,21 @@
 {% from 'components/tag/macro.jinja' import tag %}
-
-{% set show_check_in = appointment.status.is_confirmed %}
-
-<div data-event-status-container="{{ appointment.id }}" {% if show_check_in %}data-module="app-check-in"{% endif %}>
+{% set show_check_in = appointment.current_status.is_confirmed %}
+<div data-event-status-container="{{ appointment.id }}"
+     {% if show_check_in %}data-module="app-check-in"{% endif %}>
   <span data-hide-on-submit>{{ tag({
-    "text": appointment.status.text,
-    "classes": appointment.status.classes
-  })}}</span>
-
+    "text": appointment.current_status.text,
+    "classes": appointment.current_status.classes
+  }) }}</span>
   {% if show_check_in %}
-  <span data-show-on-submit hidden>{{ tag({
-    "text": "Checked in",
-    "classes": "app-nowrap"
-  })}}</span>
+    <span data-show-on-submit hidden>{{ tag({"text": "Checked in", "classes": "app-nowrap"}) }}</span>
   {% endif %}
-
   {% if show_check_in %}
-      {% set action_url = check_in_url or url('mammograms:check_in', kwargs={'id': appointment.id}) %}
-      <form action="{{ action_url }}" method="post" novalidate>
+    {% set action_url = check_in_url or url('mammograms:check_in', kwargs={'id': appointment.id}) %}
+    <form action="{{ action_url }}" method="post" novalidate>
       <p class="nhsuk-u-margin-top-2 nhsuk-u-margin-bottom-0">
-        <button class="app-button--link">
-          Check in
-        </button>
+        <button class="app-button--link">Check in</button>
       </p>
       {{ csrf_input }}
-      </form>
+    </form>
   {% endif %}
 </div>

manage_breast_screening/mammograms/forms.py

@@ -1,5 +1,7 @@
 from django import forms
 
+from ..participants.models import AppointmentStatus
+
 
 class ScreeningAppointmentForm(forms.Form):
     decision = forms.ChoiceField(
@@ -115,7 +117,7 @@ def save(self):
                 reasons_json[field_name] = value
         self.instance.stopped_reasons = reasons_json
         self.instance.reinvite = self.cleaned_data["decision"]
-        self.instance.status = self.instance.Status.ATTENDED_NOT_SCREENED
         self.instance.save()
+        self.instance.statuses.create(state=AppointmentStatus.ATTENDED_NOT_SCREENED)
 
         return self.instance

manage_breast_screening/mammograms/presenters.py

@@ -1,24 +1,25 @@
 from django.urls import reverse
 
 from ..core.utils.date_formatting import format_date, format_relative_date, format_time
-from ..participants.models import Appointment
+from ..participants.models import AppointmentStatus
 from ..participants.presenters import ParticipantPresenter
 
-Status = Appointment.Status
-
 
 def status_colour(status):
     """
     Color to render the status tag
     """
     match status:
-        case Status.CHECKED_IN:
+        case AppointmentStatus.CHECKED_IN:
             return ""  # no colour will get solid dark blue
-        case Status.SCREENED:
+        case AppointmentStatus.SCREENED:
             return "green"
-        case Status.DID_NOT_ATTEND | Status.CANCELLED:
+        case AppointmentStatus.DID_NOT_ATTEND | AppointmentStatus.CANCELLED:
             return "red"
-        case Status.ATTENDED_NOT_SCREENED | Status.PARTIALLY_SCREENED:
+        case (
+            AppointmentStatus.ATTENDED_NOT_SCREENED
+            | AppointmentStatus.PARTIALLY_SCREENED
+        ):
             return "orange"
         case _:
             return "blue"  # default blue
@@ -45,7 +46,7 @@ def __init__(self, appointment):
         self._appointment = appointment
         self._last_known_screening = appointment.screening_episode.previous()
 
-        self.allStatuses = Status
+        self.allStatuses = AppointmentStatus
         self.id = appointment.id
         self.clinic_slot = ClinicSlotPresenter(appointment.clinic_slot)
         self.participant = ParticipantPresenter(
@@ -61,14 +62,15 @@ def start_time(self):
         return self.clinic_slot.starts_at
 
     @property
-    def status(self):
-        colour = status_colour(self._appointment.status)
+    def current_status(self):
+        current_status = self._appointment.current_status
+        colour = status_colour(current_status.state)
 
         return {
             "classes": f"nhsuk-tag--{colour} app-nowrap" if colour else "app-nowrap",
-            "text": self._appointment.get_status_display(),
-            "key": self._appointment.status,
-            "is_confirmed": self._appointment.status == Status.CONFIRMED,
+            "text": current_status.get_state_display(),
+            "key": current_status.state,
+            "is_confirmed": current_status.state == AppointmentStatus.CONFIRMED,
         }
 
     @property

manage_breast_screening/mammograms/tests/system/test_user_submits_cannot_go_ahead_form.py

@@ -5,7 +5,7 @@
 from playwright.sync_api import expect
 
 from manage_breast_screening.core.system_test_setup import SystemTestCase
-from manage_breast_screening.participants.models import Appointment
+from manage_breast_screening.participants.models import AppointmentStatus
 from manage_breast_screening.participants.tests.factories import (
     AppointmentFactory,
     ParticipantFactory,
@@ -93,7 +93,8 @@ def then_i_see_the_clinics_page(self):
     def and_the_appointment_is_updated(self):
         self.appointment.refresh_from_db()
         self.assertEqual(
-            self.appointment.status, Appointment.Status.ATTENDED_NOT_SCREENED
+            self.appointment.current_status.state,
+            AppointmentStatus.ATTENDED_NOT_SCREENED,
         )
         self.assertEqual(self.appointment.reinvite, True)
         self.assertEqual(

manage_breast_screening/mammograms/tests/test_presenters.py

@@ -7,7 +7,11 @@
 import time_machine
 
 from manage_breast_screening.clinics.models import ClinicSlot
-from manage_breast_screening.participants.models import Appointment, ScreeningEpisode
+from manage_breast_screening.participants.models import (
+    Appointment,
+    AppointmentStatus,
+    ScreeningEpisode,
+)
 
 from ..presenters import AppointmentPresenter, ClinicSlotPresenter
 
@@ -24,21 +28,21 @@ def mock_appointment(self):
         "status, expected_classes, expected_text, expected_key, expected_is_confirmed",
         [
             (
-                Appointment.Status.CONFIRMED,
+                AppointmentStatus.CONFIRMED,
                 "nhsuk-tag--blue app-nowrap",
                 "Confirmed",
                 "CONFIRMED",
                 True,
             ),
             (
-                Appointment.Status.CHECKED_IN,
+                AppointmentStatus.CHECKED_IN,
                 "app-nowrap",
                 "Checked in",
                 "CHECKED_IN",
                 False,
             ),
             (
-                Appointment.Status.ATTENDED_NOT_SCREENED,
+                AppointmentStatus.ATTENDED_NOT_SCREENED,
                 "nhsuk-tag--orange app-nowrap",
                 "Attended not screened",
                 "ATTENDED_NOT_SCREENED",
@@ -55,12 +59,9 @@ def test_status(
         expected_key,
         expected_is_confirmed,
     ):
-        mock_appointment.status = status
-        mock_appointment.get_status_display.return_value = Appointment.STATUS_CHOICES[
-            status
-        ]
+        mock_appointment.current_status = AppointmentStatus(state=status)
 
-        result = AppointmentPresenter(mock_appointment).status
+        result = AppointmentPresenter(mock_appointment).current_status
 
         assert result["classes"] == expected_classes
         assert result["text"] == expected_text

manage_breast_screening/mammograms/views.py

@@ -5,8 +5,7 @@
 from django.views.decorators.http import require_http_methods
 from django.views.generic import FormView
 
-from manage_breast_screening.participants.models import Appointment, Participant
-
+from ..participants.models import Appointment, AppointmentStatus, Participant
 from .forms import (
     AppointmentCannotGoAheadForm,
     AskForMedicalInformationForm,
@@ -15,30 +14,11 @@
 )
 from .presenters import AppointmentPresenter, present_secondary_nav
 
-Status = Appointment.Status
-
 APPOINTMENT_CANNOT_PROCEED = "Appointment cannot proceed"
 
 logger = logging.getLogger(__name__)
 
 
-def status_color(status):
-    """
-    Color to render the status tag
-    """
-    match status:
-        case Status.CHECKED_IN:
-            return ""  # no colour will get solid dark blue
-        case Status.SCREENED:
-            return "green"
-        case (Status.DID_NOT_ATTEND, Status.CANCELLED):
-            return "red"
-        case (Status.ATTENDED_NOT_SCREENED, Status.PARTIALLY_SCREENED):
-            return "orange"
-        case _:
-            return "blue"  # default blue
-
-
 class BaseAppointmentForm(FormView):
     @property
     def appointment_id(self):
@@ -75,9 +55,9 @@ def get_context_data(self, **kwargs):
             }
         )
 
-        if appointment.status in [
-            appointment.Status.SCREENED,
-            appointment.Status.PARTIALLY_SCREENED,
+        if AppointmentStatus in [
+            AppointmentStatus.SCREENED,
+            AppointmentStatus.PARTIALLY_SCREENED,
         ]:
             context["secondary_nav_items"] = present_secondary_nav(appointment.pk)
 
@@ -200,9 +180,8 @@ def awaiting_images(request, id):
 
 
 @require_http_methods(["POST"])
-def check_in(request, id):
+def check_in(_request, id):
     appointment = get_object_or_404(Appointment, pk=id)
-    appointment.status = Appointment.Status.CHECKED_IN
-    appointment.save()
+    appointment.statuses.create(state=AppointmentStatus.CHECKED_IN)
 
     return redirect("mammograms:start_screening", id=id)

manage_breast_screening/participants/admin.py

@@ -16,7 +16,7 @@ class AppointmentAdmin(admin.ModelAdmin):
         "name",
         "clinic_slot__starts_at",
         "clinic_slot__duration_in_minutes",
-        "status",
+        "statuses__state",
     ]
 
     @admin.display()