Add Template name to response and filter by year

The template name should be returned for the response and the user will
pick a year, so ths adds those two features to the
notifications/templates_usage/monthly endpoint and added some tests to
test the functionality.

app/config.py

@@ -307,7 +307,7 @@ class Config(object):
 
 class Development(Config):
     NOTIFY_LOG_PATH = 'application.log'
-    SQLALCHEMY_ECHO = False
+    SQLALCHEMY_ECHO = True
     NOTIFY_EMAIL_DOMAIN = 'notify.tools'
     CSV_UPLOAD_BUCKET_NAME = 'development-notifications-csv-upload'
     DVLA_RESPONSE_BUCKET_NAME = 'notify.tools-ftp'

app/dao/services_dao.py

@@ -547,20 +547,19 @@ def dao_fetch_monthly_historical_stats_by_template():
     ).all()
 
 
-@transactional
 @statsd(namespace="dao")
-def dao_fetch_monthly_historical_usage_by_template_for_service(service_id):
+def dao_fetch_monthly_historical_usage_by_template_for_service(service_id, year):
 
-    results = dao_get_template_usage_stats_by_service(service_id)
+    results = dao_get_template_usage_stats_by_service(service_id, year)
 
     stats = list()
     for result in results:
-        stat = StatsTemplateUsageByMonth(
-            template_id=result.template_id,
-            month=result.month,
-            year=result.year,
-            count=result.count
-        )
+        stat = type("", (), {})()
+        stat.template_id = result.template_id
+        stat.name = str(result.name)
+        stat.month = result.month
+        stat.year = result.year
+        stat.count = result.count
         stats.append(stat)
 
     month = get_london_month_from_utc_column(Notification.created_at)
@@ -569,13 +568,17 @@ def dao_fetch_monthly_historical_usage_by_template_for_service(service_id):
 
     today_results = db.session.query(
         Notification.template_id,
+        Template.name,
         extract('month', month).label('month'),
         extract('year', year).label('year'),
         func.count().label('count')
+    ).join(
+        Template, Notification.template_id == Template.id
     ).filter(
         Notification.created_at >= start_date
     ).group_by(
         Notification.template_id,
+        Template.name,
         month,
         year
     ).order_by(
@@ -590,13 +593,12 @@ def dao_fetch_monthly_historical_usage_by_template_for_service(service_id):
                 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
-            )
-
+            new_stat = type("", (), {})()
+            new_stat.template_id = today_result.template_id
+            new_stat.name = today_result.name
+            new_stat.month = today_result.month
+            new_stat.year = today_result.year
+            new_stat.count = today_result.count
             stats.append(new_stat)
 
     return stats

app/dao/stats_template_usage_by_month_dao.py

@@ -30,11 +30,16 @@ def insert_or_update_stats_for_template(template_id, month, year, count):
 
 
 @statsd(namespace="dao")
-def dao_get_template_usage_stats_by_service(service_id):
+def dao_get_template_usage_stats_by_service(service_id, year):
     return db.session.query(
-        StatsTemplateUsageByMonth
+        StatsTemplateUsageByMonth.template_id,
+        Template.name,
+        StatsTemplateUsageByMonth.month,
+        StatsTemplateUsageByMonth.year,
+        StatsTemplateUsageByMonth.count
     ).join(
         Template, StatsTemplateUsageByMonth.template_id == Template.id
     ).filter(
-        Template.service_id == service_id
+        Template.service_id == service_id,
+        StatsTemplateUsageByMonth.year == year
     ).all()

app/service/rest.py

@@ -527,8 +527,24 @@ def resume_service(service_id):
 @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
+        data = dao_fetch_monthly_historical_usage_by_template_for_service(
+            service_id,
+            int(request.args.get('year', 'NaN'))
+        )
+
+        stats = list()
+        for i in data:
+            stats.append(
+                {
+                    'template_id': str(i.template_id),
+                    'name': i.name,
+                    'month': i.month,
+                    'year': i.year,
+                    'count': i.count
+                }
+            )
+
+        return jsonify(stats=stats), 200
     except ValueError:
         raise InvalidRequest('Year must be a number', status_code=400)
 

tests/app/dao/test_services_dao.py

@@ -1054,14 +1054,14 @@ def test_dao_fetch_monthly_historical_usage_by_template_for_service_no_stats_tod
     template_two = create_sample_template(notify_db, notify_db_session, template_name='2')
 
     n = notification_history(created_at=datetime(2017, 10, 1), sample_template=template_one)
-    notification_history(created_at=datetime(2016, 4, 1), sample_template=template_two)
-    notification_history(created_at=datetime(2016, 4, 1), sample_template=template_two)
+    notification_history(created_at=datetime(2017, 4, 1), sample_template=template_two)
+    notification_history(created_at=datetime(2017, 4, 1), sample_template=template_two)
     notification_history(created_at=datetime.now(), sample_template=template_two)
 
     daily_stats_template_usage_by_month()
 
     result = sorted(
-        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id),
+        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id, 2017),
         key=lambda x: (x.month, x.year)
     )
 
@@ -1069,7 +1069,7 @@ def test_dao_fetch_monthly_historical_usage_by_template_for_service_no_stats_tod
 
     assert result[0].template_id == template_two.id
     assert result[0].month == 4
-    assert result[0].year == 2016
+    assert result[0].year == 2017
     assert result[0].count == 2
 
     assert result[1].template_id == template_one.id
@@ -1107,7 +1107,7 @@ def test_dao_fetch_monthly_historical_usage_by_template_for_service_add_to_histo
     daily_stats_template_usage_by_month()
 
     result = sorted(
-        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id),
+        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id, 2017),
         key=lambda x: (x.month, x.year)
     )
 
@@ -1139,7 +1139,7 @@ def test_dao_fetch_monthly_historical_usage_by_template_for_service_add_to_histo
     )
 
     result = sorted(
-        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id),
+        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id, 2017),
         key=lambda x: (x.month, x.year)
     )
 
@@ -1190,7 +1190,7 @@ def test_dao_fetch_monthly_historical_usage_by_template_for_service_does_add_old
     daily_stats_template_usage_by_month()
 
     result = sorted(
-        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id),
+        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id, 2017),
         key=lambda x: (x.month, x.year)
     )
 
@@ -1215,7 +1215,78 @@ def test_dao_fetch_monthly_historical_usage_by_template_for_service_does_add_old
     )
 
     result = sorted(
-        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id),
+        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id, 2017),
+        key=lambda x: (x.month, x.year)
+    )
+
+    assert len(result) == 2
+
+
+@freeze_time("2017-11-10 11:09:00.000000")
+def test_dao_fetch_monthly_historical_usage_by_template_for_service_get_this_year_only(
+        notify_db,
+        notify_db_session,
+        sample_service
+):
+    notification_history = functools.partial(
+        create_notification_history,
+        notify_db,
+        notify_db_session,
+        status='delivered'
+    )
+
+    template_one = create_sample_template(notify_db, notify_db_session, template_name='1')
+    template_two = create_sample_template(notify_db, notify_db_session, template_name='2')
+    template_three = create_sample_template(notify_db, notify_db_session, template_name='3')
+
+    date = datetime.now()
+    day = date.day
+    month = date.month
+    year = date.year
+
+    n = notification_history(created_at=datetime(2016, 9, 1), sample_template=template_one)
+    notification_history(created_at=datetime(year, month, day) - timedelta(days=1), sample_template=template_two)
+    notification_history(created_at=datetime(year, month, day) - timedelta(days=1), sample_template=template_two)
+
+    daily_stats_template_usage_by_month()
+
+    result = sorted(
+        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id, 2017),
+        key=lambda x: (x.month, x.year)
+    )
+
+    assert len(result) == 1
+
+    assert result[0].template_id == template_two.id
+    assert result[0].month == 11
+    assert result[0].year == 2017
+    assert result[0].count == 2
+
+    create_notification(
+        notify_db,
+        notify_db_session,
+        service=sample_service,
+        template=template_three,
+        created_at=datetime.utcnow() - timedelta(days=2)
+    )
+
+    result = sorted(
+        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id, 2017),
+        key=lambda x: (x.month, x.year)
+    )
+
+    assert len(result) == 1
+
+    create_notification(
+        notify_db,
+        notify_db_session,
+        service=sample_service,
+        template=template_three,
+        created_at=datetime.utcnow()
+    )
+
+    result = sorted(
+        dao_fetch_monthly_historical_usage_by_template_for_service(n.service_id, 2017),
         key=lambda x: (x.month, x.year)
     )
 

tests/app/dao/test_stats_template_usage_by_month_dao.py

@@ -68,6 +68,37 @@ def test_dao_get_template_usage_stats_by_service(sample_service):
     db.session.add(stats1)
     db.session.add(stats2)
 
-    result = dao_get_template_usage_stats_by_service(sample_service.id)
+    result = dao_get_template_usage_stats_by_service(sample_service.id, 2017)
 
     assert len(result) == 2
+
+
+def test_dao_get_template_usage_stats_by_service_specific_year(sample_service):
+
+    email_template = create_template(service=sample_service, template_type="email")
+
+    stats1 = StatsTemplateUsageByMonth(
+        template_id=email_template.id,
+        month=1,
+        year=2016,
+        count=10
+    )
+
+    stats2 = StatsTemplateUsageByMonth(
+        template_id=email_template.id,
+        month=2,
+        year=2017,
+        count=10
+    )
+
+    db.session.add(stats1)
+    db.session.add(stats2)
+
+    result = dao_get_template_usage_stats_by_service(sample_service.id, 2017)
+
+    assert len(result) == 1
+    assert result[0].template_id == email_template.id
+    assert result[0].name == email_template.name
+    assert result[0].month == 2
+    assert result[0].year == 2017
+    assert result[0].count == 10

tests/app/service/test_rest.py

@@ -1984,6 +1984,7 @@ def test_get_template_usage_by_month_returns_correct_data(
     assert len(resp_json) == 1
 
     assert resp_json[0]["template_id"] == str(sample_template.id)
+    assert resp_json[0]["name"] == sample_template.name
     assert resp_json[0]["month"] == 4
     assert resp_json[0]["year"] == 2016
     assert resp_json[0]["count"] == 5