notifications-admin/app/main/views/activity.py

from flask import abort, render_template, request, url_for

from app import current_service, job_api_client
from app.enums import NotificationStatus, ServicePermission
from app.formatters import get_time_left
from app.main import main
from app.utils.pagination import (
    generate_next_dict,
    generate_pagination_pages,
    generate_previous_dict,
    get_page_from_request,
)
from app.utils.user import user_has_permissions


def get_download_availability(service_id):
    """
    Check if there are jobs available for each download time period.
    """
    jobs_1_day = job_api_client.get_page_of_jobs(service_id, page=1, limit_days=1)
    jobs_3_days = job_api_client.get_page_of_jobs(service_id, page=1, limit_days=3)
    jobs_5_days = job_api_client.get_page_of_jobs(service_id, page=1, limit_days=5)
    jobs_7_days = job_api_client.get_immediate_jobs(service_id)

    has_1_day_data = len(generate_job_dict(jobs_1_day)) > 0
    has_3_day_data = len(generate_job_dict(jobs_3_days)) > 0
    has_5_day_data = len(generate_job_dict(jobs_5_days)) > 0
    has_7_day_data = len(jobs_7_days) > 0

    return {
        "has_1_day_data": has_1_day_data,
        "has_3_day_data": has_3_day_data,
        "has_5_day_data": has_5_day_data,
        "has_7_day_data": has_7_day_data,
        "has_any_download_data": has_1_day_data
        or has_3_day_data
        or has_5_day_data
        or has_7_day_data,
    }


@main.route("/activity/services/<uuid:service_id>")
@user_has_permissions(ServicePermission.VIEW_ACTIVITY)
def all_jobs_activity(service_id):
    service_data_retention_days = 7
    page = get_page_from_request()
    jobs = job_api_client.get_page_of_jobs(service_id, page=page)
    all_jobs_dict = generate_job_dict(jobs)
    prev_page, next_page, pagination = handle_pagination(jobs, service_id, page)
    message_type = ("sms",)
    download_availability = get_download_availability(service_id)
    return render_template(
        "views/activity/all-activity.html",
        all_jobs_dict=all_jobs_dict,
        service_data_retention_days=service_data_retention_days,
        next_page=next_page,
        prev_page=prev_page,
        pagination=pagination,
        **download_availability,
        download_link_one_day=url_for(
            ".download_notifications_csv",
            service_id=current_service.id,
            message_type=message_type,
            status=request.args.get("status"),
            number_of_days="one_day",
        ),
        download_link_three_day=url_for(
            ".download_notifications_csv",
            service_id=current_service.id,
            message_type=message_type,
            status=request.args.get("status"),
            number_of_days="three_day",
        ),
        download_link_five_day=url_for(
            ".download_notifications_csv",
            service_id=current_service.id,
            message_type=message_type,
            status=request.args.get("status"),
            number_of_days="five_day",
        ),
        download_link_seven_day=url_for(
            ".download_notifications_csv",
            service_id=current_service.id,
            message_type=message_type,
            status=request.args.get("status"),
            number_of_days="seven_day",
        ),
    )


def handle_pagination(jobs, service_id, page):
    if page is None:
        abort(404, "Invalid page argument ({}).".format(request.args.get("page")))
    prev_page = (
        generate_previous_dict("main.all_jobs_activity", service_id, page)
        if page > 1
        else None
    )
    total_items = jobs.get("total", 0)
    page_size = jobs.get("page_size", 50)
    total_pages = (total_items + page_size - 1) // page_size
    has_next_link = jobs.get("links", {}).get("next") is not None
    next_page = (
        generate_next_dict("main.all_jobs_activity", service_id, page)
        if has_next_link and total_items > 50 and page < total_pages
        else None
    )
    pagination = generate_pagination_pages(
        jobs.get("total", {}), jobs.get("page_size", {}), page
    )
    return prev_page, next_page, pagination


def get_job_statistics(job, status):
    statistics = job.get("statistics", [])
    for stat in statistics:
        if stat.get("status") == status:
            return stat.get("count")
    return None


def create_job_dict_entry(job):
    job_id = job.get("id")
    can_download = get_time_left(job.get("created_at")) != "Data no longer available"
    activity_time = job.get("processing_started") or job.get("created_at")

    return {
        "job_id": job_id,
        "can_download": can_download,
        "download_link": (
            url_for(".view_job_csv", service_id=current_service.id, job_id=job_id)
            if can_download
            else None
        ),
        "view_job_link": url_for(
            ".view_job", service_id=current_service.id, job_id=job_id
        ),
        "activity_time": activity_time,
        "created_by": job.get("created_by"),
        "template_name": job.get("template_name"),
        "delivered_count": get_job_statistics(job, NotificationStatus.DELIVERED),
        "failed_count": get_job_statistics(job, NotificationStatus.FAILED),
    }


def generate_job_dict(jobs):
    if not jobs or not jobs.get("data"):
        return []
    return [create_job_dict_entry(job) for job in jobs["data"]]