Speed up issue-to-issue navigation

2026-04-11 11:05:32 -05:00
parent 11de5ae9c9
commit 1729e41179
8 changed files with 347 additions and 32 deletions
@@ -0,0 +1,116 @@
+import { QueryClient } from "@tanstack/react-query";
+import type { Issue } from "@paperclipai/shared";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { issuesApi } from "@/api/issues";
+import {
+  fetchIssueDetail,
+  getCachedIssueDetail,
+  prefetchIssueDetail,
+  seedIssueDetailCache,
+} from "./issueDetailCache";
+import { queryKeys } from "./queryKeys";
+
+vi.mock("@/api/issues", () => ({
+  issuesApi: {
+    get: vi.fn(),
+  },
+}));
+
+function createIssue(overrides: Partial<Issue> = {}): Issue {
+  return {
+    id: "issue-1",
+    identifier: "PAP-1",
+    companyId: "company-1",
+    projectId: null,
+    projectWorkspaceId: null,
+    goalId: null,
+    parentId: null,
+    title: "Fast link target",
+    description: null,
+    status: "todo",
+    priority: "medium",
+    assigneeAgentId: null,
+    assigneeUserId: null,
+    createdByAgentId: null,
+    createdByUserId: null,
+    issueNumber: 1,
+    requestDepth: 0,
+    billingCode: null,
+    assigneeAdapterOverrides: null,
+    executionWorkspaceId: null,
+    executionWorkspacePreference: null,
+    executionWorkspaceSettings: null,
+    checkoutRunId: null,
+    executionRunId: null,
+    executionAgentNameKey: null,
+    executionLockedAt: null,
+    startedAt: null,
+    completedAt: null,
+    cancelledAt: null,
+    hiddenAt: null,
+    createdAt: new Date("2026-04-11T00:00:00.000Z"),
+    updatedAt: new Date("2026-04-11T00:00:00.000Z"),
+    labels: [],
+    labelIds: [],
+    myLastTouchAt: null,
+    lastExternalCommentAt: null,
+    isUnreadForMe: false,
+    ...overrides,
+  };
+}
+
+describe("issueDetailCache", () => {
+  let queryClient: QueryClient;
+
+  beforeEach(() => {
+    queryClient = new QueryClient({
+      defaultOptions: {
+        queries: {
+          retry: false,
+        },
+      },
+    });
+    vi.clearAllMocks();
+  });
+
+  it("seeds and resolves issue detail by both identifier and id", () => {
+    const issue = createIssue();
+
+    seedIssueDetailCache(queryClient, issue, { issueRef: issue.identifier });
+
+    expect(getCachedIssueDetail(queryClient, issue.identifier)).toEqual(issue);
+    expect(getCachedIssueDetail(queryClient, issue.id)).toEqual(issue);
+    expect(queryClient.getQueryData(queryKeys.issues.detail(issue.identifier!))).toEqual(issue);
+    expect(queryClient.getQueryData(queryKeys.issues.detail(issue.id))).toEqual(issue);
+  });
+
+  it("prefetches with the provided issue snapshot before the network result lands", async () => {
+    const issue = createIssue();
+    let releaseFetch: (() => void) | null = null;
+    vi.mocked(issuesApi.get).mockImplementation(
+      () =>
+        new Promise<Issue>((resolve) => {
+          releaseFetch = () => resolve(issue);
+        }),
+    );
+
+    const prefetchPromise = prefetchIssueDetail(queryClient, issue.identifier!, { issue });
+
+    expect(getCachedIssueDetail(queryClient, issue.identifier)).toEqual(issue);
+    expect(getCachedIssueDetail(queryClient, issue.id)).toEqual(issue);
+
+    releaseFetch?.();
+    await prefetchPromise;
+  });
+
+  it("hydrates both cache aliases from a fetched issue detail response", async () => {
+    const issue = createIssue();
+    vi.mocked(issuesApi.get).mockResolvedValue(issue);
+
+    const result = await fetchIssueDetail(queryClient, issue.identifier!);
+
+    expect(result).toEqual(issue);
+    expect(queryClient.getQueryData(queryKeys.issues.detail(issue.identifier!))).toEqual(issue);
+    expect(queryClient.getQueryData(queryKeys.issues.detail(issue.id))).toEqual(issue);
+  });
+});