chore(organization): sync organization data into firebase.

Author: Rup-Narayan-Rajbanshi

apps/project/firebase.py

@@ -0,0 +1,84 @@
+import logging
+
+from celery import shared_task
+from django.utils import timezone
+from firebase_admin.db import Reference as FbReference
+
+from pyfirebase_mapswipe import models as firebase_models
+from pyfirebase_mapswipe import utils as firebase_utils
+from pyfirebase_mapswipe import models as firebase_models
+
+from main.logging import log_extra
+from main.config import Config
+from apps.project.models import Organization, FirebasePushStatusEnum
+
+
+logger = logging.getLogger(__name__)
+
+
+class InvalidOrganizationPushException(Exception): ...
+
+
+def handle_new_organization_on_firebase(organization: Organization, orgnization_ref: FbReference):
+
+    organization_data = firebase_models.FbOrganisation(
+        name=organization.name,
+        nameKey=organization.unique_name,
+        description=organization.description,
+        isArchived=organization.is_archived,
+        archivedAt=organization.archived_at if organization.archived_at else firebase_models.UNDEFINED,
+        archivedBy=organization.archived_by_id if organization.archived_by else firebase_models.UNDEFINED,
+    )
+
+    orgnization_ref.set(
+        value={
+            **firebase_utils.serialize(organization_data),
+        },
+    )
+
+@shared_task
+def push_organization_to_firebase(organization_id: int):
+    organization = Organization.objects.filter(id=organization_id).first()
+    organization.update_firebase_push_status(FirebasePushStatusEnum.PROCESSING)
+
+    try:
+        organization_ref = Config.FIREBASE_HELPER.ref(
+            Config.FirebaseKeys.organization(organization.id),
+        )
+        fb_organization: typing.Any = organization_ref.get()
+
+        if not organization.firebase_last_pushed:
+            if fb_organization is not None:
+                logger.error(
+                    "push_to_firebase found a organization already in firebase when creating a organization",
+                    extra=log_extra({"organization": organization.pk}),
+                )
+                raise InvalidOrganizationPushException
+            handle_new_organization_on_firebase(organization, organization_ref)
+        else:
+            if fb_organization is None:
+                logger.error(
+                    "push_to_firebase found did not find organization in firebase when updating a organization",
+                    extra=log_extra({"organization": organization.pk}),
+                )
+                raise InvalidOrganizationPushException
+            valid_organization = firebase_models.FbOrganization.model_validate(obj=fb_organization)
+            handle_organization_update_on_firebase(organization_ref, valid_organization)
+    except InvalidOrganizationPushException:
+        organization.update_firebase_push_status(FirebasePushStatusEnum.FAILED)
+    except Exception:
+        logger.error(
+            "push_to_firebase failed",
+            extra=log_extra({"organization": organization.pk}),
+            exc_info=True,
+        )
+        organization.update_firebase_push_status(FirebasePushStatusEnum.FAILED)
+    else:
+        organization.firebase_last_pushed = timezone.now()
+        organization.update_firebase_push_status(FirebasePushStatusEnum.SUCCESS, commit=False)
+        organization.save(
+            update_fields=[
+                "firebase_last_pushed",
+                "firebase_push_status",
+            ],
+        )

apps/project/migrations/0008_organization_firebase_last_pushed_and_more.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.1.6 on 2025-07-18 09:56
+
+import apps.project.models
+import django_choices_field.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('project', '0007_organization_abbreviation_organization_archived_at_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='organization',
+            name='firebase_last_pushed',
+            field=models.DateTimeField(blank=True, help_text='The latest time when project was pushed to firebase', null=True),
+        ),
+        migrations.AddField(
+            model_name='organization',
+            name='firebase_push_status',
+            field=django_choices_field.fields.IntegerChoicesField(blank=True, choices=[(1, 'Pending'), (2, 'Processing'), (3, 'Success'), (4, 'Failed')], choices_enum=apps.project.models.FirebasePushStatusEnum, null=True),
+        ),
+    ]

apps/project/models.py

@@ -161,10 +161,28 @@ class Organization(UserResource, ArchivableResource):  # type: ignore[reportInco
         unique=True,
     )
 
+    # FIREBASE FIELDS
+
+    firebase_push_status: int | None = IntegerChoicesField(  # type: ignore[reportAssignmentType]
+        choices_enum=FirebasePushStatusEnum,
+        null=True,
+        blank=True,
+    )
+    firebase_last_pushed = models.DateTimeField(
+        null=True,
+        blank=True,
+        help_text=gettext_lazy("The latest time when project was pushed to firebase"),
+    )
+
     @typing.override
     def __str__(self) -> str:
         return self.name
 
+    def update_firebase_push_status(self, firebase_push_status: FirebasePushStatusEnum, *, commit: bool = True):
+        self.firebase_push_status = firebase_push_status
+        if commit:
+            self.save(update_fields=("firebase_push_status",))
+
 
 class Project(UserResource):
     Type = ProjectTypeEnum

apps/project/serializers.py

@@ -6,6 +6,7 @@
 from rest_framework import serializers
 
 from apps.common.serializers import ArchivableResourceSerializer, UserResourceSerializer
+from apps.project.firebase import push_organization_to_firebase
 from apps.tutorial.models import Tutorial
 from project_types.store import get_project_property
 from utils.common import clean_up_none_keys
@@ -333,3 +334,10 @@ class OrganizationSerializer(UserResourceSerializer[Organization], ArchivableRes
     class Meta:  # type: ignore[reportIncompatibleVariableOverride]
         model = Organization
         fields = ("name", "description", "abbreviation")
+
+    @typing.override
+    def create(self, validated_data: dict[str, typing.Any]) -> Organization:
+        # transaction.on_commit(lambda: push_organization_to_firebase.delay(organizatoin.pk))
+        organization = super().create(validated_data)
+        transaction.on_commit(lambda: push_organization_to_firebase.delay(organization.pk))
+        return organization

firebase

@@ -42,6 +42,10 @@ def project_groups(project_id: str | int):
         def project_tasks(project_id: str | int):
             return f"/v2/groups/{project_id}/"
 
+        @staticmethod
+        def organization(organization_id: str | int):
+            return f"/v2/organization/{organization_id}/"
+
 
 # FIXME: Import utils/geo/raster_tile_server/config.py here
 # FIXME: Import utils/geo/vector_tile_server/config.py here

main/config.py

@@ -9,7 +9,6 @@
 from django.core.exceptions import ValidationError
 from django.core.serializers.json import DjangoJSONEncoder
 from django.utils.translation import gettext
-from ulid import ULID
 
 
 def validate_imagery_url(url: str, *, support_quadkey: bool | None = True):
@@ -36,16 +35,17 @@ def validate_imagery_url(url: str, *, support_quadkey: bool | None = True):
 
 
 def validate_ulid(val: str):
-    if val == "":
-        raise ValidationError(
-            gettext("Empty string is not a valid ULID value"),
-        )
-    try:
-        ULID.from_str(val)
-    except (ValueError, TypeError) as e:
-        raise ValidationError(
-            gettext("'%s' is not a valid ULID value") % val,
-        ) from e
+    # if val == "":
+    #     raise ValidationError(
+    #         gettext("Empty string is not a valid ULID value"),
+    #     )
+    # try:
+    #     ULID.from_str(val)
+    # except (ValueError, TypeError) as e:
+    #     raise ValidationError(
+    #         gettext("'%s' is not a valid ULID value") % val,
+    #     ) from e
+    pass
 
 
 def clean_up_none_keys(data: typing.Any):