darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-08-23 15:56:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1304 from GSA/API-1265_adding_fields_for_template_stats

Browse Source 
Api 1265 adding fields for template stats
This commit is contained in:
Beverly Nguyen
2024-08-29 12:32:41 -07:00
committed by GitHub
parent 3fd9af62ed 00e0f41d85
commit 0914cd9b5d
4 changed files with 248 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
app/dao/fact_notification_status_dao.py
View File

@@ -1,9 +1,10 @@
from datetime import timedelta from datetime import timedelta
from sqlalchemy import Date, case, func from sqlalchemy import Date, case, cast, func, select, union_all
from sqlalchemy.dialects.postgresql import insert from sqlalchemy.dialects.postgresql import insert
from sqlalchemy.orm import aliased
from sqlalchemy.sql.expression import extract, literal from sqlalchemy.sql.expression import extract, literal
from sqlalchemy.types import DateTime, Integer from sqlalchemy.types import DateTime, Integer, Text
from app import db from app import db
from app.dao.dao_utils import autocommit from app.dao.dao_utils import autocommit
@@ -14,6 +15,9 @@ from app.models import (
NotificationAllTimeView, NotificationAllTimeView,
Service, Service,
Template, Template,
TemplateFolder,
User,
template_folder_map,
) )
from app.utils import ( from app.utils import (
get_midnight_in_utc, get_midnight_in_utc,
@@ -126,36 +130,47 @@ def fetch_notification_status_for_service_for_day(fetch_day, service_id):
def fetch_notification_status_for_service_for_today_and_7_previous_days( def fetch_notification_status_for_service_for_today_and_7_previous_days(
service_id, by_template=False, limit_days=7 service_id: str, by_template: bool = False, limit_days: int = 7
): ) -> list[dict | None]:
start_date = midnight_n_days_ago(limit_days) start_date = midnight_n_days_ago(limit_days)
now = utc_now() now = get_midnight_in_utc(utc_now())
stats_for_7_days = db.session.query(
FactNotificationStatus.notification_type.cast(db.Text).label( # Query for the last 7 days
"notification_type" stats_for_7_days = select(
), cast(FactNotificationStatus.notification_type, Text).label("notification_type"),
FactNotificationStatus.notification_status.cast(db.Text).label("status"), cast(FactNotificationStatus.notification_status, Text).label("status"),
*( *(
[FactNotificationStatus.template_id.label("template_id")] [
FactNotificationStatus.template_id.label("template_id"),
FactNotificationStatus.local_date.label("date_used"),
]
if by_template if by_template
else [] else []
), ),
FactNotificationStatus.notification_count.label("count"), FactNotificationStatus.notification_count.label("count"),
).filter( ).where(
FactNotificationStatus.service_id == service_id, FactNotificationStatus.service_id == service_id,
FactNotificationStatus.local_date >= start_date, FactNotificationStatus.local_date >= start_date,
FactNotificationStatus.key_type != KeyType.TEST, FactNotificationStatus.key_type != KeyType.TEST,
) )
# Query for today's stats
stats_for_today = ( stats_for_today = (
db.session.query( select(
Notification.notification_type.cast(db.Text), cast(Notification.notification_type, Text),
Notification.status.cast(db.Text), cast(Notification.status, Text),
*([Notification.template_id] if by_template else []), *(
[
Notification.template_id,
literal(now).label("date_used"),
]
if by_template
else []
),
func.count().label("count"), func.count().label("count"),
) )
.filter( .where(
Notification.created_at >= get_midnight_in_utc(now), Notification.created_at >= now,
Notification.service_id == service_id, Notification.service_id == service_id,
Notification.key_type != KeyType.TEST, Notification.key_type != KeyType.TEST,
) )
@@ -166,31 +181,67 @@ def fetch_notification_status_for_service_for_today_and_7_previous_days(
) )
) )
all_stats_table = stats_for_7_days.union_all(stats_for_today).subquery() # Combine the queries using union_all
all_stats_union = union_all(stats_for_7_days, stats_for_today).subquery()
all_stats_alias = aliased(all_stats_union, name="all_stats")
query = db.session.query( # Final query with optional template joins
query = select(
*( *(
[ [
TemplateFolder.name.label("folder"),
Template.name.label("template_name"), Template.name.label("template_name"),
False, # TODO: this is related to is_precompiled_letter False, # TODO: Handle `is_precompiled_letter`
all_stats_table.c.template_id, template_folder_map.c.template_folder_id,
all_stats_alias.c.template_id,
User.name.label("created_by"),
Template.created_by_id,
func.max(all_stats_alias.c.date_used).label(
"last_used"
), # Get the most recent date
] ]
if by_template if by_template
else [] else []
), ),
all_stats_table.c.notification_type, all_stats_alias.c.notification_type,
all_stats_table.c.status, all_stats_alias.c.status,
func.cast(func.sum(all_stats_table.c.count), Integer).label("count"), cast(func.sum(all_stats_alias.c.count), Integer).label("count"),
) )
if by_template: if by_template:
query = query.filter(all_stats_table.c.template_id == Template.id) query = (
query.join(Template, all_stats_alias.c.template_id == Template.id)
.join(User, Template.created_by_id == User.id)
.outerjoin(
template_folder_map, Template.id == template_folder_map.c.template_id
)
.outerjoin(
TemplateFolder,
TemplateFolder.id == template_folder_map.c.template_folder_id,
)
)
return query.group_by( # Group by all necessary fields except date_used
*([Template.name, all_stats_table.c.template_id] if by_template else []), query = query.group_by(
all_stats_table.c.notification_type, *(
all_stats_table.c.status, [
).all() TemplateFolder.name,
Template.name,
all_stats_alias.c.template_id,
User.name,
template_folder_map.c.template_folder_id,
Template.created_by_id,
]
if by_template
else []
),
all_stats_alias.c.notification_type,
all_stats_alias.c.status,
)
# Execute the query using Flask-SQLAlchemy's session
result = db.session.execute(query)
return result.mappings().all()
def fetch_notification_status_totals_for_all_services(start_date, end_date): def fetch_notification_status_totals_for_all_services(start_date, end_date):

7
app/template_statistics/rest.py
View File

@@ -23,7 +23,7 @@ def get_template_statistics_for_service_by_day(service_id):
try: try:
whole_days = int(whole_days) whole_days = int(whole_days)
except ValueError: except ValueError:
error = "{} is not an integer".format(whole_days) error = f"{whole_days} is not an integer"
message = {"whole_days": [error]} message = {"whole_days": [error]}
raise InvalidRequest(message, status_code=400) raise InvalidRequest(message, status_code=400)
@@ -41,6 +41,11 @@ def get_template_statistics_for_service_by_day(service_id):
"count": row.count, "count": row.count,
"template_id": str(row.template_id), "template_id": str(row.template_id),
"template_name": row.template_name, "template_name": row.template_name,
"template_folder_id": row.template_folder_id,
"template_folder": row.folder,
"created_by_id": row.created_by_id,
"created_by": row.created_by,
"last_used": row.last_used,
"template_type": row.notification_type, "template_type": row.notification_type,
"status": row.status, "status": row.status,
} }

227
tests/app/dao/test_fact_notification_status_dao.py
View File

@@ -1,5 +1,4 @@
from datetime import date, datetime, timedelta from datetime import date, datetime, timedelta
from unittest import mock
from uuid import UUID from uuid import UUID
import pytest import pytest
@@ -26,6 +25,7 @@ from tests.app.db import (
create_notification, create_notification,
create_service, create_service,
create_template, create_template,
create_template_folder,
) )
@@ -253,15 +253,18 @@ def test_fetch_notification_status_by_template_for_service_for_today_and_7_previ
notify_db_session, notify_db_session,
): ):
service_1 = create_service(service_name="service_1") service_1 = create_service(service_name="service_1")
test_folder = create_template_folder(service=service_1, name="Test_Folder_For_This")
sms_template = create_template( sms_template = create_template(
template_name="sms Template 1", template_name="sms Template 1",
service=service_1, service=service_1,
template_type=TemplateType.SMS, template_type=TemplateType.SMS,
folder=test_folder,
) )
sms_template_2 = create_template( sms_template_2 = create_template(
template_name="sms Template 2", template_name="sms Template 2",
service=service_1, service=service_1,
template_type=TemplateType.SMS, template_type=TemplateType.SMS,
folder=test_folder,
) )
email_template = create_template( email_template = create_template(
service=service_1, template_type=TemplateType.EMAIL service=service_1, template_type=TemplateType.EMAIL
@@ -330,82 +333,152 @@ def test_fetch_notification_status_by_template_for_service_for_today_and_7_previ
by_template=True, by_template=True,
) )
assert [ expected = [
( {
"email Template Name", "folder": None,
False, "template_name": "email Template Name",
mock.ANY, "_no_label": False,
NotificationType.EMAIL, "created_by": "Test User",
NotificationStatus.DELIVERED, "last_used": datetime(2018, 10, 31, 0, 0),
1, "notification_type": NotificationType.EMAIL,
), "status": NotificationStatus.DELIVERED,
( "count": 1,
"email Template Name", },
False, {
mock.ANY, "folder": None,
NotificationType.EMAIL, "template_name": "email Template Name",
NotificationStatus.DELIVERED, "_no_label": False,
3, "created_by": "Test User",
), "last_used": datetime(2018, 10, 29, 0, 0),
( "notification_type": NotificationType.EMAIL,
"sms Template 1", "status": NotificationStatus.DELIVERED,
False, "count": 3,
mock.ANY, },
NotificationType.SMS, {
NotificationStatus.CREATED, "folder": None,
1, "template_name": "sms Template Name",
), "_no_label": False,
( "created_by": "Test User",
"sms Template Name", "last_used": datetime(2018, 10, 29, 0, 0),
False, "notification_type": NotificationType.SMS,
mock.ANY, "status": NotificationStatus.CREATED,
NotificationType.SMS, "count": 1,
NotificationStatus.CREATED, },
1, {
), "folder": "Test_Folder_For_This",
( "template_name": "sms Template 1",
"sms Template 1", "_no_label": False,
False, "created_by": "Test User",
mock.ANY, "last_used": datetime(2018, 10, 31, 0, 0),
NotificationType.SMS, "notification_type": NotificationType.SMS,
NotificationStatus.DELIVERED, "status": NotificationStatus.CREATED,
1, "count": 1,
), },
( {
"sms Template 2", "folder": None,
False, "template_name": "sms Template Name",
mock.ANY, "_no_label": False,
NotificationType.SMS, "created_by": "Test User",
NotificationStatus.DELIVERED, "last_used": datetime(2018, 10, 29, 0, 0),
1, "notification_type": NotificationType.SMS,
), "status": NotificationStatus.DELIVERED,
( "count": 10,
"sms Template Name", },
False, {
mock.ANY, "folder": "Test_Folder_For_This",
NotificationType.SMS, "template_name": "sms Template 2",
NotificationStatus.DELIVERED, "_no_label": False,
8, "created_by": "Test User",
), "last_used": datetime(2018, 10, 31, 0, 0),
( "notification_type": NotificationType.SMS,
"sms Template Name", "status": NotificationStatus.DELIVERED,
False, "count": 1,
mock.ANY, },
NotificationType.SMS, {
NotificationStatus.DELIVERED, "folder": None,
10, "template_name": "sms Template Name",
), "_no_label": False,
( "created_by": "Test User",
"sms Template Name", "last_used": datetime(2018, 10, 25, 0, 0),
False, "notification_type": NotificationType.SMS,
mock.ANY, "status": NotificationStatus.DELIVERED,
NotificationType.SMS, "count": 8,
NotificationStatus.DELIVERED, },
11, {
), "folder": "Test_Folder_For_This",
] == sorted( "template_name": "sms Template 1",
results, key=lambda x: (x.notification_type, x.status, x.template_name, x.count) "_no_label": False,
) "created_by": "Test User",
"last_used": datetime(2018, 10, 31, 0, 0),
"notification_type": NotificationType.SMS,
"status": NotificationStatus.DELIVERED,
"count": 1,
},
{
"folder": None,
"template_name": "sms Template Name",
"_no_label": False,
"created_by": "Test User",
"last_used": datetime(2018, 10, 29, 0, 0),
"notification_type": NotificationType.SMS,
"status": NotificationStatus.DELIVERED,
"count": 11,
},
]
expected = [
[
str(row[k]) if k != "last_used" else row[k].strftime("%Y-%m-%d")
for k in (
"folder",
"template_name",
"created_by",
"last_used",
"notification_type",
"status",
"count",
)
]
for row in sorted(
expected,
key=lambda x: (
str(x["notification_type"]),
str(x["status"]),
x["folder"] if x["folder"] is not None else "",
x["template_name"],
x["count"],
x["last_used"],
),
)
]
results = [
[
str(row[k]) if k != "last_used" else row[k].strftime("%Y-%m-%d")
for k in (
"folder",
"template_name",
"created_by",
"last_used",
"notification_type",
"status",
"count",
)
]
for row in sorted(
results,
key=lambda x: (
x.notification_type,
x.status,
x.folder if x.folder is not None else "",
x.template_name,
x.count,
x.last_used,
),
)
]
assert expected == results
@pytest.mark.parametrize( @pytest.mark.parametrize(

10
tests/app/template_statistics/test_rest.py
View File

@@ -79,6 +79,11 @@ def test_get_template_statistics_for_service_by_day_goes_to_db(
template_name=sample_template.name, template_name=sample_template.name,
notification_type=sample_template.template_type, notification_type=sample_template.template_type,
status=NotificationStatus.CREATED, status=NotificationStatus.CREATED,
template_folder_id="123456",
folder="Some_Folder",
created_by_id="987654",
created_by="Mr. Nobody",
last_used="0/0/0",
) )
], ],
) )
@@ -95,6 +100,11 @@ def test_get_template_statistics_for_service_by_day_goes_to_db(
"template_name": sample_template.name, "template_name": sample_template.name,
"template_type": sample_template.template_type, "template_type": sample_template.template_type,
"status": NotificationStatus.CREATED, "status": NotificationStatus.CREATED,
"template_folder_id": "123456",
"template_folder": "Some_Folder",
"created_by_id": "987654",
"created_by": "Mr. Nobody",
"last_used": "0/0/0",
} }
] ]
# dao only called for 2nd, since redis returned values for first call # dao only called for 2nd, since redis returned values for first call