Added new endpoint to get the new template stats

Added a new endpoint which combines the usage of the stats table and the
data from the notifications tables, instead of using all the data from
the notification_history table. This should speed up the query times
and improve the page performance.

- Updated to make the stats create and update function transactional as
it actually wasn't committing the data to the table
- Added the get from the stats table
- Add a a method to combine the two results
- Added the endpoint

app/celery/scheduled_tasks.py

@@ -408,7 +408,7 @@ def check_job_status():
         raise JobIncompleteError("Job(s) {} have not completed.".format(job_ids))
 
 
-@notify_celery.task(name='daily-stats-template_usage_by_month')
+@notify_celery.task(name='daily-stats-template-usage-by-month')
 @statsd(namespace="tasks")
 def daily_stats_template_usage_by_month():
     results = dao_fetch_monthly_historical_stats_by_template()

app/config.py

@@ -242,7 +242,7 @@ class Config(object):
             'schedule': crontab(),
             'options': {'queue': QueueNames.PERIODIC}
         },
-        'daily-stats-template_usage_by_month': {
+        'daily-stats-template-usage-by-month': {
             'task': 'daily-stats-template_usage_by_month',
             'schedule': crontab(hour=0, minute=50),
             'options': {'queue': QueueNames.PERIODIC}

app/dao/services_dao.py

@@ -12,31 +12,33 @@ from app.dao.dao_utils import (
 )
 from app.dao.date_util import get_financial_year
 from app.dao.service_sms_sender_dao import insert_service_sms_sender
+from app.dao.stats_template_usage_by_month_dao import dao_get_template_usage_stats_by_service
 from app.models import (
-    ProviderStatistics,
-    VerifyCode,
+    AnnualBilling,
     ApiKey,
+    InboundNumber,
+    InvitedUser,
+    Job,
+    JobStatistics,
+    Notification,
+    NotificationHistory,
+    Permission,
+    ProviderStatistics,
+    Service,
+    ServicePermission,
+    ServiceSmsSender,
+    StatsTemplateUsageByMonth,
     Template,
     TemplateHistory,
     TemplateRedacted,
-    InboundNumber,
-    Job,
-    NotificationHistory,
-    Notification,
-    Permission,
     User,
-    InvitedUser,
-    Service,
-    ServicePermission,
-    KEY_TYPE_TEST,
-    NOTIFICATION_STATUS_TYPES,
-    TEMPLATE_TYPES,
-    JobStatistics,
-    SMS_TYPE,
+    VerifyCode,
     EMAIL_TYPE,
     INTERNATIONAL_SMS_TYPE,
-    ServiceSmsSender,
-    AnnualBilling
+    KEY_TYPE_TEST,
+    NOTIFICATION_STATUS_TYPES,
+    SMS_TYPE,
+    TEMPLATE_TYPES
 )
 from app.service.statistics import format_monthly_template_notification_stats
 from app.statsd_decorators import statsd
@@ -540,5 +542,61 @@ def dao_fetch_monthly_historical_stats_by_template():
         month,
         year
     ).order_by(
-        NotificationHistory.template_id
+        year,
+        month
     ).all()
+
+
+@transactional
+@statsd(namespace="dao")
+def dao_fetch_monthly_historical_usage_by_template_for_service(service_id):
+
+    results = dao_get_template_usage_stats_by_service(service_id)
+
+    stats = list()
+    for result in results:
+        stat = StatsTemplateUsageByMonth(
+            template_id=result.template_id,
+            month=result.month,
+            year=result.year,
+            count=result.count
+        )
+        stats.append(stat)
+
+    month = get_london_month_from_utc_column(Notification.created_at)
+    year = func.date_trunc("year", Notification.created_at)
+    start_date = datetime.combine(date.today(), time.min)
+
+    today_results = db.session.query(
+        Notification.template_id,
+        extract('month', month).label('month'),
+        extract('year', year).label('year'),
+        func.count().label('count')
+    ).filter(
+        Notification.created_at >= start_date
+    ).group_by(
+        Notification.template_id,
+        month,
+        year
+    ).order_by(
+        Notification.template_id
+    ).all()
+
+    for today_result in today_results:
+        add_to_stats = True
+        for stat in stats:
+            if today_result.template_id == stat.template_id:
+                stat.count = stat.count + today_result.count
+                add_to_stats = False
+
+        if add_to_stats:
+            new_stat = StatsTemplateUsageByMonth(
+                template_id=today_result.template_id,
+                month=today_result.month,
+                year=today_result.year,
+                count=today_result.count
+            )
+
+            stats.append(new_stat)
+
+    return stats

app/dao/stats_template_usage_by_month_dao.py

@@ -1,7 +1,11 @@
 from app import db
-from app.models import StatsTemplateUsageByMonth
+from app.statsd_decorators import statsd
+from app.dao.dao_utils import transactional
+from app.models import StatsTemplateUsageByMonth, Template
 
 
+@transactional
+@statsd(namespace="dao")
 def insert_or_update_stats_for_template(template_id, month, year, count):
     result = db.session.query(
         StatsTemplateUsageByMonth
@@ -21,4 +25,16 @@ def insert_or_update_stats_for_template(template_id, month, year, count):
             year=year,
             count=count
         )
+
         db.session.add(monthly_stats)
+
+
+@statsd(namespace="dao")
+def dao_get_template_usage_stats_by_service(service_id):
+    return db.session.query(
+        StatsTemplateUsageByMonth
+    ).join(
+        Template, StatsTemplateUsageByMonth.template_id == Template.id
+    ).filter(
+        Template.service_id == service_id
+    ).all()

app/models.py

@@ -1613,3 +1613,11 @@ class StatsTemplateUsageByMonth(db.Model):
         nullable=False,
         default=0
     )
+
+    def serialize(self):
+        return {
+            'template_id': str(self.template_id),
+            'month': self.month,
+            'year': self.year,
+            'count': self.count
+        }

app/service/rest.py

@@ -31,23 +31,25 @@ from app.dao.service_sms_sender_dao import (
     dao_get_sms_senders_by_service_id,
     update_existing_sms_sender_with_inbound_number)
 from app.dao.services_dao import (
-    dao_fetch_service_by_id,
-    dao_fetch_all_services,
-    dao_create_service,
-    dao_update_service,
-    dao_fetch_all_services_by_user,
     dao_add_user_to_service,
-    dao_remove_user_from_service,
+    dao_archive_service,
+    dao_create_service,
+    dao_fetch_all_services,
+    dao_fetch_all_services_by_user,
+    dao_fetch_monthly_historical_stats_for_service,
+    dao_fetch_monthly_historical_stats_by_template_for_service,
+    dao_fetch_monthly_historical_usage_by_template_for_service,
+    dao_fetch_service_by_id,
     dao_fetch_stats_for_service,
     dao_fetch_todays_stats_for_service,
     dao_fetch_todays_stats_for_all_services,
-    dao_archive_service,
-    fetch_stats_by_date_range_for_all_services,
-    dao_suspend_service,
     dao_resume_service,
-    dao_fetch_monthly_historical_stats_for_service,
-    dao_fetch_monthly_historical_stats_by_template_for_service,
-    fetch_aggregate_stats_by_date_range_for_all_services)
+    dao_remove_user_from_service,
+    dao_suspend_service,
+    dao_update_service,
+    fetch_aggregate_stats_by_date_range_for_all_services,
+    fetch_stats_by_date_range_for_all_services
+)
 from app.dao.service_whitelist_dao import (
     dao_fetch_service_whitelist,
     dao_add_and_commit_whitelisted_contacts,
@@ -522,6 +524,15 @@ def resume_service(service_id):
     return '', 204
 
 
+@service_blueprint.route('/<uuid:service_id>/notifications/templates_usage/monthly', methods=['GET'])
+def get_monthly_template_usage(service_id):
+    try:
+        data = dao_fetch_monthly_historical_usage_by_template_for_service(service_id)
+        return jsonify(stats=[i.serialize() for i in data]), 200
+    except ValueError:
+        raise InvalidRequest('Year must be a number', status_code=400)
+
+
 @service_blueprint.route('/<uuid:service_id>/notifications/templates/monthly', methods=['GET'])
 def get_monthly_template_stats(service_id):
     service = dao_fetch_service_by_id(service_id)