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>
196 lines
6.0 KiB
TypeScript
196 lines
6.0 KiB
TypeScript
import { act, screen, waitFor } from '@testing-library/react'
|
|
import { ResizablePanel, ResizablePanelGroup } from 'ui'
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { LayoutSidebar } from './index'
|
|
import { LayoutSidebarProvider, SIDEBAR_KEYS } from './LayoutSidebarProvider'
|
|
import { MobileSheetProvider } from '@/components/layouts/Navigation/NavigationBar/MobileSheetContext'
|
|
import { sidebarManagerState } from '@/state/sidebar-manager-state'
|
|
import { render } from '@/tests/helpers'
|
|
import { routerMock } from '@/tests/lib/route-mock'
|
|
|
|
vi.mock('@/components/ui/AIAssistantPanel/AIAssistant', () => ({
|
|
AIAssistant: () => <div data-testid="ai-assistant-sidebar">AI Assistant</div>,
|
|
}))
|
|
|
|
vi.mock('@/components/ui/EditorPanel/EditorPanel', () => ({
|
|
EditorPanel: () => <div data-testid="editor-panel-sidebar">Editor Panel</div>,
|
|
}))
|
|
|
|
vi.mock('@/components/ui/AdvisorPanel/AdvisorPanel', () => ({
|
|
AdvisorPanel: () => <div data-testid="advisor-panel-sidebar">Advisor Panel</div>,
|
|
}))
|
|
|
|
vi.mock('nuqs', async () => {
|
|
let queryValue = 'ai-assistant'
|
|
return {
|
|
useQueryState: () => [queryValue, (v: string) => (queryValue = v)],
|
|
parseAsString: () => {},
|
|
}
|
|
})
|
|
|
|
const mockProject = {
|
|
id: 1,
|
|
ref: 'default',
|
|
name: 'Project 1',
|
|
status: 'ACTIVE_HEALTHY' as const,
|
|
organization_id: 1,
|
|
cloud_provider: 'AWS',
|
|
region: 'us-east-1',
|
|
inserted_at: new Date().toISOString(),
|
|
subscription_id: 'subscription-1',
|
|
db_host: 'db.supabase.co',
|
|
is_branch_enabled: false,
|
|
is_physical_backups_enabled: false,
|
|
restUrl: 'https://project-1.supabase.co',
|
|
}
|
|
|
|
let mockProjectData: typeof mockProject | undefined = mockProject
|
|
|
|
vi.mock('@/hooks/misc/useSelectedProject', () => ({
|
|
useSelectedProjectQuery: () => {
|
|
// Access the variable at runtime when the function is called
|
|
return {
|
|
data: mockProjectData,
|
|
}
|
|
},
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useSelectedOrganization', () => ({
|
|
useSelectedOrganizationQuery: () => ({
|
|
data: {
|
|
id: 1,
|
|
name: 'Organization 1',
|
|
slug: 'test-org',
|
|
plan: { id: 'free', name: 'Free' },
|
|
managed_by: 'supabase',
|
|
is_owner: true,
|
|
billing_email: 'billing@example.com',
|
|
billing_partner: null,
|
|
usage_billing_enabled: false,
|
|
stripe_customer_id: 'stripe-1',
|
|
subscription_id: 'subscription-1',
|
|
organization_requires_mfa: false,
|
|
opt_in_tags: [],
|
|
restriction_status: null,
|
|
restriction_data: null,
|
|
organization_missing_address: false,
|
|
requires_indirect_tax_declaration: false,
|
|
},
|
|
}),
|
|
}))
|
|
|
|
vi.mock('@/lib/telemetry/track', () => ({
|
|
useTrack: () => vi.fn(),
|
|
}))
|
|
|
|
const resetSidebarManagerState = () => {
|
|
Object.keys(sidebarManagerState.sidebars).forEach((id) => {
|
|
sidebarManagerState.unregisterSidebar(id)
|
|
})
|
|
sidebarManagerState.closeActive()
|
|
}
|
|
|
|
describe('LayoutSidebar', () => {
|
|
beforeEach(() => {
|
|
routerMock.setCurrentUrl('/projects/default')
|
|
})
|
|
|
|
afterEach(() => {
|
|
resetSidebarManagerState()
|
|
localStorage.clear()
|
|
})
|
|
|
|
const renderSidebar = () =>
|
|
render(
|
|
<ResizablePanelGroup orientation="horizontal">
|
|
<ResizablePanel>
|
|
<div />
|
|
</ResizablePanel>
|
|
<LayoutSidebarProvider>
|
|
<MobileSheetProvider>
|
|
<LayoutSidebar />
|
|
</MobileSheetProvider>
|
|
</LayoutSidebarProvider>
|
|
</ResizablePanelGroup>
|
|
)
|
|
|
|
it('does not render when there is no active sidebar', () => {
|
|
renderSidebar()
|
|
|
|
expect(screen.queryByTestId('ai-assistant-sidebar')).toBeNull()
|
|
})
|
|
|
|
it('renders the active sidebar content when toggled on', async () => {
|
|
renderSidebar()
|
|
|
|
await waitFor(() => {
|
|
expect(sidebarManagerState.sidebars[SIDEBAR_KEYS.AI_ASSISTANT]).toBeDefined()
|
|
})
|
|
|
|
act(() => {
|
|
sidebarManagerState.toggleSidebar(SIDEBAR_KEYS.AI_ASSISTANT)
|
|
})
|
|
|
|
const sidebar = await screen.findByTestId('ai-assistant-sidebar')
|
|
expect(sidebar).toBeTruthy()
|
|
})
|
|
|
|
describe('at organization level', () => {
|
|
beforeEach(() => {
|
|
routerMock.setCurrentUrl('/org/default')
|
|
// Set project to undefined to simulate org-level (no project)
|
|
mockProjectData = undefined
|
|
})
|
|
|
|
afterEach(() => {
|
|
// Reset to project data for other tests
|
|
mockProjectData = mockProject
|
|
})
|
|
|
|
it('does not register project-related sidebars when no project is available', async () => {
|
|
renderSidebar()
|
|
|
|
// Wait a bit to ensure sidebars have been registered
|
|
await waitFor(() => {
|
|
// Project-related sidebars should not be registered
|
|
expect(sidebarManagerState.sidebars[SIDEBAR_KEYS.AI_ASSISTANT]).toBeUndefined()
|
|
expect(sidebarManagerState.sidebars[SIDEBAR_KEYS.EDITOR_PANEL]).toBeUndefined()
|
|
// Advisor panel should still be available (doesn't require project)
|
|
expect(sidebarManagerState.sidebars[SIDEBAR_KEYS.ADVISOR_PANEL]).toBeDefined()
|
|
})
|
|
})
|
|
|
|
it('does not render project-related sidebars even when toggled', async () => {
|
|
renderSidebar()
|
|
|
|
await waitFor(() => {
|
|
expect(sidebarManagerState.sidebars[SIDEBAR_KEYS.ADVISOR_PANEL]).toBeDefined()
|
|
})
|
|
|
|
// Try to toggle AI_ASSISTANT - should not work since it's not registered
|
|
act(() => {
|
|
sidebarManagerState.toggleSidebar(SIDEBAR_KEYS.AI_ASSISTANT)
|
|
})
|
|
|
|
// Should not render since it's not registered
|
|
expect(screen.queryByTestId('ai-assistant-sidebar')).toBeNull()
|
|
expect(screen.queryByTestId('editor-panel-sidebar')).toBeNull()
|
|
|
|
// Advisor panel should work
|
|
act(() => {
|
|
sidebarManagerState.toggleSidebar(SIDEBAR_KEYS.ADVISOR_PANEL)
|
|
})
|
|
|
|
expect(await screen.findByTestId('advisor-panel-sidebar')).toBeTruthy()
|
|
})
|
|
})
|
|
|
|
// [Joshen] JFYI temporarily commented this one out - I'm struggling to figure out the mocking to get this to work
|
|
// it('auto-opens when sidebar query param matches a registered sidebar', async () => {
|
|
// routerMock.setCurrentUrl(`/?sidebar=${SIDEBAR_KEYS.AI_ASSISTANT}`)
|
|
// renderSidebar()
|
|
// await screen.findByTestId('ai-assistant-sidebar')
|
|
// })
|
|
})
|