edx-platform/openedx/features/survey_report/models.py

"""
Survey Report models.
"""

import uuid

from django.db import models
from jsonfield import JSONField

SURVEY_REPORT_PROCESSING = 'processing'
SURVEY_REPORT_GENERATED = 'generated'
SURVEY_REPORT_ERROR = 'error'

SURVEY_REPORT_STATES = [
    (SURVEY_REPORT_PROCESSING, 'Processing'),
    (SURVEY_REPORT_GENERATED, 'Generated'),
    (SURVEY_REPORT_ERROR, 'Error'),
]


class SurveyReport(models.Model):
    """
    This model stores information to automate the way of gathering impact data from the openedx project.

    .. no_pii:

    fields:
    - courses_offered: Total number of active unique courses.
    - learner: Recently active users with login in some weeks.
    - registered_learners: Total number of users ever registered in the platform.
    - enrollments: Total number of active enrollments in the platform.
    - generated_certificates: Total number of generated certificates.
    - extra_data: Extra information that will be saved in the report, E.g: site_name, openedx-release.
    - state: State of the async generating process.
    """
    courses_offered = models.BigIntegerField(default=0, help_text="Total number of active unique courses.")
    learners = models.BigIntegerField(
        default=0,
        help_text="Total number of recently active users with login in some weeks."
    )
    registered_learners = models.BigIntegerField(
        default=0,
        help_text="Total number of users ever registered in the platform."
    )
    enrollments = models.BigIntegerField(default=0, help_text="Total number of active enrollments in the platform.")
    generated_certificates = models.BigIntegerField(default=0, help_text="Total number of generated certificates.")
    extra_data = JSONField(
        blank=True,
        default=dict,
        help_text="Extra information that will be saved in the report, E.g: site_name, openedx-release.",
    )
    created_at = models.DateTimeField(auto_now=True)
    state = models.CharField(
        max_length=24,
        choices=SURVEY_REPORT_STATES,
        default=SURVEY_REPORT_PROCESSING,
        help_text="State of the async generating process."
    )

    class Meta:
        ordering = ["-created_at"]
        get_latest_by = 'created_at'


class SurveyReportUpload(models.Model):
    """
    This model stores the result of the POST request made to an external service after generating a survey report.

    .. no_pii:

    fields:
    - sent_at: Date when the report was sent.
    - report: The report that was sent.
    - status: Request status code.
    - request_details: Information about the send request.
    """
    sent_at = models.DateTimeField(auto_now=True, help_text="Date when the report was sent to external api.")
    report = models.ForeignKey(SurveyReport, on_delete=models.CASCADE, help_text="The report that was sent.")
    status_code = models.IntegerField(help_text="Request status code.")
    request_details = models.CharField(
        max_length=255,
        null=True,
        blank=True,
        help_text="Information about the send request."
    )

    def is_uploaded(self) -> bool:
        return 200 <= self.status_code < 300


class SurveyReportAnonymousSiteID(models.Model):
    """
    This model is just to save the identification which will be send to the external API when
    the settings ANONYMOUS_SURVEY_REPORT is defined.

    .. no_pii:
    """
    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)