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>
88 lines
3.0 KiB
TypeScript
88 lines
3.0 KiB
TypeScript
import { screen } from '@testing-library/react'
|
|
import { http, HttpResponse } from 'msw'
|
|
import { ResizablePanelGroup } from 'ui'
|
|
import { describe, expect, it, vi } from 'vitest'
|
|
|
|
import { UserPanel } from './UserPanel'
|
|
import type { User } from '@/data/auth/users-infinite-query'
|
|
import { BASE_PATH } from '@/lib/constants'
|
|
import { customRender } from '@/tests/lib/custom-render'
|
|
import { addAPIMock, mswServer } from '@/tests/lib/msw'
|
|
import { createMockProfileContext } from '@/tests/lib/profile-helpers'
|
|
|
|
const { mockUser } = vi.hoisted(() => ({
|
|
mockUser: {
|
|
id: '11111111-1111-1111-1111-111111111111',
|
|
email: 'user@example.com',
|
|
providers: ['email'],
|
|
} as unknown as User,
|
|
}))
|
|
|
|
// Project resolution is pure scaffolding here (it only supplies `ref` to the
|
|
// user query); mocking the whole project query chain over the network would add
|
|
// noise without testing anything this spec cares about.
|
|
vi.mock('@/hooks/misc/useSelectedProject', () => ({
|
|
useSelectedProjectQuery: vi
|
|
.fn()
|
|
.mockReturnValue({ data: { ref: 'project-ref', connectionString: 'postgres://' } }),
|
|
}))
|
|
|
|
// Heavy tab bodies — the sanctioned use of vi.mock. This spec only asserts tab
|
|
// visibility, not what the tabs render.
|
|
vi.mock('./UserOverview', () => ({
|
|
UserOverview: () => <div data-testid="user-overview" />,
|
|
}))
|
|
vi.mock('./UserLogs', () => ({
|
|
UserLogs: () => <div data-testid="user-logs" />,
|
|
}))
|
|
|
|
const renderPanel = (disabledFeatures: string[] = []) => {
|
|
// The user query flows through pg-meta SQL; mock it at the network boundary.
|
|
addAPIMock({
|
|
method: 'post',
|
|
path: '/platform/pg-meta/:ref/query',
|
|
response: () => HttpResponse.json([mockUser] as any),
|
|
})
|
|
|
|
// `/api/enabled-features-overrides` is a Next.js route, not an OpenAPI path,
|
|
// so addAPIMock can't type it — register a raw handler. Feature state is
|
|
// driven by the profile's disabled_features below.
|
|
mswServer.use(
|
|
http.get(`${BASE_PATH}/api/enabled-features-overrides`, () =>
|
|
HttpResponse.json({ disabled_features: [] })
|
|
)
|
|
)
|
|
|
|
return customRender(
|
|
<ResizablePanelGroup orientation="horizontal">
|
|
<UserPanel />
|
|
</ResizablePanelGroup>,
|
|
{
|
|
nuqs: { searchParams: `?show=${mockUser.id}` },
|
|
profileContext: createMockProfileContext({
|
|
profile: {
|
|
disabled_features: disabledFeatures as any,
|
|
} as any,
|
|
}),
|
|
}
|
|
)
|
|
}
|
|
|
|
describe('UserPanel', () => {
|
|
it('shows the Logs tab when logs:all is enabled', async () => {
|
|
renderPanel([])
|
|
|
|
expect(await screen.findByRole('tab', { name: 'Overview' })).toBeInTheDocument()
|
|
expect(screen.getByRole('tab', { name: 'Logs' })).toBeInTheDocument()
|
|
expect(screen.getByRole('tab', { name: 'Raw JSON' })).toBeInTheDocument()
|
|
})
|
|
|
|
it('hides the Logs tab when logs:all is disabled', async () => {
|
|
renderPanel(['logs:all'])
|
|
|
|
expect(await screen.findByRole('tab', { name: 'Overview' })).toBeInTheDocument()
|
|
expect(screen.queryByRole('tab', { name: 'Logs' })).not.toBeInTheDocument()
|
|
expect(screen.getByRole('tab', { name: 'Raw JSON' })).toBeInTheDocument()
|
|
})
|
|
})
|