notifications-admin/app/models/job.py

from werkzeug.utils import cached_property

from app.enums import JobStatus, NotificationStatus
from app.models import JSONModel, ModelList, PaginatedModelList
from app.notify_client.job_api_client import job_api_client
from app.notify_client.notification_api_client import notification_api_client
from app.notify_client.service_api_client import service_api_client
from app.utils import set_status_filters
from app.utils.time import is_less_than_days_ago


class Job(JSONModel):
    ALLOWED_PROPERTIES = {
        "id",
        "service",
        "template_name",
        "template_version",
        "original_file_name",
        "created_at",
        "notification_count",
        "created_by",
        "template_type",
        "recipient",
    }

    @classmethod
    def from_id(cls, job_id, service_id):
        return cls(job_api_client.get_job(service_id, job_id)["data"])

    @property
    def status(self):
        return self._dict.get("job_status")

    @property
    def cancelled(self):
        return self.status == JobStatus.CANCELLED

    @property
    def scheduled(self):
        return self.status == JobStatus.SCHEDULED

    @property
    def scheduled_for(self):
        return self._dict.get("scheduled_for")

    @property
    def upload_type(self):
        return self._dict.get("upload_type")

    @property
    def processing_started(self):
        if not self._dict.get("processing_started"):
            return None
        return self._dict["processing_started"]

    def _aggregate_statistics(self, *statuses):
        return sum(
            outcome["count"]
            for outcome in self._dict["statistics"]
            if not statuses or outcome["status"] in statuses
        )

    @property
    def notifications_delivered(self):
        return self._aggregate_statistics(
            NotificationStatus.DELIVERED, NotificationStatus.SENT
        )

    @property
    def notifications_failed(self):
        return self._aggregate_statistics(
            NotificationStatus.FAILED,
            NotificationStatus.TECHNICAL_FAILURE,
            NotificationStatus.TEMPORARY_FAILURE,
            NotificationStatus.PERMANENT_FAILURE,
            NotificationStatus.CANCELLED,
        )

    @property
    def notifications_requested(self):
        return self._aggregate_statistics()

    @property
    def notifications_sent(self):
        return self.notifications_delivered + self.notifications_failed

    @property
    def notifications_sending(self):
        if self.scheduled:
            return 0
        return self.notification_count - self.notifications_sent

    @property
    def notifications_created(self):
        return notification_api_client.get_notification_count_for_job_id(
            service_id=self.service, job_id=self.id
        )

    @property
    def still_processing(self):
        return self.status != JobStatus.FINISHED or self.percentage_complete < 100

    @cached_property
    def finished_processing(self):
        return self.notification_count == self.notifications_sent

    @property
    def awaiting_processing_or_recently_processed(self):
        if not self.processing_started:
            # Assume that if processing hasn’t started yet then the job
            # must have been created recently enough to not have any
            # notifications yet
            return True
        return is_less_than_days_ago(self.processing_started, 1)

    @property
    def template_id(self):
        return self._dict["template"]

    @cached_property
    def template(self):
        return service_api_client.get_service_template(
            service_id=self.service,
            template_id=self.template_id,
            version=self.template_version,
        )["data"]

    @property
    def percentage_complete(self):
        return self.notifications_requested / self.notification_count * 100

    @cached_property
    def all_notifications(self):
        return self.get_notifications(set_status_filters({}))["notifications"]

    @property
    def uncancellable_notifications(self):
        # TODO: this is redundant now
        return (n for n in self.all_notifications)

    @property
    def failure_rate(self):
        if not self.notifications_delivered:
            return 100 if self.notifications_failed else 0
        return (
            self.notifications_failed
            / (self.notifications_failed + self.notifications_delivered)
            * 100
        )

    @property
    def high_failure_rate(self):
        return self.failure_rate > 30

    def get_notifications(self, status):
        return notification_api_client.get_notifications_for_service(
            self.service,
            self.id,
            status=status,
        )

    def cancel(self):
        return job_api_client.cancel_job(self.service, self.id)


class ImmediateJobs(ModelList):
    client_method = job_api_client.get_immediate_jobs
    model = Job


class ScheduledJobs(ImmediateJobs):
    client_method = job_api_client.get_scheduled_jobs


class PaginatedJobs(PaginatedModelList, ImmediateJobs):
    client_method = job_api_client.get_page_of_jobs
    statuses = None

    def __init__(self, service_id, *, page=None, limit_days=None):
        super().__init__(
            service_id,
            statuses=self.statuses,
            page=page,
            limit_days=limit_days,
        )


class PaginatedJobsAndScheduledJobs(PaginatedJobs):
    statuses = job_api_client.NON_CANCELLED_JOB_STATUSES


class PaginatedUploads(PaginatedModelList, ImmediateJobs):
    client_method = job_api_client.get_uploads