Merge branch 'chore/api_endpoints' of github.com:makeplane/plane into develop-deploy

apiserver/plane/api/serializers/__init__.py

@@ -9,8 +9,9 @@ from .issue import (
     IssueCommentSerializer,
     IssueAttachmentSerializer,
     IssueActivitySerializer,
+    IssueExpandSerializer,
 )
 from .state import StateLiteSerializer, StateSerializer
-from .cycle import CycleSerializer, CycleIssueSerializer
-from .module import ModuleSerializer, ModuleIssueSerializer
+from .cycle import CycleSerializer, CycleIssueSerializer, CycleLiteSerializer
+from .module import ModuleSerializer, ModuleIssueSerializer, ModuleLiteSerializer
 from .inbox import InboxIssueSerializer

apiserver/plane/api/serializers/cycle.py

@@ -46,4 +46,11 @@ class CycleIssueSerializer(BaseSerializer):
             "workspace",
             "project",
             "cycle",
-        ]
+        ]
+
+
+class CycleLiteSerializer(BaseSerializer):
+
+    class Meta:
+        model = Cycle
+        fields = "__all__"

apiserver/plane/api/serializers/issue.py

@@ -19,6 +19,8 @@ from plane.db.models import (
     ProjectMember,
 )
 from .base import BaseSerializer
+from .cycle import CycleSerializer, CycleLiteSerializer
+from .module import ModuleSerializer, ModuleLiteSerializer
 
 
 class IssueSerializer(BaseSerializer):
@@ -309,3 +311,42 @@ class IssueActivitySerializer(BaseSerializer):
             "created_by",
             "updated_by",
         ]
+
+
+class CycleIssueSerializer(BaseSerializer):
+    cycle = CycleSerializer(read_only=True)
+
+    class Meta:
+        fields = [
+            "cycle",
+        ]
+
+
+class ModuleIssueSerializer(BaseSerializer):
+    module = ModuleSerializer(read_only=True)
+
+    class Meta:
+        fields = [
+            "module",
+        ]
+
+
+class IssueExpandSerializer(BaseSerializer):
+    # Serialize the related cycle. It's a OneToOne relation.
+    cycle = CycleLiteSerializer(source="issue_cycle.cycle", read_only=True)
+
+    # Serialize the related module. It's a OneToOne relation.
+    module = ModuleLiteSerializer(source="issue_module.module", read_only=True)
+
+    class Meta:
+        model = Issue
+        fields = "__all__"
+        read_only_fields = [
+            "id",
+            "workspace",
+            "project",
+            "created_by",
+            "updated_by",
+            "created_at",
+            "updated_at",
+        ]

apiserver/plane/api/serializers/module.py

@@ -21,7 +21,6 @@ class ModuleSerializer(BaseSerializer):
         write_only=True,
         required=False,
     )
-    is_favorite = serializers.BooleanField(read_only=True)
     total_issues = serializers.IntegerField(read_only=True)
     cancelled_issues = serializers.IntegerField(read_only=True)
     completed_issues = serializers.IntegerField(read_only=True)
@@ -153,4 +152,11 @@ class ModuleLinkSerializer(BaseSerializer):
             raise serializers.ValidationError(
                 {"error": "URL already exists for this Issue"}
             )
-        return ModuleLink.objects.create(**validated_data)
+        return ModuleLink.objects.create(**validated_data)
+    
+
+class ModuleLiteSerializer(BaseSerializer):
+
+    class Meta:
+        model = Module
+        fields = "__all__"

apiserver/plane/api/views/base.py

@@ -38,6 +38,7 @@ class TimezoneMixin:
 
 class WebhookMixin:
     webhook_event = None
+    bulk = False
 
     def finalize_response(self, request, response, *args, **kwargs):
         response = super().finalize_response(request, response, *args, **kwargs)
@@ -45,17 +46,17 @@ class WebhookMixin:
         # Check for the case should webhook be sent
         if (
             self.webhook_event
-            and self.request.method in ["DELETE"]
-            and response.status_code in [204]
+            and self.request.method in ["POST", "PATCH", "DELETE"]
+            and response.status_code in [200, 201, 204]
         ):
-            # Get the id
-            object_id = self.kwargs.get("pk")
             # Push the object to delay
             send_webhook.delay(
                 event=self.webhook_event,
-                event_id=object_id,
+                payload=response.data,
+                kw=self.kwargs,
                 action=self.request.method,
                 slug=self.workspace_slug,
+                bulk=self.bulk,
             )
 
         return response

apiserver/plane/api/views/cycle.py

@@ -311,6 +311,7 @@ class CycleIssueAPIEndpoint(WebhookMixin, BaseAPIView):
     serializer_class = CycleIssueSerializer
     model = CycleIssue
     webhook_event = "cycle_issue"
+    bulk = True
     permission_classes = [
         ProjectEntityPermission,
     ]

apiserver/plane/api/views/module.py

@@ -195,6 +195,7 @@ class ModuleIssueAPIEndpoint(WebhookMixin, BaseAPIView):
     serializer_class = ModuleIssueSerializer
     model = ModuleIssue
     webhook_event = "module_issue"
+    bulk = True
 
     permission_classes = [
         ProjectEntityPermission,

apiserver/plane/api/views/state.py

@@ -79,7 +79,7 @@ class StateAPIEndpoint(BaseAPIView):
         return Response(status=status.HTTP_204_NO_CONTENT)
 
     def patch(self, request, slug, project_id, state_id=None):
-        state = State.objects.filter(workspace__slug=slug, project_id=project_id, pk=state_id)
+        state = State.objects.get(workspace__slug=slug, project_id=project_id, pk=state_id)
         serializer = StateSerializer(state, data=request.data, partial=True)
         if serializer.is_valid():
             serializer.save()

apiserver/plane/app/views/base.py

@@ -43,27 +43,28 @@ class TimezoneMixin:
 
 class WebhookMixin:
     webhook_event = None
+    bulk = False
 
     def finalize_response(self, request, response, *args, **kwargs):
         response = super().finalize_response(request, response, *args, **kwargs)
+
+        # Check for the case should webhook be sent
         if (
             self.webhook_event
-            and self.request.method in ["POST", "PATCH"]
+            and self.request.method in ["POST", "PATCH", "DELETE"]
             and response.status_code in [200, 201, 204]
         ):
-            # Get the id
-            object_id = (
-                response.data.get("id") if isinstance(response.data, dict) else None
-            )
-
+            # Push the object to delay
             send_webhook.delay(
                 event=self.webhook_event,
-                event_id=object_id,
+                payload=response.data,
+                kw=self.kwargs,
                 action=self.request.method,
                 slug=self.workspace_slug,
+                bulk=self.bulk,
             )
-        return response
 
+        return response
 
 
 class BaseViewSet(TimezoneMixin, ModelViewSet, BasePaginator):

apiserver/plane/app/views/config.py

@@ -58,6 +58,7 @@ class ConfigurationEndpoint(BaseAPIView):
         ) and get_configuration_value(
             instance_configuration, "ENABLE_MAGIC_LINK_LOGIN", "0"
         ) == "1"
+
         data["email_password_login"] = (
             get_configuration_value(
                 instance_configuration, "ENABLE_EMAIL_PASSWORD", "0"

apiserver/plane/app/views/cycle.py

@@ -502,7 +502,10 @@ class CycleViewSet(WebhookMixin, BaseViewSet):
 class CycleIssueViewSet(WebhookMixin, BaseViewSet):
     serializer_class = CycleIssueSerializer
     model = CycleIssue
+
     webhook_event = "cycle_issue"
+    bulk = True
+
     permission_classes = [
         ProjectEntityPermission,
     ]

apiserver/plane/app/views/module.py

@@ -287,6 +287,8 @@ class ModuleIssueViewSet(WebhookMixin, BaseViewSet):
     serializer_class = ModuleIssueSerializer
     model = ModuleIssue
     webhook_event = "module_issue"
+    bulk = True
+
 
     filterset_fields = [
         "issue__labels__id",

apiserver/plane/bgtasks/webhook_task.py

@@ -31,11 +31,12 @@ from plane.api.serializers import (
     CycleIssueSerializer,
     ModuleIssueSerializer,
     IssueCommentSerializer,
+    IssueExpandSerializer,
 )
 
 SERIALIZER_MAPPER = {
     "project": ProjectSerializer,
-    "issue": IssueSerializer,
+    "issue": IssueExpandSerializer,
     "cycle": CycleSerializer,
     "module": ModuleSerializer,
     "cycle_issue": CycleIssueSerializer,
@@ -54,11 +55,14 @@ MODEL_MAPPER = {
 }
 
 
-def get_model_data(event, event_id):
+def get_model_data(event, event_id, many=False):
     model = MODEL_MAPPER.get(event)
-    queryset = model.objects.get(pk=event_id)
+    if many:
+        queryset = model.objects.filter(pk__in=event_id)
+    else:
+        queryset = model.objects.get(pk=event_id)
     serializer = SERIALIZER_MAPPER.get(event)
-    return serializer(queryset).data
+    return serializer(queryset, many=many).data
 
 
 @shared_task(
@@ -68,7 +72,7 @@ def get_model_data(event, event_id):
     max_retries=5,
     retry_jitter=True,
 )
-def webhook_task(self, webhook, slug, event, event_id, action):
+def webhook_task(self, webhook, slug, event, event_data, action):
     try:
         webhook = Webhook.objects.get(id=webhook, workspace__slug=slug)
 
@@ -79,8 +83,6 @@ def webhook_task(self, webhook, slug, event, event_id, action):
             "X-Plane-Event": event,
         }
 
-        event_data = get_model_data(event=event, event_id=event_id)
-
         # # Your secret key
         event_data = (
             json.loads(json.dumps(event_data, cls=DjangoJSONEncoder))
@@ -90,11 +92,11 @@ def webhook_task(self, webhook, slug, event, event_id, action):
 
         # Use HMAC for generating signature
         if webhook.secret_key:
-            event_data_json = json.dumps(event_data) if event_data is not None else '{}'
+            event_data_json = json.dumps(event_data) if event_data is not None else "{}"
             hmac_signature = hmac.new(
                 webhook.secret_key.encode("utf-8"),
                 event_data_json.encode("utf-8"),
-                hashlib.sha256
+                hashlib.sha256,
             )
             signature = hmac_signature.hexdigest()
             headers["X-Plane-Signature"] = signature
@@ -158,7 +160,6 @@ def webhook_task(self, webhook, slug, event, event_id, action):
         raise requests.RequestException()
 
     except Exception as e:
-        print(e)
         if settings.DEBUG:
             print(e)
         capture_exception(e)
@@ -166,7 +167,7 @@ def webhook_task(self, webhook, slug, event, event_id, action):
 
 
 @shared_task()
-def send_webhook(event, event_id, action, slug):
+def send_webhook(event, payload, kw, action, slug, bulk):
     try:
         webhooks = Webhook.objects.filter(workspace__slug=slug, is_active=True)
 
@@ -185,8 +186,39 @@ def send_webhook(event, event_id, action, slug):
         if event == "issue_comment":
             webhooks = webhooks.filter(issue_comment=True)
 
-        for webhook in webhooks:
-            webhook_task.delay(webhook.id, slug, event, event_id, action)
+        if webhooks:
+            if action in ["POST", "PATCH"]:
+                if bulk and event in ["cycle_issue", "module_issue"]:
+                    event_data = IssueExpandSerializer(
+                        Issue.objects.filter(
+                            pk__in=[
+                                str(event.get("issue")) for event in payload
+                            ]
+                        ).prefetch_related("issue_cycle", "issue_module"), many=True
+                    ).data
+                    event = "issue"
+                    action = "PATCH"
+                else:
+                    event_data = [
+                        get_model_data(
+                            event=event,
+                            event_id=payload.get("id") if isinstance(payload, dict) else None,
+                            many=False,
+                        )
+                    ]
+
+            if action == "DELETE":
+                event_data = [{"id": kw.get("pk")}]
+
+            for webhook in webhooks:
+                for data in event_data:
+                    webhook_task.delay(
+                        webhook=webhook.id,
+                        slug=slug,
+                        event=event,
+                        event_data=data,
+                        action=action,
+                    )
 
     except Exception as e:
         if settings.DEBUG:

apiserver/plane/db/models/module.py

@@ -51,9 +51,9 @@ class Module(ProjectBaseModel):
 
     def save(self, *args, **kwargs):
         if self._state.adding:
-            smallest_sort_order = Module.objects.filter(
-                project=self.project
-            ).aggregate(smallest=models.Min("sort_order"))["smallest"]
+            smallest_sort_order = Module.objects.filter(project=self.project).aggregate(
+                smallest=models.Min("sort_order")
+            )["smallest"]
 
             if smallest_sort_order is not None:
                 self.sort_order = smallest_sort_order - 10000