feat: user display name (#1179)

* feat: user display name for the entire system

* feat: update issue activity to remove emails

* dev: update to display name wherever assignees__email and member__email

* dev: update display names on issue activity and the user script

* dev: update display_name function to generate display_name from email

* dev: add email for test purpose

* dev: set default display name for the user

* dev: add migration script and default value

* dev: annotate with assignees_id

* dev: return assignees id

* dev: display name for the profile

* dev: project members endpoint

* dev: url update

* dev: trailing /

* dev: update workspace member serializer

* fix: activity for assignees

apiserver/plane/api/serializers/__init__.py

@@ -1,10 +1,5 @@
 from .base import BaseSerializer
-from .people import (
-    ChangePasswordSerializer,
-    ResetPasswordSerializer,
-    TokenSerializer,
-)
-from .user import UserSerializer, UserLiteSerializer
+from .user import UserSerializer, UserLiteSerializer, ChangePasswordSerializer, ResetPasswordSerializer, UserAdminLiteSerializer
 from .workspace import (
     WorkSpaceSerializer,
     WorkSpaceMemberSerializer,
@@ -12,6 +7,7 @@ from .workspace import (
     WorkSpaceMemberInviteSerializer,
     WorkspaceLiteSerializer,
     WorkspaceThemeSerializer,
+    WorkspaceMemberAdminSerializer,
 )
 from .project import (
     ProjectSerializer,

apiserver/plane/api/serializers/people.py

@@ -1,57 +0,0 @@
-from rest_framework.serializers import (
-    ModelSerializer,
-    Serializer,
-    CharField,
-    SerializerMethodField,
-)
-from rest_framework.authtoken.models import Token
-from rest_framework_simplejwt.tokens import RefreshToken
-
-
-from plane.db.models import User
-
-
-class UserSerializer(ModelSerializer):
-    class Meta:
-        model = User
-        fields = "__all__"
-        extra_kwargs = {"password": {"write_only": True}}
-
-
-class ChangePasswordSerializer(Serializer):
-    model = User
-
-    """
-    Serializer for password change endpoint.
-    """
-    old_password = CharField(required=True)
-    new_password = CharField(required=True)
-
-
-class ResetPasswordSerializer(Serializer):
-    model = User
-
-    """
-    Serializer for password change endpoint.
-    """
-    new_password = CharField(required=True)
-    confirm_password = CharField(required=True)
-
-
-class TokenSerializer(ModelSerializer):
-
-    user = UserSerializer()
-    access_token = SerializerMethodField()
-    refresh_token = SerializerMethodField()
-
-    def get_access_token(self, obj):
-        refresh_token = RefreshToken.for_user(obj.user)
-        return str(refresh_token.access_token)
-
-    def get_refresh_token(self, obj):
-        refresh_token = RefreshToken.for_user(obj.user)
-        return str(refresh_token)
-
-    class Meta:
-        model = Token
-        fields = "__all__"

apiserver/plane/api/serializers/project.py

@@ -7,7 +7,7 @@ from rest_framework import serializers
 # Module imports
 from .base import BaseSerializer
 from plane.api.serializers.workspace import WorkSpaceSerializer, WorkspaceLiteSerializer
-from plane.api.serializers.user import UserLiteSerializer
+from plane.api.serializers.user import UserLiteSerializer, UserAdminLiteSerializer
 from plane.db.models import (
     Project,
     ProjectMember,
@@ -110,6 +110,17 @@ class ProjectMemberSerializer(BaseSerializer):
         fields = "__all__"
 
 
+class ProjectMemberAdminSerializer(BaseSerializer):
+    workspace = WorkspaceLiteSerializer(read_only=True)
+    project = ProjectLiteSerializer(read_only=True)
+    member = UserAdminLiteSerializer(read_only=True)
+
+
+    class Meta:
+        model = ProjectMember
+        fields = "__all__"
+
+
 class ProjectMemberInviteSerializer(BaseSerializer):
     project = ProjectLiteSerializer(read_only=True)
     workspace = WorkspaceLiteSerializer(read_only=True)

apiserver/plane/api/serializers/user.py

@@ -1,3 +1,6 @@
+# Third party imports
+from rest_framework import serializers
+
 # Module import
 from .base import BaseSerializer
 from plane.db.models import User
@@ -37,11 +40,50 @@ class UserLiteSerializer(BaseSerializer):
             "id",
             "first_name",
             "last_name",
-            "email",
             "avatar",
             "is_bot",
+            "display_name",
         ]
         read_only_fields = [
             "id",
             "is_bot",
         ]
+
+
+class UserAdminLiteSerializer(BaseSerializer):
+
+    class Meta:
+        model = User
+        fields = [
+            "id",
+            "first_name",
+            "last_name",
+            "avatar",
+            "is_bot",
+            "display_name",
+            "email",
+        ]
+        read_only_fields = [
+            "id",
+            "is_bot",
+        ]
+
+
+class ChangePasswordSerializer(serializers.Serializer):
+    model = User
+
+    """
+    Serializer for password change endpoint.
+    """
+    old_password = serializers.CharField(required=True)
+    new_password = serializers.CharField(required=True)
+
+
+class ResetPasswordSerializer(serializers.Serializer):
+    model = User
+
+    """
+    Serializer for password change endpoint.
+    """
+    new_password = serializers.CharField(required=True)
+    confirm_password = serializers.CharField(required=True)

apiserver/plane/api/serializers/workspace.py

@@ -3,7 +3,7 @@ from rest_framework import serializers
 
 # Module imports
 from .base import BaseSerializer
-from .user import UserLiteSerializer
+from .user import UserLiteSerializer, UserAdminLiteSerializer
 
 from plane.db.models import (
     User,
@@ -33,10 +33,30 @@ class WorkSpaceSerializer(BaseSerializer):
             "owner",
         ]
 
+class WorkspaceLiteSerializer(BaseSerializer):
+    class Meta:
+        model = Workspace
+        fields = [
+            "name",
+            "slug",
+            "id",
+        ]
+        read_only_fields = fields
+
+
 
 class WorkSpaceMemberSerializer(BaseSerializer):
     member = UserLiteSerializer(read_only=True)
-    workspace = WorkSpaceSerializer(read_only=True)
+    workspace = WorkspaceLiteSerializer(read_only=True)
+
+    class Meta:
+        model = WorkspaceMember
+        fields = "__all__"
+
+
+class WorkspaceMemberAdminSerializer(BaseSerializer):
+    member = UserAdminLiteSerializer(read_only=True)
+    workspace = WorkspaceLiteSerializer(read_only=True)
 
     class Meta:
         model = WorkspaceMember
@@ -101,17 +121,6 @@ class TeamSerializer(BaseSerializer):
             return super().update(instance, validated_data)
 
 
-class WorkspaceLiteSerializer(BaseSerializer):
-    class Meta:
-        model = Workspace
-        fields = [
-            "name",
-            "slug",
-            "id",
-        ]
-        read_only_fields = fields
-
-
 class WorkspaceThemeSerializer(BaseSerializer):
     class Meta:
         model = WorkspaceTheme