test: migrate to MSW testing architecture for App integration test

Major testing infrastructure upgrade from manual mocks to Mock Service Worker (MSW):

New MSW infrastructure (tests/msw/):
- Add state.ts: In-memory state manager with full CRUD operations
  - Manage providers and current selections per app type (Claude/Codex)
  - Auto-switch current provider when deleted
  - Deep clone to prevent reference pollution
- Add handlers.ts: HTTP request handlers for 10 Tauri API endpoints
  - Mock get_providers, switch_provider, add/update/delete_provider
  - Mock update_sort_order, update_tray_menu, import_default_config
  - Support error scenarios (404 for non-existent providers)
- Add tauriMocks.ts: Tauri API mock layer
  - Transparently convert invoke() calls to HTTP requests
  - Mock event listener system with emitTauriEvent helper
  - Use cross-fetch for Node.js environment
- Add server.ts: MSW server setup for Node.js test environment

Refactor App.test.tsx (-170 lines, -43%):
- Remove 23 manual mocks (useProvidersQuery, useProviderActions, etc.)
- Run real hooks with MSW-backed API calls instead of mock implementations
- Test real state changes instead of mock call counts
- Add comprehensive flow: duplicate → create → edit → delete → event listening
- Verify actual provider list changes and current selection updates

Setup integration:
- Add MSW server lifecycle to tests/setupTests.ts
  - Start server before all tests
  - Reset handlers and state after each test
  - Close server after all tests complete
- Clear all mocks in afterEach for test isolation

Dependencies:
- Add msw@^2.11.6 for API mocking
- Add cross-fetch@^4.1.0 for fetch polyfill in Node.js

Type fixes:
- Add missing imports (AppType, Provider) in handlers.ts
- Fix HttpResponse.json generic constraint with as any (MSW best practice)
- Change invalid category "default" to "official" in state.ts

Test results: All 50 tests passing across 8 files, 0 TypeScript errors
This commit is contained in:
Jason
2025-10-25 16:48:43 +08:00
parent 2c7dcb023a
commit 96a8712f2d
8 changed files with 793 additions and 265 deletions

View File

@@ -1,144 +1,21 @@
import { Suspense } from "react";
import { describe, it, expect, vi, beforeEach, beforeAll } from "vitest";
import { describe, it, expect, vi, beforeEach } from "vitest";
import { render, screen, waitFor, fireEvent } from "@testing-library/react";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import App from "@/App";
import { resetProviderState, listProviders } from "../msw/state";
import { emitTauriEvent } from "../msw/tauriMocks";
const {
toastSuccessMock,
toastErrorMock,
deleteProviderMock,
addProviderMock,
updateProviderMock,
saveUsageScriptMock,
onSwitchedMock,
updateSortOrderMock,
updateTrayMenuMock,
openExternalMock,
useProvidersQueryMock,
useProviderActionsMock,
providersDataMock,
getAllMock,
getCurrentMock,
importDefaultMock,
} = vi.hoisted(() => {
const deleteProviderMock = vi.fn();
const addProviderMock = vi.fn();
const updateProviderMock = vi.fn();
const saveUsageScriptMock = vi.fn();
const onSwitchedMock = vi.fn();
const updateSortOrderMock = vi.fn();
const updateTrayMenuMock = vi.fn();
const openExternalMock = vi.fn();
const useProvidersQueryMock = vi.fn();
const getAllMock = vi.fn();
const getCurrentMock = vi.fn();
const importDefaultMock = vi.fn();
const toastSuccessMock = vi.fn();
const toastErrorMock = vi.fn();
const providersDataMock = {
claude: [
{
id: "claude-1",
name: "Claude Default",
settingsConfig: {},
category: "default",
sortIndex: 0,
},
{
id: "claude-2",
name: "Claude Custom",
settingsConfig: {},
category: "custom",
sortIndex: 1,
},
],
codex: [
{
id: "codex-1",
name: "Codex Default",
settingsConfig: {},
category: "default",
sortIndex: 0,
},
{
id: "codex-2",
name: "Codex Secondary",
settingsConfig: {},
category: "custom",
sortIndex: 1,
},
],
};
const useProviderActionsMock = vi.fn(() => ({
addProvider: addProviderMock,
updateProvider: updateProviderMock,
deleteProvider: deleteProviderMock,
saveUsageScript: saveUsageScriptMock,
}));
return {
toastSuccessMock,
toastErrorMock,
deleteProviderMock,
addProviderMock,
updateProviderMock,
saveUsageScriptMock,
onSwitchedMock,
updateSortOrderMock,
updateTrayMenuMock,
openExternalMock,
useProvidersQueryMock,
useProviderActionsMock,
providersDataMock,
getAllMock,
getCurrentMock,
importDefaultMock,
};
});
vi.mock("@/lib/query", () => ({
useProvidersQuery: (...args: unknown[]) => useProvidersQueryMock(...args),
}));
vi.mock("@/hooks/useProviderActions", () => ({
useProviderActions: () => useProviderActionsMock(),
}));
vi.mock("@/lib/api", () => ({
providersApi: {
onSwitched: onSwitchedMock,
updateSortOrder: updateSortOrderMock,
updateTrayMenu: updateTrayMenuMock,
getAll: getAllMock,
getCurrent: getCurrentMock,
importDefault: importDefaultMock,
},
settingsApi: {
openExternal: openExternalMock,
},
}));
const toastSuccessMock = vi.fn();
const toastErrorMock = vi.fn();
vi.mock("sonner", () => ({
toast: {
success: toastSuccessMock,
error: toastErrorMock,
success: (...args: unknown[]) => toastSuccessMock(...args),
error: (...args: unknown[]) => toastErrorMock(...args),
},
}));
vi.mock("react-i18next", async () => {
const actual = await vi.importActual<typeof import("react-i18next")>("react-i18next");
return {
...actual,
useTranslation: () => ({
t: (key: string, options?: Record<string, unknown>) =>
options?.defaultValue ?? key,
}),
};
});
vi.mock("@/components/providers/ProviderList", () => ({
ProviderList: ({
providers,
@@ -153,29 +30,13 @@ vi.mock("@/components/providers/ProviderList", () => ({
}: any) => (
<div>
<div data-testid="provider-list">{JSON.stringify(providers)}</div>
<button onClick={() => onSwitch({ id: currentProviderId })}>switch</button>
<button onClick={() => onEdit({ id: currentProviderId })}>edit</button>
<button onClick={() => onDelete({ id: currentProviderId })}>delete</button>
<button
onClick={() =>
onDuplicate(
providers[currentProviderId] ?? {
id: "claude-1",
name: "Claude Default",
settingsConfig: {},
sortIndex: 0,
},
)
}
>
duplicate
</button>
<button onClick={() => onConfigureUsage({ id: currentProviderId })}>
usage
</button>
<button onClick={() => onOpenWebsite("https://example.com")}>
open-website
</button>
<div data-testid="current-provider">{currentProviderId}</div>
<button onClick={() => onSwitch(providers[currentProviderId])}>switch</button>
<button onClick={() => onEdit(providers[currentProviderId])}>edit</button>
<button onClick={() => onDelete(providers[currentProviderId])}>delete</button>
<button onClick={() => onDuplicate(providers[currentProviderId])}>duplicate</button>
<button onClick={() => onConfigureUsage(providers[currentProviderId])}>usage</button>
<button onClick={() => onOpenWebsite("https://example.com")}>open-website</button>
<button onClick={() => onCreate?.()}>create</button>
</div>
),
@@ -185,8 +46,17 @@ vi.mock("@/components/providers/AddProviderDialog", () => ({
AddProviderDialog: ({ open, onOpenChange, onSubmit, appType }: any) =>
open ? (
<div data-testid="add-provider-dialog">
<button onClick={() => onSubmit({ name: "New Provider", appType })}>
add-provider
<button
onClick={() =>
onSubmit({
name: `New ${appType} Provider`,
settingsConfig: {},
category: "custom",
sortIndex: 99,
})
}
>
confirm-add
</button>
<button onClick={() => onOpenChange(false)}>close-add</button>
</div>
@@ -197,16 +67,15 @@ vi.mock("@/components/providers/EditProviderDialog", () => ({
EditProviderDialog: ({ open, provider, onSubmit, onOpenChange }: any) =>
open ? (
<div data-testid="edit-provider-dialog">
<span>{provider?.id}</span>
<button
onClick={() =>
onSubmit({
id: provider?.id,
name: `${provider?.name}-edited`,
...provider,
name: `${provider.name}-edited`,
})
}
>
save-edit
confirm-edit
</button>
<button onClick={() => onOpenChange(false)}>close-edit</button>
</div>
@@ -217,7 +86,7 @@ vi.mock("@/components/UsageScriptModal", () => ({
default: ({ isOpen, provider, onSave, onClose }: any) =>
isOpen ? (
<div data-testid="usage-modal">
<span>{provider?.id}</span>
<span data-testid="usage-provider">{provider?.id}</span>
<button onClick={() => onSave("script-code")}>save-script</button>
<button onClick={() => onClose()}>close-usage</button>
</div>
@@ -238,7 +107,7 @@ vi.mock("@/components/settings/SettingsDialog", () => ({
SettingsDialog: ({ open, onOpenChange, onImportSuccess }: any) =>
open ? (
<div data-testid="settings-dialog">
<button onClick={() => onImportSuccess?.()}>settings-on-import</button>
<button onClick={() => onImportSuccess?.()}>trigger-import-success</button>
<button onClick={() => onOpenChange(false)}>close-settings</button>
</div>
) : (
@@ -250,7 +119,8 @@ vi.mock("@/components/AppSwitcher", () => ({
AppSwitcher: ({ activeApp, onSwitch }: any) => (
<div data-testid="app-switcher">
<span>{activeApp}</span>
<button onClick={() => onSwitch("codex")}>switch-app</button>
<button onClick={() => onSwitch("claude")}>switch-claude</button>
<button onClick={() => onSwitch("codex")}>switch-codex</button>
</div>
),
}));
@@ -272,124 +142,84 @@ vi.mock("@/components/mcp/McpPanel", () => ({
),
}));
const mockRefetch = vi.fn();
const queryClient = new QueryClient();
let AppComponent: typeof import("@/App").default;
describe("App Integration", () => {
beforeAll(async () => {
const module = await import("@/App");
AppComponent = module.default;
});
const renderApp = () => {
const client = new QueryClient();
return render(
<QueryClientProvider client={client}>
<Suspense fallback={<div data-testid="loading">loading</div>}>
<App />
</Suspense>
</QueryClientProvider>,
);
};
describe("App Integration with MSW", () => {
beforeEach(() => {
queryClient.clear();
mockRefetch.mockReset();
mockRefetch.mockResolvedValue(undefined);
useProvidersQueryMock.mockReset();
getAllMock.mockReset();
getCurrentMock.mockReset();
importDefaultMock.mockReset();
onSwitchedMock.mockResolvedValue(() => {});
updateSortOrderMock.mockResolvedValue(undefined);
updateTrayMenuMock.mockResolvedValue(undefined);
openExternalMock.mockResolvedValue(undefined);
useProvidersQueryMock.mockImplementation((appType: string) => {
const providers = providersDataMock[appType as keyof typeof providersDataMock] || [];
getAllMock.mockResolvedValue(Object.fromEntries(providers.map((provider) => [provider.id, provider])));
getCurrentMock.mockResolvedValue(providers[0]?.id ?? "");
importDefaultMock.mockResolvedValue(false);
return {
data: {
providers: Object.fromEntries(
providers.map((provider) => [provider.id, provider]),
),
currentProviderId: providers[0]?.id ?? "",
},
isLoading: false,
refetch: mockRefetch,
};
});
resetProviderState();
toastSuccessMock.mockReset();
toastErrorMock.mockReset();
});
it("should render providers, open dialogs, and execute core flows", async () => {
const { container } = render(
<QueryClientProvider client={queryClient}>
<Suspense fallback={<div data-testid="loading">loading</div>}>
<AppComponent />
</Suspense>
</QueryClientProvider>,
);
it("runs provider flows with mocked dialogs but real hooks", async () => {
renderApp();
// 初始加载后,应显示 ProviderList mock 渲染的 JSON
await waitFor(() =>
expect(screen.getByTestId("provider-list")).toBeInTheDocument(),
expect(screen.getByTestId("provider-list").textContent).toContain("claude-1"),
);
expect(screen.getByText("CC Switch")).toBeInTheDocument();
// 打开设置对话框并触发导入成功回调
fireEvent.click(screen.getByText("update-badge")); // open settings via badge
fireEvent.click(screen.getByText("update-badge"));
expect(screen.getByTestId("settings-dialog")).toBeInTheDocument();
fireEvent.click(screen.getByText("settings-on-import"));
await waitFor(() => expect(mockRefetch).toHaveBeenCalledTimes(1));
await waitFor(() => expect(updateTrayMenuMock).toHaveBeenCalledTimes(1));
fireEvent.click(screen.getByText("trigger-import-success"));
fireEvent.click(screen.getByText("close-settings"));
expect(screen.queryByTestId("settings-dialog")).not.toBeInTheDocument();
// 切换到 codex 应用,确保 useProvidersQuery 被使用
fireEvent.click(screen.getByText("switch-app"));
await waitFor(() => {
expect(useProvidersQueryMock).toHaveBeenCalledWith("codex");
});
fireEvent.click(screen.getByText("switch-codex"));
await waitFor(() =>
expect(screen.getByTestId("provider-list").textContent).toContain("codex-1"),
);
// 添加供应商流程
fireEvent.click(screen.getByText("header.addProvider"));
fireEvent.click(screen.getByText("duplicate"));
await waitFor(() =>
expect(screen.getByTestId("provider-list").textContent).toMatch(/copy/),
);
fireEvent.click(screen.getByText("create"));
expect(screen.getByTestId("add-provider-dialog")).toBeInTheDocument();
fireEvent.click(screen.getByText("add-provider"));
expect(addProviderMock).toHaveBeenCalledWith({ name: "New Provider", appType: "codex" });
fireEvent.click(screen.getByText("close-add"));
fireEvent.click(screen.getByText("confirm-add"));
await waitFor(() =>
expect(screen.getByTestId("provider-list").textContent).toMatch(/New codex Provider/),
);
// 编辑供应商流程
fireEvent.click(screen.getByText("edit"));
expect(screen.getByTestId("edit-provider-dialog")).toBeInTheDocument();
fireEvent.click(screen.getByText("save-edit"));
expect(updateProviderMock).toHaveBeenCalledWith({
id: "codex-1",
name: "undefined-edited",
});
fireEvent.click(screen.getByText("close-edit"));
fireEvent.click(screen.getByText("confirm-edit"));
await waitFor(() =>
expect(screen.getByTestId("provider-list").textContent).toMatch(/-edited/),
);
// 删除供应商流程
fireEvent.click(screen.getByText("delete"));
expect(screen.getByTestId("confirm-dialog")).toBeInTheDocument();
fireEvent.click(screen.getByText("confirm-delete"));
expect(deleteProviderMock).toHaveBeenCalledWith("codex-1");
// 复制供应商流程(触发排序更新 + 添加)
fireEvent.click(screen.getByText("duplicate"));
await waitFor(() => {
expect(updateSortOrderMock).toHaveBeenCalled();
});
expect(addProviderMock).toHaveBeenCalledTimes(2);
// 使用脚本弹窗
fireEvent.click(screen.getByText("usage"));
expect(screen.getByTestId("usage-modal")).toBeInTheDocument();
fireEvent.click(screen.getByText("save-script"));
expect(saveUsageScriptMock).toHaveBeenCalledWith(
{ id: "codex-1" },
"script-code",
);
fireEvent.click(screen.getByText("close-usage"));
expect(screen.queryByTestId("usage-modal")).not.toBeInTheDocument();
// 打开网站链接
fireEvent.click(screen.getByText("delete"));
expect(screen.getByTestId("confirm-dialog")).toBeInTheDocument();
fireEvent.click(screen.getByText("confirm-delete"));
await waitFor(() =>
expect(Object.keys(listProviders("codex"))).not.toContain("codex-1"),
);
await waitFor(() =>
expect(screen.getByTestId("current-provider").textContent).not.toBe("codex-1"),
);
fireEvent.click(screen.getByText("open-website"));
expect(openExternalMock).toHaveBeenCalledWith("https://example.com");
// 确保页面保留核心元素
expect(container.textContent).toContain("CC Switch");
emitTauriEvent("provider-switched", { appType: "codex", providerId: "codex-2" });
await waitFor(() =>
expect(screen.getByTestId("current-provider").textContent).toBe("codex-2"),
);
expect(toastSuccessMock).toHaveBeenCalled();
expect(toastErrorMock).not.toHaveBeenCalled();
});
});