Merge pull request #1571 from GSA/fix_message_ratio_endpoint

Fix message ratio endpoint

Author: terrazoon

app/dao/notifications_dao.py

@@ -279,6 +279,44 @@ def dao_get_notification_count_for_service(*, service_id):
     return db.session.execute(stmt).scalar()
 
 
+def dao_get_notification_count_for_service_message_ratio(service_id, current_year):
+    start_date = datetime(current_year, 1, 1)
+    end_date = datetime(current_year + 1, 1, 1)
+    stmt1 = (
+        select(func.count())
+        .select_from(Notification)
+        .where(
+            Notification.service_id == service_id,
+            Notification.status
+            not in [
+                NotificationStatus.CANCELLED,
+                NotificationStatus.CREATED,
+                NotificationStatus.SENDING,
+            ],
+            Notification.created_at >= start_date,
+            Notification.created_at < end_date,
+        )
+    )
+    stmt2 = (
+        select(func.count())
+        .select_from(NotificationHistory)
+        .where(
+            NotificationHistory.service_id == service_id,
+            NotificationHistory.status
+            not in [
+                NotificationStatus.CANCELLED,
+                NotificationStatus.CREATED,
+                NotificationStatus.SENDING,
+            ],
+            NotificationHistory.created_at >= start_date,
+            NotificationHistory.created_at < end_date,
+        )
+    )
+    recent_count = db.session.execute(stmt1).scalar_one()
+    old_count = db.session.execute(stmt2).scalar_one()
+    return recent_count + old_count
+
+
 def dao_get_failed_notification_count():
     stmt = select(func.count(Notification.id)).where(
         Notification.status == NotificationStatus.FAILED

app/job/rest.py

@@ -1,5 +1,6 @@
+from zoneinfo import ZoneInfo
+
 import dateutil
-import pytz
 from flask import Blueprint, current_app, jsonify, request
 
 from app.aws.s3 import (
@@ -225,7 +226,7 @@ def get_scheduled_job_stats(service_id):
         jsonify(
             count=count,
             soonest_scheduled_for=(
-                soonest_scheduled_for.replace(tzinfo=pytz.UTC).isoformat()
+                soonest_scheduled_for.replace(tzinfo=ZoneInfo("UTC")).isoformat()
                 if soonest_scheduled_for
                 else None
             ),

app/service/rest.py

@@ -1,13 +1,14 @@
 import itertools
 from datetime import datetime, timedelta
+from zoneinfo import ZoneInfo
 
 from flask import Blueprint, current_app, jsonify, request
 from sqlalchemy import select
 from sqlalchemy.exc import IntegrityError
 from sqlalchemy.orm.exc import NoResultFound
 from werkzeug.datastructures import MultiDict
 
-from app import db, redis_store
+from app import db
 from app.aws.s3 import get_personalisation_from_s3, get_phone_number_from_s3
 from app.config import QueueNames
 from app.dao import fact_notification_status_dao, notifications_dao
@@ -28,7 +29,10 @@
     fetch_stats_for_all_services_by_date_range,
 )
 from app.dao.inbound_numbers_dao import dao_allocate_number_for_service
-from app.dao.notifications_dao import dao_get_notification_count_for_service
+from app.dao.notifications_dao import (
+    dao_get_notification_count_for_service,
+    dao_get_notification_count_for_service_message_ratio,
+)
 from app.dao.organization_dao import dao_get_organization_by_service_id
 from app.dao.service_data_retention_dao import (
     fetch_service_data_retention,
@@ -109,7 +113,6 @@
 from app.service.utils import get_guest_list_objects
 from app.user.users_schema import post_set_permissions_schema
 from app.utils import get_prev_next_pagination_links, utc_now
-from notifications_utils.clients.redis import total_limit_cache_key
 
 service_blueprint = Blueprint("service", __name__)
 
@@ -1145,20 +1148,24 @@ def modify_service_data_retention(service_id, data_retention_id):
 def get_service_message_ratio():
     service_id = request.args.get("service_id")
 
+    current_year = datetime.now(tz=ZoneInfo("UTC")).year
     my_service = dao_fetch_service_by_id(service_id)
-
-    cache_key = total_limit_cache_key(service_id)
-    messages_sent = redis_store.get(cache_key)
-    if messages_sent is None:
-        messages_sent = 0
-        current_app.logger.warning(
-            f"Messages sent was not being tracked for service {service_id}"
+    messages_sent = dao_get_notification_count_for_service_message_ratio(
+        service_id, current_year
+    )
+    messages_remaining = my_service.total_message_limit - messages_sent
+
+    if my_service.total_message_limit - messages_sent < 0:
+        raise Exception(
+            f"Math error get_service_message_ratio(), \
+                        total {my_service.total_message_limit} \
+                        messages_sent {messages_sent} remaining {messages_remaining} \
+                        service_id {service_id} current_year {current_year}"
         )
-    else:
-        messages_sent = int(messages_sent)
 
     return {
         "messages_sent": messages_sent,
+        "messages_remaining": messages_remaining,
         "total_message_limit": my_service.total_message_limit,
     }, 200
 

notifications_utils/timezones.py

@@ -1,9 +1,9 @@
 import os
+from zoneinfo import ZoneInfo
 
-import pytz
 from dateutil import parser
 
-local_timezone = pytz.timezone(os.getenv("TIMEZONE", "America/New_York"))
+local_timezone = os.getenv("TIMEZONE", ZoneInfo("America/New_York"))
 
 
 def utc_string_to_aware_gmt_datetime(date):
@@ -12,5 +12,5 @@ def utc_string_to_aware_gmt_datetime(date):
     Returns an aware local datetime, essentially the time you'd see on your clock
     """
     date = parser.parse(date)
-    forced_utc = date.replace(tzinfo=pytz.utc)
+    forced_utc = date.replace(tzinfo=ZoneInfo("UTC"))
     return forced_utc.astimezone(local_timezone)

poetry.lock

@@ -56,7 +56,6 @@ numpy = "^1.26.4"
 ordered-set = "^4.1.0"
 phonenumbers = "^8.13.42"
 python-json-logger = "^2.0.7"
-pytz = "^2024.1"
 regex = "^2024.7.24"
 shapely = "^2.0.5"
 smartypants = "^2.0.1"

pyproject.toml

@@ -1,9 +1,9 @@
 import json
 import uuid
 from datetime import datetime, timedelta
+from zoneinfo import ZoneInfo
 
 import pytest
-import pytz
 import requests_mock
 from flask import current_app, url_for
 from sqlalchemy import delete, select
@@ -988,4 +988,4 @@ def delete(endpoint, _expected_status=204, **endpoint_kwargs):
 
 
 def datetime_in_past(days=0, seconds=0):
-    return datetime.now(tz=pytz.utc) - timedelta(days=days, seconds=seconds)
+    return datetime.now(tz=ZoneInfo("UTC")) - timedelta(days=days, seconds=seconds)

tests/app/conftest.py

@@ -2,9 +2,9 @@
 import uuid
 from datetime import date, datetime, timedelta
 from unittest.mock import ANY
+from zoneinfo import ZoneInfo
 
 import pytest
-import pytz
 from freezegun import freeze_time
 
 import app.celery.tasks
@@ -183,7 +183,7 @@ def test_create_scheduled_job(client, sample_template, mocker, fake_uuid):
     assert resp_json["data"]["id"] == fake_uuid
     assert (
         resp_json["data"]["scheduled_for"]
-        == datetime(2016, 1, 5, 11, 59, 0, tzinfo=pytz.UTC).isoformat()
+        == datetime(2016, 1, 5, 11, 59, 0, tzinfo=ZoneInfo("UTC")).isoformat()
     )
     assert resp_json["data"]["job_status"] == JobStatus.SCHEDULED
     assert resp_json["data"]["template"] == str(sample_template.id)

tests/app/job/test_rest.py

@@ -1668,7 +1668,9 @@ def test_remove_user_from_service(client, sample_user_service_permission):
 def test_get_service_message_ratio(mocker, client, sample_user_service_permission):
     service = sample_user_service_permission.service
 
-    mock_redis = mocker.patch("app.service.rest.redis_store.get")
+    mock_redis = mocker.patch(
+        "app.service.rest.dao_get_notification_count_for_service_message_ratio"
+    )
     mock_redis.return_value = 1
 
     endpoint = url_for(