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>
160 lines
4.5 KiB
TypeScript
160 lines
4.5 KiB
TypeScript
import { screen } from '@testing-library/react'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { AdvisorButton } from '@/components/layouts/AppLayout/AdvisorButton'
|
|
import { render } from '@/tests/helpers'
|
|
|
|
const {
|
|
mockUseProjectLintsQuery,
|
|
mockUseNotificationsV2Query,
|
|
mockUseAdvisorSignals,
|
|
mockToggleSidebar,
|
|
} = vi.hoisted(() => ({
|
|
mockUseProjectLintsQuery: vi.fn(),
|
|
mockUseNotificationsV2Query: vi.fn(),
|
|
mockUseAdvisorSignals: vi.fn(),
|
|
mockToggleSidebar: vi.fn(),
|
|
}))
|
|
|
|
vi.mock('@/data/lint/lint-query', () => ({
|
|
useProjectLintsQuery: mockUseProjectLintsQuery,
|
|
}))
|
|
|
|
vi.mock('@/data/notifications/notifications-v2-query', () => ({
|
|
useNotificationsV2Query: mockUseNotificationsV2Query,
|
|
}))
|
|
|
|
vi.mock('@/components/ui/AdvisorPanel/useAdvisorSignals', () => ({
|
|
useAdvisorSignals: mockUseAdvisorSignals,
|
|
}))
|
|
|
|
vi.mock('@/lib/constants', async (importOriginal) => ({
|
|
...(await importOriginal<typeof import('@/lib/constants')>()),
|
|
IS_PLATFORM: true,
|
|
}))
|
|
|
|
vi.mock('@/state/sidebar-manager-state', () => ({
|
|
useSidebarManagerSnapshot: () => ({
|
|
toggleSidebar: mockToggleSidebar,
|
|
activeSidebar: undefined,
|
|
}),
|
|
}))
|
|
|
|
describe('AdvisorButton', () => {
|
|
beforeEach(() => {
|
|
mockUseProjectLintsQuery.mockReturnValue({ data: [], isPending: false, isError: false })
|
|
mockUseNotificationsV2Query.mockReturnValue({
|
|
data: { pages: [[]] },
|
|
isPending: false,
|
|
isError: false,
|
|
})
|
|
mockUseAdvisorSignals.mockReturnValue({
|
|
data: [],
|
|
isPending: false,
|
|
isError: false,
|
|
dismissSignal: vi.fn(),
|
|
})
|
|
})
|
|
|
|
it('shows a warning dot when advisor signals are present', () => {
|
|
mockUseAdvisorSignals.mockReturnValue({
|
|
data: [
|
|
{
|
|
id: 'signal-1',
|
|
fingerprint: 'signal:banned-ip:203.0.113.10:v1',
|
|
source: 'signal',
|
|
signalType: 'banned-ip',
|
|
severity: 'warning',
|
|
tab: 'security',
|
|
title: 'Banned IP address',
|
|
description: 'Signal',
|
|
actions: [],
|
|
sourceData: {
|
|
type: 'banned-ip',
|
|
ip: '203.0.113.10',
|
|
},
|
|
},
|
|
],
|
|
isPending: false,
|
|
isError: false,
|
|
dismissSignal: vi.fn(),
|
|
})
|
|
|
|
const { container } = render(<AdvisorButton projectRef="project-ref" />)
|
|
|
|
expect(container.querySelector('.bg-warning')).toBeInTheDocument()
|
|
expect(container.querySelector('.bg-destructive')).not.toBeInTheDocument()
|
|
expect(container.querySelector('.bg-brand')).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('keeps the destructive dot when a critical issue is present', () => {
|
|
mockUseProjectLintsQuery.mockReturnValue({
|
|
data: [
|
|
{
|
|
cache_key: 'lint-1',
|
|
name: 'unknown_lint',
|
|
detail: 'Critical lint detail',
|
|
description: 'Description',
|
|
level: 'ERROR',
|
|
categories: ['SECURITY'],
|
|
metadata: {},
|
|
},
|
|
],
|
|
isPending: false,
|
|
isError: false,
|
|
})
|
|
mockUseAdvisorSignals.mockReturnValue({
|
|
data: [
|
|
{
|
|
id: 'signal-1',
|
|
fingerprint: 'signal:banned-ip:203.0.113.10:v1',
|
|
source: 'signal',
|
|
signalType: 'banned-ip',
|
|
severity: 'warning',
|
|
tab: 'security',
|
|
title: 'Banned IP address',
|
|
description: 'Signal',
|
|
actions: [],
|
|
sourceData: {
|
|
type: 'banned-ip',
|
|
ip: '203.0.113.10',
|
|
},
|
|
},
|
|
],
|
|
isPending: false,
|
|
isError: false,
|
|
dismissSignal: vi.fn(),
|
|
})
|
|
|
|
const { container } = render(<AdvisorButton projectRef="project-ref" />)
|
|
|
|
expect(container.querySelector('.bg-destructive')).toBeInTheDocument()
|
|
expect(container.querySelector('.bg-warning')).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('falls back to the brand dot for unread notifications when there are no issues', () => {
|
|
mockUseNotificationsV2Query.mockReturnValue({
|
|
data: {
|
|
pages: [
|
|
[
|
|
{
|
|
id: 'notif-1',
|
|
status: 'new',
|
|
priority: 'Info',
|
|
},
|
|
],
|
|
],
|
|
},
|
|
isPending: false,
|
|
isError: false,
|
|
})
|
|
|
|
const { container } = render(<AdvisorButton projectRef="project-ref" />)
|
|
|
|
expect(container.querySelector('.bg-brand')).toBeInTheDocument()
|
|
expect(container.querySelector('.bg-warning')).not.toBeInTheDocument()
|
|
expect(container.querySelector('.bg-destructive')).not.toBeInTheDocument()
|
|
expect(screen.getByRole('button')).toBeInTheDocument()
|
|
})
|
|
})
|