Files
multica/packages/views/settings/components/workspace-tab.test.tsx
Bohan Jiang 6e0f7b0f36 feat(settings): allow editing workspace issue prefix (MUL-2369) (#2809)
* feat(settings): allow editing workspace issue prefix (MUL-2369)

Workspace admins can now change the issue prefix from Settings → General.
The change is gated by a confirmation dialog that warns about external
references (PR titles, branch names, links) breaking, because issue
identifiers are rendered as `prefix-N` on the fly — changing the prefix
effectively renames every existing issue.

Refs https://github.com/multica-ai/multica/issues/2797

Co-authored-by: multica-agent <github@multica.ai>

* fix(settings): invalidate issue cache when workspace prefix changes (MUL-2369)

Issue identifiers (`MUL-123`) are recomputed from `workspace.issue_prefix`
at read time, so cached issues kept showing the old `OLD-N` keys after a
prefix change. Without invalidation the confirm dialog's "all issues will
be renumbered" promise was broken until a hard refresh — and other tabs
receiving the `workspace:updated` WS event saw the same drift.

- WorkspaceTab: after a prefix-changing save, invalidate `issueKeys.all`
  in addition to the workspace list. Non-prefix saves stay cheap.
- Realtime: split `workspace:updated` out of the generic `workspace`
  refresh into a specific handler that compares cached vs incoming
  `issue_prefix` and invalidates issues only when it actually changed.
- Docs: align the "uppercase" language with the actual UI/backend rule
  (uppercase letters and digits, up to 10 chars).

Co-authored-by: multica-agent <github@multica.ai>

---------

Co-authored-by: multica-agent <github@multica.ai>
2026-05-19 14:47:34 +08:00

238 lines
7.8 KiB
TypeScript

import type { ReactNode } from "react";
import { describe, it, expect, beforeEach, vi } from "vitest";
import { render, screen, waitFor } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { I18nProvider } from "@multica/core/i18n/react";
import enCommon from "../../locales/en/common.json";
import enSettings from "../../locales/en/settings.json";
const mockUpdateWorkspace = vi.hoisted(() => vi.fn());
const mockInvalidateQueries = vi.hoisted(() => vi.fn());
const workspaceRef = vi.hoisted(() => ({
current: {
id: "workspace-1",
name: "Test Workspace",
slug: "test-workspace",
description: "",
context: "",
issue_prefix: "TES",
repos: [] as { url: string }[],
},
}));
const membersRef = vi.hoisted(() => ({
current: [{ user_id: "user-1", role: "owner" as "owner" | "admin" | "member" }],
}));
vi.mock("@tanstack/react-query", () => ({
useQuery: () => ({ data: membersRef.current, isFetched: true }),
useQueryClient: () => ({
setQueryData: vi.fn(),
getQueryData: vi.fn(() => []),
invalidateQueries: mockInvalidateQueries,
}),
}));
vi.mock("@multica/core/hooks", () => ({
useWorkspaceId: () => "workspace-1",
}));
vi.mock("@multica/core/paths", () => ({
useCurrentWorkspace: () => workspaceRef.current,
useHasOnboarded: () => true,
resolvePostAuthDestination: () => "/",
}));
vi.mock("@multica/core/platform", () => ({
setCurrentWorkspace: vi.fn(),
}));
vi.mock("@multica/core/workspace/queries", () => ({
memberListOptions: () => ({ queryKey: ["members"], queryFn: vi.fn() }),
workspaceListOptions: () => ({ queryKey: ["workspaces"], queryFn: vi.fn() }),
workspaceKeys: { list: () => ["workspaces"] },
}));
vi.mock("@multica/core/issues/queries", () => ({
issueKeys: { all: (wsId: string) => ["issues", wsId] },
}));
vi.mock("@multica/core/workspace/mutations", () => ({
useLeaveWorkspace: () => ({ mutateAsync: vi.fn() }),
useDeleteWorkspace: () => ({ mutateAsync: vi.fn() }),
}));
vi.mock("@multica/core/api", () => ({
api: { updateWorkspace: mockUpdateWorkspace },
}));
vi.mock("@multica/core/auth", () => {
const useAuthStore = Object.assign(
(sel?: (s: { user: { id: string } }) => unknown) =>
sel ? sel({ user: { id: "user-1" } }) : { user: { id: "user-1" } },
{ getState: () => ({ user: { id: "user-1" } }) },
);
return { useAuthStore };
});
vi.mock("../../navigation", () => ({
useNavigation: () => ({ push: vi.fn() }),
}));
vi.mock("./delete-workspace-dialog", () => ({
DeleteWorkspaceDialog: () => null,
}));
vi.mock("sonner", () => ({
toast: { success: vi.fn(), error: vi.fn() },
}));
import { WorkspaceTab } from "./workspace-tab";
const TEST_RESOURCES = {
en: { common: enCommon, settings: enSettings },
};
function I18nWrapper({ children }: { children: ReactNode }) {
return (
<I18nProvider locale="en" resources={TEST_RESOURCES}>
{children}
</I18nProvider>
);
}
describe("WorkspaceTab — issue prefix editing", () => {
beforeEach(() => {
vi.clearAllMocks();
workspaceRef.current = {
id: "workspace-1",
name: "Test Workspace",
slug: "test-workspace",
description: "",
context: "",
issue_prefix: "TES",
repos: [],
};
membersRef.current = [{ user_id: "user-1", role: "owner" }];
mockUpdateWorkspace.mockImplementation(
async (
_id: string,
payload: { issue_prefix?: string; name?: string },
) => ({
...workspaceRef.current,
...payload,
issue_prefix: payload.issue_prefix ?? workspaceRef.current.issue_prefix,
}),
);
});
it("renders the current prefix in the input", () => {
render(<WorkspaceTab />, { wrapper: I18nWrapper });
const input = screen.getByPlaceholderText("TES") as HTMLInputElement;
expect(input.value).toBe("TES");
});
it("uppercases and strips non-alphanumeric input as the user types", async () => {
const user = userEvent.setup();
render(<WorkspaceTab />, { wrapper: I18nWrapper });
const input = screen.getByPlaceholderText("TES") as HTMLInputElement;
await user.clear(input);
await user.type(input, "ab-12!cd");
expect(input.value).toBe("AB12CD");
});
it("saves directly without confirm when the prefix is unchanged", async () => {
const user = userEvent.setup();
render(<WorkspaceTab />, { wrapper: I18nWrapper });
await user.click(screen.getByRole("button", { name: /^Save$/ }));
await waitFor(() => {
expect(mockUpdateWorkspace).toHaveBeenCalledTimes(1);
});
// No issue_prefix in the payload when unchanged — avoids no-op churn
// and keeps the request shape identical to pre-feature behavior.
expect(mockUpdateWorkspace).toHaveBeenCalledWith(
"workspace-1",
expect.not.objectContaining({ issue_prefix: expect.anything() }),
);
expect(screen.queryByText(/Change issue prefix/i)).toBeNull();
// Non-prefix saves must NOT invalidate the issue cache — would
// trigger an unnecessary workspace-wide refetch on every name edit.
expect(mockInvalidateQueries).not.toHaveBeenCalledWith(
expect.objectContaining({ queryKey: ["issues", "workspace-1"] }),
);
});
it("shows a confirm dialog before saving when the prefix changes, and only saves on confirm", async () => {
const user = userEvent.setup();
render(<WorkspaceTab />, { wrapper: I18nWrapper });
const input = screen.getByPlaceholderText("TES") as HTMLInputElement;
await user.clear(input);
await user.type(input, "NEW");
await user.click(screen.getByRole("button", { name: /^Save$/ }));
// Save is gated behind the dialog — no API call yet.
expect(mockUpdateWorkspace).not.toHaveBeenCalled();
// Dialog body mentions both the old and new prefix in the warning.
await screen.findByText(/Change issue prefix/i);
expect(screen.getByText(/TES-N/)).toBeTruthy();
expect(screen.getByText(/NEW-N/)).toBeTruthy();
await user.click(screen.getByRole("button", { name: "Confirm" }));
await waitFor(() => {
expect(mockUpdateWorkspace).toHaveBeenCalledTimes(1);
});
expect(mockUpdateWorkspace).toHaveBeenCalledWith(
"workspace-1",
expect.objectContaining({ issue_prefix: "NEW" }),
);
// Issue identifiers (`MUL-123`) are recomputed from the workspace
// prefix at read time, so cached issues display the stale OLD-N key
// until invalidated. Without this the confirm dialog's promise that
// "all issues will be renumbered to NEW-N" is a lie.
expect(mockInvalidateQueries).toHaveBeenCalledWith(
expect.objectContaining({ queryKey: ["issues", "workspace-1"] }),
);
});
it("cancelling the confirm dialog does not save", async () => {
const user = userEvent.setup();
render(<WorkspaceTab />, { wrapper: I18nWrapper });
const input = screen.getByPlaceholderText("TES") as HTMLInputElement;
await user.clear(input);
await user.type(input, "NEW");
await user.click(screen.getByRole("button", { name: /^Save$/ }));
await screen.findByText(/Change issue prefix/i);
await user.click(screen.getByRole("button", { name: "Cancel" }));
expect(mockUpdateWorkspace).not.toHaveBeenCalled();
// The user's edited value is preserved so they can resume.
expect(input.value).toBe("NEW");
});
it("disables Save when the prefix is empty", async () => {
const user = userEvent.setup();
render(<WorkspaceTab />, { wrapper: I18nWrapper });
const input = screen.getByPlaceholderText("TES") as HTMLInputElement;
await user.clear(input);
expect(screen.getByRole("button", { name: /^Save$/ })).toBeDisabled();
});
it("disables the prefix input for non-admins", () => {
membersRef.current = [{ user_id: "user-1", role: "member" }];
render(<WorkspaceTab />, { wrapper: I18nWrapper });
expect(screen.getByPlaceholderText("TES")).toBeDisabled();
});
});