π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
feat: workspace user preference api (#6497)
Sangeetha6a8d3202b7d5
diff --git a/apiserver/plane/app/serializers/workspace.py b/apiserver/plane/app/serializers/workspace.pyindex 5d8e5a4d5e..68e1260851 100644--- a/apiserver/plane/app/serializers/workspace.py+++ b/apiserver/plane/app/serializers/workspace.py@@ -22,6 +22,7 @@ from plane.db.models import (ProjectMember,WorkspaceHomePreference,Sticky,+ WorkspaceUserPreference,)from plane.utils.constants import RESTRICTED_WORKSPACE_SLUGS@@ -258,3 +259,10 @@ class StickySerializer(BaseSerializer):fields = "__all__"read_only_fields = ["workspace", "owner"]extra_kwargs = {"name": {"required": False}}+++class WorkspaceUserPreferenceSerializer(BaseSerializer):+ class Meta:+ model = WorkspaceUserPreference+ fields = ["key", "is_pinned", "sort_order"]+ read_only_fields = ["workspace", "created_by", "updated_by"]diff --git a/apiserver/plane/app/urls/workspace.py b/apiserver/plane/app/urls/workspace.pyindex 90fdf64c27..ea81d1ef73 100644--- a/apiserver/plane/app/urls/workspace.py+++ b/apiserver/plane/app/urls/workspace.py@@ -31,6 +31,7 @@ from plane.app.views import (UserRecentVisitViewSet,WorkspaceHomePreferenceViewSet,WorkspaceStickyViewSet,+ WorkspaceUserPreferenceViewSet,)@@ -258,4 +259,15 @@ urlpatterns = [),name="workspace-sticky",),+ # User Preference+ path(+ "workspaces/<str:slug>/user-preferences/",+ WorkspaceUserPreferenceViewSet.as_view(),+ name="workspace-user-preference",+ ),+ path(+ "workspaces/<str:slug>/user-preferences/<str:key>/",+ WorkspaceUserPreferenceViewSet.as_view(),+ name="workspace-user-preference",+ ),]diff --git a/apiserver/plane/app/views/__init__.py b/apiserver/plane/app/views/__init__.pyindex 6c49ca9a84..cb10c879f4 100644--- a/apiserver/plane/app/views/__init__.py+++ b/apiserver/plane/app/views/__init__.py@@ -48,6 +48,7 @@ from .workspace.favorite import (WorkspaceFavoriteGroupEndpoint,)from .workspace.recent_visit import UserRecentVisitViewSet+from .workspace.user_preference import WorkspaceUserPreferenceViewSetfrom .workspace.member import (WorkSpaceMemberViewSet,diff --git a/apiserver/plane/app/views/workspace/user_preference.py b/apiserver/plane/app/views/workspace/user_preference.pynew file mode 100644index 0000000000..4c245b8f8d--- /dev/null+++ b/apiserver/plane/app/views/workspace/user_preference.py@@ -0,0 +1,74 @@+# Module imports+from ..base import BaseAPIView+from plane.db.models.workspace import WorkspaceUserPreference+from plane.app.serializers.workspace import WorkspaceUserPreferenceSerializer+from plane.app.permissions import allow_permission, ROLE+from plane.db.models import Workspace+++# Third party imports+from rest_framework.response import Response+from rest_framework import status+++class WorkspaceUserPreferenceViewSet(BaseAPIView):+ model = WorkspaceUserPreference++ def get_serializer_class(self):+ return WorkspaceUserPreferenceSerializer++ @allow_permission([ROLE.ADMIN, ROLE.MEMBER, ROLE.GUEST], level="WORKSPACE")+ def get(self, request, slug):+ workspace = Workspace.objects.get(slug=slug)++ get_preference = WorkspaceUserPreference.objects.filter(+ user=request.user, workspace_id=workspace.id+ )++ create_preference_keys = []++ keys = [key for key, _ in WorkspaceUserPreference.UserPreferenceKeys.choices]++ for preference in keys:+ if preference not in get_preference.values_list("key", flat=True):+ create_preference_keys.append(preference)++ preference = WorkspaceUserPreference.objects.bulk_create(+ [+ WorkspaceUserPreference(+ key=key, user=request.user, workspace=workspace+ )+ for key in create_preference_keys+ ],+ batch_size=10,+ ignore_conflicts=True,+ )++ preference = WorkspaceUserPreference.objects.filter(+ user=request.user, workspace_id=workspace.id+ )++ return Response(+ preference.values("key", "is_pinned", "sort_order"),+ status=status.HTTP_200_OK,+ )++ @allow_permission([ROLE.ADMIN, ROLE.MEMBER, ROLE.GUEST], level="WORKSPACE")+ def patch(self, request, slug, key):+ preference = WorkspaceUserPreference.objects.filter(+ key=key, workspace__slug=slug, user=request.user+ ).first()++ if preference:+ serializer = WorkspaceUserPreferenceSerializer(+ preference, data=request.data, partial=True+ )++ if serializer.is_valid():+ serializer.save()+ return Response(serializer.data, status=status.HTTP_200_OK)+ return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)++ return Response(+ {"detail": "Preference not found"}, status=status.HTTP_404_NOT_FOUND+ )diff --git a/apiserver/plane/db/models/__init__.py b/apiserver/plane/db/models/__init__.pyindex 436ed5148b..8e20a8d671 100644--- a/apiserver/plane/db/models/__init__.py+++ b/apiserver/plane/db/models/__init__.py@@ -69,7 +69,8 @@ from .workspace import (WorkspaceTheme,WorkspaceUserProperties,WorkspaceUserLink,- WorkspaceHomePreference+ WorkspaceHomePreference,+ WorkspaceUserPreference,)from .favorite import UserFavoritediff --git a/apiserver/plane/db/models/workspace.py b/apiserver/plane/db/models/workspace.pyindex ddeb50fcf5..cb80fa056b 100644--- a/apiserver/plane/db/models/workspace.py+++ b/apiserver/plane/db/models/workspace.py@@ -388,7 +388,6 @@ class WorkspaceHomePreference(BaseModel):return f"{self.workspace.name} {self.user.email} {self.key}"-class WorkspaceUserPreference(BaseModel):"""Preference for the workspace for a user"""@@ -396,6 +395,8 @@ class WorkspaceUserPreference(BaseModel):CYCLES = "cycles", "Cycles"VIEWS = "views", "Views"ANALYTICS = "analytics", "Analytics"+ TEAMS = "teams", "Teams"+ INITIATIVES = "initiatives", "Initiatives"PROJECTS = "projects", "Projects"workspace = models.ForeignKey(