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>
154 lines
5.1 KiB
TypeScript
154 lines
5.1 KiB
TypeScript
import { screen } from '@testing-library/react'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { ConnectionPooling } from './ConnectionPooling'
|
|
import { customRender } from '@/tests/lib/custom-render'
|
|
|
|
const {
|
|
mockUpdatePoolerConfig,
|
|
mockUseAsyncCheckPermissions,
|
|
mockUseCheckEntitlements,
|
|
mockUseHighAvailability,
|
|
mockUseMaxConnectionsQuery,
|
|
mockUsePgbouncerConfigQuery,
|
|
mockUsePgbouncerConfigurationUpdateMutation,
|
|
mockUseProjectAddonsQuery,
|
|
mockUseSelectedProjectQuery,
|
|
} = vi.hoisted(() => ({
|
|
mockUpdatePoolerConfig: vi.fn(),
|
|
mockUseAsyncCheckPermissions: vi.fn(),
|
|
mockUseCheckEntitlements: vi.fn(),
|
|
mockUseHighAvailability: vi.fn(),
|
|
mockUseMaxConnectionsQuery: vi.fn(),
|
|
mockUsePgbouncerConfigQuery: vi.fn(),
|
|
mockUsePgbouncerConfigurationUpdateMutation: vi.fn(),
|
|
mockUseProjectAddonsQuery: vi.fn(),
|
|
mockUseSelectedProjectQuery: vi.fn(),
|
|
}))
|
|
|
|
vi.mock('common', async (importOriginal) => ({
|
|
...(await importOriginal<typeof import('common')>()),
|
|
useParams: () => ({ ref: 'ha-project' }),
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useCheckPermissions', () => ({
|
|
useAsyncCheckPermissions: mockUseAsyncCheckPermissions,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useCheckEntitlements', () => ({
|
|
useCheckEntitlements: mockUseCheckEntitlements,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useHighAvailability', () => ({
|
|
useHighAvailability: mockUseHighAvailability,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useSelectedProject', () => ({
|
|
useSelectedProjectQuery: mockUseSelectedProjectQuery,
|
|
useIsHighAvailability: () => mockUseHighAvailability().isHighAvailability ?? false,
|
|
}))
|
|
|
|
vi.mock('@/data/database/max-connections-query', () => ({
|
|
useMaxConnectionsQuery: mockUseMaxConnectionsQuery,
|
|
}))
|
|
|
|
vi.mock('@/data/database/pgbouncer-config-query', () => ({
|
|
usePgbouncerConfigQuery: mockUsePgbouncerConfigQuery,
|
|
}))
|
|
|
|
vi.mock('@/data/database/pgbouncer-config-update-mutation', () => ({
|
|
usePgbouncerConfigurationUpdateMutation: mockUsePgbouncerConfigurationUpdateMutation,
|
|
}))
|
|
|
|
vi.mock('@/data/subscriptions/project-addons-query', () => ({
|
|
useProjectAddonsQuery: mockUseProjectAddonsQuery,
|
|
}))
|
|
|
|
const expectEveryQueryCall = (queryMock: ReturnType<typeof vi.fn>, enabled: boolean) => {
|
|
expect(queryMock).toHaveBeenCalled()
|
|
for (const [, options] of queryMock.mock.calls) {
|
|
expect(options).toEqual({ enabled })
|
|
}
|
|
}
|
|
|
|
describe('ConnectionPooling', () => {
|
|
beforeEach(() => {
|
|
mockUseSelectedProjectQuery.mockReturnValue({
|
|
data: {
|
|
id: 1,
|
|
ref: 'ha-project',
|
|
infra_compute_size: 'small',
|
|
connectionString: 'postgresql://example',
|
|
},
|
|
})
|
|
mockUseHighAvailability.mockReturnValue({ isHighAvailability: true, isPending: false })
|
|
mockUseAsyncCheckPermissions.mockReturnValue({ can: true })
|
|
mockUseCheckEntitlements.mockReturnValue({ hasAccess: true })
|
|
mockUsePgbouncerConfigQuery.mockReturnValue({
|
|
data: undefined,
|
|
error: undefined,
|
|
isPending: false,
|
|
isError: false,
|
|
isSuccess: false,
|
|
})
|
|
mockUseMaxConnectionsQuery.mockReturnValue({ data: undefined })
|
|
mockUseProjectAddonsQuery.mockReturnValue({
|
|
data: {
|
|
selected_addons: [
|
|
{
|
|
type: 'compute_instance',
|
|
variant: { name: 'Small', identifier: 'ci_small' },
|
|
},
|
|
],
|
|
},
|
|
isSuccess: true,
|
|
})
|
|
mockUsePgbouncerConfigurationUpdateMutation.mockReturnValue({
|
|
mutate: mockUpdatePoolerConfig,
|
|
isPending: false,
|
|
})
|
|
})
|
|
|
|
it('renders High Availability pooling settings as read-only', () => {
|
|
customRender(<ConnectionPooling />)
|
|
|
|
expect(
|
|
screen.getAllByText(
|
|
'Connection pooling settings are managed automatically on High Availability projects'
|
|
)
|
|
).toHaveLength(1)
|
|
expect(screen.getByRole('link', { name: 'Learn more' })).toHaveAttribute(
|
|
'href',
|
|
'https://multigres.com/blog/pooling-without-choosing-a-mode'
|
|
)
|
|
|
|
expect(screen.queryByText('Enable IPv4 add-on')).not.toBeInTheDocument()
|
|
expect(screen.getByPlaceholderText('Managed automatically')).toBeDisabled()
|
|
expect(screen.getByDisplayValue('100000')).toBeDisabled()
|
|
expect(screen.queryByRole('button', { name: 'Cancel' })).not.toBeInTheDocument()
|
|
expect(screen.queryByRole('button', { name: 'Save' })).not.toBeInTheDocument()
|
|
expect(mockUpdatePoolerConfig).not.toHaveBeenCalled()
|
|
|
|
expectEveryQueryCall(mockUsePgbouncerConfigQuery, false)
|
|
expectEveryQueryCall(mockUseMaxConnectionsQuery, false)
|
|
})
|
|
|
|
it('does not fetch pooling config while the high availability state is pending', () => {
|
|
mockUseHighAvailability.mockReturnValue({ isHighAvailability: false, isPending: true })
|
|
|
|
customRender(<ConnectionPooling />)
|
|
|
|
expectEveryQueryCall(mockUsePgbouncerConfigQuery, false)
|
|
expectEveryQueryCall(mockUseMaxConnectionsQuery, false)
|
|
})
|
|
|
|
it('fetches pooling config for non high availability projects', () => {
|
|
mockUseHighAvailability.mockReturnValue({ isHighAvailability: false, isPending: false })
|
|
|
|
customRender(<ConnectionPooling />)
|
|
|
|
expectEveryQueryCall(mockUsePgbouncerConfigQuery, true)
|
|
expectEveryQueryCall(mockUseMaxConnectionsQuery, true)
|
|
})
|
|
})
|