# Python imports import json # Django imports from django.db.models import ( Func, F, Q, Exists, OuterRef, Count, Prefetch, Case, When, Value, CharField, ) from django.utils import timezone from django.contrib.postgres.aggregates import ArrayAgg from django.contrib.postgres.fields import ArrayField from django.db.models import UUIDField from django.db.models.functions import Coalesce # Third party imports from rest_framework.response import Response from rest_framework import status # Module imports from .. import BaseViewSet, BaseAPIView, WebhookMixin from plane.app.serializers import ( CycleSerializer, CycleFavoriteSerializer, CycleWriteSerializer, CycleUserPropertiesSerializer, ) from plane.app.permissions import ( ProjectEntityPermission, ProjectLitePermission, ) from plane.db.models import ( User, Cycle, CycleIssue, Issue, CycleFavorite, Label, CycleUserProperties, ) from plane.bgtasks.issue_activites_task import issue_activity from plane.utils.analytics_plot import burndown_plot class CycleViewSet(WebhookMixin, BaseViewSet): serializer_class = CycleSerializer model = Cycle webhook_event = "cycle" permission_classes = [ ProjectEntityPermission, ] def perform_create(self, serializer): serializer.save( project_id=self.kwargs.get("project_id"), owned_by=self.request.user, ) def get_queryset(self): favorite_subquery = CycleFavorite.objects.filter( user=self.request.user, cycle_id=OuterRef("pk"), project_id=self.kwargs.get("project_id"), workspace__slug=self.kwargs.get("slug"), ) return self.filter_queryset( super() .get_queryset() .filter(workspace__slug=self.kwargs.get("slug")) .filter(project_id=self.kwargs.get("project_id")) .filter( project__project_projectmember__member=self.request.user, project__project_projectmember__is_active=True, ) .select_related("project", "workspace", "owned_by") .prefetch_related( Prefetch( "issue_cycle__issue__assignees", queryset=User.objects.only( "avatar", "first_name", "id" ).distinct(), ) ) .prefetch_related( Prefetch( "issue_cycle__issue__labels", queryset=Label.objects.only( "name", "color", "id" ).distinct(), ) ) .annotate(is_favorite=Exists(favorite_subquery)) .annotate( completed_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="completed", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( cancelled_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="cancelled", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( started_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="started", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( unstarted_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="unstarted", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( backlog_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="backlog", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( status=Case( When( Q(start_date__lte=timezone.now()) & Q(end_date__gte=timezone.now()), then=Value("CURRENT"), ), When( start_date__gt=timezone.now(), then=Value("UPCOMING") ), When(end_date__lt=timezone.now(), then=Value("COMPLETED")), When( Q(start_date__isnull=True) & Q(end_date__isnull=True), then=Value("DRAFT"), ), default=Value("DRAFT"), output_field=CharField(), ) ) .annotate( assignee_ids=Coalesce( ArrayAgg( "issue_cycle__issue__assignees__id", distinct=True, filter=~Q( issue_cycle__issue__assignees__id__isnull=True ), ), Value([], output_field=ArrayField(UUIDField())), ) ) .order_by("-is_favorite", "name") .distinct() ) def list(self, request, slug, project_id): queryset = self.get_queryset().annotate( total_issues=Count( "issue_cycle", filter=Q( issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) cycle_view = request.GET.get("cycle_view", "all") # Update the order by queryset = queryset.order_by("-is_favorite", "-created_at") # Current Cycle if cycle_view == "current": queryset = queryset.filter( start_date__lte=timezone.now(), end_date__gte=timezone.now(), ) data = queryset.values( # necessary fields "id", "workspace_id", "project_id", # model fields "name", "description", "start_date", "end_date", "owned_by_id", "view_props", "sort_order", "external_source", "external_id", "progress_snapshot", # meta fields "is_favorite", "total_issues", "cancelled_issues", "completed_issues", "started_issues", "unstarted_issues", "backlog_issues", "assignee_ids", "status", ) if data: assignee_distribution = ( Issue.objects.filter( issue_cycle__cycle_id=data[0]["id"], workspace__slug=slug, project_id=project_id, ) .annotate(display_name=F("assignees__display_name")) .annotate(assignee_id=F("assignees__id")) .annotate(avatar=F("assignees__avatar")) .values("display_name", "assignee_id", "avatar") .annotate( total_issues=Count( "id", filter=Q(archived_at__isnull=True, is_draft=False), ), ) .annotate( completed_issues=Count( "id", filter=Q( completed_at__isnull=False, archived_at__isnull=True, is_draft=False, ), ) ) .annotate( pending_issues=Count( "id", filter=Q( completed_at__isnull=True, archived_at__isnull=True, is_draft=False, ), ) ) .order_by("display_name") ) label_distribution = ( Issue.objects.filter( issue_cycle__cycle_id=data[0]["id"], workspace__slug=slug, project_id=project_id, ) .annotate(label_name=F("labels__name")) .annotate(color=F("labels__color")) .annotate(label_id=F("labels__id")) .values("label_name", "color", "label_id") .annotate( total_issues=Count( "id", filter=Q(archived_at__isnull=True, is_draft=False), ) ) .annotate( completed_issues=Count( "id", filter=Q( completed_at__isnull=False, archived_at__isnull=True, is_draft=False, ), ) ) .annotate( pending_issues=Count( "id", filter=Q( completed_at__isnull=True, archived_at__isnull=True, is_draft=False, ), ) ) .order_by("label_name") ) data[0]["distribution"] = { "assignees": assignee_distribution, "labels": label_distribution, "completion_chart": {}, } if data[0]["start_date"] and data[0]["end_date"]: data[0]["distribution"]["completion_chart"] = ( burndown_plot( queryset=queryset.first(), slug=slug, project_id=project_id, cycle_id=data[0]["id"], ) ) return Response(data, status=status.HTTP_200_OK) data = queryset.values( # necessary fields "id", "workspace_id", "project_id", # model fields "name", "description", "start_date", "end_date", "owned_by_id", "view_props", "sort_order", "external_source", "external_id", "progress_snapshot", # meta fields "total_issues", "is_favorite", "cancelled_issues", "completed_issues", "started_issues", "unstarted_issues", "backlog_issues", "assignee_ids", "status", ) return Response(data, status=status.HTTP_200_OK) def create(self, request, slug, project_id): if ( request.data.get("start_date", None) is None and request.data.get("end_date", None) is None ) or ( request.data.get("start_date", None) is not None and request.data.get("end_date", None) is not None ): serializer = CycleWriteSerializer(data=request.data) if serializer.is_valid(): serializer.save( project_id=project_id, owned_by=request.user, ) cycle = ( self.get_queryset() .filter(pk=serializer.data["id"]) .values( # necessary fields "id", "workspace_id", "project_id", # model fields "name", "description", "start_date", "end_date", "owned_by_id", "view_props", "sort_order", "external_source", "external_id", "progress_snapshot", # meta fields "is_favorite", "cancelled_issues", "completed_issues", "started_issues", "unstarted_issues", "backlog_issues", "assignee_ids", "status", ) .first() ) return Response(cycle, status=status.HTTP_201_CREATED) return Response( serializer.errors, status=status.HTTP_400_BAD_REQUEST ) else: return Response( { "error": "Both start date and end date are either required or are to be null" }, status=status.HTTP_400_BAD_REQUEST, ) def partial_update(self, request, slug, project_id, pk): queryset = self.get_queryset().filter( workspace__slug=slug, project_id=project_id, pk=pk ) cycle = queryset.first() request_data = request.data if ( cycle.end_date is not None and cycle.end_date < timezone.now().date() ): if "sort_order" in request_data: # Can only change sort order for a completed cycle`` request_data = { "sort_order": request_data.get( "sort_order", cycle.sort_order ) } else: return Response( { "error": "The Cycle has already been completed so it cannot be edited" }, status=status.HTTP_400_BAD_REQUEST, ) serializer = CycleWriteSerializer( cycle, data=request.data, partial=True ) if serializer.is_valid(): serializer.save() cycle = queryset.values( # necessary fields "id", "workspace_id", "project_id", # model fields "name", "description", "start_date", "end_date", "owned_by_id", "view_props", "sort_order", "external_source", "external_id", "progress_snapshot", # meta fields "is_favorite", "cancelled_issues", "completed_issues", "started_issues", "unstarted_issues", "backlog_issues", "assignee_ids", "status", ).first() return Response(cycle, status=status.HTTP_200_OK) return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) def retrieve(self, request, slug, project_id, pk): queryset = ( self.get_queryset() .filter(pk=pk) .annotate( total_issues=Count( "issue_cycle", filter=Q( issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) ) data = ( self.get_queryset() .filter(pk=pk) .annotate( total_issues=Issue.issue_objects.filter( project_id=self.kwargs.get("project_id"), parent__isnull=True, issue_cycle__cycle_id=pk, ) .order_by() .annotate(count=Func(F("id"), function="Count")) .values("count") ) .annotate( sub_issues=Issue.issue_objects.filter( project_id=self.kwargs.get("project_id"), parent__isnull=False, issue_cycle__cycle_id=pk, ) .order_by() .annotate(count=Func(F("id"), function="Count")) .values("count") ) .values( # necessary fields "id", "workspace_id", "project_id", # model fields "name", "description", "start_date", "end_date", "owned_by_id", "view_props", "sort_order", "external_source", "external_id", "progress_snapshot", "sub_issues", # meta fields "is_favorite", "total_issues", "cancelled_issues", "completed_issues", "started_issues", "unstarted_issues", "backlog_issues", "assignee_ids", "status", ) .first() ) queryset = queryset.first() # Assignee Distribution assignee_distribution = ( Issue.objects.filter( issue_cycle__cycle_id=pk, workspace__slug=slug, project_id=project_id, ) .annotate(first_name=F("assignees__first_name")) .annotate(last_name=F("assignees__last_name")) .annotate(assignee_id=F("assignees__id")) .annotate(avatar=F("assignees__avatar")) .annotate(display_name=F("assignees__display_name")) .values( "first_name", "last_name", "assignee_id", "avatar", "display_name", ) .annotate( total_issues=Count( "id", filter=Q(archived_at__isnull=True, is_draft=False), ), ) .annotate( completed_issues=Count( "id", filter=Q( completed_at__isnull=False, archived_at__isnull=True, is_draft=False, ), ) ) .annotate( pending_issues=Count( "id", filter=Q( completed_at__isnull=True, archived_at__isnull=True, is_draft=False, ), ) ) .order_by("first_name", "last_name") ) # Label Distribution label_distribution = ( Issue.objects.filter( issue_cycle__cycle_id=pk, workspace__slug=slug, project_id=project_id, ) .annotate(label_name=F("labels__name")) .annotate(color=F("labels__color")) .annotate(label_id=F("labels__id")) .values("label_name", "color", "label_id") .annotate( total_issues=Count( "id", filter=Q(archived_at__isnull=True, is_draft=False), ), ) .annotate( completed_issues=Count( "id", filter=Q( completed_at__isnull=False, archived_at__isnull=True, is_draft=False, ), ) ) .annotate( pending_issues=Count( "id", filter=Q( completed_at__isnull=True, archived_at__isnull=True, is_draft=False, ), ) ) .order_by("label_name") ) data["distribution"] = { "assignees": assignee_distribution, "labels": label_distribution, "completion_chart": {}, } if queryset.start_date and queryset.end_date: data["distribution"]["completion_chart"] = burndown_plot( queryset=queryset, slug=slug, project_id=project_id, cycle_id=pk, ) return Response( data, status=status.HTTP_200_OK, ) def destroy(self, request, slug, project_id, pk): cycle_issues = list( CycleIssue.objects.filter( cycle_id=self.kwargs.get("pk") ).values_list("issue", flat=True) ) cycle = Cycle.objects.get( workspace__slug=slug, project_id=project_id, pk=pk ) issue_activity.delay( type="cycle.activity.deleted", requested_data=json.dumps( { "cycle_id": str(pk), "cycle_name": str(cycle.name), "issues": [str(issue_id) for issue_id in cycle_issues], } ), actor_id=str(request.user.id), issue_id=str(pk), project_id=str(project_id), current_instance=None, epoch=int(timezone.now().timestamp()), notification=True, origin=request.META.get("HTTP_ORIGIN"), ) # Delete the cycle cycle.delete() return Response(status=status.HTTP_204_NO_CONTENT) class CycleDateCheckEndpoint(BaseAPIView): permission_classes = [ ProjectEntityPermission, ] def post(self, request, slug, project_id): start_date = request.data.get("start_date", False) end_date = request.data.get("end_date", False) cycle_id = request.data.get("cycle_id") if not start_date or not end_date: return Response( {"error": "Start date and end date both are required"}, status=status.HTTP_400_BAD_REQUEST, ) # Check if any cycle intersects in the given interval cycles = Cycle.objects.filter( Q(workspace__slug=slug) & Q(project_id=project_id) & ( Q(start_date__lte=start_date, end_date__gte=start_date) | Q(start_date__lte=end_date, end_date__gte=end_date) | Q(start_date__gte=start_date, end_date__lte=end_date) ) ).exclude(pk=cycle_id) if cycles.exists(): return Response( { "error": "You have a cycle already on the given dates, if you want to create a draft cycle you can do that by removing dates", "status": False, } ) else: return Response({"status": True}, status=status.HTTP_200_OK) class CycleFavoriteViewSet(BaseViewSet): serializer_class = CycleFavoriteSerializer model = CycleFavorite def get_queryset(self): return self.filter_queryset( super() .get_queryset() .filter(workspace__slug=self.kwargs.get("slug")) .filter(user=self.request.user) .select_related("cycle", "cycle__owned_by") ) def create(self, request, slug, project_id): serializer = CycleFavoriteSerializer(data=request.data) if serializer.is_valid(): serializer.save(user=request.user, project_id=project_id) return Response(serializer.data, status=status.HTTP_201_CREATED) return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) def destroy(self, request, slug, project_id, cycle_id): cycle_favorite = CycleFavorite.objects.get( project=project_id, user=request.user, workspace__slug=slug, cycle_id=cycle_id, ) cycle_favorite.delete() return Response(status=status.HTTP_204_NO_CONTENT) class TransferCycleIssueEndpoint(BaseAPIView): permission_classes = [ ProjectEntityPermission, ] def post(self, request, slug, project_id, cycle_id): new_cycle_id = request.data.get("new_cycle_id", False) if not new_cycle_id: return Response( {"error": "New Cycle Id is required"}, status=status.HTTP_400_BAD_REQUEST, ) new_cycle = Cycle.objects.filter( workspace__slug=slug, project_id=project_id, pk=new_cycle_id ).first() old_cycle = ( Cycle.objects.filter( workspace__slug=slug, project_id=project_id, pk=cycle_id ) .annotate( total_issues=Count( "issue_cycle", filter=Q( issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( completed_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="completed", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( cancelled_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="cancelled", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( started_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="started", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( unstarted_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="unstarted", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) .annotate( backlog_issues=Count( "issue_cycle__issue__state__group", filter=Q( issue_cycle__issue__state__group="backlog", issue_cycle__issue__archived_at__isnull=True, issue_cycle__issue__is_draft=False, ), ) ) ) # Pass the new_cycle queryset to burndown_plot completion_chart = burndown_plot( queryset=old_cycle.first(), slug=slug, project_id=project_id, cycle_id=cycle_id, ) # Get the assignee distribution assignee_distribution = ( Issue.objects.filter( issue_cycle__cycle_id=cycle_id, workspace__slug=slug, project_id=project_id, ) .annotate(display_name=F("assignees__display_name")) .annotate(assignee_id=F("assignees__id")) .annotate(avatar=F("assignees__avatar")) .values("display_name", "assignee_id", "avatar") .annotate( total_issues=Count( "id", filter=Q(archived_at__isnull=True, is_draft=False), ), ) .annotate( completed_issues=Count( "id", filter=Q( completed_at__isnull=False, archived_at__isnull=True, is_draft=False, ), ) ) .annotate( pending_issues=Count( "id", filter=Q( completed_at__isnull=True, archived_at__isnull=True, is_draft=False, ), ) ) .order_by("display_name") ) # assignee distribution serialized assignee_distribution_data = [ { "display_name": item["display_name"], "assignee_id": ( str(item["assignee_id"]) if item["assignee_id"] else None ), "avatar": item["avatar"], "total_issues": item["total_issues"], "completed_issues": item["completed_issues"], "pending_issues": item["pending_issues"], } for item in assignee_distribution ] # Get the label distribution label_distribution = ( Issue.objects.filter( issue_cycle__cycle_id=cycle_id, workspace__slug=slug, project_id=project_id, ) .annotate(label_name=F("labels__name")) .annotate(color=F("labels__color")) .annotate(label_id=F("labels__id")) .values("label_name", "color", "label_id") .annotate( total_issues=Count( "id", filter=Q(archived_at__isnull=True, is_draft=False), ) ) .annotate( completed_issues=Count( "id", filter=Q( completed_at__isnull=False, archived_at__isnull=True, is_draft=False, ), ) ) .annotate( pending_issues=Count( "id", filter=Q( completed_at__isnull=True, archived_at__isnull=True, is_draft=False, ), ) ) .order_by("label_name") ) assignee_distribution_data = [ { "display_name": item["display_name"], "assignee_id": ( str(item["assignee_id"]) if item["assignee_id"] else None ), "avatar": item["avatar"], "total_issues": item["total_issues"], "completed_issues": item["completed_issues"], "pending_issues": item["pending_issues"], } for item in assignee_distribution ] # Label distribution serilization label_distribution_data = [ { "label_name": item["label_name"], "color": item["color"], "label_id": ( str(item["label_id"]) if item["label_id"] else None ), "total_issues": item["total_issues"], "completed_issues": item["completed_issues"], "pending_issues": item["pending_issues"], } for item in label_distribution ] current_cycle = Cycle.objects.filter( workspace__slug=slug, project_id=project_id, pk=cycle_id ).first() current_cycle.progress_snapshot = { "total_issues": old_cycle.first().total_issues, "completed_issues": old_cycle.first().completed_issues, "cancelled_issues": old_cycle.first().cancelled_issues, "started_issues": old_cycle.first().started_issues, "unstarted_issues": old_cycle.first().unstarted_issues, "backlog_issues": old_cycle.first().backlog_issues, "distribution": { "labels": label_distribution_data, "assignees": assignee_distribution_data, "completion_chart": completion_chart, }, } current_cycle.save(update_fields=["progress_snapshot"]) if ( new_cycle.end_date is not None and new_cycle.end_date < timezone.now().date() ): return Response( { "error": "The cycle where the issues are transferred is already completed" }, status=status.HTTP_400_BAD_REQUEST, ) cycle_issues = CycleIssue.objects.filter( cycle_id=cycle_id, project_id=project_id, workspace__slug=slug, issue__state__group__in=["backlog", "unstarted", "started"], ) updated_cycles = [] for cycle_issue in cycle_issues: cycle_issue.cycle_id = new_cycle_id updated_cycles.append(cycle_issue) cycle_issues = CycleIssue.objects.bulk_update( updated_cycles, ["cycle_id"], batch_size=100 ) return Response({"message": "Success"}, status=status.HTTP_200_OK) class CycleUserPropertiesEndpoint(BaseAPIView): permission_classes = [ ProjectLitePermission, ] def patch(self, request, slug, project_id, cycle_id): cycle_properties = CycleUserProperties.objects.get( user=request.user, cycle_id=cycle_id, project_id=project_id, workspace__slug=slug, ) cycle_properties.filters = request.data.get( "filters", cycle_properties.filters ) cycle_properties.display_filters = request.data.get( "display_filters", cycle_properties.display_filters ) cycle_properties.display_properties = request.data.get( "display_properties", cycle_properties.display_properties ) cycle_properties.save() serializer = CycleUserPropertiesSerializer(cycle_properties) return Response(serializer.data, status=status.HTTP_201_CREATED) def get(self, request, slug, project_id, cycle_id): cycle_properties, _ = CycleUserProperties.objects.get_or_create( user=request.user, project_id=project_id, cycle_id=cycle_id, workspace__slug=slug, ) serializer = CycleUserPropertiesSerializer(cycle_properties) return Response(serializer.data, status=status.HTTP_200_OK)