Files
supabase__supabase/apps/studio/components/layouts/AppLayout/ProjectDropdown.test.tsx
Alaister Young 1966209483 chore(deps): upgrade vitest to v5 (#49994)
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>
2026-09-10 16:45:54 +08:00

193 lines
5.7 KiB
TypeScript

import { screen } from '@testing-library/react'
import type { ComponentProps } from 'react'
import { beforeEach, describe, expect, it, vi } from 'vitest'
import { ProjectDropdown } from './ProjectDropdown'
import type { OrganizationProjectSelector } from '@/components/ui/OrganizationProjectSelector'
import { MANAGED_BY } from '@/lib/constants/infrastructure'
import { createMockOrganization, render } from '@/tests/helpers'
type OrganizationProjectSelectorProps = ComponentProps<typeof OrganizationProjectSelector>
const { mockSelectedOrganization, mockSelectedProject, mockSelectorProject, mockSelectorProps } =
vi.hoisted(() => ({
mockSelectedOrganization: vi.fn(),
mockSelectedProject: vi.fn(),
mockSelectorProject: vi.fn(),
mockSelectorProps: vi.fn(),
}))
const mockPush = vi.hoisted(() => vi.fn())
vi.mock('common', async (importOriginal) => {
const original = (await importOriginal()) as typeof import('common')
return {
...original,
useParams: () => ({ ref: 'proj_1' }),
}
})
vi.mock('next/router', () => ({
useRouter: () => ({
route: '/project/[ref]/settings',
query: { ref: 'proj_1' },
push: mockPush,
}),
}))
vi.mock('@/lib/constants', async (importOriginal) => {
const original = (await importOriginal()) as typeof import('@/lib/constants')
return { ...original, IS_PLATFORM: true }
})
vi.mock('@/hooks/misc/useSelectedProject', () => ({
useSelectedProjectQuery: () => ({
data: mockSelectedProject(),
isPending: false,
}),
}))
vi.mock('@/data/projects/project-detail-query', () => ({
useProjectDetailQuery: () => ({ data: undefined, isPending: false }),
}))
vi.mock('@/hooks/misc/useSelectedOrganization', () => ({
useSelectedOrganizationQuery: () => ({ data: mockSelectedOrganization() }),
}))
vi.mock('@/hooks/misc/useIsFeatureEnabled', () => ({
useIsFeatureEnabled: () => false,
}))
vi.mock('@/components/ui/OrganizationProjectSelector', () => ({
OrganizationProjectSelector: (props: OrganizationProjectSelectorProps) => {
mockSelectorProps(props)
return (
<div>
<div data-testid="project-selector-trigger">
{props.renderTrigger?.({
isLoading: false,
project: mockSelectorProject(),
listboxId: 'project-selector-listbox',
open: false,
})}
</div>
<div data-testid="project-selector-row">{props.renderRow?.(mockSelectorProject())}</div>
</div>
)
},
}))
vi.mock('@/components/ui/PartnerIcon', () => ({
default: ({ organization }: { organization: { managed_by: string } }) =>
organization.managed_by === MANAGED_BY.SUPABASE ? null : (
<div data-testid="partner-icon" data-managed-by={organization.managed_by} />
),
}))
describe('ProjectDropdown', () => {
beforeEach(() => {
mockSelectedOrganization.mockReturnValue(
createMockOrganization({
slug: 'supabase-org',
managed_by: MANAGED_BY.SUPABASE,
})
)
mockSelectedProject.mockReturnValue({
ref: 'proj_1',
name: 'Hammer',
parentRef: 'proj_1',
parent_project_ref: undefined,
integration_source: 'stripe_projects',
})
mockSelectorProject.mockReturnValue({
ref: 'proj_1',
name: 'Hammer',
status: 'ACTIVE_HEALTHY',
integration_source: 'stripe_projects',
})
})
it('uses project detail integration_source for the selected pill and project row data for selector rows', () => {
mockSelectedOrganization.mockReturnValue(
createMockOrganization({
slug: 'stripe-org',
billing_partner: null,
integration_source: 'stripe_projects',
managed_by: MANAGED_BY.STRIPE_PROJECTS,
})
)
render(<ProjectDropdown />)
expect(screen.getAllByTestId('partner-icon')).toHaveLength(2)
})
it('does not fall back to org-level integration state when matching project data is unavailable', () => {
mockSelectedOrganization.mockReturnValue(
createMockOrganization({
slug: 'stripe-org',
billing_partner: null,
integration_source: 'stripe_projects',
managed_by: MANAGED_BY.STRIPE_PROJECTS,
})
)
mockSelectedProject.mockReturnValue({
ref: 'proj_2',
name: 'Mallet',
parentRef: 'proj_2',
parent_project_ref: undefined,
integration_source: null,
})
mockSelectorProject.mockReturnValue({
ref: 'proj_2',
name: 'Mallet',
status: 'ACTIVE_HEALTHY',
integration_source: null,
})
render(<ProjectDropdown />)
expect(screen.queryAllByTestId('partner-icon')).toHaveLength(0)
})
it('falls back to the organization-level state for partner-billed orgs', () => {
mockSelectedOrganization.mockReturnValue(
createMockOrganization({
slug: 'partner-org',
billing_partner: 'vercel_marketplace',
managed_by: MANAGED_BY.VERCEL_MARKETPLACE,
})
)
mockSelectedProject.mockReturnValue({
ref: 'proj_2',
name: 'Mallet',
parentRef: 'proj_2',
parent_project_ref: undefined,
integration_source: null,
})
mockSelectorProject.mockReturnValue({
ref: 'proj_2',
name: 'Mallet',
status: 'ACTIVE_HEALTHY',
integration_source: null,
})
render(<ProjectDropdown />)
expect(screen.getAllByTestId('partner-icon')).toHaveLength(1)
expect(screen.getByTestId('partner-icon')).toHaveAttribute(
'data-managed-by',
MANAGED_BY.VERCEL_MARKETPLACE
)
})
it('provides project command items with links that preserve the current route', () => {
render(<ProjectDropdown />)
const selectorProps = mockSelectorProps.mock.lastCall?.[0]
expect(selectorProps.getItemHref({ ref: 'proj_2' })).toBe('/project/proj_2/settings')
expect(selectorProps.onSelect).toBeUndefined()
})
})