models.py

# pyright: reportUninitializedInstanceVariable=false
# TODO(thenav56): Check and add missing unique_together
import datetime
import typing

from django.db import models
from django_choices_field import IntegerChoicesField

from apps.contributor.models import ContributorUser, ContributorUserGroup
from apps.project.models import ProjectTask, ProjectTaskGroup


class MappingSessionClientTypeEnum(models.IntegerChoices):
    """Enum representing client type used during a mapping session.
    https://github.com/react-native-device-info/react-native-device-info#getsystemname.
    """

    UNKNOWN = 0, "Unknown"
    MOBILE_ANDROID = 1, "Mobile (Android)"
    MOBILE_IOS = 2, "Mobile (IOS)"
    WEB = 3, "Web"

    @classmethod
    def get_client_type(cls, value: str) -> "MappingSessionClientTypeEnum":
        return {
            "mobile-android": cls.MOBILE_ANDROID,
            "mobile-ios": cls.MOBILE_IOS,
            "mobile-iphone os": cls.MOBILE_IOS,
            "mobile-ipados": cls.MOBILE_IOS,
            "web": cls.WEB,
        }.get(value, cls.UNKNOWN)

    @classmethod
    def get_client_type_label_sql(cls, field: str) -> str:
        return f"""
            CASE {field}
                WHEN {cls.MOBILE_ANDROID.value} THEN 'android'
                WHEN {cls.MOBILE_IOS.value} THEN 'ios'
                WHEN {cls.WEB.value} THEN 'web'
            ELSE 'unknown'
            END
        """


class MappingSession(models.Model):
    """Model representing a mapping session where a contributor user worked on a specific project task group."""

    project_task_group = models.ForeignKey[ProjectTaskGroup, ProjectTaskGroup](ProjectTaskGroup, on_delete=models.PROTECT)
    contributor_user = models.ForeignKey[ContributorUser, ContributorUser](ContributorUser, on_delete=models.PROTECT)

    app_version = models.CharField[str, str](max_length=255)
    client_type: int = IntegerChoicesField(choices_enum=MappingSessionClientTypeEnum)  # type: ignore[reportAssignmentType]
    items_count = models.IntegerField[int, int]()  # TODO(thenav56): Rename or just use task_group.number_of_tasks?
    start_time = models.DateTimeField[datetime.datetime | None, datetime.datetime | None](
        null=True,
        blank=True,
    )  # XXX: New data are not null
    end_time = models.DateTimeField[datetime.datetime | None, datetime.datetime | None](
        null=True,
        blank=True,
    )  # XXX: New data are not null

    # Type hints
    id: int
    project_task_group_id: int
    contributor_user_id: int

    class Meta:
        unique_together = (("project_task_group", "contributor_user"),)

    @typing.override
    def __str__(self):
        return str(self.pk)


class MappingSessionUserGroup(models.Model):
    """Model representing a link between mapping session and contributor user group.

    There can be multiple contributor user group linked to the same mapping session.
    """

    mapping_session = models.ForeignKey[MappingSession, MappingSession](MappingSession, on_delete=models.PROTECT)
    user_group = models.ForeignKey[ContributorUserGroup, ContributorUserGroup](
        ContributorUserGroup,
        on_delete=models.PROTECT,
        related_name="+",
    )

    # Type hints
    mapping_session_id: int
    user_group_id: int

    class Meta:
        unique_together = (("mapping_session", "user_group"),)

    @typing.override
    def __str__(self):
        return str(self.pk)


class MappingSessionResult(models.Model):
    """Model representing the result of a mapping session."""

    session = models.ForeignKey[MappingSession, MappingSession](MappingSession, on_delete=models.PROTECT)
    project_task = models.ForeignKey[ProjectTask, ProjectTask](ProjectTask, on_delete=models.PROTECT)
    result = models.PositiveSmallIntegerField[int, int]()

    # TODO(thenav56): Add constraint to make sure we have non-duplicate row with task_id, .session.user_id

    # Type hints
    session_id: int
    project_task_id: int

    class Meta:
        unique_together = (("session", "project_task"),)

    @typing.override
    def __str__(self):
        return str(self.pk)


# TODO: Rename to MappingSessionUserGroupStage?
class MappingSessionUserGroupTemp(models.Model):
    """Model storing intermediate data representing groups while pulling data from firebase."""

    project_firebase_id = models.CharField[str, str](max_length=255)
    group_firebase_id = models.CharField[str, str](max_length=255)
    contributor_user_firebase_id = models.CharField[str, str](max_length=255)
    user_group_firebase_id = models.CharField[str, str](max_length=255)

    @typing.override
    def __str__(self):
        return str(self.pk)


# TODO(thenav56): Rename to MappingSessionResultStage?
# TODO(thenav56): Look into avoiding WAL for this table? As we don't need to backup this table data (UNLOGGED)
class MappingSessionResultTemp(models.Model):
    """Model storing intermediate data representing results while pulling data from firebase."""

    # Firebase id (Raw data from firebase pushed from mapswipe web/phone apps)
    project_firebase_id = models.CharField[str, str](max_length=255)
    group_firebase_id = models.CharField[str, str](max_length=255)
    contributor_user_firebase_id = models.CharField[str, str](max_length=255)
    task_firebase_id = models.CharField[str, str](max_length=255)

    # Internal reference fields (Firebase id transformed to internal ids)
    # NOTE: why BigIntegerField, check settings.py DEFAULT_AUTO_FIELD
    # NOTE: If we use ForeignKey here, then we get pending state issue with TRUNCATE
    group_id = models.BigIntegerField[int | None, int | None](blank=True, null=True)
    task_id = models.BigIntegerField[int | None, int | None](blank=True, null=True)
    contributor_user_id = models.BigIntegerField[int | None, int | None](blank=True, null=True)

    # Mapping metadata
    start_time = models.DateTimeField[datetime.datetime, datetime.datetime]()
    end_time = models.DateTimeField[datetime.datetime, datetime.datetime]()
    result = models.PositiveSmallIntegerField[int, int]()
    app_version = models.CharField[str, str](max_length=255)
    client_type: int = IntegerChoicesField(choices_enum=MappingSessionClientTypeEnum)  # type: ignore[reportAssignmentType]

    # Misc
    is_firebase_mapping_valid = models.BooleanField[bool | None, bool | None](blank=True, null=True)

    # Typing hints
    id: int

    @typing.override
    def __str__(self):
        return str(self.pk)


# TODO(thenav56): mapping_sessions_results_geometry (This was used for DIGITIZATION)
#
# CREATE TABLE IF NOT EXISTS mapping_sessions_results_geometry (
#     mapping_session_id int8,
#     task_id varchar,
#     result geometry not null,
#     PRIMARY KEY (mapping_session_id, task_id),
#     FOREIGN KEY (mapping_session_id)
#     references mapping_sessions (mapping_session_id)
# );