Skip to content

⭐️⭐️⭐️ Open-source, self-hosted alternative to Linear and Plane. Project management and issue tracking where teams and AI agents work side by side to plan and ship products.

improvement(api): list issues with their time, status time and parent (#765)

Kene61895a0ab8b
diff --git a/apps/api/src/modules/issues/__tests__/integration/issues.test.ts b/apps/api/src/modules/issues/__tests__/integration/issues.test.ts
index 02845efa..0efeeb4f 100644
--- a/apps/api/src/modules/issues/__tests__/integration/issues.test.ts
+++ b/apps/api/src/modules/issues/__tests__/integration/issues.test.ts
@@ -1319,6 +1319,41 @@ describe('issues', () => {
expect(after.completedAt).toBeInstanceOf(Date);
});
+ it('returns the time, the status time and the parent', async () => {
+ const { asOwner, columnId, columnIds } = await setupProject();
+ const parent = (await createIssue(asOwner, columnId, { title: 'Parent' })).data!;
+ const child = (
+ await createIssue(asOwner, columnId, {
+ title: 'Child',
+ parentId: parent.id,
+ estimateMinutes: 120,
+ })
+ ).data!;
+ const spentOn = new Date().toISOString().slice(0, 10);
+ await asOwner.issues({ issueId: child.id }).worklogs.post({ minutes: 30, spentOn });
+ await asOwner.issues({ issueId: child.id }).worklogs.post({ minutes: 15, spentOn });
+
+ const before = (await list(asOwner)).data!;
+ expect(before.find((i) => i.id === parent.id)).toMatchObject({
+ parent: null,
+ estimateMinutes: null,
+ loggedMinutes: 0,
+ });
+ const fresh = before.find((i) => i.id === child.id)!;
+ expect(fresh).toMatchObject({
+ parent: { id: parent.id, identifier: parent.identifier, title: 'Parent' },
+ estimateMinutes: 120,
+ loggedMinutes: 45,
+ });
+ const full = async () => (await asOwner.issues({ issueId: child.id }).get()).data!;
+ expect(fresh.statusSince).toEqual((await full()).statusSince);
+
+ await asOwner.issues({ issueId: child.id }).patch({ columnId: columnIds[1] });
+ const moved = (await list(asOwner)).data!.find((i) => i.id === child.id)!;
+ expect(moved.statusSince).toEqual((await full()).statusSince);
+ expect(moved.statusSince).not.toEqual(fresh.statusSince);
+ });
+
it('filters by created and updated time', async () => {
const { asOwner, columnId } = await setupProject();
const one = (await createIssue(asOwner, columnId, { title: 'Timed' })).data!;
diff --git a/apps/api/src/modules/issues/index.ts b/apps/api/src/modules/issues/index.ts
index 18861672..a7a8ed34 100644
--- a/apps/api/src/modules/issues/index.ts
+++ b/apps/api/src/modules/issues/index.ts
@@ -499,7 +499,7 @@ export const issueRoutes = new Elysia({ name: 'issues', detail: { tags: ['Issues
detail: {
summary: 'List issues by filters',
description:
- "List a project's issues by field filters, most recently updated first. Each issue carries createdAt, updatedAt and completedAt.",
+ "List a project's issues by field filters, most recently updated first. Each issue carries createdAt, updatedAt, completedAt, statusSince (when it entered its current column), estimateMinutes, loggedMinutes and its parent's identifier and title.",
...mcpTool('list_issues'),
},
},
diff --git a/apps/api/src/modules/issues/model.ts b/apps/api/src/modules/issues/model.ts
index 90bf66e5..39484c6a 100644
--- a/apps/api/src/modules/issues/model.ts
+++ b/apps/api/src/modules/issues/model.ts
@@ -324,14 +324,18 @@ export const IssueSearchHitResponse = t.Object({
initiativeId: t.Nullable(t.Number()),
cycleId: t.Nullable(t.Number()),
parentId: t.Nullable(t.Number()),
+ parent: t.Nullable(t.Object({ id: t.Number(), identifier: t.String(), title: t.String() })),
assigneeUserId: t.Nullable(t.String()),
delegateUserId: t.Nullable(t.String()),
priority: t.Nullable(t.String()),
dueDate: t.Nullable(t.String()),
+ estimateMinutes: t.Nullable(t.Number()),
+ loggedMinutes: t.Number(),
labelIds: t.Array(t.Number()),
archived: t.Boolean(),
createdAt: t.String(),
updatedAt: t.String(),
+ statusSince: t.String(),
completedAt: t.Nullable(t.String()),
});
diff --git a/apps/api/src/modules/issues/service.ts b/apps/api/src/modules/issues/service.ts
index 2bc5cb6b..11ad695d 100644
--- a/apps/api/src/modules/issues/service.ts
+++ b/apps/api/src/modules/issues/service.ts
@@ -11,6 +11,7 @@ import {
issueFieldOption,
issueAttachment,
issueKeyAlias,
+ issueWorklog,
customField,
customFieldOption,
initiative,
@@ -257,14 +258,18 @@ export interface IssueSearchHit {
initiativeId: number | null;
cycleId: number | null;
parentId: number | null;
+ parent: { id: number; identifier: string; title: string } | null;
assigneeUserId: string | null;
delegateUserId: string | null;
priority: string | null;
dueDate: string | null;
+ estimateMinutes: number | null;
+ loggedMinutes: number;
labelIds: number[];
archived: boolean;
createdAt: string;
updatedAt: string;
+ statusSince: string;
completedAt: string | null;
}
@@ -280,6 +285,17 @@ const completedAt = sql<Date | null>`(
AND p.state_type IS DISTINCT FROM 'completed'
AND (p.entered_at, p.id) > (s.entered_at, s.id)))`.mapWith(issueStatus.enteredAt);
+// The same values attachStatusSince and attachLoggedMinutes give a full IssueRow.
+const statusSince = sql<Date>`coalesce(
+ (SELECT s.entered_at FROM ${issueStatus} s WHERE s.issue_id = ${issue}.id AND s.left_at IS NULL),
+ ${issue}.created_at)`.mapWith(issueStatus.enteredAt);
+const loggedMinutes = sql<number>`(
+ SELECT coalesce(sum(w.minutes), 0)::int FROM ${issueWorklog} w WHERE w.issue_id = ${issue}.id)`;
+const parentSequenceNumber = sql<number | null>`(
+ SELECT p.sequence_number FROM ${issue} p WHERE p.id = ${issue}.parent_id)`;
+const parentTitle = sql<string | null>`(
+ SELECT p.title FROM ${issue} p WHERE p.id = ${issue}.parent_id)`;
+
// Escapes LIKE metacharacters so the query is matched literally (Postgres LIKE uses
// '\' as the default escape character).
function escapeLike(value: string): string {
@@ -339,28 +355,67 @@ const hitColumns = {
title: issue.title,
priority: issue.priority,
dueDate: issue.dueDate,
+ estimateMinutes: issue.estimateMinutes,
+ loggedMinutes,
archivedAt: issue.archivedAt,
createdAt: issue.createdAt,
updatedAt: issue.updatedAt,
+ statusSince,
completedAt,
+ parentSequenceNumber,
+ parentTitle,
};
type HitRow = Omit<
IssueSearchHit,
- 'identifier' | 'labelIds' | 'archived' | 'createdAt' | 'updatedAt' | 'completedAt'
-> & { archivedAt: Date | null; createdAt: Date; updatedAt: Date; completedAt: Date | null };
+ | 'identifier'
+ | 'parent'
+ | 'labelIds'
+ | 'archived'
+ | 'createdAt'
+ | 'updatedAt'
+ | 'statusSince'
+ | 'completedAt'
+> & {
+ archivedAt: Date | null;
+ createdAt: Date;
+ updatedAt: Date;
+ statusSince: Date;
+ completedAt: Date | null;
+ parentSequenceNumber: number | null;
+ parentTitle: string | null;
+};
function toHit(
- { archivedAt, createdAt, updatedAt, completedAt, ...r }: HitRow,
+ {
+ archivedAt,
+ createdAt,
+ updatedAt,
+ statusSince,
+ completedAt,
+ parentSequenceNumber,
+ parentTitle,
+ ...r
+ }: HitRow,
projectKey: string,
): IssueSearchHit {
return {
...r,
identifier: `${projectKey}-${r.sequenceNumber}`,
+ // A parent is always in the issue's own project, so it carries the same key.
+ parent:
+ r.parentId !== null && parentSequenceNumber !== null && parentTitle !== null
+ ? {
+ id: r.parentId,
+ identifier: `${projectKey}-${parentSequenceNumber}`,
+ title: parentTitle,
+ }
+ : null,
labelIds: [],
archived: archivedAt !== null,
createdAt: iso(createdAt),
updatedAt: iso(updatedAt),
+ statusSince: iso(statusSince),
completedAt: completedAt ? iso(completedAt) : null,
};
}