mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +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>
271 lines
8.7 KiB
TypeScript
271 lines
8.7 KiB
TypeScript
import { fireEvent, screen } from '@testing-library/react'
|
|
import { LOCAL_STORAGE_KEYS } from 'common'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import OrganizationLayout from './OrganizationLayout'
|
|
import { MANAGED_BY } from '@/lib/constants/infrastructure'
|
|
import { createMockOrganization, render } from '@/tests/helpers'
|
|
|
|
const {
|
|
mockUseAwsRedirectQuery,
|
|
mockUseCustomContent,
|
|
mockUseLocalStorageQuery,
|
|
mockSetIsBannerDismissed,
|
|
mockUseRegisterOrgMenu,
|
|
mockUseSelectedOrganizationQuery,
|
|
mockUseVercelRedirectQuery,
|
|
} = vi.hoisted(() => ({
|
|
mockUseAwsRedirectQuery: vi.fn(),
|
|
mockUseCustomContent: vi.fn(),
|
|
mockUseLocalStorageQuery: vi.fn(),
|
|
mockSetIsBannerDismissed: vi.fn(),
|
|
mockUseRegisterOrgMenu: vi.fn(),
|
|
mockUseSelectedOrganizationQuery: vi.fn(),
|
|
mockUseVercelRedirectQuery: vi.fn(),
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useSelectedOrganization', () => ({
|
|
useSelectedOrganizationQuery: mockUseSelectedOrganizationQuery,
|
|
}))
|
|
|
|
vi.mock('@/data/integrations/vercel-redirect-query', () => ({
|
|
useVercelRedirectQuery: mockUseVercelRedirectQuery,
|
|
}))
|
|
|
|
vi.mock('@/data/integrations/aws-redirect-query', () => ({
|
|
useAwsRedirectQuery: mockUseAwsRedirectQuery,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useLocalStorage', () => ({
|
|
useLocalStorageQuery: mockUseLocalStorageQuery,
|
|
}))
|
|
|
|
vi.mock('@/hooks/custom-content/useCustomContent', () => ({
|
|
useCustomContent: mockUseCustomContent,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/withAuth', () => ({
|
|
withAuth: (Component: any) => Component,
|
|
}))
|
|
|
|
vi.mock('./OrganizationLayout/useRegisterOrgMenu', () => ({
|
|
useRegisterOrgMenu: mockUseRegisterOrgMenu,
|
|
}))
|
|
|
|
vi.mock('@/components/ui/PartnerIcon', () => ({
|
|
default: () => <div data-testid="partner-icon" />,
|
|
}))
|
|
|
|
const renderLayout = () =>
|
|
render(
|
|
<OrganizationLayout title="General">
|
|
<div>Organization content</div>
|
|
</OrganizationLayout>
|
|
)
|
|
|
|
describe('OrganizationLayout', () => {
|
|
beforeEach(() => {
|
|
mockUseLocalStorageQuery.mockReturnValue([
|
|
false,
|
|
mockSetIsBannerDismissed,
|
|
{ isSuccess: true, isLoading: false, isError: false, error: null },
|
|
])
|
|
mockUseCustomContent.mockReturnValue({ appTitle: 'Supabase' })
|
|
mockUseVercelRedirectQuery.mockReturnValue({ data: undefined, isSuccess: false })
|
|
mockUseAwsRedirectQuery.mockReturnValue({ data: undefined, isSuccess: false })
|
|
})
|
|
|
|
it('renders the exact Vercel banner copy and manage URL', () => {
|
|
mockUseSelectedOrganizationQuery.mockReturnValue({
|
|
data: createMockOrganization({
|
|
managed_by: MANAGED_BY.VERCEL_MARKETPLACE,
|
|
partner_id: 'vercel-installation-id',
|
|
}),
|
|
})
|
|
mockUseVercelRedirectQuery.mockReturnValue({
|
|
data: { url: 'https://vercel.com/manage-org' },
|
|
isSuccess: true,
|
|
})
|
|
|
|
renderLayout()
|
|
|
|
expect(screen.getByText('This organization is managed via Vercel Marketplace')).toBeTruthy()
|
|
expect(
|
|
screen.getByText('Billing and some organization access settings are managed in Vercel.')
|
|
).toBeTruthy()
|
|
expect(screen.getByRole('link', { name: 'Manage' }).getAttribute('href')).toBe(
|
|
'https://vercel.com/manage-org'
|
|
)
|
|
expect(mockUseVercelRedirectQuery).toHaveBeenCalledWith(
|
|
{ installationId: 'vercel-installation-id' },
|
|
expect.objectContaining({ enabled: true })
|
|
)
|
|
expect(mockUseLocalStorageQuery).toHaveBeenCalledWith(
|
|
LOCAL_STORAGE_KEYS.ORGANIZATION_MARKETPLACE_BANNER_DISMISSED(
|
|
'abcdefghijklmnopqrst',
|
|
MANAGED_BY.VERCEL_MARKETPLACE
|
|
),
|
|
false
|
|
)
|
|
expect(mockUseAwsRedirectQuery).toHaveBeenCalledWith(
|
|
{ organizationSlug: 'abcdefghijklmnopqrst' },
|
|
expect.objectContaining({ enabled: false })
|
|
)
|
|
})
|
|
|
|
it('renders the exact AWS banner copy and manage URL', () => {
|
|
mockUseSelectedOrganizationQuery.mockReturnValue({
|
|
data: createMockOrganization({
|
|
managed_by: MANAGED_BY.AWS_MARKETPLACE,
|
|
slug: 'aws-org',
|
|
}),
|
|
})
|
|
mockUseAwsRedirectQuery.mockReturnValue({
|
|
data: { url: 'https://console.aws.amazon.com/billing/home' },
|
|
isSuccess: true,
|
|
})
|
|
|
|
renderLayout()
|
|
|
|
expect(screen.getByText('This organization is billed via AWS Marketplace')).toBeTruthy()
|
|
expect(
|
|
screen.getByText('Changes to billing and payment details must be made in AWS.')
|
|
).toBeTruthy()
|
|
expect(screen.getByRole('link', { name: 'Manage' }).getAttribute('href')).toBe(
|
|
'https://console.aws.amazon.com/billing/home'
|
|
)
|
|
expect(mockUseAwsRedirectQuery).toHaveBeenCalledWith(
|
|
{ organizationSlug: 'aws-org' },
|
|
expect.objectContaining({ enabled: true })
|
|
)
|
|
expect(mockUseLocalStorageQuery).toHaveBeenCalledWith(
|
|
LOCAL_STORAGE_KEYS.ORGANIZATION_MARKETPLACE_BANNER_DISMISSED(
|
|
'aws-org',
|
|
MANAGED_BY.AWS_MARKETPLACE
|
|
),
|
|
false
|
|
)
|
|
expect(mockUseVercelRedirectQuery).toHaveBeenCalledWith(
|
|
{ installationId: undefined },
|
|
expect.objectContaining({ enabled: false })
|
|
)
|
|
})
|
|
|
|
it('does not render Manage for Vercel when redirect URL is unavailable', () => {
|
|
mockUseSelectedOrganizationQuery.mockReturnValue({
|
|
data: createMockOrganization({
|
|
managed_by: MANAGED_BY.VERCEL_MARKETPLACE,
|
|
partner_id: 'vercel-installation-id',
|
|
}),
|
|
})
|
|
mockUseVercelRedirectQuery.mockReturnValue({
|
|
data: undefined,
|
|
isSuccess: false,
|
|
})
|
|
|
|
renderLayout()
|
|
|
|
expect(screen.getByText('This organization is managed via Vercel Marketplace')).toBeTruthy()
|
|
expect(screen.queryByRole('link', { name: 'Manage' })).toBeNull()
|
|
})
|
|
|
|
it('does not render Manage for AWS when redirect URL is unavailable', () => {
|
|
mockUseSelectedOrganizationQuery.mockReturnValue({
|
|
data: createMockOrganization({
|
|
managed_by: MANAGED_BY.AWS_MARKETPLACE,
|
|
slug: 'aws-org',
|
|
}),
|
|
})
|
|
mockUseAwsRedirectQuery.mockReturnValue({
|
|
data: undefined,
|
|
isSuccess: false,
|
|
})
|
|
|
|
renderLayout()
|
|
|
|
expect(screen.getByText('This organization is billed via AWS Marketplace')).toBeTruthy()
|
|
expect(screen.queryByRole('link', { name: 'Manage' })).toBeNull()
|
|
})
|
|
|
|
it('does not render a banner for Supabase-managed organizations', () => {
|
|
mockUseSelectedOrganizationQuery.mockReturnValue({
|
|
data: createMockOrganization({
|
|
managed_by: MANAGED_BY.SUPABASE,
|
|
}),
|
|
})
|
|
|
|
renderLayout()
|
|
|
|
expect(screen.queryByRole('link', { name: 'Manage' })).toBeNull()
|
|
expect(screen.queryByText('This organization is managed via Vercel Marketplace')).toBeNull()
|
|
expect(screen.queryByText('This organization is billed via AWS Marketplace')).toBeNull()
|
|
})
|
|
|
|
it('renders Stripe connected copy with no Manage button', () => {
|
|
mockUseSelectedOrganizationQuery.mockReturnValue({
|
|
data: createMockOrganization({
|
|
managed_by: MANAGED_BY.STRIPE_PROJECTS,
|
|
}),
|
|
})
|
|
|
|
renderLayout()
|
|
|
|
expect(screen.getByText('This organization is connected to Stripe')).toBeTruthy()
|
|
expect(
|
|
screen.getByText('Changes here will be reflected in your connected Stripe account.')
|
|
).toBeTruthy()
|
|
expect(screen.queryByRole('link', { name: 'Manage' })).toBeNull()
|
|
expect(mockUseVercelRedirectQuery).toHaveBeenCalledWith(
|
|
{ installationId: undefined },
|
|
expect.objectContaining({ enabled: false })
|
|
)
|
|
expect(mockUseLocalStorageQuery).toHaveBeenCalledWith(
|
|
LOCAL_STORAGE_KEYS.ORGANIZATION_MARKETPLACE_BANNER_DISMISSED(
|
|
'abcdefghijklmnopqrst',
|
|
MANAGED_BY.STRIPE_PROJECTS
|
|
),
|
|
false
|
|
)
|
|
expect(mockUseAwsRedirectQuery).toHaveBeenCalledWith(
|
|
{ organizationSlug: 'abcdefghijklmnopqrst' },
|
|
expect.objectContaining({ enabled: false })
|
|
)
|
|
})
|
|
|
|
it('hides banner when dismissal state is persisted', () => {
|
|
mockUseLocalStorageQuery.mockReturnValue([
|
|
true,
|
|
mockSetIsBannerDismissed,
|
|
{ isSuccess: true, isLoading: false, isError: false, error: null },
|
|
])
|
|
mockUseSelectedOrganizationQuery.mockReturnValue({
|
|
data: createMockOrganization({
|
|
managed_by: MANAGED_BY.VERCEL_MARKETPLACE,
|
|
partner_id: 'vercel-installation-id',
|
|
}),
|
|
})
|
|
|
|
renderLayout()
|
|
|
|
expect(screen.queryByRole('link', { name: 'Manage' })).toBeNull()
|
|
expect(screen.queryByText('This organization is managed via Vercel Marketplace')).toBeNull()
|
|
})
|
|
|
|
it('dismisses the banner and persists the state', () => {
|
|
mockUseSelectedOrganizationQuery.mockReturnValue({
|
|
data: createMockOrganization({
|
|
managed_by: MANAGED_BY.AWS_MARKETPLACE,
|
|
}),
|
|
})
|
|
mockUseAwsRedirectQuery.mockReturnValue({
|
|
data: { url: 'https://console.aws.amazon.com/billing/home' },
|
|
isSuccess: true,
|
|
})
|
|
|
|
renderLayout()
|
|
|
|
fireEvent.click(screen.getByRole('button', { name: 'Dismiss banner' }))
|
|
expect(mockSetIsBannerDismissed).toHaveBeenCalledWith(true)
|
|
})
|
|
})
|