DWPF-704 update dw usage of feedback package and implement custom notifications

.env.ci

@@ -6,7 +6,7 @@ ALLOWED_HOSTS=*
 AUTHBROKER_URL=https://test.gov.uk
 AUTHBROKER_CLIENT_ID=test
 AUTHBROKER_CLIENT_SECRET=test
-WAGTAIL_BASE_URL=http://localhost:8000
+WAGTAIL_BASE_URL=http://localhost:8000/
 AWS_STORAGE_BUCKET_NAME=test
 AWS_REGION=eu-west-2
 AWS_ACCESS_KEY_ID=test

.env.example

@@ -5,7 +5,7 @@ DJANGO_DEBUG=true
 DJANGO_SECRET_KEY=this_is_an_example_use_a_proper_key_in_production
 
 # Wagtail
-WAGTAIL_BASE_URL=http://localhost:8000
+WAGTAIL_BASE_URL=http://localhost:8000/
 
 # Container connections
 DATABASE_URL=psql://postgres:postgres@db:5432/digital_workspace

pyproject.toml

@@ -77,6 +77,7 @@ django-extensions = "^3.2.1"
 werkzeug = "^2.2.3"
 blessings = "^1.7"
 pytest-mock = "^3.11.1"
+pytest-freezer = "^0.4.8"
 
 [build-system]
 requires = ["poetry-core"]

requirements.txt

@@ -29,7 +29,7 @@ django-cogwheels==0.3 ; python_version >= "3.11" and python_version < "4.0"
 django-crispy-forms==1.14.0 ; python_version >= "3.11" and python_version < "4.0"
 django-elasticsearch-dsl==7.3 ; python_version >= "3.11" and python_version < "4.0"
 django-environ==0.10.0 ; python_version >= "3.11" and python_version < "4"
-django-feedback-govuk==0.2.7 ; python_version >= "3.11" and python_version < "4.0"
+django-feedback-govuk==0.2.8 ; python_version >= "3.11" and python_version < "4.0"
 django-filter==22.1 ; python_version >= "3.11" and python_version < "4.0"
 django-hawk-drf==1.1.1 ; python_version >= "3.11" and python_version < "4.0"
 django-hawk==1.2.1 ; python_version >= "3.11" and python_version < "4.0"

src/config/celery.py

@@ -16,4 +16,9 @@
         "task": "core.tasks.ingest_uk_staff_locations",
         "schedule": crontab(minute="0", hour="3"),
     },
+    # Daily feedback email task
+    "schedule-feedback-email-notification": {
+        "task": "core.tasks.schedule_feedback_email_notification",
+        "schedule": crontab(hour=6, minute=0),
+    },
 }

src/config/settings/base.py

@@ -596,15 +596,15 @@
 CRISPY_ALLOWED_TEMPLATE_PACKS = ["gds"]
 CRISPY_TEMPLATE_PACK = "gds"
 
+# Feedback notifications email
+FEEDBACK_NOTIFICATION_EMAIL_TEMPLATE_ID = env("FEEDBACK_NOTIFICATION_EMAIL_TEMPLATE_ID")
+FEEDBACK_NOTIFICATION_EMAIL_RECIPIENTS = env.list(
+    "FEEDBACK_NOTIFICATION_EMAIL_RECIPIENTS", default=[]
+)
+
 # Feedback
 DJANGO_FEEDBACK_GOVUK = {
     "SERVICE_NAME": "the beta experience",
-    "FEEDBACK_NOTIFICATION_EMAIL_TEMPLATE_ID": env(
-        "FEEDBACK_NOTIFICATION_EMAIL_TEMPLATE_ID"
-    ),
-    "FEEDBACK_NOTIFICATION_EMAIL_RECIPIENTS": env.list(
-        "FEEDBACK_NOTIFICATION_EMAIL_RECIPIENTS", default=[]
-    ),
     "COPY": {
         "SUBMIT_TITLE": "Providing feedback on your experience will help us improve the service",
         "FIELD_SATISFACTION_LEGEND": "How satisfied are you with Digital Workspace?",

src/config/urls.py

@@ -49,9 +49,7 @@
     path("peoplefinder/api/", include(api_urlpatterns)),
     path("sitemap.xml", sitemap),
     # Feedback
-    path(
-        "feedback/", include(feedback_urls), name="feedback"
-    ),  # @TODO [DWPF-454] remove feedback after beta
+    path("feedback/", include(feedback_urls), name="feedback"),
     # Wagtail
     path("", include(wagtail_urls)),
 ]

src/core/tasks.py

@@ -1,5 +1,6 @@
 from config.celery import celery_app
 from peoplefinder.services.uk_staff_locations import UkStaffLocationService
+from feedback import utils
 
 
 @celery_app.task(bind=True)
@@ -21,3 +22,12 @@ def ingest_uk_staff_locations(self):
         f"Updated: {updated}\n"
         f"Deleted: {deleted}\n"
     )
+
+
+@celery_app.task(bind=True)
+def schedule_feedback_email_notification():
+    feedback_received = utils.feedback_received_within()
+    if not feedback_received:
+        return
+    message = utils.send_feedback_notification()
+    print(f"Message: {message}")

src/feedback/test/test_utils.py

@@ -0,0 +1,107 @@
+import pytest
+from unittest.mock import call
+from django.test import override_settings
+from django_feedback_govuk.models import BaseFeedback
+
+from feedback.utils import feedback_received_within, send_feedback_notification
+
+
+def test_no_feedback_submitted_and_feedback_submitted_within_24hrs(db):
+    # feedback_received_within() returns False if no feedback was submitted and True if feedback was submitted within the last 24hrs.
+    assert not feedback_received_within()
+    BaseFeedback.objects.create()
+    assert feedback_received_within()
+
+
+def test_feedback_submitted_over_24hrs_ago(db, freezer):
+    # feedback_received_within() returns False if feedback was submitted over 24hrs ago
+    freezer.move_to("2023-09-01")
+    BaseFeedback.objects.create()
+    assert feedback_received_within()
+
+    freezer.move_to("2023-09-03")
+    assert not feedback_received_within()
+
+
+@override_settings(
+    GOVUK_NOTIFY_API_KEY=None,
+    FEEDBACK_NOTIFICATION_EMAIL_TEMPLATE_ID=None,
+    WAGTAILADMIN_BASE_URL=None,
+)
+def test_send_feedback_notification_when_no_settings_are_set():
+    # send_feedback_notification() raises an error when called with no settings provided
+    with pytest.raises(ValueError) as raised_execption:
+        send_feedback_notification()
+        assert (
+            raised_execption.value.args[0]
+            == "Missing required settings for sending feedback notifications"
+        )
+
+
+@override_settings(
+    GOVUK_NOTIFY_API_KEY="test-api-key",
+    FEEDBACK_NOTIFICATION_EMAIL_RECIPIENTS=[],
+    FEEDBACK_NOTIFICATION_EMAIL_TEMPLATE_ID="test-template-id",
+    WAGTAILADMIN_BASE_URL="https://test.example.com/",
+)
+def test_send_feedback_notification_with_no_email_recipients():
+    # send_feedback_notification() raises an error when the email_recipients list is empty
+    with pytest.raises(ValueError) as raised_exception:
+        send_feedback_notification()
+        assert (
+            raised_exception.value.args[0]
+            == "Missing required settings for sending feedback notifications"
+        )
+
+
+@override_settings(
+    GOVUK_NOTIFY_API_KEY="this-is-my-really-long-api-key-because-gov-uk-notify-expects-it-to-be-long-when-you-create-a-service",
+    FEEDBACK_NOTIFICATION_EMAIL_RECIPIENTS=["[email protected]"],
+    FEEDBACK_NOTIFICATION_EMAIL_TEMPLATE_ID="test-template-id",
+    WAGTAILADMIN_BASE_URL="https://test.example.com/",
+)
+def test_send_feedback_notification_with_valid_settings(mocker):
+    # send_feedback_notification() does not raise an error when all the settings provided are valid
+    mock_send_email_notification = mocker.patch(
+        "feedback.utils.NotificationsAPIClient.send_email_notification"
+    )
+    send_feedback_notification()
+    mock_send_email_notification.assert_called_once_with(
+        email_address="[email protected]",
+        template_id="test-template-id",
+        personalisation={
+            "feedback_url": "https://test.example.com/feedback/submitted/"
+        },
+    )
+
+
+@override_settings(
+    GOVUK_NOTIFY_API_KEY="this-is-my-really-long-api-key-because-gov-uk-notify-expects-it-to-be-long-when-you-create-a-service",
+    FEEDBACK_NOTIFICATION_EMAIL_RECIPIENTS=["[email protected]", "[email protected]"],
+    FEEDBACK_NOTIFICATION_EMAIL_TEMPLATE_ID="test-template-id",
+    WAGTAILADMIN_BASE_URL="https://test.example.com/",
+)
+def test_send_feedback_notification_with_multiple_emails(mocker):
+    # send_email_notification() is called once per email address
+    mock_send_email_notification = mocker.patch(
+        "feedback.utils.NotificationsAPIClient.send_email_notification"
+    )
+    expected_calls = [
+        call(
+            email_address="[email protected]",
+            template_id="test-template-id",
+            personalisation={
+                "feedback_url": "https://test.example.com/feedback/submitted/"
+            },
+        ),
+        call(
+            email_address="[email protected]",
+            template_id="test-template-id",
+            personalisation={
+                "feedback_url": "https://test.example.com/feedback/submitted/"
+            },
+        ),
+    ]
+    send_feedback_notification()
+    assert mock_send_email_notification.call_count == len(expected_calls)
+    mock_send_email_notification.assert_has_calls(expected_calls)

src/feedback/utils.py

@@ -0,0 +1,44 @@
+from datetime import timedelta
+
+from django.conf import settings
+from django.urls import reverse
+from django.utils import timezone
+from django_feedback_govuk.models import BaseFeedback
+from notifications_python_client.notifications import NotificationsAPIClient
+
+
+def feedback_received_within(days=1):
+    return BaseFeedback.objects.filter(
+        submitted_at__gte=timezone.now() - timedelta(days=days)
+    ).exists()
+
+
+def send_feedback_notification():
+    email_recipients = settings.FEEDBACK_NOTIFICATION_EMAIL_RECIPIENTS
+    govuk_notify_template_id = settings.FEEDBACK_NOTIFICATION_EMAIL_TEMPLATE_ID
+    base_url = settings.WAGTAILADMIN_BASE_URL
+    notify_api_key = settings.GOVUK_NOTIFY_API_KEY
+
+    if not all(
+        [
+            notify_api_key,
+            govuk_notify_template_id,
+            base_url,
+            email_recipients,
+        ]
+    ):
+        raise ValueError("Missing required settings for sending feedback notifications")
+
+    if base_url[-1] == "/":
+        base_url = base_url[:-1]
+
+    notification_client = NotificationsAPIClient(
+        settings.GOVUK_NOTIFY_API_KEY,
+    )
+
+    for email_recipient in email_recipients:
+        notification_client.send_email_notification(
+            email_address=email_recipient,
+            template_id=govuk_notify_template_id,
+            personalisation={"feedback_url": base_url + reverse("submitted-feedback")},
+        )