Merge pull request #683 from alphagov/paginate-dashboard

Paginate `GET /service/{}/job` query

app/dao/jobs_dao.py

@@ -1,10 +1,11 @@
-from datetime import date, timedelta, datetime
-from sqlalchemy import desc, asc, cast, Date as sql_date
+from datetime import datetime
+
+from sqlalchemy import func, desc, asc, cast, Date as sql_date
+
 from app import db
 from app.dao import days_ago
 from app.models import Job, NotificationHistory, JOB_STATUS_SCHEDULED
 from app.statsd_decorators import statsd
-from sqlalchemy import func, asc
 
 
 @statsd(namespace="dao")
@@ -26,11 +27,14 @@ def dao_get_job_by_service_id_and_job_id(service_id, job_id):
     return Job.query.filter_by(service_id=service_id, id=job_id).one()
 
 
-def dao_get_jobs_by_service_id(service_id, limit_days=None):
+def dao_get_jobs_by_service_id(service_id, limit_days=None, page=1, page_size=50):
     query_filter = [Job.service_id == service_id]
     if limit_days is not None:
         query_filter.append(cast(Job.created_at, sql_date) >= days_ago(limit_days))
-    return Job.query.filter(*query_filter).order_by(desc(Job.created_at)).all()
+    return Job.query \
+        .filter(*query_filter) \
+        .order_by(desc(Job.created_at)) \
+        .paginate(page=page, per_page=page_size)
 
 
 def dao_get_job_by_id(job_id):

app/job/rest.py

@@ -96,20 +96,14 @@ def get_jobs_by_service(service_id):
     if request.args.get('limit_days'):
         try:
             limit_days = int(request.args['limit_days'])
-        except ValueError as e:
+        except ValueError:
             errors = {'limit_days': ['{} is not an integer'.format(request.args['limit_days'])]}
             raise InvalidRequest(errors, status_code=400)
     else:
         limit_days = None
 
-    jobs = dao_get_jobs_by_service_id(service_id, limit_days)
-    data = job_schema.dump(jobs, many=True).data
-
-    for job_data in data:
-        statistics = dao_get_notification_outcomes_for_job(service_id, job_data['id'])
-        job_data['statistics'] = [{'status': statistic[1], 'count': statistic[0]} for statistic in statistics]
-
-    return jsonify(data=data)
+    page = int(request.args.get('page', 1))
+    return jsonify(**get_paginated_jobs(service_id, limit_days, page))
 
 
 @job.route('', methods=['POST'])
@@ -144,3 +138,28 @@ def create_job(service_id):
     job_json['statistics'] = []
 
     return jsonify(data=job_json), 201
+
+
+def get_paginated_jobs(service_id, limit_days, page):
+    pagination = dao_get_jobs_by_service_id(
+        service_id,
+        limit_days=limit_days,
+        page=page,
+        page_size=current_app.config['PAGE_SIZE']
+    )
+
+    data = job_schema.dump(pagination.items, many=True).data
+    for job_data in data:
+        statistics = dao_get_notification_outcomes_for_job(service_id, job_data['id'])
+        job_data['statistics'] = [{'status': statistic[1], 'count': statistic[0]} for statistic in statistics]
+
+    return {
+        'data': data,
+        'page_size': pagination.per_page,
+        'total': pagination.total,
+        'links': pagination_links(
+            pagination,
+            '.get_jobs_by_service',
+            service_id=service_id
+        )
+    }

app/utils.py

@@ -4,7 +4,7 @@ from flask import url_for
 def pagination_links(pagination, endpoint, **kwargs):
     if 'page' in kwargs:
         kwargs.pop('page', None)
-    links = dict()
+    links = {}
     if pagination.has_prev:
         links['prev'] = url_for(endpoint, page=pagination.prev_num, **kwargs)
     if pagination.has_next: