mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-09-04 19:38:24 -04:00
3d7f07493b
- _Processed_ is all the notifications that we know about, ie sending,
failed and delivered
- _Sending_ is notifications that we have either put into a queue or are
waiting to hear back from the provider about.
The big numbers on the dashboard are a count of all the messages we’ve
processed. So when you click them, the table of notifications you see
on the dashboard should contain that number of notifications.
This also gets the activity page one step closer to being like the job
page:
| Before | After
---------|----------------------------|---------------------------------
Activity | Sending, failed, both | Processed, sending, failed, delivered
Job page | Sending, failed, delivered | Sending, failed, delivered
263 lines
8.6 KiB
Python
263 lines
8.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
import time
|
|
|
|
from flask import (
|
|
render_template,
|
|
abort,
|
|
jsonify,
|
|
request,
|
|
url_for,
|
|
current_app
|
|
)
|
|
from flask_login import login_required
|
|
from werkzeug.datastructures import MultiDict
|
|
from notifications_utils.template import Template
|
|
|
|
from app import (
|
|
job_api_client,
|
|
notification_api_client,
|
|
service_api_client,
|
|
current_service,
|
|
format_datetime_short)
|
|
from app.main import main
|
|
from app.utils import (
|
|
get_page_from_request,
|
|
generate_previous_next_dict,
|
|
user_has_permissions,
|
|
generate_notifications_csv)
|
|
|
|
|
|
def _parse_filter_args(filter_dict):
|
|
if not isinstance(filter_dict, MultiDict):
|
|
filter_dict = MultiDict(filter_dict)
|
|
|
|
return MultiDict(
|
|
(
|
|
key,
|
|
(','.join(filter_dict.getlist(key))).split(',')
|
|
)
|
|
for key in filter_dict.keys()
|
|
if ''.join(filter_dict.getlist(key))
|
|
)
|
|
|
|
|
|
def _set_status_filters(filter_args):
|
|
all_failure_statuses = ['failed', 'temporary-failure', 'permanent-failure', 'technical-failure']
|
|
all_statuses = ['sending', 'delivered'] + all_failure_statuses
|
|
if filter_args.get('status'):
|
|
if 'processed' in filter_args.get('status'):
|
|
filter_args['status'] = all_statuses
|
|
elif 'failed' in filter_args.get('status'):
|
|
filter_args['status'].extend(all_failure_statuses[1:])
|
|
else:
|
|
filter_args['status'] = all_statuses
|
|
|
|
|
|
@main.route("/services/<service_id>/jobs")
|
|
@login_required
|
|
@user_has_permissions('view_activity', admin_override=True)
|
|
def view_jobs(service_id):
|
|
jobs = job_api_client.get_job(service_id)['data']
|
|
return render_template(
|
|
'views/jobs/jobs.html',
|
|
jobs=jobs
|
|
)
|
|
|
|
|
|
@main.route("/services/<service_id>/jobs/<job_id>")
|
|
@login_required
|
|
@user_has_permissions('view_activity', admin_override=True)
|
|
def view_job(service_id, job_id):
|
|
job = job_api_client.get_job(service_id, job_id)['data']
|
|
template = service_api_client.get_service_template(service_id=service_id,
|
|
template_id=job['template'],
|
|
version=job['template_version'])['data']
|
|
notifications = notification_api_client.get_notifications_for_service(service_id, job_id)
|
|
finished = job['status'] == 'finished'
|
|
return render_template(
|
|
'views/jobs/job.html',
|
|
notifications=notifications['notifications'],
|
|
job=job,
|
|
uploaded_at=job['created_at'],
|
|
finished=job.get('notifications_sent', 0) and ((
|
|
job.get('notifications_sent', 0) -
|
|
job.get('notifications_delivered', 0) -
|
|
job.get('notifications_failed', 0)
|
|
) == 0),
|
|
uploaded_file_name=job['original_file_name'],
|
|
first_email_template=[
|
|
template for template in service_api_client.get_service_templates(service_id)['data']
|
|
if template['template_type'] == 'email'
|
|
][0] if request.args.get('help') else None,
|
|
template=Template(
|
|
template,
|
|
prefix=current_service['name']
|
|
)
|
|
)
|
|
|
|
|
|
@main.route("/services/<service_id>/jobs/<job_id>.csv")
|
|
@login_required
|
|
@user_has_permissions('view_activity', admin_override=True)
|
|
def view_job_csv(service_id, job_id):
|
|
job = job_api_client.get_job(service_id, job_id)['data']
|
|
template = service_api_client.get_service_template(
|
|
service_id=service_id,
|
|
template_id=job['template'],
|
|
version=job['template_version']
|
|
)['data']
|
|
|
|
return (
|
|
generate_notifications_csv(
|
|
notification_api_client.get_notifications_for_service(
|
|
service_id,
|
|
job_id,
|
|
page_size=job['notification_count']
|
|
)['notifications']
|
|
),
|
|
200,
|
|
{
|
|
'Content-Type': 'text/csv; charset=utf-8',
|
|
'Content-Disposition': 'inline; filename="{} - {}.csv"'.format(
|
|
template['name'],
|
|
format_datetime_short(job['created_at'])
|
|
)
|
|
}
|
|
)
|
|
|
|
|
|
@main.route("/services/<service_id>/jobs/<job_id>.json")
|
|
@login_required
|
|
@user_has_permissions('view_activity', admin_override=True)
|
|
def view_job_updates(service_id, job_id):
|
|
job = job_api_client.get_job(service_id, job_id)['data']
|
|
notifications = notification_api_client.get_notifications_for_service(service_id, job_id)
|
|
finished = (
|
|
job.get('notifications_sent', 0) -
|
|
job.get('notifications_delivered', 0) -
|
|
job.get('notifications_failed', 0)
|
|
) == 0
|
|
return jsonify(**{
|
|
'counts': render_template(
|
|
'partials/jobs/count.html',
|
|
job=job,
|
|
finished=finished
|
|
),
|
|
'notifications': render_template(
|
|
'partials/jobs/notifications.html',
|
|
job=job,
|
|
notifications=notifications['notifications'],
|
|
finished=finished
|
|
),
|
|
'status': render_template(
|
|
'partials/jobs/status.html',
|
|
job=job,
|
|
finished=finished
|
|
),
|
|
})
|
|
|
|
|
|
@main.route('/services/<service_id>/notifications/<message_type>')
|
|
@main.route('/services/<service_id>/notifications/<message_type>.csv', endpoint="view_notifications_csv")
|
|
@login_required
|
|
@user_has_permissions('view_activity', admin_override=True)
|
|
def view_notifications(service_id, message_type):
|
|
# TODO get the api to return count of pages as well.
|
|
page = get_page_from_request()
|
|
if page is None:
|
|
abort(404, "Invalid page argument ({}) reverting to page 1.".format(request.args['page'], None))
|
|
if message_type not in ['email', 'sms']:
|
|
abort(404)
|
|
|
|
filter_args = _parse_filter_args(request.args)
|
|
_set_status_filters(filter_args)
|
|
|
|
notifications = notification_api_client.get_notifications_for_service(
|
|
service_id=service_id,
|
|
page=page,
|
|
template_type=[message_type],
|
|
status=filter_args.get('status'),
|
|
limit_days=current_app.config['ACTIVITY_STATS_LIMIT_DAYS'])
|
|
view_dict = dict(
|
|
message_type=message_type,
|
|
status=request.args.get('status')
|
|
)
|
|
prev_page = None
|
|
if notifications['links'].get('prev', None):
|
|
prev_page = generate_previous_next_dict(
|
|
'main.view_notifications',
|
|
service_id,
|
|
view_dict,
|
|
page - 1,
|
|
'Previous page',
|
|
'page {}'.format(page - 1))
|
|
next_page = None
|
|
if notifications['links'].get('next', None):
|
|
next_page = generate_previous_next_dict(
|
|
'main.view_notifications',
|
|
service_id,
|
|
view_dict,
|
|
page + 1,
|
|
'Next page',
|
|
'page {}'.format(page + 1))
|
|
if request.path.endswith('csv'):
|
|
csv_content = generate_notifications_csv(
|
|
notification_api_client.get_notifications_for_service(
|
|
service_id=service_id,
|
|
page=page,
|
|
page_size=notifications['total'],
|
|
template_type=[message_type],
|
|
status=filter_args.get('status'),
|
|
limit_days=current_app.config['ACTIVITY_STATS_LIMIT_DAYS'])['notifications'])
|
|
return csv_content, 200, {
|
|
'Content-Type': 'text/csv; charset=utf-8',
|
|
'Content-Disposition': 'inline; filename="notifications.csv"'
|
|
}
|
|
return render_template(
|
|
'views/notifications.html',
|
|
notifications=notifications['notifications'],
|
|
page=page,
|
|
prev_page=prev_page,
|
|
next_page=next_page,
|
|
request_args=request.args,
|
|
message_type=message_type,
|
|
download_link=url_for(
|
|
'.view_notifications_csv',
|
|
service_id=current_service['id'],
|
|
message_type=message_type,
|
|
status=request.args.get('status')
|
|
),
|
|
status_filters=[
|
|
[item[0], item[1], url_for(
|
|
'.view_notifications',
|
|
service_id=current_service['id'],
|
|
message_type=message_type,
|
|
status=item[1]
|
|
)] for item in [
|
|
['Processed', 'sending,delivered,failed'],
|
|
['Sending', 'sending'],
|
|
['Delivered', 'delivered'],
|
|
['Failed', 'failed'],
|
|
]
|
|
]
|
|
)
|
|
|
|
|
|
@main.route("/services/<service_id>/jobs/<job_id>/notification/<string:notification_id>")
|
|
@login_required
|
|
@user_has_permissions('view_activity', admin_override=True)
|
|
def view_notification(service_id, job_id, notification_id):
|
|
|
|
now = time.strftime('%H:%M')
|
|
|
|
return render_template(
|
|
'views/notification.html',
|
|
message=[
|
|
message for message in messages if message['id'] == notification_id
|
|
][0],
|
|
delivered_at=now,
|
|
uploaded_at=now,
|
|
job_id=job_id
|
|
)
|