chore(firebase): sync team members to firebase while removing team member

Author: Rup-Narayan-Rajbanshi

apps/contributor/admin.py

@@ -1,5 +1,4 @@
 import typing
-from datetime import datetime
 
 from django.contrib import admin
 from django.db import transaction
@@ -9,7 +8,7 @@
 
 from apps.common.admin import ArchivableResourceAdmin
 
-from .firebase import FirebaseContributorTeam
+from .firebase import FirebaseContributorTeam, firebase_contributor_user
 from .models import ContributorTeam, ContributorUser, ContributorUserGroup, ContributorUserGroupMembership
 
 
@@ -40,6 +39,11 @@ def has_add_permission(self, *args, **kwargs):
     def has_delete_permission(self, *args, **kwargs):
         return False
 
+    @typing.override
+    def save_model(self, request, obj, form, change):
+        super().save_model(request, obj, form, change)  # type: ignore[reportAttributeAccessIssue]
+        transaction.on_commit(lambda: firebase_contributor_user.delay(obj.id))
+
 
 @admin.register(ContributorUserGroup)
 class ContributorUserGroupAdmin(DjangoQLSearchMixin, admin.ModelAdmin):
@@ -53,27 +57,18 @@ class ContributorTeamAdmin(ArchivableResourceAdmin, DjangoQLSearchMixin, admin.M
         "is_archived",
         "created_at",
         "modified_at",
-        "view_contributor_users",
+        "view_team_members",
     )
     list_filter = ("is_archived",)
 
     @typing.override
     def save_model(self, request, obj, form, change):
-        if not change:
-            obj.created_by = request.user
-        obj.modified_by = request.user
-        if obj.is_archived:
-            obj.archived_by = request.user
-            obj.archived_at = datetime.now()
-        else:
-            obj.archived_by = None
-            obj.archived_at = None
         super().save_model(request, obj, form, change)  # type: ignore[reportAttributeAccessIssue]
         transaction.on_commit(lambda: FirebaseContributorTeam.task.delay(obj.id))
 
-    def view_contributor_users(self, obj):
+    def view_team_members(self, obj):
         url = reverse("admin:contributor_contributoruser_changelist") + f"?team__id__exact={obj.id}"
-        return format_html('<a href="{}">View Contributors</a>', url)
+        return format_html('<a href="{}">View Team Members</a>', url)
 
 
 @admin.register(ContributorUserGroupMembership)

apps/contributor/firebase.py

@@ -64,11 +64,10 @@ def handle_new_object_on_firebase(self, model_obj: ContributorUser, fb_reference
 
     @typing.override
     def handle_object_update_on_firebase(self, model_obj: ContributorUser, fb_reference: FbReference):
-        team_id = str(model_obj.team.id) if model_obj.team else ""
         fb_reference.update(
             value=firebase_utils.serialize(
                 firebase_models.FbUserUpdateInput(
-                    teamId=team_id or firebase_models.UNDEFINED,
+                    teamId=model_obj.team.firebase_id if model_obj.team else firebase_models.UNDEFINED,
                 ),
             ),
         )

apps/contributor/management/commands/create_contributor_users.py

@@ -4,15 +4,50 @@
 
 from django.conf import settings
 from django.core.management.base import BaseCommand
-from django.db import transaction
+from django.utils import timezone
+from pyfirebase_mapswipe import extended_models as firebase_extended_models
+from pyfirebase_mapswipe import models as firebase_models
+from pyfirebase_mapswipe import utils as firebase_utils
 
 from apps.contributor.factories import ContributorTeamFactory, ContributorUserFactory
-from apps.contributor.firebase import FirebaseContributorTeam
+from apps.contributor.models import ContributorTeam, ContributorUser
 from apps.user.factories import UserFactory
+from main.config import Config
 
 logger = logging.getLogger(__name__)
 
 
+def push_team_to_firebase(team: ContributorTeam):
+    fb_reference = Config.FIREBASE_HELPER.ref(
+        Config.FirebaseKeys.contributor_team(team.firebase_id),
+    )
+    contributor_team_data = firebase_models.FbTeam(
+        teamName=team.name,
+        isArchived=team.is_archived,
+        teamToken=str(team.token),
+    )
+    fb_reference.set(
+        value=firebase_utils.serialize(contributor_team_data),
+    )
+
+
+def push_team_member_to_firebase(member: ContributorUser):
+    fb_reference = Config.FIREBASE_HELPER.ref(
+        Config.FirebaseKeys.contributor_user(member.firebase_id),
+    )
+    team_member_data = firebase_extended_models.FbUser(
+        userName=member.username,
+        username=member.username,
+        userNameKey=member.username.lower(),
+        usernameKey=member.username.lower(),
+        teamId=member.team.firebase_id if member.team else firebase_models.UNDEFINED,
+        created=timezone.now(),
+    )
+    fb_reference.set(
+        value=firebase_utils.serialize(team_member_data),
+    )
+
+
 class Command(BaseCommand):
     help = "Create dummy contributor users. Also sync these users to firebase"
 
@@ -26,13 +61,17 @@ def handle(self, *args, **options):
         user_resources = dict(
             created_by=user,
             modified_by=user,
+            firebase_last_pushed=timezone.now(),
         )
         team_a, team_b = ContributorTeamFactory.create_batch(2, **user_resources)
         for team in [team_a, team_b]:
-            transaction.on_commit(lambda team_id=team.pk: FirebaseContributorTeam.task.delay(team_id))
+            push_team_to_firebase(team)
 
-        ContributorUserFactory.create_batch(5, team=team_a)
-        ContributorUserFactory.create_batch(5, team=team_b)
-        ContributorUserFactory.create_batch(20)
+        team_a_members = ContributorUserFactory.create_batch(5, team=team_a, firebase_last_pushed=timezone.now())
+        team_b_members = ContributorUserFactory.create_batch(5, team=team_b, firebase_last_pushed=timezone.now())
+        no_team_members = ContributorUserFactory.create_batch(5, firebase_last_pushed=timezone.now())
+        for team_members in [team_a_members, team_b_members, no_team_members]:
+            for member in team_members:
+                push_team_member_to_firebase(member)
 
         logger.info("Contributor users created successfully")

firebase

@@ -300,7 +300,7 @@ type ContributorSwipeStatType {
 }
 
 """
-ContributorTeam(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, name, token)
+ContributorTeam(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, token)
 """
 input ContributorTeamFilter {
   id: IDBaseFilterLookup
@@ -318,7 +318,7 @@ input ContributorTeamOrder {
 }
 
 """
-ContributorTeam(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, name, token)
+ContributorTeam(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, token)
 """
 type ContributorTeamType implements UserResourceTypeMixin {
   clientId: String!
@@ -353,7 +353,7 @@ type ContributorTimeStatType {
 }
 
 """
-ContributorUser(id, old_id, firebase_push_status, firebase_last_pushed, canonical_id, user_id, team, username, created_at, modified_at)
+ContributorUser(id, old_id, firebase_id, firebase_push_status, firebase_last_pushed, user_id, team, username, created_at, modified_at)
 """
 input ContributorUserFilter {
   id: IDBaseFilterLookup
@@ -376,7 +376,7 @@ type ContributorUserFilteredStats implements ContributorUserUserGroupBaseFilterS
 }
 
 """
-ContributorUserGroup(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, name, description)
+ContributorUserGroup(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, description)
 """
 input ContributorUserGroupCreateInput {
   clientId: String!
@@ -385,7 +385,7 @@ input ContributorUserGroupCreateInput {
 }
 
 """
-ContributorUserGroup(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, name, description)
+ContributorUserGroup(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, description)
 """
 input ContributorUserGroupFilter {
   id: IDBaseFilterLookup
@@ -483,7 +483,7 @@ type ContributorUserGroupStatsType {
 }
 
 """
-ContributorUserGroup(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, name, description)
+ContributorUserGroup(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, description)
 """
 type ContributorUserGroupType implements UserResourceTypeMixin {
   clientId: String!
@@ -518,7 +518,7 @@ type ContributorUserGroupTypeOffsetPaginated {
 }
 
 """
-ContributorUserGroup(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, name, description)
+ContributorUserGroup(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, description)
 """
 input ContributorUserGroupUpdateInput {
   clientId: String!
@@ -560,7 +560,7 @@ type ContributorUserStats {
 }
 
 """
-ContributorUser(id, old_id, firebase_push_status, firebase_last_pushed, canonical_id, user_id, team, username, created_at, modified_at)
+ContributorUser(id, old_id, firebase_id, firebase_push_status, firebase_last_pushed, user_id, team, username, created_at, modified_at)
 """
 type ContributorUserType {
   id: ID!
@@ -845,7 +845,7 @@ enum Ordering {
 }
 
 """
-Organization(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, name, description, abbreviation, unique_name)
+Organization(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, description, abbreviation, unique_name)
 """
 input OrganizationCreateInput {
   clientId: String!
@@ -855,7 +855,7 @@ input OrganizationCreateInput {
 }
 
 """
-Organization(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, name, description, abbreviation, unique_name)
+Organization(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, description, abbreviation, unique_name)
 """
 input OrganizationFilter {
   id: IDBaseFilterLookup
@@ -878,7 +878,7 @@ type OrganizationSwipeStatsType {
 }
 
 """
-Organization(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, name, description, abbreviation, unique_name)
+Organization(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, description, abbreviation, unique_name)
 """
 type OrganizationType implements UserResourceTypeMixin {
   clientId: String!
@@ -912,7 +912,7 @@ type OrganizationTypeOffsetPaginated {
 }
 
 """
-Organization(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, name, description, abbreviation, unique_name)
+Organization(id, client_id, created_at, modified_at, created_by, modified_by, is_archived, archived_at, archived_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, name, description, abbreviation, unique_name)
 """
 input OrganizationUpdateInput {
   clientId: String!
@@ -928,7 +928,7 @@ enum OverlayLayerTypeEnum {
 }
 
 """
-Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
+Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
 """
 input ProcessedProjectUpdateInput {
   clientId: String!
@@ -1028,7 +1028,7 @@ type ProjectAssetTypeOffsetPaginated {
 }
 
 """
-Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
+Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
 """
 input ProjectCreateInput {
   clientId: String!
@@ -1074,7 +1074,7 @@ type ProjectCustomSubOption {
 }
 
 """
-Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
+Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
 """
 input ProjectFilter {
   id: IDBaseFilterLookup
@@ -1290,7 +1290,7 @@ input ProjectStatusEnumFilterLookup {
 }
 
 """
-Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
+Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
 """
 type ProjectType implements UserResourceTypeMixin {
   clientId: String!
@@ -1449,7 +1449,7 @@ type ProjectTypeSwipeStatsType {
 }
 
 """
-Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_push_status, firebase_last_pushed, canonical_id, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
+Project(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, project_type, requesting_organization, topic, region, project_number, look_for, additional_info_url, description, image, tutorial, verification_number, group_size, max_tasks_per_user, project_type_specifics, project_type_specific_output, centroid, is_featured, status, processing_status, team, is_private, progress, required_results, result_count)
 """
 input ProjectUpdateInput {
   clientId: String!
@@ -1703,7 +1703,7 @@ type TutorialAssetTypeOffsetPaginated {
 }
 
 """
-Tutorial(id, client_id, created_at, modified_at, created_by, modified_by, old_id, project, name, status)
+Tutorial(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, project, name, status)
 """
 input TutorialCreateInput {
   clientId: String!
@@ -1714,7 +1714,7 @@ input TutorialCreateInput {
 }
 
 """
-Tutorial(id, client_id, created_at, modified_at, created_by, modified_by, old_id, project, name, status)
+Tutorial(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, project, name, status)
 """
 input TutorialFilter {
   id: IDBaseFilterLookup
@@ -2003,7 +2003,7 @@ input TutorialTaskUpdateInput {
 }
 
 """
-Tutorial(id, client_id, created_at, modified_at, created_by, modified_by, old_id, project, name, status)
+Tutorial(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, project, name, status)
 """
 type TutorialType implements UserResourceTypeMixin {
   clientId: String!
@@ -2038,7 +2038,7 @@ type TutorialTypeOffsetPaginated {
 }
 
 """
-Tutorial(id, client_id, created_at, modified_at, created_by, modified_by, old_id, project, name, status)
+Tutorial(id, client_id, created_at, modified_at, created_by, modified_by, old_id, firebase_id, firebase_push_status, firebase_last_pushed, project, name, status)
 """
 input TutorialUpdateInput {
   clientId: String!