Skip to content

perf(api): improve performance on states and modules endpoints #9275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
p11o wants to merge 5 commits into
base: preview
Choose a base branch
from
+269 −285
Open

perf(api): improve performance on states and modules endpoints #9275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a866adc
perf(api): replace JOIN membership filter with Exists() in state quer…
p11o Jun 19, 2026
21ec42d
perf(api): replace Count(distinct=True) with Coalesce(Subquery) in mo…
p11o Jun 19, 2026
a58d466
docs: add docstrings to satisfy coverage threshold
p11o Jun 19, 2026
e41ad2d
perf(api): replace JOIN membership filter with Exists() in view and a…
p11o Jun 24, 2026
23c8d0c
fix(api): prevent cross-project activity/comment reads in IssueActivi…
p11o Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
326 changes: 68 additions & 258 deletions apps/api/plane/api/views/module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

# Django imports
from django.core import serializers
from django.db.models import Count, F, Func, OuterRef, Prefetch, Q
from django.db.models import Count, F, Func, IntegerField, OuterRef, Prefetch, Q, Subquery
from django.db.models.functions import Coalesce
from django.utils import timezone
from django.core.serializers.json import DjangoJSONEncoder

Expand Down Expand Up @@ -73,6 +74,56 @@
)


def _module_issue_count_subquery(state_group=None):
"""Return a Coalesce(Subquery) that counts active module issues, optionally filtered by state group."""
filters = Q(
module_id=OuterRef("pk"),
issue__archived_at__isnull=True,
issue__is_draft=False,
deleted_at__isnull=True,
)
if state_group:
filters &= Q(issue__state__group=state_group)
return Coalesce(
Subquery(
ModuleIssue.objects.filter(filters)
.order_by()
.values("module_id")
.annotate(count=Count("id"))
.values("count"),
output_field=IntegerField(),
),
0,
)


def _build_module_queryset(slug, project_id, order_by="-created_at"):
"""Build the base Module queryset with issue-count annotations.

Uses correlated subqueries for each state-group count to avoid the row
inflation caused by COUNT(DISTINCT ...) across a multi-table join path.
"""
return (
Module.objects.filter(project_id=project_id)
.filter(workspace__slug=slug)
.select_related("project", "workspace", "lead")
.prefetch_related("members")
.prefetch_related(
Prefetch(
"link_module",
queryset=ModuleLink.objects.select_related("module", "created_by"),
)
)
.annotate(total_issues=_module_issue_count_subquery())
.annotate(completed_issues=_module_issue_count_subquery("completed"))
.annotate(cancelled_issues=_module_issue_count_subquery("cancelled"))
.annotate(started_issues=_module_issue_count_subquery("started"))
.annotate(unstarted_issues=_module_issue_count_subquery("unstarted"))
.annotate(backlog_issues=_module_issue_count_subquery("backlog"))
.order_by(order_by)
)


class ModuleListCreateAPIEndpoint(BaseAPIView):
"""Module List and Create Endpoint"""

Expand All @@ -83,91 +134,11 @@ class ModuleListCreateAPIEndpoint(BaseAPIView):
use_read_replica = True

def get_queryset(self):
return (
Module.objects.filter(project_id=self.kwargs.get("project_id"))
.filter(workspace__slug=self.kwargs.get("slug"))
.select_related("project")
.select_related("workspace")
.select_related("lead")
.prefetch_related("members")
.prefetch_related(
Prefetch(
"link_module",
queryset=ModuleLink.objects.select_related("module", "created_by"),
)
)
.annotate(
total_issues=Count(
"issue_module",
filter=Q(
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
completed_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="completed",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
cancelled_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="cancelled",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
started_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="started",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
unstarted_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="unstarted",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
backlog_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="backlog",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.order_by(self.kwargs.get("order_by", "-created_at"))
"""Return active (non-archived) modules for the project."""
return _build_module_queryset(
slug=self.kwargs.get("slug"),
project_id=self.kwargs.get("project_id"),
order_by=self.kwargs.get("order_by", "-created_at"),
)

@module_docs(
Expand Down Expand Up @@ -286,91 +257,11 @@ class ModuleDetailAPIEndpoint(BaseAPIView):
use_read_replica = True

def get_queryset(self):
return (
Module.objects.filter(project_id=self.kwargs.get("project_id"))
.filter(workspace__slug=self.kwargs.get("slug"))
.select_related("project")
.select_related("workspace")
.select_related("lead")
.prefetch_related("members")
.prefetch_related(
Prefetch(
"link_module",
queryset=ModuleLink.objects.select_related("module", "created_by"),
)
)
.annotate(
total_issues=Count(
"issue_module",
filter=Q(
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
completed_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="completed",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
cancelled_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="cancelled",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
started_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="started",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
unstarted_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="unstarted",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
backlog_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="backlog",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.order_by(self.kwargs.get("order_by", "-created_at"))
"""Return the module queryset for detail, update, and delete operations."""
return _build_module_queryset(
slug=self.kwargs.get("slug"),
project_id=self.kwargs.get("project_id"),
order_by=self.kwargs.get("order_by", "-created_at"),
)

@module_docs(
Expand Down Expand Up @@ -893,93 +784,12 @@ class ModuleArchiveUnarchiveAPIEndpoint(BaseAPIView):
use_read_replica = True

def get_queryset(self):
return (
Module.objects.filter(project_id=self.kwargs.get("project_id"))
.filter(workspace__slug=self.kwargs.get("slug"))
.filter(archived_at__isnull=False)
.select_related("project")
.select_related("workspace")
.select_related("lead")
.prefetch_related("members")
.prefetch_related(
Prefetch(
"link_module",
queryset=ModuleLink.objects.select_related("module", "created_by"),
)
)
.annotate(
total_issues=Count(
"issue_module",
filter=Q(
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
completed_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="completed",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
cancelled_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="cancelled",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
started_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="started",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
unstarted_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="unstarted",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.annotate(
backlog_issues=Count(
"issue_module__issue__state__group",
filter=Q(
issue_module__issue__state__group="backlog",
issue_module__issue__archived_at__isnull=True,
issue_module__issue__is_draft=False,
issue_module__deleted_at__isnull=True,
),
distinct=True,
)
)
.order_by(self.kwargs.get("order_by", "-created_at"))
)
"""Return only archived modules for the project."""
return _build_module_queryset(
slug=self.kwargs.get("slug"),
project_id=self.kwargs.get("project_id"),
order_by=self.kwargs.get("order_by", "-created_at"),
).filter(archived_at__isnull=False)

@module_docs(
operation_id="list_archived_modules",
Expand Down
Loading