BA-1808 [BE] Add basic profile information to JWT claims

baseapp-auth/baseapp_auth/graphql/object_types.py

@@ -49,7 +49,7 @@ def resolve_profiles(self, info):
                 return Profile.objects.none()
             return Profile.objects.filter(
                 Q(owner_id=info.context.user.id) | Q(members__user_id=info.context.user.id)
-            )
+            ).distinct()
 
     interfaces += (UserProfiles, ProfileInterface)
 

baseapp-auth/baseapp_auth/rest_framework/users/serializers.py

@@ -1,6 +1,9 @@
 from datetime import timedelta
 
+import swapper
 from baseapp_auth.utils.referral_utils import get_user_referral_model, use_referrals
+from baseapp_core.graphql import get_obj_relay_id
+from baseapp_core.rest_framework.fields import ThumbnailImageField
 from baseapp_core.rest_framework.serializers import ModelSerializer
 from baseapp_referrals.utils import get_referral_code, get_user_from_referral_code
 from constance import config
@@ -14,13 +17,41 @@
 from .fields import AvatarField
 
 User = get_user_model()
+Profile = swapper.load_model("baseapp_profiles", "Profile")
 
 from baseapp_auth.password_validators import apply_password_validators
 
 
+class JWTProfileSerializer(serializers.ModelSerializer):
+    """
+    Serializes minimal profile data that will be attached to the JWT token as claim
+    """
+
+    id = serializers.SerializerMethodField()
+    url_path = serializers.SerializerMethodField()
+    image = ThumbnailImageField(required=False, sizes={"small": (100, 100)})
+
+    class Meta:
+        model = Profile
+        fields = ("id", "name", "image", "url_path")
+
+    def get_id(self, profile):
+        return get_obj_relay_id(profile)
+
+    def get_url_path(self, profile):
+        path_obj = getattr(profile, "url_path", None)
+        return getattr(path_obj, "path", None)
+
+    def to_representation(self, profile):
+        data = super().to_representation(profile)
+        if data["image"] is not None:
+            data["image"] = data["image"]["small"]
+        return data
+
+
 class UserBaseSerializer(ModelSerializer):
-    name = serializers.CharField(required=False, allow_blank=True, source="first_name")
-    avatar = AvatarField(required=False, allow_null=True)
+    profile = JWTProfileSerializer(read_only=True)
+    avatar = AvatarField(required=False, allow_null=True, write_only=True)
     email_verification_required = serializers.SerializerMethodField()
     referral_code = serializers.SerializerMethodField()
     referred_by_code = serializers.CharField(required=False, allow_blank=True, write_only=True)
@@ -29,15 +60,15 @@ class Meta:
         model = User
         fields = (
             "id",
+            "avatar",
+            "profile",
             "email",
             "is_email_verified",
             "email_verification_required",
             "new_email",
             "is_new_email_confirmed",
             "referral_code",
             "referred_by_code",
-            "avatar",
-            "name",
             "phone_number",
             "preferred_language",
         )

baseapp-auth/baseapp_auth/tests/integration/test_login.py

@@ -134,7 +134,7 @@ def test_jwt_token_contains_user_data(self, client, data):
 
         assert validated_token["id"] == user.id
         assert validated_token["email"] == user.email
-        assert validated_token["name"] == user.first_name
+        assert validated_token["profile"]["name"] == user.first_name + " " + user.last_name
 
 
 class TestLoginMfaAuthToken(TestLoginBase):

baseapp-auth/baseapp_auth/tests/integration/test_users.py

@@ -42,28 +42,35 @@ def test_object_keys_for_own_user(self, user_client):
         h.responseOk(r)
         expected = {
             "id",
+            "profile",
             "email",
             "is_email_verified",
             "email_verification_required",
             "new_email",
             "is_new_email_confirmed",
             "referral_code",
-            "avatar",
-            "name",
             "phone_number",
             "preferred_language",
         }
         actual = set(r.data.keys())
         assert expected == actual
 
+        profile_expected = {"id", "name", "image", "url_path"}
+        profile_actual = set(r.data["profile"].keys())
+        assert profile_expected == profile_actual
+
     def test_object_keys_for_other_user(self, user_client):
         user = UserFactory()
         r = user_client.get(self.reverse(kwargs={"pk": user.pk}))
         h.responseOk(r)
-        expected = {"id", "avatar", "name", "phone_number"}
+        expected = {"id", "profile", "phone_number"}
         actual = set(r.data.keys())
         assert expected == actual
 
+        profile_expected = {"id", "name", "image", "url_path"}
+        profile_actual = set(r.data["profile"].keys())
+        assert profile_expected == profile_actual
+
 
 class TestUsersUpdate(ApiMixin):
     view_name = "users-detail"
@@ -138,7 +145,7 @@ def test_can_upload_avatar(self, user_client, image_base64):
         r = user_client.patch(self.reverse(kwargs={"pk": user_client.user.pk}), data)
         h.responseOk(r)
         user_client.user.profile.refresh_from_db()
-        assert user_client.user.profile.image is not None
+        assert bool(user_client.user.profile.image) is True
 
     def test_can_clear_avatar(self, user_client, image_djangofile):
         user_client.user.profile.image = image_djangofile
@@ -167,7 +174,7 @@ def test_can_search(self, user_client):
         r = user_client.get(self.reverse(query_params={"q": "John Smith"}))
         h.responseOk(r)
         assert len(r.data["results"]) == 1
-        assert r.data["results"][0]["name"] == "John"
+        assert r.data["results"][0]["profile"]["name"] == "John Smith"
 
 
 class TestUsersMe(ApiMixin):

baseapp-auth/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = baseapp_auth
-version = 0.4.9
+version = 0.4.10
 description = BaseApp Auth
 long_description = file: README.md
 url = https://github.com/silverlogic/baseapp-backend

baseapp-profiles/baseapp_profiles/managers.py

@@ -3,7 +3,7 @@
 
 class ProfileManager(models.Manager):
     def filter_user_profiles(self, user):
-        return self.filter(models.Q(members__user=user) | models.Q(owner=user))
+        return self.filter(models.Q(members__user=user) | models.Q(owner=user)).distinct()
 
     def get_if_member(self, user, **kwargs):
         if user.is_superuser:

baseapp-profiles/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = baseapp_profiles
-version = 0.3.2
+version = 0.3.3
 description = BaseApp Profiles
 long_description = file: README.md
 long_description_content_type = text/markdown