feat(firebase): validate data before updating the data

- add inheritance checks to FirebasePush

Author: tnagorra

apps/common/firebase.py

@@ -3,6 +3,7 @@
 import typing
 
 from firebase_admin.db import Reference as FbReference
+from pydantic import BaseModel, ConfigDict
 
 from apps.common.models import FirebasePushResource, FirebasePushStatusEnum
 from main.celery import app
@@ -14,41 +15,74 @@
 class InvalidObjectPushException(Exception): ...
 
 
-class FirebasePush[T: FirebasePushResource](abc.ABC):
-    model: type[T]
+# FIXME(tnagorra): Add inheritance_checks for model and firebase_model
+class FirebasePush[T: FirebasePushResource, K: BaseModel](abc.ABC):
+    model_class: type[T]
+    firebase_model_class: type[K]
 
     def __init__(
         self,
         obj_id: int,
     ):
         self.obj_id = obj_id
 
+    @classmethod
+    def _inheritance_checks(cls):
+        # FIXME(tnagorra): Find a better way to skip for base classes
+        if cls.__name__ == "FirebasePush":
+            # Skip check for the abstract class
+            return
+
+        missing_fields = []
+        for attr_name in [
+            "model_class",
+            "firebase_model_class",
+        ]:
+            if getattr(cls, attr_name, None) is None:
+                missing_fields.append(attr_name)
+
+        if missing_fields:
+            raise NotImplementedError(f"Please define {','.join(missing_fields)} for {cls}")
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        cls._inheritance_checks()
+
     @abc.abstractmethod
     def handle_new_object_on_firebase(self, model_obj: T, fb_reference: FbReference): ...
 
     @abc.abstractmethod
-    def handle_object_update_on_firebase(self, model_obj: T, fb_reference: FbReference): ...
+    def handle_object_update_on_firebase(self, model_obj: T, fb_obj: K, fb_reference: FbReference): ...
 
     @abc.abstractmethod
     def get_firebase_path(self, firebase_id: str, model: type[T]) -> str: ...
 
     def push(self) -> None:
-        model_obj = self.model.objects.get(id=self.obj_id)
+        model_obj = self.model_class.objects.get(id=self.obj_id)
+
+        # FIXME(tnagorra): The following fails because set firebase_push_status is not set on create/update
+        # if model_obj.firebase_push_status_enum != FirebasePushStatusEnum.PENDING:
+        #     logger.warning(
+        #         "Firebase push error: push is not required for %s",
+        #         model_obj._meta.label,
+        #         extra={"id": model_obj.pk},
+        #     )
+        #     return
 
         model_obj.update_firebase_push_status(FirebasePushStatusEnum.PROCESSING)
 
         try:
             model_ref = Config.FIREBASE_HELPER.ref(
-                self.get_firebase_path(model_obj.firebase_id, self.model),
+                self.get_firebase_path(model_obj.firebase_id, self.model_class),
             )
             fb_model: typing.Any = model_ref.get()
 
             if not model_obj.firebase_last_pushed:
                 if fb_model is not None:
                     logger.error(
-                        "Firebase creation error: existing %s found",
+                        "Firebase create error: %s already exists in Firebase",
                         model_obj._meta.label,
-                        extra={"model_obj_id": model_obj.pk},
+                        extra={"id": model_obj.pk},
                     )
                     raise InvalidObjectPushException
                 self.handle_new_object_on_firebase(model_obj, model_ref)
@@ -57,17 +91,24 @@ def push(self) -> None:
                     logger.error(
                         "Firebase update error: missing %s in Firebase",
                         model_obj._meta.label,
-                        extra={"model_obj_id": model_obj.pk},
+                        extra={"id": model_obj.pk},
                     )
                     raise InvalidObjectPushException
-                self.handle_object_update_on_firebase(model_obj, model_ref)
 
+                class RelaxedModel(self.firebase_model_class):
+                    model_config = ConfigDict(extra="ignore")
+
+                # NOTE: we want to ignore extra fields from firebase
+                valid_fb_model = RelaxedModel.model_validate(obj=fb_model)
+                valid_fb_model = self.firebase_model_class.model_validate(valid_fb_model)
+
+                self.handle_object_update_on_firebase(model_obj, valid_fb_model, model_ref)
         except InvalidObjectPushException:
             model_obj.update_firebase_push_status(FirebasePushStatusEnum.FAILED)
         except Exception:
             logger.error(
-                "Unexpected error while pushing to Firebase",
-                extra={"model_obj_id": model_obj.pk},
+                "Firebase push error: Unexpected error occurred",
+                extra={"id": model_obj.pk},
                 exc_info=True,
             )
             model_obj.update_firebase_push_status(FirebasePushStatusEnum.FAILED)

apps/contributor/firebase.py

@@ -3,6 +3,7 @@
 
 from celery import shared_task
 from firebase_admin.db import Reference as FbReference
+from pyfirebase_mapswipe import extended_models as firebase_ext_models
 from pyfirebase_mapswipe import models as firebase_models
 from pyfirebase_mapswipe import utils as firebase_utils
 
@@ -14,9 +15,9 @@
 logger = logging.getLogger(__name__)
 
 
-class FirebaseContributorTeam(FirebasePush[ContributorTeam]):
-    model_obj: ContributorTeam
-    model = ContributorTeam
+class FirebaseContributorTeam(FirebasePush[ContributorTeam, firebase_models.FbTeam]):
+    model_class = ContributorTeam
+    firebase_model_class = firebase_models.FbTeam
 
     @typing.override
     def handle_new_object_on_firebase(self, model_obj: ContributorTeam, fb_reference: FbReference):
@@ -31,7 +32,12 @@ def handle_new_object_on_firebase(self, model_obj: ContributorTeam, fb_reference
         )
 
     @typing.override
-    def handle_object_update_on_firebase(self, model_obj: ContributorTeam, fb_reference: FbReference):
+    def handle_object_update_on_firebase(
+        self,
+        model_obj: ContributorTeam,
+        fb_obj: firebase_models.FbTeam,
+        fb_reference: FbReference,
+    ):
         fb_reference.update(
             value=firebase_utils.serialize(
                 firebase_models.FbTeam(
@@ -53,17 +59,22 @@ def task(obj_id: int) -> None:
         FirebaseContributorTeam(obj_id).push()
 
 
-class FirebaseContributorUser(FirebasePush[ContributorUser]):
-    model_obj: ContributorUser
-    model = ContributorUser
+class FirebaseContributorUser(FirebasePush[ContributorUser, firebase_ext_models.FbUser]):
+    model_class = ContributorUser
+    firebase_model_class = firebase_ext_models.FbUser
 
     @typing.override
     def handle_new_object_on_firebase(self, model_obj: ContributorUser, fb_reference: FbReference):
         # FIXME(tnagorra): Use a better exception
         raise Exception("User cannot be created from mapswipe-backend")
 
     @typing.override
-    def handle_object_update_on_firebase(self, model_obj: ContributorUser, fb_reference: FbReference):
+    def handle_object_update_on_firebase(
+        self,
+        model_obj: ContributorUser,
+        fb_obj: firebase_ext_models.FbUser,
+        fb_reference: FbReference,
+    ):
         fb_reference.update(
             value=firebase_utils.serialize(
                 firebase_models.FbUserUpdateInput(

apps/project/firebase.py

@@ -13,9 +13,9 @@
 logger = logging.getLogger(__name__)
 
 
-class FirebaseOrganizationPush(FirebasePush[Organization]):
-    model_obj: Organization
-    model = Organization
+class FirebaseOrganizationPush(FirebasePush[Organization, firebase_models.FbOrganisation]):
+    model_class = Organization
+    firebase_model_class = firebase_models.FbOrganisation
 
     @typing.override
     def handle_new_object_on_firebase(self, model_obj: Organization, fb_reference: FbReference):
@@ -31,7 +31,12 @@ def handle_new_object_on_firebase(self, model_obj: Organization, fb_reference: F
         )
 
     @typing.override
-    def handle_object_update_on_firebase(self, model_obj: Organization, fb_reference: FbReference):
+    def handle_object_update_on_firebase(
+        self,
+        model_obj: Organization,
+        fb_obj: firebase_models.FbOrganisation,
+        fb_reference: FbReference,
+    ):
         fb_reference.update(
             value=firebase_utils.serialize(
                 firebase_models.FbOrganisation(