Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

fix(api): stop embedding task rows in the project list response

Alex Makarski7771d46c57fb
diff --git a/apps/api/src/project/controllers/get-projects.ts b/apps/api/src/project/controllers/get-projects.ts
index bcee8eb18..a7c29f938 100644
--- a/apps/api/src/project/controllers/get-projects.ts
+++ b/apps/api/src/project/controllers/get-projects.ts
@@ -1,6 +1,57 @@
-import { and, eq, isNull } from "drizzle-orm";
+import { and, count, eq, inArray, isNull, min, sql } from "drizzle-orm";
import db from "../../database";
-import { projectTable } from "../../database/schema";
+import { projectTable, taskTable } from "../../database/schema";
+
+type ProjectStatistics = {
+ completionPercentage: number;
+ totalTasks: number;
+ dueDate: Date | null;
+};
+
+const EMPTY_STATISTICS: ProjectStatistics = {
+ completionPercentage: 0,
+ totalTasks: 0,
+ dueDate: null,
+};
+
+async function getProjectStatistics(projectIds: string[]) {
+ const statisticsByProject = new Map<string, ProjectStatistics>();
+
+ if (projectIds.length === 0) {
+ return statisticsByProject;
+ }
+
+ // Aggregate in the database instead of loading every task row into memory.
+ // This endpoint needs three numbers per project; the previous
+ // `with: { tasks: true }` made both the query and the response grow linearly
+ // with the number of tasks in the workspace.
+ const rows = await db
+ .select({
+ projectId: taskTable.projectId,
+ totalTasks: count(),
+ completedTasks: count(
+ sql`case when ${taskTable.status} in ('done', 'archived') then 1 end`,
+ ),
+ dueDate: min(taskTable.dueDate),
+ })
+ .from(taskTable)
+ .where(inArray(taskTable.projectId, projectIds))
+ .groupBy(taskTable.projectId);
+
+ for (const row of rows) {
+ const totalTasks = Number(row.totalTasks);
+ const completedTasks = Number(row.completedTasks);
+
+ statisticsByProject.set(row.projectId, {
+ totalTasks,
+ completionPercentage:
+ totalTasks > 0 ? Math.round((completedTasks / totalTasks) * 100) : 0,
+ dueDate: row.dueDate ?? null,
+ });
+ }
+
+ return statisticsByProject;
+}
async function getProjects(workspaceId: string, includeArchived = false) {
const projects = await db.query.projectTable.findMany({
@@ -10,39 +61,19 @@ async function getProjects(workspaceId: string, includeArchived = false) {
eq(projectTable.workspaceId, workspaceId),
isNull(projectTable.archivedAt),
),
- with: {
- tasks: true,
- },
});
- const projectsWithStatistics = projects.map((project) => {
- const totalTasks = project.tasks.length;
- const completedTasks = project.tasks.filter(
- (task) => task.status === "done" || task.status === "archived",
- ).length;
- const completionPercentage =
- totalTasks > 0 ? Math.round((completedTasks / totalTasks) * 100) : 0;
-
- const dueDate = project.tasks.reduce((earliest: Date | null, task) => {
- if (!earliest || (task.dueDate && task.dueDate < earliest))
- return task.dueDate;
- return earliest;
- }, null);
-
- return {
- ...project,
- statistics: {
- completionPercentage,
- totalTasks,
- dueDate,
- },
- archivedTasks: [],
- plannedTasks: [],
- columns: [],
- };
- });
+ const statisticsByProject = await getProjectStatistics(
+ projects.map((project) => project.id),
+ );
- return projectsWithStatistics;
+ return projects.map((project) => ({
+ ...project,
+ statistics: statisticsByProject.get(project.id) ?? EMPTY_STATISTICS,
+ archivedTasks: [],
+ plannedTasks: [],
+ columns: [],
+ }));
}
export default getProjects;
diff --git a/tests/api-integration/project-list.test.ts b/tests/api-integration/project-list.test.ts
new file mode 100644
index 000000000..25b46f03f
--- /dev/null
+++ b/tests/api-integration/project-list.test.ts
@@ -0,0 +1,157 @@
+import { beforeEach, describe, expect, it } from "vitest";
+import db, { schema } from "../../apps/api/src/database";
+import { createApp } from "../../apps/api/src/index";
+import { mockAuthenticatedSession } from "./helpers/auth";
+import { resetTestDatabase } from "./helpers/database";
+import {
+ createProjectFixture,
+ createWorkspaceMember,
+} from "./helpers/fixtures";
+
+type ProjectListEntry = typeof schema.projectTable.$inferSelect & {
+ statistics: {
+ completionPercentage: number;
+ totalTasks: number;
+ dueDate: string | null;
+ };
+ tasks?: unknown;
+};
+
+async function seedTasks(
+ projectId: string,
+ tasks: { title: string; status: string; dueDate?: Date; number: number }[],
+) {
+ for (const task of tasks) {
+ await db.insert(schema.taskTable).values({
+ projectId,
+ title: task.title,
+ status: task.status,
+ dueDate: task.dueDate ?? null,
+ number: task.number,
+ });
+ }
+}
+
+describe("API integration: project list payload", () => {
+ beforeEach(async () => {
+ await resetTestDatabase();
+ });
+
+ it("does not embed task rows in the project list response", async () => {
+ const member = await createWorkspaceMember();
+ const { project } = await createProjectFixture({
+ workspaceId: member.workspace.id,
+ });
+
+ await seedTasks(project.id, [
+ { title: "First", status: "to-do", number: 1 },
+ { title: "Second", status: "done", number: 2 },
+ { title: "Third", status: "archived", number: 3 },
+ ]);
+
+ mockAuthenticatedSession(member.user);
+ const { app } = createApp();
+
+ const response = await app.request(
+ `/api/project?workspaceId=${member.workspace.id}`,
+ );
+
+ expect(response.status).toBe(200);
+ const payload = (await response.json()) as ProjectListEntry[];
+ expect(payload).toHaveLength(1);
+
+ // The list endpoint is a summary view. Task rows must not ride along:
+ // the payload grows without bound as a project fills up.
+ expect(payload[0].tasks).toBeUndefined();
+ });
+
+ it("still reports accurate task statistics without embedding tasks", async () => {
+ const member = await createWorkspaceMember();
+ const { project } = await createProjectFixture({
+ workspaceId: member.workspace.id,
+ });
+
+ const earliest = new Date("2026-01-10T00:00:00.000Z");
+ const later = new Date("2026-03-01T00:00:00.000Z");
+
+ await seedTasks(project.id, [
+ { title: "Open", status: "to-do", dueDate: later, number: 1 },
+ { title: "Closed", status: "done", dueDate: earliest, number: 2 },
+ { title: "Filed", status: "archived", number: 3 },
+ { title: "Doing", status: "in-progress", number: 4 },
+ ]);
+
+ mockAuthenticatedSession(member.user);
+ const { app } = createApp();
+
+ const response = await app.request(
+ `/api/project?workspaceId=${member.workspace.id}`,
+ );
+ const payload = (await response.json()) as ProjectListEntry[];
+
+ // done + archived count as completed: 2 of 4 => 50%
+ expect(payload[0].statistics).toMatchObject({
+ totalTasks: 4,
+ completionPercentage: 50,
+ });
+ expect(new Date(payload[0].statistics.dueDate as string)).toEqual(earliest);
+ });
+
+ it("reports zeroed statistics for a project with no tasks", async () => {
+ const member = await createWorkspaceMember();
+ await createProjectFixture({ workspaceId: member.workspace.id });
+
+ mockAuthenticatedSession(member.user);
+ const { app } = createApp();
+
+ const response = await app.request(
+ `/api/project?workspaceId=${member.workspace.id}`,
+ );
+ const payload = (await response.json()) as ProjectListEntry[];
+
+ expect(payload[0].statistics).toMatchObject({
+ totalTasks: 0,
+ completionPercentage: 0,
+ dueDate: null,
+ });
+ expect(payload[0].tasks).toBeUndefined();
+ });
+
+ it("keeps statistics isolated per project", async () => {
+ const member = await createWorkspaceMember();
+ const { project: alpha } = await createProjectFixture({
+ workspaceId: member.workspace.id,
+ name: "Alpha",
+ slug: "alpha",
+ });
+ const { project: beta } = await createProjectFixture({
+ workspaceId: member.workspace.id,
+ name: "Beta",
+ slug: "beta",
+ });
+
+ await seedTasks(alpha.id, [
+ { title: "A1", status: "done", number: 1 },
+ { title: "A2", status: "to-do", number: 2 },
+ ]);
+ await seedTasks(beta.id, [{ title: "B1", status: "done", number: 1 }]);
+
+ mockAuthenticatedSession(member.user);
+ const { app } = createApp();
+
+ const response = await app.request(
+ `/api/project?workspaceId=${member.workspace.id}`,
+ );
+ const payload = (await response.json()) as ProjectListEntry[];
+
+ const byName = new Map(payload.map((p) => [p.name, p]));
+ expect(byName.get("Alpha")?.statistics).toMatchObject({
+ totalTasks: 2,
+ completionPercentage: 50,
+ });
+ expect(byName.get("Beta")?.statistics).toMatchObject({
+ totalTasks: 1,
+ completionPercentage: 100,
+ });
+ });
+});