mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 18:05:11 +03:00
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>
280 lines
8.2 KiB
TypeScript
280 lines
8.2 KiB
TypeScript
import { screen, waitFor } from '@testing-library/react'
|
|
import userEvent from '@testing-library/user-event'
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { AdvisorSection } from '@/components/interfaces/ProjectHome/AdvisorSection'
|
|
import { SIDEBAR_KEYS } from '@/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
|
|
import { AdvisorPanel } from '@/components/ui/AdvisorPanel/AdvisorPanel'
|
|
import { advisorState } from '@/state/advisor-state'
|
|
import { sidebarManagerState } from '@/state/sidebar-manager-state'
|
|
import { render } from '@/tests/helpers'
|
|
|
|
const {
|
|
mockUseProjectLintsQuery,
|
|
mockUseBannedIPsQuery,
|
|
mockUseSelectedProjectQuery,
|
|
mockUseNotificationsV2Query,
|
|
mockUseNotificationsV2UpdateMutation,
|
|
mockUseTrack,
|
|
} = vi.hoisted(() => ({
|
|
mockUseProjectLintsQuery: vi.fn(),
|
|
mockUseBannedIPsQuery: vi.fn(),
|
|
mockUseSelectedProjectQuery: vi.fn(),
|
|
mockUseNotificationsV2Query: vi.fn(),
|
|
mockUseNotificationsV2UpdateMutation: vi.fn(),
|
|
mockUseTrack: vi.fn(),
|
|
}))
|
|
|
|
vi.mock('common', async () => {
|
|
const actual = await vi.importActual<typeof import('common')>('common')
|
|
|
|
return {
|
|
...actual,
|
|
useParams: () => ({ ref: 'project-ref' }),
|
|
}
|
|
})
|
|
|
|
vi.mock('@/data/lint/lint-query', () => ({
|
|
useProjectLintsQuery: mockUseProjectLintsQuery,
|
|
}))
|
|
|
|
vi.mock('@/data/banned-ips/banned-ips-query', () => ({
|
|
useBannedIPsQuery: mockUseBannedIPsQuery,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useSelectedProject', () => ({
|
|
useSelectedProjectQuery: mockUseSelectedProjectQuery,
|
|
}))
|
|
|
|
vi.mock('@/data/notifications/notifications-v2-query', () => ({
|
|
useNotificationsV2Query: mockUseNotificationsV2Query,
|
|
}))
|
|
|
|
vi.mock('@/data/notifications/notifications-v2-update-mutation', () => ({
|
|
useNotificationsV2UpdateMutation: mockUseNotificationsV2UpdateMutation,
|
|
}))
|
|
|
|
vi.mock('@/lib/constants', async (importOriginal) => ({
|
|
...(await importOriginal<typeof import('@/lib/constants')>()),
|
|
IS_PLATFORM: true,
|
|
}))
|
|
|
|
vi.mock('@/lib/telemetry/track', () => ({
|
|
useTrack: mockUseTrack,
|
|
}))
|
|
|
|
vi.mock('@/state/ai-assistant-state', () => ({
|
|
useAiAssistantStateSnapshot: () => ({
|
|
newChat: vi.fn(),
|
|
}),
|
|
}))
|
|
|
|
vi.mock('@/components/ui/AiAssistantDropdown', () => ({
|
|
AiAssistantDropdown: () => <div data-testid="advisor-assistant-dropdown" />,
|
|
}))
|
|
|
|
vi.mock('./AdvisorFilters', () => ({
|
|
AdvisorFilters: () => <div data-testid="advisor-filters" />,
|
|
}))
|
|
|
|
vi.mock('./AdvisorPanelHeader', () => ({
|
|
AdvisorPanelHeader: () => <div data-testid="advisor-panel-header" />,
|
|
}))
|
|
|
|
describe('Advisor signals integration', () => {
|
|
beforeEach(() => {
|
|
window.localStorage.clear()
|
|
advisorState.reset()
|
|
sidebarManagerState.unregisterSidebar(SIDEBAR_KEYS.ADVISOR_PANEL)
|
|
sidebarManagerState.registerSidebar(SIDEBAR_KEYS.ADVISOR_PANEL, () => null)
|
|
sidebarManagerState.clearActiveSidebar()
|
|
|
|
mockUseTrack.mockReturnValue(vi.fn())
|
|
mockUseSelectedProjectQuery.mockReturnValue({
|
|
data: { ref: 'project-ref' },
|
|
})
|
|
mockUseProjectLintsQuery.mockImplementation((_variables, options) => {
|
|
if (options?.enabled === false) {
|
|
return {
|
|
data: undefined,
|
|
isPending: false,
|
|
isError: false,
|
|
}
|
|
}
|
|
|
|
return {
|
|
data: [
|
|
{
|
|
cache_key: 'lint-1',
|
|
name: 'unknown_lint',
|
|
detail: 'Critical lint detail',
|
|
level: 'ERROR',
|
|
categories: ['SECURITY'],
|
|
metadata: {},
|
|
},
|
|
],
|
|
isPending: false,
|
|
isError: false,
|
|
}
|
|
})
|
|
mockUseBannedIPsQuery.mockImplementation((_variables, options) => {
|
|
if (options?.enabled === false) {
|
|
return {
|
|
data: undefined,
|
|
isPending: false,
|
|
isError: false,
|
|
}
|
|
}
|
|
|
|
return {
|
|
data: {
|
|
banned_ipv4_addresses: ['203.0.113.10'],
|
|
},
|
|
isPending: false,
|
|
isError: false,
|
|
}
|
|
})
|
|
mockUseNotificationsV2Query.mockReturnValue({
|
|
data: { pages: [[]] },
|
|
isPending: false,
|
|
isError: false,
|
|
})
|
|
mockUseNotificationsV2UpdateMutation.mockReturnValue({
|
|
mutate: vi.fn(),
|
|
})
|
|
})
|
|
|
|
afterEach(() => {
|
|
advisorState.reset()
|
|
sidebarManagerState.unregisterSidebar(SIDEBAR_KEYS.ADVISOR_PANEL)
|
|
sidebarManagerState.clearActiveSidebar()
|
|
})
|
|
|
|
it('renders signal items and dismisses them across the homepage and panel', async () => {
|
|
render(
|
|
<>
|
|
<AdvisorSection />
|
|
<AdvisorPanel />
|
|
</>
|
|
)
|
|
|
|
expect(screen.getByText('Advisor found 2 issues')).toBeInTheDocument()
|
|
expect(screen.getByText('Banned IP address')).toBeInTheDocument()
|
|
expect(screen.getAllByText('Critical lint detail').length).toBeGreaterThan(0)
|
|
expect(
|
|
screen.getAllByText((_, node) =>
|
|
Boolean(
|
|
node?.textContent?.includes(
|
|
'The IP address 203.0.113.10 is temporarily blocked because of suspicious traffic or repeated failed password attempts.'
|
|
)
|
|
)
|
|
).length
|
|
).toBeGreaterThan(0)
|
|
|
|
await userEvent.click(screen.getByText('Banned IP address'))
|
|
|
|
expect(screen.getByText('Entity')).toBeInTheDocument()
|
|
expect(screen.getByText('Issue')).toBeInTheDocument()
|
|
expect(screen.getByText('Resolve')).toBeInTheDocument()
|
|
expect(screen.getAllByTestId('advisor-assistant-dropdown').length).toBeGreaterThan(0)
|
|
expect(
|
|
screen.getAllByText((_, node) =>
|
|
Boolean(
|
|
node?.textContent?.includes(
|
|
'The IP address 203.0.113.10 is temporarily blocked because of suspicious traffic or repeated failed password attempts.'
|
|
)
|
|
)
|
|
).length
|
|
).toBeGreaterThan(0)
|
|
expect(screen.getByRole('link', { name: 'Learn more' })).toHaveAttribute(
|
|
'href',
|
|
'https://supabase.com/docs/reference/cli/supabase-network-bans'
|
|
)
|
|
|
|
expect(screen.getAllByText('Banned IP address').length).toBeGreaterThan(0)
|
|
|
|
await userEvent.click(screen.getByRole('button', { name: 'Dismiss' }))
|
|
|
|
await waitFor(() => {
|
|
expect(screen.queryByText('Banned IP address')).not.toBeInTheDocument()
|
|
})
|
|
|
|
expect(screen.getAllByText('Critical lint detail').length).toBeGreaterThan(0)
|
|
})
|
|
|
|
it('shows an overflow affordance when the homepage cap hides additional issues', () => {
|
|
mockUseProjectLintsQuery.mockImplementation((_variables, options) => {
|
|
if (options?.enabled === false) {
|
|
return {
|
|
data: undefined,
|
|
isPending: false,
|
|
isError: false,
|
|
}
|
|
}
|
|
|
|
return {
|
|
data: [
|
|
{
|
|
cache_key: 'lint-1',
|
|
name: 'unknown_lint',
|
|
detail: 'Critical lint detail 1',
|
|
level: 'ERROR',
|
|
categories: ['SECURITY'],
|
|
metadata: {},
|
|
},
|
|
{
|
|
cache_key: 'lint-2',
|
|
name: 'unknown_lint',
|
|
detail: 'Critical lint detail 2',
|
|
level: 'ERROR',
|
|
categories: ['SECURITY'],
|
|
metadata: {},
|
|
},
|
|
{
|
|
cache_key: 'lint-3',
|
|
name: 'unknown_lint',
|
|
detail: 'Critical lint detail 3',
|
|
level: 'ERROR',
|
|
categories: ['SECURITY'],
|
|
metadata: {},
|
|
},
|
|
{
|
|
cache_key: 'lint-4',
|
|
name: 'unknown_lint',
|
|
detail: 'Critical lint detail 4',
|
|
level: 'ERROR',
|
|
categories: ['SECURITY'],
|
|
metadata: {},
|
|
},
|
|
],
|
|
isPending: false,
|
|
isError: false,
|
|
}
|
|
})
|
|
|
|
render(<AdvisorSection />)
|
|
|
|
expect(screen.getByText('Advisor found 5 issues')).toBeInTheDocument()
|
|
expect(screen.getByRole('button', { name: 'View 1 more issue in Advisor' })).toBeInTheDocument()
|
|
expect(screen.queryByText('Banned IP address')).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('does not block the homepage while signal items are pending', () => {
|
|
mockUseProjectLintsQuery.mockReturnValue({
|
|
data: [],
|
|
isPending: false,
|
|
isError: false,
|
|
})
|
|
mockUseBannedIPsQuery.mockReturnValue({
|
|
data: undefined,
|
|
isPending: true,
|
|
isError: false,
|
|
})
|
|
|
|
render(<AdvisorSection />)
|
|
|
|
// Lints have loaded — homepage renders without being blocked by signal loading
|
|
expect(screen.getByText('Advisor found no issues')).toBeInTheDocument()
|
|
})
|
|
})
|