mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55: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>
397 lines
12 KiB
TypeScript
397 lines
12 KiB
TypeScript
import { screen } from '@testing-library/react'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { PlanUpdateSidePanel } from './PlanUpdateSidePanel'
|
|
import { MANAGED_BY } from '@/lib/constants/infrastructure'
|
|
import { createMockOrganization, render } from '@/tests/helpers'
|
|
|
|
const mockSelectedOrganization = vi.hoisted(() => vi.fn())
|
|
const mockPush = vi.hoisted(() => vi.fn())
|
|
const mockPartnerManagedResource = vi.hoisted(() => vi.fn())
|
|
const mockUsePHFlag = vi.hoisted(() => vi.fn())
|
|
const mockFeatureFlags = vi.hoisted(() => vi.fn())
|
|
const mockIsPlatform = vi.hoisted(() => ({ value: true }))
|
|
|
|
vi.mock('common', async (importOriginal) => {
|
|
const original = (await importOriginal()) as typeof import('common')
|
|
return {
|
|
...original,
|
|
useParams: () => ({ slug: 'stripe-org' }),
|
|
useFeatureFlags: mockFeatureFlags,
|
|
get IS_PLATFORM() {
|
|
return mockIsPlatform.value
|
|
},
|
|
}
|
|
})
|
|
|
|
vi.mock('next/router', () => ({
|
|
useRouter: () => ({
|
|
pathname: '/org/[slug]/billing',
|
|
query: {},
|
|
push: mockPush,
|
|
}),
|
|
}))
|
|
|
|
vi.mock('shared-data/plans', () => ({
|
|
plans: [
|
|
{
|
|
id: 'tier_free',
|
|
planId: 'free',
|
|
name: 'Free',
|
|
costUnit: '/ month',
|
|
features: ['Unlimited API requests'],
|
|
description: 'Perfect for passion projects & simple websites.',
|
|
preface: 'Get started with:',
|
|
footer: 'Free projects are paused after 1 week of inactivity. Limit of 2 active projects.',
|
|
},
|
|
{
|
|
id: 'tier_pro',
|
|
planId: 'pro',
|
|
name: 'Pro',
|
|
nameBadge: 'Most Popular',
|
|
costUnit: '/ month',
|
|
features: ['Email support'],
|
|
description: 'For production applications with the power to scale.',
|
|
preface: 'Everything in the Free Plan, plus:',
|
|
},
|
|
],
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useSelectedOrganization', () => ({
|
|
useSelectedOrganizationQuery: () => ({ data: mockSelectedOrganization() }),
|
|
}))
|
|
|
|
vi.mock('@/lib/telemetry/track', () => ({
|
|
useTrack: () => vi.fn(),
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useCheckPermissions', () => ({
|
|
useAsyncCheckPermissions: () => ({ can: true }),
|
|
}))
|
|
|
|
vi.mock('@/state/organization-settings', () => ({
|
|
useOrgSettingsPageStateSnapshot: () => ({
|
|
panelKey: 'subscriptionPlan',
|
|
setPanelKey: vi.fn(),
|
|
}),
|
|
}))
|
|
|
|
vi.mock('@/data/projects/org-projects-infinite-query', () => ({
|
|
useOrgProjectsInfiniteQuery: () => ({ data: undefined }),
|
|
}))
|
|
|
|
vi.mock('@/data/organizations/free-project-limit-check-query', () => ({
|
|
useFreeProjectLimitCheckQuery: () => ({ data: [] }),
|
|
}))
|
|
|
|
vi.mock('@/data/organizations/organization-query', () => ({
|
|
useOrganizationQuery: () => ({ data: { has_oriole_project: false } }),
|
|
}))
|
|
|
|
vi.mock('@/data/subscriptions/org-subscription-query', () => ({
|
|
useOrgSubscriptionQuery: () => ({
|
|
data: { plan: { id: 'free', name: 'Free' } },
|
|
isSuccess: true,
|
|
}),
|
|
}))
|
|
|
|
vi.mock('@/data/subscriptions/org-plans-query', () => ({
|
|
useOrgPlansQuery: () => ({
|
|
data: {
|
|
plans: [
|
|
{ id: 'free', price: 0 },
|
|
{ id: 'pro', price: 25 },
|
|
],
|
|
},
|
|
isPending: false,
|
|
}),
|
|
}))
|
|
|
|
vi.mock('@/data/organizations/organization-billing-subscription-preview', () => ({
|
|
useOrganizationBillingSubscriptionPreview: () => ({}),
|
|
}))
|
|
|
|
vi.mock('@/components/ui/PartnerManagedResource', () => ({
|
|
default: (props: any) => {
|
|
mockPartnerManagedResource(props)
|
|
return <div data-testid="partner-managed-resource">{props.details}</div>
|
|
},
|
|
}))
|
|
|
|
vi.mock('./EnterpriseCard', () => ({
|
|
EnterpriseCard: () => <div>Enterprise</div>,
|
|
}))
|
|
|
|
vi.mock('./DowngradeModal', () => ({
|
|
DowngradeModal: () => null,
|
|
}))
|
|
|
|
vi.mock('./ExitSurveyModal', () => ({
|
|
ExitSurveyModal: () => null,
|
|
}))
|
|
|
|
vi.mock('./UpgradeModal', () => ({
|
|
default: () => null,
|
|
}))
|
|
|
|
vi.mock('./MembersExceedLimitModal', () => ({
|
|
default: () => null,
|
|
}))
|
|
|
|
vi.mock('./SubscriptionPlanUpdateDialog', () => ({
|
|
SubscriptionPlanUpdateDialog: () => null,
|
|
}))
|
|
|
|
vi.mock('@/hooks/ui/useFlag', () => ({
|
|
usePHFlag: mockUsePHFlag,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useTrackExperimentExposure', () => ({
|
|
useTrackExperimentExposure: vi.fn(),
|
|
}))
|
|
|
|
describe('PlanUpdateSidePanel', () => {
|
|
beforeEach(() => {
|
|
mockIsPlatform.value = true
|
|
mockFeatureFlags.mockReturnValue({ posthog: {}, configcat: {}, hasLoaded: true })
|
|
mockUsePHFlag.mockReturnValue('control')
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({
|
|
slug: 'stripe-org',
|
|
billing_partner: null,
|
|
integration_source: 'stripe_projects',
|
|
managed_by: MANAGED_BY.STRIPE_PROJECTS,
|
|
})
|
|
)
|
|
})
|
|
|
|
it('shows Stripe-managed messaging without treating Stripe orgs as partner-billed', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.getByTestId('partner-managed-resource')).toBeInTheDocument()
|
|
expect(screen.getByText('stripe projects upgrade supabase/free')).toBeInTheDocument()
|
|
expect(screen.getByRole('button', { name: 'Upgrade to Pro' })).toBeInTheDocument()
|
|
})
|
|
|
|
it('uses the current plan in the Stripe Projects upgrade command', () => {
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({
|
|
slug: 'stripe-org',
|
|
billing_partner: null,
|
|
integration_source: 'stripe_projects',
|
|
managed_by: MANAGED_BY.STRIPE_PROJECTS,
|
|
plan: { id: 'pro', name: 'Pro' },
|
|
})
|
|
)
|
|
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.getByText('stripe projects upgrade supabase/pro')).toBeInTheDocument()
|
|
})
|
|
|
|
it('uses the Stripe Projects downgrade command for team plans', () => {
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({
|
|
slug: 'stripe-org',
|
|
billing_partner: null,
|
|
integration_source: 'stripe_projects',
|
|
managed_by: MANAGED_BY.STRIPE_PROJECTS,
|
|
plan: { id: 'team', name: 'Team' },
|
|
})
|
|
)
|
|
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.getByText('stripe projects downgrade supabase/team')).toBeInTheDocument()
|
|
})
|
|
|
|
it('still shows partner-managed messaging for billing-partner orgs', () => {
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({
|
|
slug: 'aws-org',
|
|
billing_partner: 'aws_marketplace',
|
|
managed_by: MANAGED_BY.AWS_MARKETPLACE,
|
|
})
|
|
)
|
|
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.getByTestId('partner-managed-resource')).toBeInTheDocument()
|
|
})
|
|
|
|
describe('parity variant', () => {
|
|
beforeEach(() => {
|
|
mockUsePHFlag.mockReturnValue('parity')
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({ slug: 'test-org', billing_partner: null })
|
|
)
|
|
})
|
|
|
|
it('renders plan description', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
expect(
|
|
screen.getByText('Perfect for passion projects & simple websites.')
|
|
).toBeInTheDocument()
|
|
})
|
|
|
|
it('renders preface line', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
expect(screen.getByText('Everything in the Free Plan, plus:')).toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('gaps variant', () => {
|
|
beforeEach(() => {
|
|
mockUsePHFlag.mockReturnValue('gaps')
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({ slug: 'test-org', billing_partner: null })
|
|
)
|
|
})
|
|
|
|
it('renders gap rows on the Free plan', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
expect(screen.getByText('Daily backups')).toBeInTheDocument()
|
|
// "Email support" appears twice: once as a Pro plan feature (✓), once as a Free plan gap (✗)
|
|
expect(screen.getAllByText('Email support')).toHaveLength(2)
|
|
})
|
|
|
|
it('shows log retention as a lesser value, not a missing feature', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
expect(screen.getByText('1-day log retention')).toBeInTheDocument()
|
|
})
|
|
|
|
it('renders the gap section heading on Free and Pro cards', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
// Free has a `lesser` item, so its heading is "Plan limits"; Pro has only `missing` items → "Not included"
|
|
expect(screen.getByText('Plan limits')).toBeInTheDocument()
|
|
expect(screen.getByText('Not included')).toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe.each(['fullscreen', 'fullscreen-gaps'])('%s variant', (flag) => {
|
|
beforeEach(() => {
|
|
mockUsePHFlag.mockReturnValue(flag)
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({ slug: 'test-org', billing_partner: null })
|
|
)
|
|
})
|
|
|
|
it('renders the full-screen shell instead of the sheet', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.getByRole('button', { name: /Go back to Studio/ })).toBeInTheDocument()
|
|
expect(screen.getByRole('link', { name: /Compare plans/ })).toBeInTheDocument()
|
|
expect(screen.queryByRole('link', { name: 'Pricing' })).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('renders parity cards', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(
|
|
screen.getByText('Perfect for passion projects & simple websites.')
|
|
).toBeInTheDocument()
|
|
expect(screen.getByText('Everything in the Free Plan, plus:')).toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('fullscreen variant', () => {
|
|
beforeEach(() => {
|
|
mockUsePHFlag.mockReturnValue('fullscreen')
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({ slug: 'test-org', billing_partner: null })
|
|
)
|
|
})
|
|
|
|
it('does not render gap rows', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.queryByText('Not included')).not.toBeInTheDocument()
|
|
expect(screen.queryByText('Plan limits')).not.toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('fullscreen-gaps variant', () => {
|
|
beforeEach(() => {
|
|
mockUsePHFlag.mockReturnValue('fullscreen-gaps')
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({ slug: 'test-org', billing_partner: null })
|
|
)
|
|
})
|
|
|
|
it('renders gap rows inside the full-screen shell', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.getByRole('button', { name: /Go back to Studio/ })).toBeInTheDocument()
|
|
expect(screen.getByText('Daily backups')).toBeInTheDocument()
|
|
expect(screen.getByText('1-day log retention')).toBeInTheDocument()
|
|
// Free has a `lesser` item → "Plan limits"; Pro has only `missing` items → "Not included"
|
|
expect(screen.getByText('Plan limits')).toBeInTheDocument()
|
|
expect(screen.getByText('Not included')).toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('while feature flags are still loading', () => {
|
|
beforeEach(() => {
|
|
mockFeatureFlags.mockReturnValue({ posthog: {}, configcat: {}, hasLoaded: false })
|
|
mockUsePHFlag.mockReturnValue(undefined)
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({ slug: 'test-org', billing_partner: null })
|
|
)
|
|
})
|
|
|
|
it('opens neither shell, so the fullscreen variant cannot flash the sheet', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.queryByRole('button', { name: /Go back to Studio/ })).not.toBeInTheDocument()
|
|
expect(screen.queryByRole('button', { name: 'Upgrade to Pro' })).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('does not gate the panel when self-hosted, where flags never load', () => {
|
|
mockIsPlatform.value = false
|
|
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.getByRole('button', { name: 'Upgrade to Pro' })).toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe.each(['control', 'parity', 'gaps'])('%s variant keeps the sheet shell', (flag) => {
|
|
beforeEach(() => {
|
|
mockUsePHFlag.mockReturnValue(flag)
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({ slug: 'test-org', billing_partner: null })
|
|
)
|
|
})
|
|
|
|
it('renders the sheet header and no full-screen chrome', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
|
|
expect(screen.getByRole('link', { name: 'Pricing' })).toBeInTheDocument()
|
|
expect(screen.queryByRole('button', { name: /Go back to Studio/ })).not.toBeInTheDocument()
|
|
})
|
|
})
|
|
|
|
describe('control variant', () => {
|
|
beforeEach(() => {
|
|
mockUsePHFlag.mockReturnValue('control')
|
|
mockSelectedOrganization.mockReturnValue(
|
|
createMockOrganization({ slug: 'test-org', billing_partner: null })
|
|
)
|
|
})
|
|
|
|
it('does not render preface or description', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
expect(screen.queryByText('Everything in the Free Plan, plus:')).not.toBeInTheDocument()
|
|
expect(
|
|
screen.queryByText('Perfect for passion projects & simple websites.')
|
|
).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('does not render gap rows', () => {
|
|
render(<PlanUpdateSidePanel />)
|
|
expect(screen.queryByText('Not included')).not.toBeInTheDocument()
|
|
expect(screen.queryByText('Plan limits')).not.toBeInTheDocument()
|
|
})
|
|
})
|
|
})
|