mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +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>
165 lines
5.2 KiB
TypeScript
165 lines
5.2 KiB
TypeScript
import { render, screen } from '@testing-library/react'
|
|
import type { ReactNode } from 'react'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { Project } from './Project'
|
|
|
|
const { mockUseIsFeatureEnabled, mockUseProjectPauseStatusQuery, mockUseSelectedProjectQuery } =
|
|
vi.hoisted(() => ({
|
|
mockUseIsFeatureEnabled: vi.fn(),
|
|
mockUseProjectPauseStatusQuery: vi.fn(),
|
|
mockUseSelectedProjectQuery: vi.fn(),
|
|
}))
|
|
|
|
vi.mock('next/link', () => ({
|
|
default: ({ href, children }: { href: string; children: ReactNode }) => (
|
|
<a href={href}>{children}</a>
|
|
),
|
|
}))
|
|
|
|
vi.mock('ui', () => ({
|
|
Button: ({
|
|
children,
|
|
asChild,
|
|
type: _type,
|
|
...props
|
|
}: {
|
|
children: ReactNode
|
|
asChild?: boolean
|
|
type?: string
|
|
}) =>
|
|
asChild ? (
|
|
<>{children}</>
|
|
) : (
|
|
<button tabIndex={0} {...props}>
|
|
{children}
|
|
</button>
|
|
),
|
|
Card: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
CardContent: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
}))
|
|
|
|
vi.mock('ui-patterns/PageSection', () => ({
|
|
PageSection: ({ children, id }: { children: ReactNode; id?: string }) => (
|
|
<section id={id}>{children}</section>
|
|
),
|
|
PageSectionContent: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
PageSectionDescription: ({ children }: { children: ReactNode }) => <p>{children}</p>,
|
|
PageSectionMeta: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
PageSectionSummary: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
PageSectionTitle: ({ children }: { children: ReactNode }) => <h2>{children}</h2>,
|
|
}))
|
|
|
|
vi.mock('@/components/interfaces/Project/ResumeProjectButton', () => ({
|
|
ResumeProjectButton: () => <div>ResumeProjectButton</div>,
|
|
}))
|
|
|
|
vi.mock('./Infrastructure/PauseProjectButton', () => ({
|
|
PauseProjectButton: () => <div>PauseProjectButton</div>,
|
|
}))
|
|
|
|
vi.mock('./Infrastructure/RestartServerButton', () => ({
|
|
RestartServerButton: () => <div>RestartServerButton</div>,
|
|
}))
|
|
|
|
vi.mock('@/data/projects/project-pause-status-query', () => ({
|
|
useProjectPauseStatusQuery: mockUseProjectPauseStatusQuery,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useIsFeatureEnabled', () => ({
|
|
useIsFeatureEnabled: mockUseIsFeatureEnabled,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useSelectedProject', () => ({
|
|
useSelectedProjectQuery: mockUseSelectedProjectQuery,
|
|
}))
|
|
|
|
describe('Project settings availability', () => {
|
|
beforeEach(() => {
|
|
mockUseIsFeatureEnabled.mockReturnValue({
|
|
projectSettingsRestartProject: true,
|
|
})
|
|
|
|
mockUseProjectPauseStatusQuery.mockReturnValue({
|
|
data: undefined,
|
|
isError: false,
|
|
isSuccess: false,
|
|
})
|
|
})
|
|
|
|
it('shows the restart action for active projects', () => {
|
|
mockUseSelectedProjectQuery.mockReturnValue({
|
|
data: {
|
|
parent_project_ref: null,
|
|
ref: 'active-project',
|
|
status: 'ACTIVE_HEALTHY',
|
|
},
|
|
})
|
|
|
|
render(<Project />)
|
|
|
|
expect(screen.getByText('Restart project')).toBeInTheDocument()
|
|
expect(screen.getByText('RestartServerButton')).toBeInTheDocument()
|
|
expect(screen.getByText('Pause project')).toBeInTheDocument()
|
|
expect(screen.getByText('PauseProjectButton')).toBeInTheDocument()
|
|
expect(screen.queryByText('ResumeProjectButton')).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('shows the shared resume action for paused projects that can still be restored', () => {
|
|
mockUseSelectedProjectQuery.mockReturnValue({
|
|
data: {
|
|
parent_project_ref: null,
|
|
ref: 'paused-project',
|
|
status: 'INACTIVE',
|
|
},
|
|
})
|
|
|
|
mockUseProjectPauseStatusQuery.mockReturnValue({
|
|
data: { can_restore: true },
|
|
isError: false,
|
|
isSuccess: true,
|
|
})
|
|
|
|
render(<Project />)
|
|
|
|
expect(screen.getByText('Resume project')).toBeInTheDocument()
|
|
expect(screen.getByText('Bring your paused project back online.')).toBeInTheDocument()
|
|
expect(screen.getByText('ResumeProjectButton')).toBeInTheDocument()
|
|
expect(screen.queryByText('Pause project')).not.toBeInTheDocument()
|
|
expect(screen.queryByText('PauseProjectButton')).not.toBeInTheDocument()
|
|
expect(screen.queryByText('RestartServerButton')).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('links back to the dashboard when the paused project can no longer be restored', () => {
|
|
mockUseSelectedProjectQuery.mockReturnValue({
|
|
data: {
|
|
parent_project_ref: null,
|
|
ref: 'paused-project',
|
|
status: 'INACTIVE',
|
|
},
|
|
})
|
|
|
|
mockUseProjectPauseStatusQuery.mockReturnValue({
|
|
data: { can_restore: false },
|
|
isError: false,
|
|
isSuccess: true,
|
|
})
|
|
|
|
render(<Project />)
|
|
|
|
expect(screen.getAllByText('View project dashboard')).toHaveLength(2)
|
|
expect(
|
|
screen.getByText(
|
|
'This project can no longer be resumed here. Open the dashboard to download backups and view recovery options.'
|
|
)
|
|
).toBeInTheDocument()
|
|
expect(screen.getByRole('link', { name: 'View project dashboard' })).toHaveAttribute(
|
|
'href',
|
|
'/project/paused-project'
|
|
)
|
|
expect(screen.queryByText('Pause project')).not.toBeInTheDocument()
|
|
expect(screen.queryByText('PauseProjectButton')).not.toBeInTheDocument()
|
|
expect(screen.queryByText('ResumeProjectButton')).not.toBeInTheDocument()
|
|
})
|
|
})
|