⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.
TypeScript honoissue-managementissue-trackerjira-alternativekanbanlinear-alternativemcpproject-managementreactself-hostedtypescript
fix(board): reconcile changing public pagination
Tineb619efd5807
diff --git a/apps/api/src/task/controllers/get-tasks.ts b/apps/api/src/task/controllers/get-tasks.tsindex 9b52542d0..e9a0b8dcc 100644--- a/apps/api/src/task/controllers/get-tasks.ts+++ b/apps/api/src/task/controllers/get-tasks.ts@@ -136,7 +136,14 @@ async function getTasksPage();const [taskCount] = await db- .select({ count: sql<number>`count(*)` })+ .select({+ count: sql<number>`count(*)`,+ ...(options.publicOnly+ ? {+ revision: sql<string>`coalesce(sum(hashtextextended(jsonb_build_array(${taskTable.id}, ${taskTable.updatedAt}, ${taskTable.position}, ${taskTable.status})::text, 0)::numeric), 0)::text`,+ }+ : {}),+ }).from(taskTable).where(whereClause);@@ -356,6 +363,9 @@ async function getTasksPage(},pagination: {total,+ ...(options.publicOnly+ ? { revision: `${total}:${taskCount?.revision}` }+ : {}),page,pageSize,totalPages: Math.max(1, Math.ceil(total / pageSize)),diff --git a/apps/api/src/task/response.ts b/apps/api/src/task/response.tsindex bb21e9e3a..692b90c69 100644--- a/apps/api/src/task/response.ts+++ b/apps/api/src/task/response.ts@@ -153,6 +153,10 @@ export const boardSchema = zrelatedPage: z.number(),relatedPageSize: z.number(),relatedTotalPages: z.number(),+ revision: z.string().optional().openapi({+ description:+ "Public board task membership and ordering revision. Restart pagination if it changes between task or related pages.",+ }),}).openapi({description:diff --git a/apps/docs/openapi.json b/apps/docs/openapi.jsonindex 838bbf5c2..08d45c22a 100644--- a/apps/docs/openapi.json+++ b/apps/docs/openapi.json@@ -336,6 +336,10 @@},"relatedTotalPages": {"type": "number"+ },+ "revision": {+ "type": "string",+ "description": "Public board task membership and ordering revision. Restart pagination if it changes between task or related pages."}},"required": [diff --git a/apps/web/src/fetchers/project/get-public-project.ts b/apps/web/src/fetchers/project/get-public-project.tsindex c6e077fc7..d0f4726f1 100644--- a/apps/web/src/fetchers/project/get-public-project.ts+++ b/apps/web/src/fetchers/project/get-public-project.ts@@ -5,6 +5,7 @@ import { HttpError } from "@/lib/http-error";export type GetPublicProjectRequest = InferRequestType<(typeof client)["public-project"][":id"]["$get"]>["param"];+class BoardChanged extends Error {}async function getPublicProject({ id }: GetPublicProjectRequest,signal?: AbortSignal,@@ -15,26 +16,38 @@ async function getPublicProject(>,) => void,) {- return loadBoardPages(- async (page, relatedPage) => {- const response = await client["public-project"][":id"].$get(- {- param: { id },- query: {- page: String(page),- limit: "100",- ...(relatedPage ? { relatedPage: String(relatedPage) } : {}),- },+ for (let attempt = 0; attempt < 3; attempt++) {+ let revision: string | undefined;+ try {+ return await loadBoardPages(+ async (page, relatedPage) => {+ const response = await client["public-project"][":id"].$get(+ {+ param: { id },+ query: {+ page: String(page),+ limit: "100",+ ...(relatedPage ? { relatedPage: String(relatedPage) } : {}),+ },+ },+ { init: { signal } },+ );+ if (!response.ok)+ throw new HttpError(response.status, await response.text());+ const { pagination, ...data } = await response.json();+ if (page === 1 && !relatedPage) revision = pagination.revision;+ else if (revision !== undefined && pagination.revision !== revision)+ throw new BoardChanged();+ return { data, pagination };},- { init: { signal } },+ signal,+ onProgress,);- if (!response.ok)- throw new HttpError(response.status, await response.text());- const { pagination, ...data } = await response.json();- return { data, pagination };- },- signal,- onProgress,- );+ } catch (error) {+ if (!(error instanceof BoardChanged) || attempt === 2) throw error;+ signal?.throwIfAborted();+ }+ }+ throw new BoardChanged();}export default getPublicProject;diff --git a/apps/web/src/fetchers/task/board-fetchers.test.ts b/apps/web/src/fetchers/task/board-fetchers.test.tsindex fdfedc074..41ae31289 100644--- a/apps/web/src/fetchers/task/board-fetchers.test.ts+++ b/apps/web/src/fetchers/task/board-fetchers.test.ts@@ -141,3 +141,100 @@ describe("authenticated and public board fetchers", () => {expect(publicRequest).toHaveBeenCalledTimes(2);});});++it("restarts a public board when concurrent membership or ordering changes its revision", async () => {+ let pass = 0;+ publicRequest.mockImplementation(+ async ({ query }: { query: { page: string; relatedPage?: string } }) => {+ const page = Number(query.page);+ if (page === 1 && !query.relatedPage) pass++;+ const board = data(page);+ board.columns[0].tasks[0].title =+ pass === 1 ? "stale task" : "current task";+ return Response.json({+ ...board,+ pagination: {+ page,+ pageSize: 100,+ total: 201,+ totalPages: 3,+ revision: pass === 1 && page === 1 ? "before edit" : "after edit",+ },+ });+ },+ );+ const result = await getPublicProject({ id: "project" });+ expect(+ publicRequest.mock.calls.map(([request]) => request.query.page),+ ).toEqual(["1", "2", "1", "2", "3"]);+ expect(result.columns[0].tasks.map((task) => task.id)).toEqual([+ "task-1",+ "task-2",+ "task-3",+ ]);+ expect(+ result.columns[0].tasks.every((task) => task.title === "current task"),+ ).toBe(true);+});+it("checks related continuations against the same public board revision", async () => {+ let pass = 0;+ publicRequest.mockImplementation(+ async ({ query }: { query: { relatedPage?: string } }) => {+ if (!query.relatedPage) pass++;+ return Response.json({+ ...data(1),+ pagination: {+ page: 1,+ pageSize: 100,+ total: 1,+ totalPages: 1,+ relatedTotalPages: 2,+ revision: pass === 1 && !query.relatedPage ? "old" : "new",+ },+ });+ },+ );+ await getPublicProject({ id: "project" });+ expect(publicRequest).toHaveBeenCalledTimes(4);+});+it("bounds public board restarts under continuous changes without committing an incomplete result", async () => {+ publicRequest.mockImplementation(+ async ({ query }: { query: { page: string } }) =>+ Response.json({+ ...data(Number(query.page)),+ pagination: {+ page: Number(query.page),+ pageSize: 100,+ total: 201,+ totalPages: 3,+ revision: query.page,+ },+ }),+ );+ await expect(getPublicProject({ id: "project" })).rejects.toThrow();+ expect(+ publicRequest.mock.calls.map(([request]) => request.query.page),+ ).toEqual(["1", "2", "1", "2", "1", "2"]);+});+it("honors cancellation before restarting a changed public board", async () => {+ const controller = new AbortController();+ publicRequest.mockImplementation(+ async ({ query }: { query: { page: string } }) => {+ if (query.page === "2") controller.abort();+ return Response.json({+ ...data(Number(query.page)),+ pagination: {+ page: Number(query.page),+ pageSize: 100,+ total: 201,+ totalPages: 3,+ revision: query.page,+ },+ });+ },+ );+ await expect(+ getPublicProject({ id: "project" }, controller.signal),+ ).rejects.toThrow();+ expect(publicRequest).toHaveBeenCalledTimes(2);+});diff --git a/tests/api-integration/task-pagination.test.ts b/tests/api-integration/task-pagination.test.tsindex c032f2c7a..dc26eb7dd 100644--- a/tests/api-integration/task-pagination.test.ts+++ b/tests/api-integration/task-pagination.test.ts@@ -199,3 +199,49 @@ describe("bounded task pages", () => {}});});++it.each(["create", "delete", "move", "reorder"])(+ "changes the public pagination revision after a concurrent %s",+ async (change) => {+ const { project, app, tasks } = await fixture(237, true);+ mockAnonymousSession();+ const first = await app.request(+ `/api/public-project/${project.id}?limit=100`,+ );+ const before = (await first.json()).pagination.revision;+ expect(typeof before).toBe("string");+ const stable = await app.request(+ `/api/public-project/${project.id}?page=2&limit=100`,+ );+ expect((await stable.json()).pagination.revision).toBe(before);+ if (change === "create")+ await db.insert(schema.taskTable).values({+ id: "new-public-task",+ projectId: project.id,+ title: "new",+ number: 999,+ position: 1,+ });+ else if (change === "delete")+ await db+ .delete(schema.taskTable)+ .where(eq(schema.taskTable.id, tasks[0].id));+ else if (change === "move") {+ const { project: other } = await createProjectFixture({+ workspaceId: project.workspaceId,+ });+ await db+ .update(schema.taskTable)+ .set({ projectId: other.id })+ .where(eq(schema.taskTable.id, tasks[0].id));+ } else+ await db+ .update(schema.taskTable)+ .set({ position: 200 })+ .where(eq(schema.taskTable.id, tasks[0].id));+ const later = await app.request(+ `/api/public-project/${project.id}?page=2&limit=100`,+ );+ expect((await later.json()).pagination.revision).not.toBe(before);+ },+);