Merge pull request #1059 from GSA/1006-new-api-failed-and-delivered-messages-7-days

1006/1007/1008 created new API endpoints for front end statistics
2026-05-05 16:48:31 -04:00 · 2024-07-03 14:09:06 -04:00
parent 7699b3aab9 c368d3d3f2
commit 9c39a92545
20 changed files with 467 additions and 167 deletions
--- a/tests/app/service/test_statistics.py
+++ b/tests/app/service/test_statistics.py
@@ -301,12 +301,15 @@ def test_add_monthly_notification_status_stats():
    data = create_empty_monthly_notification_status_stats_dict(2018)
    # this data won't be affected
    data["2018-05"][NotificationType.EMAIL][NotificationStatus.SENDING] = 32
+    data["2018-05"][NotificationType.EMAIL][StatisticsType.REQUESTED] = 32

    # this data will get combined with the 8 from row_data
    data["2018-05"][NotificationType.SMS][NotificationStatus.SENDING] = 16
+    data["2018-05"][NotificationType.SMS][StatisticsType.REQUESTED] = 16

    add_monthly_notification_status_stats(data, rows)
    # first 3 months are empty
+
    assert data == {
        "2018-01": {NotificationType.SMS: {}, NotificationType.EMAIL: {}},
        "2018-02": {NotificationType.SMS: {}, NotificationType.EMAIL: {}},
@@ -315,12 +318,22 @@ def test_add_monthly_notification_status_stats():
            NotificationType.SMS: {
                NotificationStatus.SENDING: 1,
                NotificationStatus.DELIVERED: 2,
+                StatisticsType.REQUESTED: 3,
+            },
+            NotificationType.EMAIL: {
+                NotificationStatus.SENDING: 4,
+                StatisticsType.REQUESTED: 4,
            },
-            NotificationType.EMAIL: {NotificationStatus.SENDING: 4},
        },
        "2018-05": {
-            NotificationType.SMS: {NotificationStatus.SENDING: 24},
-            NotificationType.EMAIL: {NotificationStatus.SENDING: 32},
+            NotificationType.SMS: {
+                NotificationStatus.SENDING: 24,
+                StatisticsType.REQUESTED: 24,
+            },
+            NotificationType.EMAIL: {
+                NotificationStatus.SENDING: 32,
+                StatisticsType.REQUESTED: 32,
+            },
        },
        "2018-06": {NotificationType.SMS: {}, NotificationType.EMAIL: {}},
    }
--- a/tests/app/service/test_statistics_rest.py
+++ b/tests/app/service/test_statistics_rest.py
@@ -234,17 +234,36 @@ def test_get_monthly_notification_stats_returns_stats(admin_request, sample_serv
    sms_t2 = create_template(sample_service)
    email_template = create_template(sample_service, template_type=TemplateType.EMAIL)

-    create_ft_notification_status(datetime(2016, 6, 1), template=sms_t1)
-    create_ft_notification_status(datetime(2016, 6, 2), template=sms_t1)
-
-    create_ft_notification_status(datetime(2016, 7, 1), template=sms_t1)
-    create_ft_notification_status(datetime(2016, 7, 1), template=sms_t2)
-    create_ft_notification_status(
-        datetime(2016, 7, 1),
-        template=sms_t1,
-        notification_status=NotificationStatus.CREATED,
+    create_notification(
+        sms_t1,
+        created_at=datetime(2016, 6, 1, 1, 1, 0),
+        status=NotificationStatus.DELIVERED,
+    )
+    create_notification(
+        sms_t1,
+        created_at=datetime(2016, 6, 2, 1, 1, 0),
+        status=NotificationStatus.DELIVERED,
+    )
+    create_notification(
+        sms_t1,
+        created_at=datetime(2016, 7, 1, 1, 1, 0),
+        status=NotificationStatus.DELIVERED,
+    )
+    create_notification(
+        sms_t2,
+        created_at=datetime(2016, 7, 1, 1, 1, 0),
+        status=NotificationStatus.DELIVERED,
+    )
+    create_notification(
+        sms_t1,
+        created_at=datetime(2016, 7, 1, 1, 1, 0),
+        status=NotificationStatus.CREATED,
+    )
+    create_notification(
+        email_template,
+        created_at=datetime(2016, 7, 1, 1, 1, 0),
+        status=NotificationStatus.DELIVERED,
    )
-    create_ft_notification_status(datetime(2016, 7, 1), template=email_template)

    response = admin_request.get(
        "service.get_monthly_notification_stats",
@@ -256,7 +275,8 @@ def test_get_monthly_notification_stats_returns_stats(admin_request, sample_serv
    assert response["data"]["2016-06"] == {
        NotificationType.SMS: {
            # it combines the two days
-            NotificationStatus.DELIVERED: 2
+            NotificationStatus.DELIVERED: 2,
+            StatisticsType.REQUESTED: 2,
        },
        NotificationType.EMAIL: {},
    }
@@ -265,86 +285,43 @@ def test_get_monthly_notification_stats_returns_stats(admin_request, sample_serv
        NotificationType.SMS: {
            NotificationStatus.CREATED: 1,
            NotificationStatus.DELIVERED: 2,
+            StatisticsType.REQUESTED: 3,
        },
-        NotificationType.EMAIL: {StatisticsType.DELIVERED: 1},
-    }
-
-
-@freeze_time("2016-06-05 12:00:00")
-def test_get_monthly_notification_stats_combines_todays_data_and_historic_stats(
-    admin_request, sample_template
-):
-    create_ft_notification_status(
-        datetime(2016, 5, 1, 12),
-        template=sample_template,
-        count=1,
-    )
-    create_ft_notification_status(
-        datetime(2016, 6, 1, 12),
-        template=sample_template,
-        notification_status=NotificationStatus.CREATED,
-        count=2,
-    )  # noqa
-
-    create_notification(
-        sample_template,
-        created_at=datetime(2016, 6, 5, 12),
-        status=NotificationStatus.CREATED,
-    )
-    create_notification(
-        sample_template,
-        created_at=datetime(2016, 6, 5, 12),
-        status=NotificationStatus.DELIVERED,
-    )
-
-    # this doesn't get returned in the stats because it is old - it should be in ft_notification_status by now
-    create_notification(
-        sample_template,
-        created_at=datetime(2016, 6, 4, 12),
-        status=NotificationStatus.SENDING,
-    )
-
-    response = admin_request.get(
-        "service.get_monthly_notification_stats",
-        service_id=sample_template.service_id,
-        year=2016,
-    )
-
-    assert len(response["data"]) == 6  # January to June
-    assert response["data"]["2016-05"] == {
-        NotificationType.SMS: {NotificationStatus.DELIVERED: 1},
-        NotificationType.EMAIL: {},
-    }
-    assert response["data"]["2016-06"] == {
-        NotificationType.SMS: {
-            # combines the stats from the historic ft_notification_status and the current notifications
-            NotificationStatus.CREATED: 3,
-            NotificationStatus.DELIVERED: 1,
+        NotificationType.EMAIL: {
+            StatisticsType.DELIVERED: 1,
+            StatisticsType.REQUESTED: 1,
        },
-        NotificationType.EMAIL: {},
    }


 def test_get_monthly_notification_stats_ignores_test_keys(
    admin_request, sample_service
 ):
-    create_ft_notification_status(
-        datetime(2016, 6, 1),
-        service=sample_service,
+    create_template(service=sample_service)
+
+    create_notification(
+        sample_service.templates[0],
+        created_at=datetime(2016, 6, 1, 1, 1, 0),
        key_type=KeyType.NORMAL,
-        count=1,
+        status=NotificationStatus.DELIVERED,
    )
-    create_ft_notification_status(
-        datetime(2016, 6, 1),
-        service=sample_service,
+    create_notification(
+        sample_service.templates[0],
+        created_at=datetime(2016, 6, 2, 1, 1, 0),
+        key_type=KeyType.NORMAL,
+        status=NotificationStatus.DELIVERED,
+    )
+    create_notification(
+        sample_service.templates[0],
+        created_at=datetime(2016, 6, 1, 1, 1, 0),
        key_type=KeyType.TEAM,
-        count=2,
+        status=NotificationStatus.DELIVERED,
    )
-    create_ft_notification_status(
-        datetime(2016, 6, 1),
-        service=sample_service,
+    create_notification(
+        sample_service.templates[0],
+        created_at=datetime(2016, 6, 1, 1, 1, 0),
        key_type=KeyType.TEST,
-        count=4,
+        status=NotificationStatus.DELIVERED,
    )

    response = admin_request.get(
@@ -355,26 +332,27 @@ def test_get_monthly_notification_stats_ignores_test_keys(

    assert response["data"]["2016-06"][NotificationType.SMS] == {
        NotificationStatus.DELIVERED: 3,
+        StatisticsType.REQUESTED: 3,
    }


 def test_get_monthly_notification_stats_checks_dates(admin_request, sample_service):
    t = create_template(sample_service)
-    # create_ft_notification_status(datetime(2016, 3, 31), template=t, notification_status='created')
-    create_ft_notification_status(
-        datetime(2016, 4, 2),
-        template=t,
-        notification_status=NotificationStatus.SENDING,
+
+    create_notification(
+        t,
+        created_at=datetime(2016, 4, 2),
+        status=NotificationStatus.SENDING,
    )
-    create_ft_notification_status(
-        datetime(2017, 3, 31),
-        template=t,
-        notification_status=NotificationStatus.DELIVERED,
+    create_notification(
+        t,
+        created_at=datetime(2017, 3, 31),
+        status=NotificationStatus.DELIVERED,
    )
-    create_ft_notification_status(
-        datetime(2017, 4, 11),
-        template=t,
-        notification_status=NotificationStatus.PERMANENT_FAILURE,
+    create_notification(
+        t,
+        created_at=datetime(2017, 4, 11),
+        status=NotificationStatus.PERMANENT_FAILURE,
    )

    response = admin_request.get(
@@ -386,9 +364,11 @@ def test_get_monthly_notification_stats_checks_dates(admin_request, sample_servi
    assert "2017-04" not in response["data"]
    assert response["data"]["2016-04"][NotificationType.SMS] == {
        NotificationStatus.SENDING: 1,
+        StatisticsType.REQUESTED: 1,
    }
    assert response["data"]["2016-04"][NotificationType.SMS] == {
        NotificationStatus.SENDING: 1,
+        StatisticsType.REQUESTED: 1,
    }


@@ -399,15 +379,15 @@ def test_get_monthly_notification_stats_only_gets_for_one_service(

    templates = [create_template(services[0]), create_template(services[1])]

-    create_ft_notification_status(
-        datetime(2016, 6, 1),
-        template=templates[0],
-        notification_status=NotificationStatus.CREATED,
+    create_notification(
+        templates[0],
+        created_at=datetime(2016, 6, 1),
+        status=NotificationStatus.CREATED,
    )
-    create_ft_notification_status(
-        datetime(2016, 6, 1),
-        template=templates[1],
-        notification_status=NotificationStatus.DELIVERED,
+    create_notification(
+        templates[1],
+        created_at=datetime(2016, 6, 1),
+        status=NotificationStatus.DELIVERED,
    )

    response = admin_request.get(
@@ -417,6 +397,9 @@ def test_get_monthly_notification_stats_only_gets_for_one_service(
    )

    assert response["data"]["2016-06"] == {
-        NotificationType.SMS: {NotificationStatus.CREATED: 1},
+        NotificationType.SMS: {
+            NotificationStatus.CREATED: 1,
+            StatisticsType.REQUESTED: 1,
+        },
        NotificationType.EMAIL: {},
    }