mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 03:15: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>
280 lines
9.2 KiB
TypeScript
280 lines
9.2 KiB
TypeScript
import { render, screen } from '@testing-library/react'
|
|
import type { InputHTMLAttributes, ReactNode } from 'react'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { ServiceVersionsSection } from './ServiceVersionsSection'
|
|
|
|
const {
|
|
mockUseFeatures,
|
|
mockUseIsOrioleDb,
|
|
mockUseProject,
|
|
mockUseReadReplicas,
|
|
mockUseServiceVersions,
|
|
mockUseUpgradeEligibility,
|
|
} = vi.hoisted(() => ({
|
|
mockUseFeatures: vi.fn(),
|
|
mockUseIsOrioleDb: vi.fn(),
|
|
mockUseProject: vi.fn(),
|
|
mockUseReadReplicas: vi.fn(),
|
|
mockUseServiceVersions: vi.fn(),
|
|
mockUseUpgradeEligibility: vi.fn(),
|
|
}))
|
|
|
|
vi.mock('common', () => ({
|
|
useParams: () => ({ ref: 'project-ref' }),
|
|
}))
|
|
|
|
vi.mock('ui', () => ({
|
|
Badge: ({ children }: { children: ReactNode }) => <span>{children}</span>,
|
|
Card: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
CardContent: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
Input: (props: InputHTMLAttributes<HTMLInputElement>) => <input {...props} />,
|
|
InputGroup: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
InputGroupAddon: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
InputGroupInput: (props: InputHTMLAttributes<HTMLInputElement>) => <input {...props} />,
|
|
Tooltip: ({ children }: { children: ReactNode }) => <>{children}</>,
|
|
TooltipContent: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
TooltipTrigger: ({ children }: { children: ReactNode }) => <>{children}</>,
|
|
}))
|
|
|
|
vi.mock('ui-patterns/Admonition', () => ({
|
|
Admonition: ({
|
|
title,
|
|
description,
|
|
children,
|
|
}: {
|
|
title?: ReactNode
|
|
description?: ReactNode
|
|
children?: ReactNode
|
|
}) => (
|
|
<div>
|
|
<div>{title}</div>
|
|
<div>{description}</div>
|
|
{children}
|
|
</div>
|
|
),
|
|
}))
|
|
|
|
vi.mock('ui-patterns/form/FormItemLayout/FormItemLayout', () => ({
|
|
FormItemLayout: ({ label, children }: { label: ReactNode; children: ReactNode }) => (
|
|
<label>
|
|
{label}
|
|
{children}
|
|
</label>
|
|
),
|
|
}))
|
|
|
|
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('ui-patterns/ShimmeringLoader', () => ({
|
|
GenericSkeletonLoader: () => <div>Loading service versions</div>,
|
|
}))
|
|
|
|
vi.mock('../../Infrastructure/UpgradeWarnings', () => ({
|
|
ReadReplicasWarning: ({ latestPgVersion }: { latestPgVersion?: string }) => (
|
|
<div>Read replicas block upgrade to {latestPgVersion}</div>
|
|
),
|
|
ValidationErrorsWarning: ({ validationErrors }: { validationErrors?: string[] }) => (
|
|
<div>Validation errors: {validationErrors?.join(', ')}</div>
|
|
),
|
|
ValidationWarningsAdmonition: ({ warnings }: { warnings?: string[] }) => (
|
|
<div>Validation warnings: {warnings?.join(', ')}</div>
|
|
),
|
|
}))
|
|
|
|
vi.mock('../Infrastructure/ProjectUpgradeAlert', () => ({
|
|
ProjectUpgradeAlert: () => <div>Project upgrade available</div>,
|
|
}))
|
|
|
|
vi.mock('@/components/ui/AlertError', () => ({
|
|
AlertError: ({ subject }: { subject: string }) => <div>{subject}</div>,
|
|
}))
|
|
|
|
vi.mock('@/data/config/project-upgrade-eligibility-query', () => ({
|
|
useProjectUpgradeEligibilityQuery: mockUseUpgradeEligibility,
|
|
}))
|
|
|
|
vi.mock('@/data/projects/project-service-versions', () => ({
|
|
useProjectServiceVersionsQuery: mockUseServiceVersions,
|
|
}))
|
|
|
|
vi.mock('@/data/read-replicas/replicas-query', () => ({
|
|
useReadReplicasQuery: mockUseReadReplicas,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useIsFeatureEnabled', () => ({
|
|
useIsFeatureEnabled: mockUseFeatures,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useSelectedProject', () => ({
|
|
useIsOrioleDb: mockUseIsOrioleDb,
|
|
useSelectedProjectQuery: mockUseProject,
|
|
}))
|
|
|
|
describe('ServiceVersionsSection', () => {
|
|
beforeEach(() => {
|
|
mockUseFeatures.mockReturnValue({
|
|
projectAuthAll: true,
|
|
projectSettingsDatabaseUpgrades: true,
|
|
})
|
|
mockUseIsOrioleDb.mockReturnValue(false)
|
|
mockUseProject.mockReturnValue({ data: { status: 'ACTIVE_HEALTHY' } })
|
|
mockUseReadReplicas.mockReturnValue({ data: [{ identifier: 'project-ref' }] })
|
|
mockUseUpgradeEligibility.mockReturnValue({
|
|
data: {
|
|
current_app_version: 'supabase-postgres-15.8.1.060',
|
|
current_app_version_release_channel: 'ga',
|
|
latest_app_version: 'supabase-postgres-17.4.1.060',
|
|
eligible: true,
|
|
validation_errors: [],
|
|
warnings: [],
|
|
},
|
|
error: undefined,
|
|
isPending: false,
|
|
isError: false,
|
|
isSuccess: true,
|
|
})
|
|
mockUseServiceVersions.mockReturnValue({
|
|
data: {
|
|
gotrue: '2.180.0',
|
|
postgrest: '12.2.8',
|
|
'supabase-postgres': '15.8.1.060',
|
|
},
|
|
error: undefined,
|
|
isPending: false,
|
|
isError: false,
|
|
isSuccess: true,
|
|
})
|
|
})
|
|
|
|
it('preserves the paused-project state without showing stale version values', () => {
|
|
mockUseProject.mockReturnValue({ data: { status: 'INACTIVE' } })
|
|
|
|
const { container } = render(<ServiceVersionsSection />)
|
|
|
|
expect(
|
|
screen.getByText('Service versions cannot be retrieved while project is paused')
|
|
).toBeInTheDocument()
|
|
expect(screen.queryByDisplayValue('12.2.8')).not.toBeInTheDocument()
|
|
expect(container.querySelector('#service-versions')).toBeInTheDocument()
|
|
})
|
|
|
|
it('renders Auth, PostgREST, and Postgres versions with release metadata', () => {
|
|
mockUseIsOrioleDb.mockReturnValue(true)
|
|
mockUseUpgradeEligibility.mockReturnValue({
|
|
data: {
|
|
current_app_version: 'supabase-postgres-17.4.1.060-orioledb',
|
|
current_app_version_release_channel: 'beta',
|
|
latest_app_version: 'supabase-postgres-17.4.1.060-orioledb',
|
|
eligible: true,
|
|
validation_errors: [],
|
|
warnings: [],
|
|
},
|
|
error: undefined,
|
|
isPending: false,
|
|
isError: false,
|
|
isSuccess: true,
|
|
})
|
|
|
|
render(<ServiceVersionsSection />)
|
|
|
|
expect(screen.getByDisplayValue('2.180.0')).toBeInTheDocument()
|
|
expect(screen.getByDisplayValue('12.2.8')).toBeInTheDocument()
|
|
expect(screen.getByDisplayValue('17.4.1.060')).toBeInTheDocument()
|
|
expect(screen.getAllByText('beta').length).toBeGreaterThan(0)
|
|
expect(screen.getAllByText('OrioleDB').length).toBeGreaterThan(0)
|
|
expect(screen.getAllByText('Latest').length).toBeGreaterThan(0)
|
|
expect(screen.getByText('Project upgrade available')).toBeInTheDocument()
|
|
})
|
|
|
|
it('shows the read-replica upgrade block instead of the upgrade action', () => {
|
|
mockUseReadReplicas.mockReturnValue({
|
|
data: [{ identifier: 'project-ref' }, { identifier: 'replica-1' }],
|
|
})
|
|
|
|
render(<ServiceVersionsSection />)
|
|
|
|
expect(screen.getByText('Read replicas block upgrade to 17.4.1.060')).toBeInTheDocument()
|
|
expect(screen.queryByText('Project upgrade available')).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('renders upgrade validation errors and warnings for an ineligible project', () => {
|
|
mockUseUpgradeEligibility.mockReturnValue({
|
|
data: {
|
|
current_app_version: 'supabase-postgres-15.8.1.060',
|
|
latest_app_version: 'supabase-postgres-17.4.1.060',
|
|
eligible: false,
|
|
validation_errors: ['Remove read replicas'],
|
|
warnings: ['Review extension compatibility'],
|
|
},
|
|
error: undefined,
|
|
isPending: false,
|
|
isError: false,
|
|
isSuccess: true,
|
|
})
|
|
|
|
render(<ServiceVersionsSection />)
|
|
|
|
expect(screen.getByText('Validation errors: Remove read replicas')).toBeInTheDocument()
|
|
expect(
|
|
screen.getByText('Validation warnings: Review extension compatibility')
|
|
).toBeInTheDocument()
|
|
expect(screen.queryByText('Project upgrade available')).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('preserves eligibility and service-version loading and error states', () => {
|
|
mockUseUpgradeEligibility
|
|
.mockReturnValueOnce({
|
|
data: undefined,
|
|
error: undefined,
|
|
isPending: true,
|
|
isError: false,
|
|
isSuccess: false,
|
|
})
|
|
.mockReturnValueOnce({
|
|
data: undefined,
|
|
error: new Error('eligibility failed'),
|
|
isPending: false,
|
|
isError: true,
|
|
isSuccess: false,
|
|
})
|
|
|
|
const { rerender } = render(<ServiceVersionsSection />)
|
|
expect(screen.getByText('Loading service versions')).toBeInTheDocument()
|
|
|
|
rerender(<ServiceVersionsSection />)
|
|
expect(screen.getByText('Failed to retrieve Postgres version')).toBeInTheDocument()
|
|
|
|
mockUseUpgradeEligibility.mockReturnValue({
|
|
data: {
|
|
current_app_version: 'supabase-postgres-15.8.1.060',
|
|
latest_app_version: 'supabase-postgres-17.4.1.060',
|
|
eligible: true,
|
|
},
|
|
error: undefined,
|
|
isPending: false,
|
|
isError: false,
|
|
isSuccess: true,
|
|
})
|
|
mockUseServiceVersions.mockReturnValue({
|
|
data: undefined,
|
|
error: new Error('versions failed'),
|
|
isPending: false,
|
|
isError: true,
|
|
isSuccess: false,
|
|
})
|
|
|
|
rerender(<ServiceVersionsSection />)
|
|
expect(screen.getByText('Failed to retrieve versions')).toBeInTheDocument()
|
|
})
|
|
})
|