Merge pull request #5534 from alphagov/limits_stats

Show info about remaining daily limit on Settings pages

Author: CrystalPea

app/__init__.py

@@ -140,6 +140,7 @@
 from app.url_converters import (
     AgreementTypeConverter,
     BrandingTypeConverter,
+    DailyLimitTypeConverter,
     LetterFileExtensionConverter,
     SimpleDateTypeConverter,
     TemplateTypeConverter,
@@ -271,6 +272,7 @@ def inject_global_template_variables():
     application.url_map.converters["uuid"].to_python = lambda self, value: value.lower()
     application.url_map.converters["agreement_type"] = AgreementTypeConverter
     application.url_map.converters["template_type"] = TemplateTypeConverter
+    application.url_map.converters["daily_limit_type"] = DailyLimitTypeConverter
     application.url_map.converters["branding_type"] = BrandingTypeConverter
     application.url_map.converters["ticket_type"] = TicketTypeConverter
     application.url_map.converters["letter_file_extension"] = LetterFileExtensionConverter

app/main/views/service_settings/index.py

@@ -611,9 +611,31 @@ def set_per_day_international_sms_message_limit(service_id):
         "views/service-settings/set-message-limit-for-international-sms.html",
         form=form,
         error_summary_enabled=True,
+        partials=get_daily_limit_partials(daily_limit_type="international_sms"),
+        updates_url=url_for(
+            "json_updates.view_remaining_limit",
+            service_id=service_id,
+            daily_limit_type="international_sms",
+        ),
     )
 
 
+@json_updates.route(
+    "/services/<uuid:service_id>/service-settings/<daily_limit_type:daily_limit_type>/remaining-today.json"
+)
+@user_has_permissions("manage_service")
+def view_remaining_limit(service_id, daily_limit_type):
+    return jsonify(**get_daily_limit_partials(daily_limit_type=daily_limit_type))
+
+
+def get_daily_limit_partials(daily_limit_type):
+    return {
+        "remaining_limit": render_template(
+            "partials/daily-limits/remaining-limit.html", daily_limit_type=daily_limit_type
+        ),
+    }
+
+
 @main.route("/services/<uuid:service_id>/service-settings/set-international-letters", methods=["GET", "POST"])
 @user_has_permissions("manage_service")
 def service_set_international_letters(service_id):

app/models/service.py

@@ -617,9 +617,10 @@ def get_message_limit(self, notification_type):
     def remaining_messages(self, notification_type):
         if notification_type == "international_sms" and not self.has_permission("international_sms"):
             return 0
-        return self.get_message_limit(notification_type) - (
-            service_api_client.get_notification_count(self.id, notification_type=notification_type)
-        )
+        return self.get_message_limit(notification_type) - self.sent_today(notification_type)
+
+    def sent_today(self, notification_type):
+        return service_api_client.get_notification_count(self.id, notification_type=notification_type)
 
     @property
     def sign_in_method(self) -> str:

app/templates/partials/daily-limits/remaining-limit.html

@@ -0,0 +1,14 @@
+{% from "govuk_frontend_jinja/components/inset-text/macro.html" import govukInsetText %}
+
+{% set sent_today = current_service.sent_today(daily_limit_type) %}
+{% set remaining_limit = current_service.remaining_messages(daily_limit_type) %}
+
+<div class="ajax-block-container">
+    {{ govukInsetText({
+        "text": "You have sent {} today ({} remaining).".format(
+            sent_today|message_count(daily_limit_type),
+            remaining_limit|format_thousands
+        ),
+        "classes": "govuk-!-margin-top-0"
+    }) }}
+</div>

app/templates/views/service-settings.html

@@ -216,6 +216,7 @@
     {% endset %}
 
     {% set service_text_message_settings %}
+
       {% set text_message_sender_ids_html %}
         {{ current_service.default_sms_sender | nl2br if current_service.default_sms_sender else 'None'}}
         {% if current_service.count_sms_senders > 1 %}
@@ -225,6 +226,14 @@
         {% endif %}
       {% endset %}
 
+      {% set international_text_message_limit_html %}
+        {{ "{} per day".format(current_service.get_message_limit('international_sms')|format_thousands) }}
+        <div class="govuk-hint">
+          {{ current_service.sent_today("international_sms")|string + " sent today" }}
+        </div>
+      {% endset %}
+
+
       {% set base_text_message_setting_row = [
         {
           "key": {
@@ -345,7 +354,8 @@
                 "text": "International text message limit",
               },
             "value": {
-              "text": "{} per day".format(current_service.get_message_limit('international_sms')|format_thousands)
+              "text": international_text_message_limit_html,
+              "classes": "govuk-summary-list__value--truncate"
             },
             "actions": {
               "items": [

app/templates/views/service-settings/set-message-limit-for-international-sms.html

@@ -1,4 +1,5 @@
 {% extends "withnav_template.html" %}
+{% from "components/ajax-block.html" import ajax_block %}
 {% from "components/page-header.html" import page_header %}
 {% from "components/page-footer.html" import page_footer %}
 {% from "components/form.html" import form_wrapper %}
@@ -23,6 +24,9 @@
         <p class="govuk-body">
             Number of international text messages the service is allowed to send each day.
         </p>
+
+        {{ ajax_block(partials, updates_url, 'remaining_limit') }}
+
         <p class="govuk-body">
             When choosing a limit you should think about:
         </p>

app/url_converters.py

@@ -20,6 +20,10 @@ class BrandingTypeConverter(BaseConverter):
     regex = "(?:email|letter)"
 
 
+class DailyLimitTypeConverter(BaseConverter):
+    regex = f"(?:{'|'.join(Service.TEMPLATE_TYPES)}|international_sms)"
+
+
 class TicketTypeConverter(BaseConverter):
     regex = f"(?:{PROBLEM_TICKET_TYPE}|{QUESTION_TICKET_TYPE}|{GENERAL_TICKET_TYPE})"
 

tests/app/main/test_init.py

@@ -11,6 +11,7 @@ def test_all_routes_return_401_for_unauthorised(self, notify_admin, client_reque
             "template_type": "email",
             "message_type": "email",
             "job_id": fake_uuid,
+            "daily_limit_type": "email",
         }
         bad_views = []
         client_request.logout()

tests/app/main/test_permissions.py

@@ -332,6 +332,7 @@ def test_routes_have_permissions_decorators():
 def test_routes_require_types(client_request):
     partial_param_name_to_type = {
         "_id": "uuid",
+        "daily_limit_type": "daily_limit_type",
         "template_type": "template_type",
         "notification_type": "template_type",
         "branding_type": "branding_type",

tests/app/main/views/service_settings/test_service_settings.py

@@ -317,7 +317,7 @@ def test_send_files_by_email_row_on_settings_page(
                 "Start text messages with service name On Change your settings for starting text messages with service name",  # noqa
                 "Receive text messages On Change your settings for receiving text messages",
                 "Send international text messages On Change your settings for sending international text messages",
-                "International text message limit 500 per day Change daily international text message limit",
+                "International text message limit 500 per day 0 sent today Change daily international text message limit",  # noqa
                 "Send letters Off Change your settings for sending letters",
             ],
         ),
@@ -3916,15 +3916,26 @@ def test_switch_service_enable_international_sms_and_letters(
 def test_should_show_page_to_set_per_day_international_sms_message_limit(
     client_request,
     service_one,
+    mocker,
 ):
     service_one["permissions"] = ["international_sms"]
+    mock_get_notification_count = mocker.patch("app.service_api_client.get_notification_count", return_value=1)
 
     page = client_request.get(
         "main.set_per_day_international_sms_message_limit",
         service_id=SERVICE_ONE_ID,
     )
     assert normalize_spaces(page.select_one("label").text) == "Daily international text message limit"
+    # form prefilled with current limit
     assert normalize_spaces(page.select_one("input[type=text]")["value"]) == "500"
+    # today's remaining limit pulled and displayed
+    assert mock_get_notification_count.called_once_with(
+        service_id=SERVICE_ONE_ID, notification_type="international_sms"
+    )
+    assert (
+        normalize_spaces(page.select(".ajax-block-container")[0].text)
+        == "You have sent 1 international text message today (499 remaining)."
+    )
 
 
 @pytest.mark.parametrize(