mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
1966209483
Upgrades Vitest from 4.1.4 to 5.0.0 across the monorepo, fixes the handful of things v5 turned into hard errors, and drops the `vi.clearAllMocks()` boilerplate that v5's `clearMocks` default makes redundant. **Changed:** - `vitest`, `@vitest/ui`, `@vitest/coverage-v8` 4.1.4 → 5.0.0 (catalog) - `vi.mock` calls that lived inside `beforeAll`/`beforeEach`/test bodies moved to module scope (v5 throws on nested calls). Affects the Studio and docs setup files and four Studio tests. - `detectBrowser` test restores `navigator` via `vi.unstubAllGlobals()` instead of assigning `global.navigator`, which now reaches jsdom's getter-only property. - `RowEditor.utils.test.ts` restores its `JSON.stringify` spy. It used to leak a throwing mock for the rest of the file, which v5's coverage provider now trips over. A later test in the same file had been asserting the leak's side effect (valid JSON reported as invalid) and now asserts the correct behavior. - `@testing-library/jest-dom` 6.6 → 7.0.1. Its vitest type augmentation resolves through a peer now, so it lands on each package's own `vitest` instead of whichever copy pnpm hoisted. Fixes `toBeInTheDocument` type errors in dev-tools after the reshuffle. - `@testing-library/react` 16.0.0 → 16.3.3 for the React 19 peer range. - `vite: catalog:` added to dev-tools, www, and common. Without it they resolved a newer vite than the catalog pin, which forked a second vitest instance in the lockfile. There's now one. - ai-commands custom matcher types use v5's `Matchers<R, T>` form. - 110 test files: `vi.clearAllMocks()` removed from `beforeEach`/`afterEach` hooks, along with hooks that only did that and the imports they left unused. Calls that also reset/restore mocks are untouched. Second commit, mechanical. **Added:** - `.vitest/` to the root gitignore (v5 writes JSON/JUnit/HTML reporter output there) **Removed:** - `vite-tsconfig-paths` catalog entry and deps. Vitest 5 resolves tsconfig paths itself. Release-age note: this sat in draft with a temporary `minimumReleaseAgeExclude` entry for `vitest` and `@vitest/*` while 5.0.0 was inside the workspace's 3-day `minimumReleaseAge` window. That window has closed, so the exclusion is gone and nothing bypasses the release-age gate. **Perf** (local, medians of 3 runs, same machine): | Suite | v4.1.4 | v5.0.0 | |---|---|---| | studio | 144.1s | 141.7s (-2%) | | studio `--coverage` | 156.9s | 146.4s (-7%) | | ui-patterns | 6.27s | 5.07s (-19%) | | ui `--coverage` | 3.35s | 2.14s (-36%) | | www | 0.89s | 0.47s (-47%) | Studio is dominated by jsdom environment setup per file, which v5 doesn't change. `vitest doctor` recommends keeping the current pool config: the vm pools and `isolate: false` all break tests. ## To test - `pnpm install --frozen-lockfile` succeeds with no `minimumReleaseAgeExclude` entry for vitest. - CI: Studio unit tests, ui, ui-patterns, www, docs, and typecheck/lint should all be green. The lint ratchet was checked locally: warning counts on touched Studio files are identical to master. - `pnpm test:studio` locally passes with coverage (588 files, 6240 tests). - Open a Studio test that uses `toBeInTheDocument` in your editor and confirm no type errors on jest-dom matchers, in Studio and in `packages/dev-tools`. - Known pre-existing failures unrelated to this PR: one dev-tools test (`getEventCountBadge` capped pill) fails on master too. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Tests - Improved test coverage for JSON validation and mobile navigation behavior. - Updated test setup, cleanup, environment configuration, and matcher support across application and shared package suites. - Removed obsolete coverage for alternate MCP transport selection. ## Chores - Streamlined TypeScript path resolution and Vitest reporter output handling. - Updated testing libraries and Vitest tooling across documentation, Studio, website, and shared packages. - Added Vitest reporter output to ignored files. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com> Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
263 lines
7.1 KiB
TypeScript
263 lines
7.1 KiB
TypeScript
import { render, screen } from '@testing-library/react'
|
|
import userEvent from '@testing-library/user-event'
|
|
import type { MouseEventHandler, ReactElement, ReactNode } from 'react'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { LocalDropdown } from './LocalDropdown'
|
|
|
|
const {
|
|
mockRouter,
|
|
mockSetTheme,
|
|
mockSetLastRoute,
|
|
mockToggleFeaturePreviewModal,
|
|
mockEnableToolbar,
|
|
mockDismissDevToolbar,
|
|
mockSetDevToolbarOpen,
|
|
mockUseDevToolbar,
|
|
} = vi.hoisted(() => ({
|
|
mockRouter: {
|
|
pathname: '/project/[ref]/editor',
|
|
asPath: '/project/default/editor',
|
|
},
|
|
mockSetTheme: vi.fn(),
|
|
mockSetLastRoute: vi.fn(),
|
|
mockToggleFeaturePreviewModal: vi.fn(),
|
|
mockEnableToolbar: vi.fn(),
|
|
mockDismissDevToolbar: vi.fn(),
|
|
mockSetDevToolbarOpen: vi.fn(),
|
|
mockUseDevToolbar: vi.fn(() => ({
|
|
isAvailable: false,
|
|
isEnabled: false,
|
|
isOpen: false,
|
|
setIsOpen: mockSetDevToolbarOpen,
|
|
enableToolbar: mockEnableToolbar,
|
|
dismissToolbar: mockDismissDevToolbar,
|
|
events: [],
|
|
setEvents: vi.fn(),
|
|
})),
|
|
}))
|
|
|
|
vi.mock('next/router', () => ({
|
|
useRouter: () => mockRouter,
|
|
}))
|
|
|
|
vi.mock('next/link', () => ({
|
|
default: ({
|
|
href,
|
|
children,
|
|
onClick,
|
|
}: {
|
|
href: string
|
|
children: ReactNode
|
|
onClick?: MouseEventHandler<HTMLAnchorElement>
|
|
}) => (
|
|
<a href={href} onClick={onClick}>
|
|
{children}
|
|
</a>
|
|
),
|
|
}))
|
|
|
|
vi.mock('next-themes', () => ({
|
|
useTheme: () => ({
|
|
theme: 'dark',
|
|
setTheme: mockSetTheme,
|
|
}),
|
|
}))
|
|
|
|
vi.mock('@/state/app-state', () => ({
|
|
useAppStateSnapshot: () => ({
|
|
setLastRouteBeforeVisitingAccountPage: mockSetLastRoute,
|
|
}),
|
|
}))
|
|
|
|
vi.mock('@/components/ui/ProfileImage', () => ({
|
|
ProfileImage: () => <div>Avatar</div>,
|
|
}))
|
|
|
|
vi.mock('./App/FeaturePreview/FeaturePreviewContext', () => ({
|
|
useFeaturePreviewModal: () => ({
|
|
toggleFeaturePreviewModal: mockToggleFeaturePreviewModal,
|
|
}),
|
|
}))
|
|
|
|
vi.mock('@/lib/telemetry/track', () => ({ useTrack: () => vi.fn() }))
|
|
|
|
vi.mock('dev-tools', () => ({
|
|
useDevToolbar: () => mockUseDevToolbar(),
|
|
}))
|
|
|
|
vi.mock('ui', async () => {
|
|
const React = await import('react')
|
|
|
|
return {
|
|
Button: ({
|
|
children,
|
|
...props
|
|
}: React.ButtonHTMLAttributes<HTMLButtonElement> & { children?: ReactNode }) => (
|
|
<button tabIndex={0} {...props}>
|
|
{children}
|
|
</button>
|
|
),
|
|
cn: (...classes: Array<string | false | null | undefined>) => classes.filter(Boolean).join(' '),
|
|
DropdownMenu: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
DropdownMenuTrigger: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
DropdownMenuContent: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
DropdownMenuGroup: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
DropdownMenuItem: ({
|
|
children,
|
|
asChild,
|
|
onClick,
|
|
onSelect,
|
|
}: {
|
|
children: ReactNode
|
|
asChild?: boolean
|
|
onClick?: () => void
|
|
onSelect?: () => void
|
|
}) =>
|
|
asChild ? (
|
|
<div>{children}</div>
|
|
) : (
|
|
<button
|
|
tabIndex={0}
|
|
onClick={() => {
|
|
onClick?.()
|
|
onSelect?.()
|
|
}}
|
|
>
|
|
{children}
|
|
</button>
|
|
),
|
|
DropdownMenuLabel: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
DropdownMenuCheckboxItem: ({
|
|
children,
|
|
checked,
|
|
onCheckedChange,
|
|
}: {
|
|
children: ReactNode
|
|
checked?: boolean
|
|
onCheckedChange?: (checked: boolean) => void
|
|
}) => (
|
|
<button tabIndex={0} aria-checked={checked} onClick={() => onCheckedChange?.(!checked)}>
|
|
{children}
|
|
</button>
|
|
),
|
|
DropdownMenuSeparator: () => <hr />,
|
|
DropdownMenuRadioGroup: ({
|
|
children,
|
|
onValueChange,
|
|
}: {
|
|
children: ReactNode
|
|
onValueChange: (value: string) => void
|
|
}) => (
|
|
<div>
|
|
{React.Children.map(children, (child: ReactNode) =>
|
|
React.isValidElement<{ value: string; onClick?: () => void }>(child)
|
|
? React.cloneElement(child, {
|
|
onClick: () => onValueChange(child.props.value),
|
|
})
|
|
: (child as ReactElement)
|
|
)}
|
|
</div>
|
|
),
|
|
DropdownMenuRadioItem: ({
|
|
children,
|
|
onClick,
|
|
}: {
|
|
children: ReactNode
|
|
onClick?: () => void
|
|
}) => (
|
|
<button tabIndex={0} onClick={onClick}>
|
|
{children}
|
|
</button>
|
|
),
|
|
Tooltip: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
TooltipContent: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
TooltipTrigger: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
singleThemes: [
|
|
{ value: 'dark', name: 'Dark' },
|
|
{ value: 'light', name: 'Light' },
|
|
],
|
|
}
|
|
})
|
|
|
|
describe('LocalDropdown', () => {
|
|
beforeEach(() => {
|
|
mockUseDevToolbar.mockReturnValue({
|
|
isAvailable: false,
|
|
isEnabled: false,
|
|
isOpen: false,
|
|
setIsOpen: mockSetDevToolbarOpen,
|
|
enableToolbar: mockEnableToolbar,
|
|
dismissToolbar: mockDismissDevToolbar,
|
|
events: [],
|
|
setEvents: vi.fn(),
|
|
})
|
|
})
|
|
|
|
it('shows Preferences, removes Command menu, and keeps theme controls wired', async () => {
|
|
const user = userEvent.setup()
|
|
|
|
render(<LocalDropdown />)
|
|
|
|
expect(screen.getByText('Preferences')).toBeInTheDocument()
|
|
expect(screen.queryByText('Command menu')).not.toBeInTheDocument()
|
|
expect(screen.getByText('Theme')).toBeInTheDocument()
|
|
expect(screen.queryByText('Dev toolbar')).not.toBeInTheDocument()
|
|
|
|
await user.click(screen.getByText('Preferences'))
|
|
expect(mockSetLastRoute).toHaveBeenCalledWith('/project/default/editor')
|
|
|
|
await user.click(screen.getByText('Feature previews'))
|
|
expect(mockToggleFeaturePreviewModal).toHaveBeenCalledWith(true)
|
|
|
|
await user.click(screen.getByText('Light'))
|
|
expect(mockSetTheme).toHaveBeenCalledWith('light')
|
|
})
|
|
|
|
it('toggles Dev toolbar visibility from the menu', async () => {
|
|
mockUseDevToolbar.mockReturnValue({
|
|
isAvailable: true,
|
|
isEnabled: false,
|
|
isOpen: false,
|
|
setIsOpen: mockSetDevToolbarOpen,
|
|
enableToolbar: mockEnableToolbar,
|
|
dismissToolbar: mockDismissDevToolbar,
|
|
events: [],
|
|
setEvents: vi.fn(),
|
|
})
|
|
|
|
const user = userEvent.setup()
|
|
|
|
render(<LocalDropdown />)
|
|
|
|
expect(screen.getByText('Local tools')).toBeInTheDocument()
|
|
|
|
await user.click(screen.getByRole('button', { name: 'Dev toolbar' }))
|
|
|
|
expect(mockEnableToolbar).toHaveBeenCalled()
|
|
expect(mockDismissDevToolbar).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('hides Dev toolbar from the menu when toggled off', async () => {
|
|
mockUseDevToolbar.mockReturnValue({
|
|
isAvailable: true,
|
|
isEnabled: true,
|
|
isOpen: false,
|
|
setIsOpen: mockSetDevToolbarOpen,
|
|
enableToolbar: mockEnableToolbar,
|
|
dismissToolbar: mockDismissDevToolbar,
|
|
events: [],
|
|
setEvents: vi.fn(),
|
|
})
|
|
|
|
const user = userEvent.setup()
|
|
|
|
render(<LocalDropdown />)
|
|
|
|
await user.click(screen.getByRole('button', { name: 'Dev toolbar' }))
|
|
|
|
expect(mockDismissDevToolbar).toHaveBeenCalled()
|
|
expect(mockEnableToolbar).not.toHaveBeenCalled()
|
|
})
|
|
})
|