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(board): preserve edits during initial pagination

Tin667e4427aa5e
diff --git a/apps/web/src/hooks/queries/task/use-get-tasks.test.tsx b/apps/web/src/hooks/queries/task/use-get-tasks.test.tsx
index aca2840e5..78d9990da 100644
--- a/apps/web/src/hooks/queries/task/use-get-tasks.test.tsx
+++ b/apps/web/src/hooks/queries/task/use-get-tasks.test.tsx
@@ -1,5 +1,5 @@
import { QueryClientProvider } from "@tanstack/react-query";
-import { cleanup, renderHook, waitFor } from "@testing-library/react";
+import { act, cleanup, renderHook, waitFor } from "@testing-library/react";
import type { ReactNode } from "react";
import { afterEach, describe, expect, it, vi } from "vite-plus/test";
import queryClient from "@/query-client";
@@ -116,3 +116,67 @@ it.each(["private", "public"])(
await waitFor(() => expect(result.current.data).toEqual(completed));
},
);
+
+it.each(["create", "delete", "move", "edit"])(
+ "replays a local %s invalidation after initial pagination",
+ async (operation) => {
+ let finish!: (value: unknown) => void;
+ const stale = {
+ id: "initial",
+ columns: [{ tasks: [{ id: "old", title: "Before" }] }],
+ };
+ const current = {
+ id: "initial",
+ columns: [
+ {
+ tasks:
+ operation === "delete" || operation === "move"
+ ? []
+ : [
+ {
+ id: operation === "create" ? "new" : "old",
+ title: "After",
+ },
+ ],
+ },
+ ],
+ };
+ getTasks
+ .mockImplementationOnce((_id, _signal, onProgress) => {
+ onProgress(stale);
+ return new Promise((resolve) => {
+ finish = resolve;
+ });
+ })
+ .mockResolvedValue(current);
+ const { result } = renderHook(() => useGetTasks("initial"), {
+ wrapper: Wrapper,
+ });
+ await waitFor(() => expect(result.current.data).toEqual(stale));
+ expect(queryClient.getQueryData(["tasks", "initial"])).toBeUndefined();
+ act(() => {
+ for (let count = 0; count < 20; count++)
+ void queryClient.invalidateQueries({ queryKey: ["tasks", "initial"] });
+ });
+ act(() => finish(stale));
+ await waitFor(() => expect(result.current.data).toEqual(current));
+ expect(getTasks).toHaveBeenCalledTimes(2);
+ },
+);
+it("does not restart a cancelled initial board after a queued local invalidation", async () => {
+ let finish!: (value: unknown) => void;
+ getTasks.mockImplementationOnce(
+ () =>
+ new Promise((resolve) => {
+ finish = resolve;
+ }),
+ );
+ renderHook(() => useGetTasks("cancelled"), { wrapper: Wrapper });
+ await waitFor(() => expect(getTasks).toHaveBeenCalledOnce());
+ void queryClient.invalidateQueries({ queryKey: ["tasks", "cancelled"] });
+ await queryClient.cancelQueries({ queryKey: ["tasks", "cancelled"] });
+ act(() => finish({ id: "cancelled", columns: [] }));
+ await Promise.resolve();
+ expect(getTasks).toHaveBeenCalledOnce();
+ expect(queryClient.getQueryData(["tasks", "cancelled"])).toBeUndefined();
+});
diff --git a/apps/web/src/hooks/queries/task/use-get-tasks.ts b/apps/web/src/hooks/queries/task/use-get-tasks.ts
index 7f9622af8..d57e787c0 100644
--- a/apps/web/src/hooks/queries/task/use-get-tasks.ts
+++ b/apps/web/src/hooks/queries/task/use-get-tasks.ts
@@ -13,10 +13,49 @@ export function useGetTasks(projectId: string) {
setProgress(undefined);
markBoardCacheChanged(queryClient, projectId);
const hasCachedBoard = !!queryClient.getQueryData(["tasks", projectId]);
+ let invalidated = false;
+ const unsubscribe = hasCachedBoard
+ ? () => {}
+ : queryClient.getQueryCache().subscribe((event) => {
+ if (
+ event.query.queryKey[0] !== "tasks" ||
+ event.query.queryKey[1] !== projectId
+ )
+ return;
+ if (event.type === "updated" && event.action.type === "invalidate")
+ invalidated = true;
+ if (
+ event.type === "removed" ||
+ (event.type === "updated" &&
+ event.query.state.fetchStatus === "idle")
+ ) {
+ unsubscribe();
+ if (
+ invalidated &&
+ !signal.aborted &&
+ event.type === "updated" &&
+ event.action.type === "success"
+ ) {
+ queueMicrotask(() => {
+ if (
+ signal.aborted ||
+ !queryClient.getQueryData(["tasks", projectId])
+ )
+ return;
+ void queryClient.invalidateQueries({
+ queryKey: ["tasks", projectId],
+ });
+ });
+ }
+ }
+ });
try {
return await getTasks(projectId, signal, (board) => {
if (!hasCachedBoard) setProgress(board);
});
+ } catch (error) {
+ unsubscribe();
+ throw error;
} finally {
setProgress(undefined);
}
diff --git a/apps/web/src/routes/public-project.$projectId.test.tsx b/apps/web/src/routes/public-project.$projectId.test.tsx
new file mode 100644
index 000000000..433fcf672
--- /dev/null
+++ b/apps/web/src/routes/public-project.$projectId.test.tsx
@@ -0,0 +1,100 @@
+import { cleanup, fireEvent, render, screen } from "@testing-library/react";
+import type { ComponentType } from "react";
+import { afterEach, expect, it, vi } from "vite-plus/test";
+import type { ProjectWithTasks } from "@/types/project";
+import type Task from "@/types/task";
+import { Route } from "./public-project.$projectId";
+const m = vi.hoisted(() => ({
+ project: undefined as ProjectWithTasks | undefined,
+ modal: {} as { task?: Task | null; open?: boolean },
+}));
+vi.mock("@tanstack/react-router", () => ({
+ createFileRoute: () => (options: unknown) => ({
+ options,
+ useParams: () => ({ projectId: "p" }),
+ }),
+}));
+vi.mock("@/hooks/queries/project/use-get-public-project", () => ({
+ default: () => ({ data: m.project, isLoading: false }),
+}));
+vi.mock("react-i18next", () => ({
+ useTranslation: () => ({ t: (key: string) => key }),
+}));
+vi.mock("@/components/public-project/project-description", () => ({
+ PublicProjectDescription: () => null,
+}));
+vi.mock("@/components/page-title", () => ({ default: () => null }));
+vi.mock("@/components/public-project/kanban-view", () => ({
+ PublicKanbanView: ({
+ project,
+ onTaskClick,
+ }: {
+ project: ProjectWithTasks;
+ onTaskClick: (task: Task) => void;
+ }) => (
+ <button
+ onClick={() => {
+ const task = project.columns[0]?.tasks[0];
+ if (task) onTaskClick(task);
+ }}
+ >
+ Open task
+ </button>
+ ),
+}));
+vi.mock("@/components/public-project/list-view", () => ({
+ PublicListView: () => null,
+}));
+vi.mock("@/components/public-project/task-detail-modal", () => ({
+ PublicTaskDetailModal: (props: typeof m.modal) => {
+ m.modal = props;
+ return props.open ? (
+ <output data-testid="detail">
+ {props.task?.labels?.map((label) => label.name).join(",")}
+ </output>
+ ) : null;
+ },
+}));
+afterEach(cleanup);
+it("updates an open task dialog as related pages hydrate and closes when the task disappears", () => {
+ localStorage.setItem("kaneo-public-view-mode", "kanban");
+ const task = {
+ id: "task",
+ title: "Card",
+ labels: [{ id: "one", name: "First", color: "red" }],
+ externalLinks: [],
+ } as unknown as Task;
+ m.project = {
+ id: "p",
+ name: "Public",
+ slug: "PUB",
+ icon: null,
+ description: null,
+ columns: [{ id: "todo", tasks: [task] }],
+ plannedTasks: [],
+ archivedTasks: [],
+ } as unknown as ProjectWithTasks;
+ const Component = Route.options.component as ComponentType;
+ const { rerender } = render(<Component />);
+ fireEvent.click(screen.getByText("Open task"));
+ expect(screen.getByTestId("detail").textContent).toBe("First");
+ const hydrated = {
+ ...task,
+ labels: [...task.labels!, { id: "two", name: "Second", color: "blue" }],
+ externalLinks: [{ id: "pr", title: "Pull request" }],
+ } as Task;
+ m.project = {
+ ...m.project,
+ columns: [{ ...m.project.columns[0], tasks: [hydrated] }],
+ };
+ rerender(<Component />);
+ expect(screen.getByTestId("detail").textContent).toBe("First,Second");
+ expect(m.modal.task?.externalLinks).toEqual(hydrated.externalLinks);
+ m.project = {
+ ...m.project,
+ columns: [{ ...m.project.columns[0], tasks: [] }],
+ };
+ rerender(<Component />);
+ expect(m.modal.task).toBeNull();
+ expect(m.modal.open).toBe(false);
+});
diff --git a/apps/web/src/routes/public-project.$projectId.tsx b/apps/web/src/routes/public-project.$projectId.tsx
index f34a61048..db9c9a1a0 100644
--- a/apps/web/src/routes/public-project.$projectId.tsx
+++ b/apps/web/src/routes/public-project.$projectId.tsx
@@ -1,6 +1,6 @@
import { createFileRoute } from "@tanstack/react-router";
import { Layout, List } from "lucide-react";
-import { createElement, useEffect, useState } from "react";
+import { createElement, useEffect, useMemo, useState } from "react";
import { useTranslation } from "react-i18next";
import PageTitle from "@/components/page-title";
import { CopyUrlButton } from "@/components/public-project/copy-url-button";
@@ -38,7 +38,19 @@ function RouteComponent() {
return "kanban";
});
- const [selectedTask, setSelectedTask] = useState<Task | null>(null);
+ const [selectedTaskId, setSelectedTaskId] = useState<string | null>(null);
+ const selectedTask = useMemo(() => {
+ if (!selectedTaskId || !project) return null;
+ for (const column of project.columns) {
+ const task = column.tasks.find((task) => task.id === selectedTaskId);
+ if (task) return task;
+ }
+ return (
+ project.plannedTasks.find((task) => task.id === selectedTaskId) ??
+ project.archivedTasks.find((task) => task.id === selectedTaskId) ??
+ null
+ );
+ }, [project, selectedTaskId]);
const [isTaskModalOpen, setIsTaskModalOpen] = useState(false);
useEffect(() => {
@@ -46,13 +58,13 @@ function RouteComponent() {
}, [viewMode]);
const handleTaskClick = (task: Task) => {
- setSelectedTask(task);
+ setSelectedTaskId(task.id);
setIsTaskModalOpen(true);
};
const handleTaskModalClose = () => {
setIsTaskModalOpen(false);
- setSelectedTask(null);
+ setSelectedTaskId(null);
};
if (isLoading && !project) {
@@ -142,7 +154,7 @@ function RouteComponent() {
task={selectedTask}
projectSlug={project.slug}
columns={project.columns}
- open={isTaskModalOpen}
+ open={isTaskModalOpen && !!selectedTask}
onOpenChange={handleTaskModalClose}
/>
</div>