Merge pull request #563 from alphagov/week-agg

New weekly aggregate function

app/dao/services_dao.py

@@ -157,3 +157,21 @@ def _stats_for_service_query(service_id):
         Notification.notification_type,
         Notification.status,
     )
+
+
+def dao_fetch_weekly_historical_stats_for_service(service_id):
+    monday_of_notification_week = func.date_trunc('week', NotificationHistory.created_at).label('week_start')
+    return db.session.query(
+        NotificationHistory.notification_type,
+        NotificationHistory.status,
+        monday_of_notification_week,
+        func.count(NotificationHistory.id).label('count')
+    ).filter(
+        NotificationHistory.service_id == service_id
+    ).group_by(
+        NotificationHistory.notification_type,
+        NotificationHistory.status,
+        monday_of_notification_week
+    ).order_by(
+        asc(monday_of_notification_week), NotificationHistory.status
+    ).all()

app/service/rest.py

@@ -1,4 +1,4 @@
-from datetime import date
+from datetime import date, timedelta
 
 from flask import (
     jsonify,
@@ -8,7 +8,6 @@ from flask import (
 )
 from sqlalchemy.orm.exc import NoResultFound
 
-from app.models import EMAIL_TYPE, SMS_TYPE
 from app.dao.api_key_dao import (
     save_model_api_key,
     get_model_api_keys,
@@ -23,7 +22,8 @@ from app.dao.services_dao import (
     dao_add_user_to_service,
     dao_remove_user_from_service,
     dao_fetch_stats_for_service,
-    dao_fetch_todays_stats_for_service
+    dao_fetch_todays_stats_for_service,
+    dao_fetch_weekly_historical_stats_for_service
 )
 from app.dao import notifications_dao
 from app.dao.provider_statistics_dao import get_fragment_count
@@ -43,6 +43,7 @@ from app.errors import (
     register_errors,
     InvalidRequest
 )
+from app.service import statistics
 
 service = Blueprint('service', __name__)
 register_errors(service)
@@ -236,29 +237,20 @@ def get_all_notifications_for_service(service_id):
     ), 200
 
 
+@service.route('/<uuid:service_id>/notifications/weekly', methods=['GET'])
+def get_weekly_notification_stats(service_id):
+    service = dao_fetch_service_by_id(service_id)
+    stats = dao_fetch_weekly_historical_stats_for_service(service_id)
+    stats = statistics.format_weekly_notification_stats(stats, service.created_at)
+    return jsonify(data={week.date().isoformat(): statistics for week, statistics in stats.items()})
+
+
 def get_detailed_service(service_id, today_only=False):
     service = dao_fetch_service_by_id(service_id)
     stats_fn = dao_fetch_todays_stats_for_service if today_only else dao_fetch_stats_for_service
-    statistics = stats_fn(service_id)
-    service.statistics = format_statistics(statistics)
+    stats = stats_fn(service_id)
+
+    service.statistics = statistics.format_statistics(stats)
+
     data = detailed_service_schema.dump(service).data
     return jsonify(data=data)
-
-
-def format_statistics(statistics):
-    # statistics come in a named tuple with uniqueness from 'notification_type', 'status' - however missing
-    # statuses/notification types won't be represented and the status types need to be simplified/summed up
-    # so we can return emails/sms * created, sent, and failed
-    counts = {
-        template_type: {
-            status: 0 for status in ('requested', 'delivered', 'failed')
-        } for template_type in (EMAIL_TYPE, SMS_TYPE)
-    }
-    for row in statistics:
-        counts[row.notification_type]['requested'] += row.count
-        if row.status == 'delivered':
-            counts[row.notification_type]['delivered'] += row.count
-        elif row.status in ('failed', 'technical-failure', 'temporary-failure', 'permanent-failure'):
-            counts[row.notification_type]['failed'] += row.count
-
-    return counts

app/service/statistics.py

@@ -0,0 +1,53 @@
+import itertools
+from datetime import datetime, timedelta
+
+from app.models import EMAIL_TYPE, SMS_TYPE
+
+
+def format_statistics(statistics):
+    # statistics come in a named tuple with uniqueness from 'notification_type', 'status' - however missing
+    # statuses/notification types won't be represented and the status types need to be simplified/summed up
+    # so we can return emails/sms * created, sent, and failed
+    counts = _create_zeroed_stats_dicts()
+    for row in statistics:
+        _update_statuses_from_row(counts[row.notification_type], row)
+
+    return counts
+
+
+def format_weekly_notification_stats(statistics, service_created_at):
+    preceeding_monday = (service_created_at - timedelta(days=service_created_at.weekday()))
+    # turn a datetime into midnight that day http://stackoverflow.com/a/1937636
+    preceeding_monday_midnight = datetime.combine(preceeding_monday.date(), datetime.min.time())
+    week_dict = {
+        week: _create_zeroed_stats_dicts()
+        for week in _weeks_for_range(preceeding_monday_midnight, datetime.utcnow())
+    }
+    for row in statistics:
+        _update_statuses_from_row(week_dict[row.week_start][row.notification_type], row)
+
+    return week_dict
+
+
+def _create_zeroed_stats_dicts():
+    return {
+        template_type: {
+            status: 0 for status in ('requested', 'delivered', 'failed')
+        } for template_type in (EMAIL_TYPE, SMS_TYPE)
+    }
+
+
+def _update_statuses_from_row(update_dict, row):
+    update_dict['requested'] += row.count
+    if row.status == 'delivered':
+        update_dict['delivered'] += row.count
+    elif row.status in ('failed', 'technical-failure', 'temporary-failure', 'permanent-failure'):
+        update_dict['failed'] += row.count
+
+
+def _weeks_for_range(start, end):
+    """
+    Generator that yields dates from `start` to `end`, in 7 day intervals. End is inclusive.
+    """
+    infinite_date_generator = (start + timedelta(days=i) for i in itertools.count(step=7))
+    return itertools.takewhile(lambda x: x <= end, infinite_date_generator)