Merge pull request #383 from NHSDigital/send-notifications-on-working-days

Only send notifications on working days

Author: steventux

manage_breast_screening/notifications/management/commands/send_message_batch.py

@@ -1,6 +1,7 @@
 from datetime import datetime, timedelta
 from zoneinfo import ZoneInfo
 
+from business.calendar import Calendar
 from django.core.management.base import BaseCommand, CommandError
 
 from manage_breast_screening.notifications.management.commands.helpers.message_batch_helpers import (
@@ -28,6 +29,9 @@ class Command(BaseCommand):
 
     def handle(self, *args, **options):
         try:
+            if not self.bso_working_day():
+                return
+
             for routing_plan in RoutingPlan.all():
                 self.stdout.write(
                     f"Finding appointments of episode type {routing_plan.episode_types} to include in batch."
@@ -46,7 +50,6 @@ def handle(self, *args, **options):
                     )
                     continue
 
-
                 self.stdout.write(
                     f"Found {appointments.count()} appointments to batch."
                 )
@@ -81,8 +84,11 @@ def handle(self, *args, **options):
         except Exception as e:
             raise CommandError(e)
 
+    def bso_working_day(self):
+        return Calendar().is_business_day(datetime.now(tz=TZ_INFO))
+
     def schedule_date(self) -> datetime:
         today = datetime.now(tz=TZ_INFO)
         today_end = today.replace(hour=23, minute=59, second=59, microsecond=999999)
 
-        return today_end + timedelta(weeks=4)
+        return today_end + timedelta(weeks=4)

manage_breast_screening/notifications/tests/management/commands/test_send_message_batch.py

@@ -4,6 +4,7 @@
 
 import pytest
 import requests
+from dateutil import relativedelta
 
 from manage_breast_screening.notifications.management.commands.helpers.message_batch_helpers import (
     MessageBatchHelpers,
@@ -25,8 +26,9 @@
     ApiClient, "send_message_batch", return_value=MagicMock(spec=requests.Response)
 )
 @patch.object(MessageBatchHelpers, "mark_batch_as_sent")
+@pytest.mark.time_machine(datetime.today() + relativedelta.relativedelta(weekday=0))
+@pytest.mark.django_db
 class TestSendMessageBatch:
-    @pytest.mark.django_db
     def test_handle_with_a_batch_to_send(
         self, mock_mark_batch_as_sent, mock_send_message_batch
     ):
@@ -48,7 +50,6 @@ def test_handle_with_a_batch_to_send(
         )
         mock_mark_batch_as_sent.assert_called_once_with(message_batches[0], ANY)
 
-    @pytest.mark.django_db
     def test_handle_for_all_routing_plans(
         self, mock_mark_batch_as_sent, mock_send_message_batch
     ):
@@ -78,7 +79,6 @@ def test_handle_for_all_routing_plans(
         mock_mark_batch_as_sent.assert_any_call(message_batches[0], ANY)
         mock_mark_batch_as_sent.assert_any_call(message_batches[1], ANY)
 
-    @pytest.mark.django_db
     def test_handle_with_nothing_to_send(
         self, mock_mark_batch_as_sent, mock_send_message_batch
     ):
@@ -88,7 +88,6 @@ def test_handle_with_nothing_to_send(
         assert MessageBatch.objects.count() == 0
         assert Message.objects.count() == 0
 
-    @pytest.mark.django_db
     def test_handle_with_appointments_inside_schedule_window(
         self,
         mock_mark_batch_as_sent,
@@ -98,7 +97,7 @@ def test_handle_with_appointments_inside_schedule_window(
         """Test that appointments with date inside the schedule period are notified"""
         mock_send_message_batch.return_value.status_code = 201
         appointment = AppointmentFactory(
-            starts_at=datetime.now().replace(tzinfo=TZ_INFO) + timedelta(weeks=4)
+            starts_at=datetime.now(tz=TZ_INFO) + timedelta(weeks=4)
         )
         routing_plan_id = RoutingPlan.for_episode_type(appointment.episode_type).id
 
@@ -114,7 +113,6 @@ def test_handle_with_appointments_inside_schedule_window(
         )
         mock_mark_batch_as_sent.assert_called_once_with(message_batches[0], ANY)
 
-    @pytest.mark.django_db
     def test_handle_with_appointments_outside_schedule_window(
         self,
         mock_mark_batch_as_sent,
@@ -123,8 +121,7 @@ def test_handle_with_appointments_outside_schedule_window(
     ):
         """Test that appointments with date inside the schedule period are notified"""
         AppointmentFactory(
-            starts_at=datetime.now().replace(tzinfo=TZ_INFO)
-            + timedelta(weeks=4, days=1)
+            starts_at=datetime.now(tz=TZ_INFO) + timedelta(weeks=4, days=1)
         )
 
         Command().handle()
@@ -133,7 +130,6 @@ def test_handle_with_appointments_outside_schedule_window(
         assert Message.objects.count() == 0
         mock_mark_batch_as_sent.assert_not_called()
 
-    @pytest.mark.django_db
     def test_handle_with_cancelled_appointments(
         self,
         mock_mark_batch_as_sent,
@@ -143,15 +139,13 @@ def test_handle_with_cancelled_appointments(
         """Test that that cancelled appointments are not notified"""
         mock_send_message_batch.return_value.status_code = 201
 
-        valid_appointment = AppointmentFactory(
-            starts_at=datetime.today().replace(tzinfo=TZ_INFO)
-        )
+        valid_appointment = AppointmentFactory(starts_at=datetime.now(tz=TZ_INFO))
         routing_plan_id = RoutingPlan.for_episode_type(
             valid_appointment.episode_type
         ).id
 
         _cancelled_appointment = AppointmentFactory(
-            starts_at=datetime.today().replace(tzinfo=TZ_INFO), status="C"
+            starts_at=datetime.now(tz=TZ_INFO), status="C"
         )
 
         Command().handle()
@@ -163,7 +157,6 @@ def test_handle_with_cancelled_appointments(
         assert messages[0].appointment == valid_appointment
 
     @pytest.mark.parametrize("status_code", [401, 403, 404, 405, 406, 413, 415, 422])
-    @pytest.mark.django_db
     def test_handle_with_unrecoverable_failures(
         self, mark_batch_as_sent, mock_send_message_batch, status_code
     ):
@@ -172,7 +165,7 @@ def test_handle_with_unrecoverable_failures(
         notify_errors = {"errors": [{"some-error": "details"}]}
         mock_send_message_batch.return_value.json.return_value = notify_errors
         appointment = AppointmentFactory(
-            starts_at=datetime.now().replace(tzinfo=TZ_INFO) + timedelta(weeks=4)
+            starts_at=datetime.now(tz=TZ_INFO) + timedelta(weeks=4)
         )
         routing_plan_id = RoutingPlan.for_episode_type(appointment.episode_type).id
 
@@ -189,7 +182,6 @@ def test_handle_with_unrecoverable_failures(
         assert messages[0].status == "failed"
 
     @pytest.mark.parametrize("status_code", [408, 425, 429, 500, 503, 504])
-    @pytest.mark.django_db
     def test_handle_with_recoverable_failures(
         self, mark_batch_as_sent, mock_send_message_batch, status_code
     ):
@@ -199,7 +191,7 @@ def test_handle_with_recoverable_failures(
         mock_send_message_batch.return_value.json.return_value = notify_errors
 
         appointment = AppointmentFactory(
-            starts_at=datetime.now().replace(tzinfo=TZ_INFO) + timedelta(weeks=4)
+            starts_at=datetime.now(tz=TZ_INFO) + timedelta(weeks=4)
         )
         routing_plan_id = RoutingPlan.for_episode_type(appointment.episode_type).id
 
@@ -220,7 +212,24 @@ def test_handle_with_recoverable_failures(
             )
         )
 
-    def test_handle_with_error(self, mark_batch_as_sent, mock_send_message_batch):
+    def test_handle_does_nothing_on_weekend(
+        self, mock_mark_batch_as_sent, mock_send_message_batch, time_machine
+    ):
+        AppointmentFactory(starts_at=datetime.now(tz=TZ_INFO) + timedelta(weeks=4))
+        time_machine.move_to(datetime.now() + relativedelta.relativedelta(weekday=5))
+
+        Command().handle()
+
+        mock_send_message_batch.assert_not_called()
+
+        time_machine.move_to(datetime.now() + relativedelta.relativedelta(weekday=6))
+
+        Command().handle()
+
+        mock_send_message_batch.assert_not_called()
+
+    def test_handle_with_error(self, mock_mark_batch_as_sent, mock_send_message_batch):
         """Test that errors are caught and raised as CommandErrors"""
-        with pytest.raises(CommandError):
-            Command().handle()
+        with patch.object(RoutingPlan, "all", side_effect=Exception("Nooooo!")):
+            with pytest.raises(CommandError):
+                Command().handle()