Files
fusion/packages/dashboard/app/hooks/__tests__/useAuthOnboarding.test.ts
Fusion 123ec5949f feat(FN-1862): add completion state tracking for onboarding
- Add markOnboardingCompleted() to set completedAt timestamp when user finishes onboarding
- Add isOnboardingCompleted() to check if onboarding was completed (vs dismissed)
- Update ModelOnboardingModal to call markOnboardingCompleted on successful completion
- Skip onboarding auto-open when already completed locally
- Add completion state tracking tests in ModelOnboardingModal.test.tsx
- Add model-onboarding-state unit tests
- Update useAuthOnboarding to check local completion state before auto-opening
- Document localStorage completion state tracking pattern in .fusion/memory.md
2026-04-14 23:44:40 -07:00

346 lines
10 KiB
TypeScript

import { beforeEach, describe, expect, it, vi } from "vitest";
import { renderHook, waitFor } from "@testing-library/react";
import { useAuthOnboarding } from "../useAuthOnboarding";
import * as api from "../../api";
// Mock model-onboarding-state for isOnboardingCompleted
const mockIsOnboardingCompleted = vi.fn();
vi.mock("../../api", () => ({
fetchAuthStatus: vi.fn(),
fetchGlobalSettings: vi.fn(),
}));
vi.mock("../../components/model-onboarding-state", () => ({
isOnboardingCompleted: (...args: unknown[]) => mockIsOnboardingCompleted(...args),
}));
const mockFetchAuthStatus = vi.mocked(api.fetchAuthStatus);
const mockFetchGlobalSettings = vi.mocked(api.fetchGlobalSettings);
describe("useAuthOnboarding", () => {
const openModelOnboarding = vi.fn();
const openSettings = vi.fn();
beforeEach(() => {
vi.clearAllMocks();
});
// --- Trigger branches ---
it("opens onboarding when no providers are authenticated and onboarding is incomplete", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "openai", name: "OpenAI", authenticated: false }],
});
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: false,
defaultProvider: undefined,
defaultModelId: undefined,
} as never);
renderHook(() =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding,
openSettings,
}),
);
await waitFor(() => {
expect(openModelOnboarding).toHaveBeenCalledTimes(1);
});
expect(openSettings).not.toHaveBeenCalled();
});
it("opens onboarding when modelOnboardingComplete is undefined (first-run detection)", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "openai", name: "OpenAI", authenticated: false }],
});
// Explicit first-run: modelOnboardingComplete is undefined (not explicitly false)
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: undefined,
defaultProvider: undefined,
defaultModelId: undefined,
} as never);
renderHook(() =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding,
openSettings,
}),
);
await waitFor(() => {
expect(openModelOnboarding).toHaveBeenCalledTimes(1);
});
expect(openSettings).not.toHaveBeenCalled();
});
it("opens authentication settings when onboarding is complete but no providers are authenticated", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "anthropic", name: "Anthropic", authenticated: false }],
});
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: true,
defaultProvider: "anthropic",
defaultModelId: "claude-sonnet-4-5",
} as never);
renderHook(() =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding,
openSettings,
}),
);
await waitFor(() => {
expect(openSettings).toHaveBeenCalledWith("authentication");
});
expect(openModelOnboarding).not.toHaveBeenCalled();
});
it("opens onboarding when providers are authenticated but default model is missing", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "anthropic", name: "Anthropic", authenticated: true }],
});
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: false,
defaultProvider: undefined,
defaultModelId: undefined,
} as never);
renderHook(() =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding,
openSettings,
}),
);
await waitFor(() => {
expect(openModelOnboarding).toHaveBeenCalledTimes(1);
});
expect(openSettings).not.toHaveBeenCalled();
});
it("does NOT auto-open when authenticated provider exists and default model is configured", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "anthropic", name: "Anthropic", authenticated: true }],
});
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: true,
defaultProvider: "anthropic",
defaultModelId: "claude-sonnet-4-5",
} as never);
renderHook(() =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding,
openSettings,
}),
);
// Give time for any async calls to resolve
await waitFor(() => {
expect(mockFetchAuthStatus).toHaveBeenCalledTimes(1);
});
// Neither onboarding nor settings should open
expect(openModelOnboarding).not.toHaveBeenCalled();
expect(openSettings).not.toHaveBeenCalled();
});
it("does nothing when auth status fetch fails", async () => {
mockFetchAuthStatus.mockRejectedValueOnce(new Error("network"));
renderHook(() =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding,
openSettings,
}),
);
await waitFor(() => {
expect(mockFetchAuthStatus).toHaveBeenCalledTimes(1);
});
expect(openModelOnboarding).not.toHaveBeenCalled();
expect(openSettings).not.toHaveBeenCalled();
expect(mockFetchGlobalSettings).not.toHaveBeenCalled();
});
// --- One-shot guard ---
it("does not re-trigger onboarding when projectId changes after initial bootstrap", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "openai", name: "OpenAI", authenticated: false }],
});
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: false,
defaultProvider: undefined,
defaultModelId: undefined,
} as never);
// First render with project 1
const { rerender } = renderHook(
({ projectId }: { projectId: string }) =>
useAuthOnboarding({
projectId,
openModelOnboarding,
openSettings,
}),
{
initialProps: { projectId: "proj_1" },
},
);
await waitFor(() => {
expect(openModelOnboarding).toHaveBeenCalledTimes(1);
});
// Simulate project context churn - change projectId prop
rerender({ projectId: "proj_2" });
// Onboarding should NOT open again (one-shot guard prevents repeat)
expect(openModelOnboarding).toHaveBeenCalledTimes(1);
expect(openSettings).not.toHaveBeenCalled();
});
it("does not re-trigger when openModelOnboarding reference changes", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "openai", name: "OpenAI", authenticated: false }],
});
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: false,
defaultProvider: undefined,
defaultModelId: undefined,
} as never);
const { rerender } = renderHook(
({ open }: { open: () => void }) =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding: open,
openSettings,
}),
{
initialProps: { open: openModelOnboarding },
},
);
await waitFor(() => {
expect(openModelOnboarding).toHaveBeenCalledTimes(1);
});
// Simulate a new function reference (e.g., after modal manager re-render)
const newOpenOnboarding = vi.fn();
rerender({ open: newOpenOnboarding });
// Should NOT trigger again
expect(openModelOnboarding).toHaveBeenCalledTimes(1);
expect(newOpenOnboarding).not.toHaveBeenCalled();
});
it("does not re-trigger when openSettings reference changes", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "anthropic", name: "Anthropic", authenticated: false }],
});
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: true,
defaultProvider: "anthropic",
defaultModelId: "claude-sonnet-4-5",
} as never);
const { rerender } = renderHook(
({ open }: { open: (section?: string) => void }) =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding,
openSettings: open,
}),
{
initialProps: { open: openSettings },
},
);
await waitFor(() => {
expect(openSettings).toHaveBeenCalledWith("authentication");
});
// Simulate a new function reference
const newOpenSettings = vi.fn();
rerender({ open: newOpenSettings });
// Should NOT trigger again
expect(openSettings).toHaveBeenCalledTimes(1);
expect(newOpenSettings).not.toHaveBeenCalled();
});
// --- isOnboardingCompleted integration ---
it("auto-open is suppressed when isOnboardingCompleted() returns true even if modelOnboardingComplete is undefined", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "openai", name: "OpenAI", authenticated: false }],
});
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: undefined,
defaultProvider: undefined,
defaultModelId: undefined,
} as never);
// Simulate locally completed onboarding
mockIsOnboardingCompleted.mockReturnValue(true);
renderHook(() =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding,
openSettings,
}),
);
// Give time for any async calls to resolve
await waitFor(() => {
expect(mockFetchAuthStatus).toHaveBeenCalledTimes(1);
});
// Neither onboarding nor settings should open because local completion suppresses it
expect(openModelOnboarding).not.toHaveBeenCalled();
expect(openSettings).not.toHaveBeenCalled();
});
it("auto-open still fires when neither server nor local completion flag is set", async () => {
mockFetchAuthStatus.mockResolvedValue({
providers: [{ id: "openai", name: "OpenAI", authenticated: false }],
});
mockFetchGlobalSettings.mockResolvedValue({
modelOnboardingComplete: false,
defaultProvider: undefined,
defaultModelId: undefined,
} as never);
// No local completion
mockIsOnboardingCompleted.mockReturnValue(false);
renderHook(() =>
useAuthOnboarding({
projectId: "proj_123",
openModelOnboarding,
openSettings,
}),
);
await waitFor(() => {
expect(openModelOnboarding).toHaveBeenCalledTimes(1);
});
expect(openSettings).not.toHaveBeenCalled();
});
});