Merge pull request #1033 from alphagov/job-stats-for-dashboard

Job stats for dashboard

app/dao/jobs_dao.py

@@ -8,7 +8,7 @@ from app.dao import days_ago
 from app.models import (
     Job, JobStatistics, Notification, NotificationHistory, Template,
     JOB_STATUS_SCHEDULED, JOB_STATUS_PENDING,
-    EMAIL_TYPE, SMS_TYPE, LETTER_TYPE
+    LETTER_TYPE
 )
 from app.statsd_decorators import statsd
 
@@ -142,3 +142,56 @@ def dao_get_all_letter_jobs():
     return db.session.query(Job).join(Job.template).filter(
         Template.template_type == LETTER_TYPE
     ).order_by(desc(Job.created_at)).all()
+
+
+@statsd(namespace="dao")
+def dao_get_job_statistics_for_job(service_id, job_id):
+    query = Job.query.join(
+        JobStatistics, Job.id == JobStatistics.job_id
+    ).filter(
+        Job.id == job_id,
+        Job.service_id == service_id
+    ).add_columns(
+        JobStatistics.job_id,
+        Job.original_file_name,
+        Job.created_at,
+        Job.scheduled_for,
+        Job.template_id,
+        Job.template_version,
+        Job.job_status,
+        Job.service_id,
+        Job.notification_count,
+        JobStatistics.sent,
+        JobStatistics.delivered,
+        JobStatistics.failed
+    )
+    return query.one()
+
+
+@statsd(namespace="dao")
+def dao_get_job_stats_for_service(service_id, page=1, page_size=50, limit_days=None, statuses=None):
+    query = Job.query.join(
+        JobStatistics, Job.id == JobStatistics.job_id
+    ).filter(
+        Job.service_id == service_id
+    ).add_columns(
+        JobStatistics.job_id,
+        Job.original_file_name,
+        Job.created_at,
+        Job.scheduled_for,
+        Job.template_id,
+        Job.template_version,
+        Job.job_status,
+        Job.service_id,
+        Job.notification_count,
+        JobStatistics.sent,
+        JobStatistics.delivered,
+        JobStatistics.failed
+    )
+    if limit_days:
+        query = query.filter(Job.created_at >= days_ago(limit_days))
+    if statuses is not None and statuses != ['']:
+        query = query.filter(Job.job_status.in_(statuses))
+
+    query = query.order_by(Job.created_at.desc())
+    return query.paginate(page=page, per_page=page_size)

app/job/rest.py

@@ -5,14 +5,16 @@ from flask import (
     current_app
 )
 
+from app import DATETIME_FORMAT
 from app.dao.jobs_dao import (
     dao_create_job,
     dao_update_job,
     dao_get_job_by_service_id_and_job_id,
     dao_get_jobs_by_service_id,
     dao_get_future_scheduled_job_by_id_and_service_id,
-    dao_get_notification_outcomes_for_job
-)
+    dao_get_notification_outcomes_for_job,
+    dao_get_job_stats_for_service,
+    dao_get_job_statistics_for_job)
 
 from app.dao.services_dao import (
     dao_fetch_service_by_id
@@ -57,6 +59,13 @@ def get_job_by_service_and_job_id(service_id, job_id):
     return jsonify(data=data)
 
 
+@job_blueprint.route('/job-stats/<job_id>', methods=['GET'])
+def get_job_stats_by_service_and_job_id(service_id, job_id):
+    statistic = dao_get_job_statistics_for_job(service_id=service_id, job_id=job_id)
+
+    return jsonify(_serialize_job_stats(statistic))
+
+
 @job_blueprint.route('/<job_id>/cancel', methods=['POST'])
 def cancel_job(service_id, job_id):
     job = dao_get_future_scheduled_job_by_id_and_service_id(job_id, service_id)
@@ -117,6 +126,57 @@ def get_jobs_by_service(service_id):
     return jsonify(**get_paginated_jobs(service_id, limit_days, statuses, page))
 
 
+@job_blueprint.route('/job-stats', methods=['GET'])
+def get_jobs_for_service(service_id):
+    if request.args.get('limit_days'):
+        try:
+            limit_days = int(request.args['limit_days'])
+        except ValueError:
+            errors = {'limit_days': ['{} is not an integer'.format(request.args['limit_days'])]}
+            raise InvalidRequest(errors, status_code=400)
+    else:
+        limit_days = None
+    statuses = _parse_statuses(request.args.get('statuses', ''))
+    page = int(request.args.get('page', 1))
+
+    pagination = dao_get_job_stats_for_service(service_id=service_id,
+                                               page=page,
+                                               page_size=current_app.config['PAGE_SIZE'],
+                                               limit_days=limit_days,
+                                               statuses=statuses)
+    return jsonify({
+        'data': [_serialize_job_stats(x) for x in pagination.items],
+        'page_size': pagination.per_page,
+        'total': pagination.total,
+        'links': pagination_links(
+            pagination,
+            '.get_jobs_by_service',
+            service_id=service_id
+        )
+    })
+
+
+def _parse_statuses(statuses):
+    return [x.strip() for x in statuses.split(',')]
+
+
+def _serialize_job_stats(stat):
+    return {
+        "job_id": stat.job_id,
+        "original_file_name": stat.original_file_name,
+        "created_at": stat.created_at.strftime(DATETIME_FORMAT),
+        "scheduled_for": stat.scheduled_for,
+        "template_id": stat.template_id,
+        "template_version": stat.template_version,
+        "job_status": stat.job_status,
+        "service_id": stat.service_id,
+        "requested": stat.notification_count,
+        "sent": stat.sent,
+        "delivered": stat.delivered,
+        "failed": stat.failed
+    }
+
+
 @job_blueprint.route('', methods=['POST'])
 def create_job(service_id):
     service = dao_fetch_service_by_id(service_id)