mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 01:45: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>
277 lines
8.7 KiB
TypeScript
277 lines
8.7 KiB
TypeScript
import { render, screen } from '@testing-library/react'
|
|
import type { ReactNode } from 'react'
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { ComputeAndDiskUsageCharts } from './ComputeAndDiskUsageCharts'
|
|
import type { InfraMonitoringMultiResponse } from '@/data/analytics/infra-monitoring-query'
|
|
|
|
const { mockGetInfraMonitoringAttributes, mockUseInfraMonitoringAttributesQuery, mockUseProject } =
|
|
vi.hoisted(() => ({
|
|
mockGetInfraMonitoringAttributes: vi.fn(),
|
|
mockUseInfraMonitoringAttributesQuery: vi.fn(),
|
|
mockUseProject: vi.fn(),
|
|
}))
|
|
|
|
vi.mock('common', () => ({
|
|
useParams: () => ({ ref: 'project-ref' }),
|
|
}))
|
|
|
|
vi.mock('ui', () => ({
|
|
cn: (...classes: Array<string | false | null | undefined>) => classes.filter(Boolean).join(' '),
|
|
}))
|
|
|
|
vi.mock('ui-patterns/Chart', async () => {
|
|
const React = await vi.importActual<typeof import('react')>('react')
|
|
const ChartStateContext = React.createContext({ isLoading: false, isErrored: false })
|
|
|
|
return {
|
|
Chart: ({
|
|
children,
|
|
isLoading,
|
|
isErrored,
|
|
}: {
|
|
children: ReactNode
|
|
isLoading: boolean
|
|
isErrored: boolean
|
|
}) => (
|
|
<ChartStateContext.Provider value={{ isLoading, isErrored }}>
|
|
{children}
|
|
</ChartStateContext.Provider>
|
|
),
|
|
ChartCard: ({ children, className }: { children: ReactNode; className?: string }) => (
|
|
<div className={className}>{children}</div>
|
|
),
|
|
ChartContent: ({
|
|
children,
|
|
isEmpty,
|
|
loadingState,
|
|
errorState,
|
|
emptyState,
|
|
}: {
|
|
children: ReactNode
|
|
isEmpty: boolean
|
|
loadingState: ReactNode
|
|
errorState: ReactNode
|
|
emptyState: ReactNode
|
|
}) => {
|
|
const { isLoading, isErrored } = React.useContext(ChartStateContext)
|
|
|
|
if (isLoading) return loadingState
|
|
if (isErrored) return errorState
|
|
if (isEmpty) return emptyState
|
|
return children
|
|
},
|
|
ChartEmptyState: ({ title, description }: { title: string; description?: string }) => (
|
|
<div>
|
|
<span>{title}</span>
|
|
{description && <span>{description}</span>}
|
|
</div>
|
|
),
|
|
ChartHeader: ({ children }: { children: ReactNode }) => <div>{children}</div>,
|
|
ChartLine: ({ dataKey, dataKeys }: { dataKey: string; dataKeys: string[] }) => (
|
|
<div data-testid={`chart-line-${dataKey}`} data-keys={dataKeys.join(',')} />
|
|
),
|
|
ChartLoadingState: () => <div>Loading chart</div>,
|
|
ChartMetric: ({
|
|
label,
|
|
value,
|
|
status,
|
|
tooltip,
|
|
}: {
|
|
label: string
|
|
value: ReactNode
|
|
status?: string
|
|
tooltip?: ReactNode
|
|
}) => (
|
|
<div
|
|
data-testid={`metric-${label}`}
|
|
data-status={status}
|
|
data-has-tooltip={tooltip !== undefined}
|
|
>
|
|
{label}: {value}
|
|
</div>
|
|
),
|
|
}
|
|
})
|
|
|
|
vi.mock('@/data/analytics/infra-monitoring-query', () => ({
|
|
getInfraMonitoringAttributes: mockGetInfraMonitoringAttributes,
|
|
useInfraMonitoringAttributesQuery: mockUseInfraMonitoringAttributesQuery,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useSelectedProject', () => ({
|
|
useSelectedProjectQuery: mockUseProject,
|
|
}))
|
|
|
|
vi.mock('@/lib/helpers', () => ({
|
|
formatBytes: (bytes: number) => `${bytes} bytes`,
|
|
}))
|
|
|
|
const buildUsageResponse = ({
|
|
cpu = 40,
|
|
memory = 50,
|
|
diskIo = 60,
|
|
database = 40,
|
|
wal = 5,
|
|
system = 5,
|
|
diskSize = 100,
|
|
}: {
|
|
cpu?: number
|
|
memory?: number
|
|
diskIo?: number
|
|
database?: number
|
|
wal?: number
|
|
system?: number
|
|
diskSize?: number
|
|
} = {}): InfraMonitoringMultiResponse => ({
|
|
series: {},
|
|
data: [
|
|
{
|
|
period_start: '2026-07-20T00:00:00.000Z',
|
|
values: {
|
|
max_cpu_usage: String(cpu),
|
|
ram_usage: String(memory),
|
|
disk_io_consumption: String(diskIo),
|
|
pg_database_size: String(database),
|
|
disk_fs_used_wal: String(wal),
|
|
disk_fs_used_system: String(system),
|
|
disk_fs_size: String(diskSize),
|
|
},
|
|
},
|
|
],
|
|
})
|
|
|
|
describe('ComputeAndDiskUsageCharts', () => {
|
|
beforeEach(() => {
|
|
mockUseProject.mockReturnValue({ data: { infra_compute_size: 'micro' } })
|
|
mockUseInfraMonitoringAttributesQuery.mockReturnValue({
|
|
data: buildUsageResponse(),
|
|
isLoading: false,
|
|
isError: false,
|
|
})
|
|
mockGetInfraMonitoringAttributes.mockResolvedValue(buildUsageResponse())
|
|
})
|
|
|
|
afterEach(() => {
|
|
vi.useRealTimers()
|
|
})
|
|
|
|
it('renders warning and critical summaries and all chart data', () => {
|
|
mockUseInfraMonitoringAttributesQuery.mockReturnValue({
|
|
data: buildUsageResponse({
|
|
cpu: 80,
|
|
memory: 91,
|
|
diskIo: 70,
|
|
database: 80,
|
|
wal: 5,
|
|
system: 5,
|
|
}),
|
|
isLoading: false,
|
|
isError: false,
|
|
})
|
|
|
|
const { container } = render(<ComputeAndDiskUsageCharts />)
|
|
|
|
expect(screen.getByTestId('metric-Compute')).toHaveTextContent('91%')
|
|
expect(screen.getByTestId('metric-Compute')).toHaveAttribute('data-status', 'negative')
|
|
expect(screen.getByTestId('metric-CPU')).toHaveAttribute('data-status', 'warning')
|
|
expect(screen.getByTestId('metric-Memory')).toHaveAttribute('data-status', 'negative')
|
|
expect(screen.getByTestId('metric-Disk IO')).toHaveAttribute('data-status', 'default')
|
|
expect(screen.getByTestId('metric-Compute')).toHaveAttribute('data-has-tooltip', 'true')
|
|
expect(screen.getByTestId('metric-Disk')).toHaveAttribute('data-has-tooltip', 'true')
|
|
for (const label of ['CPU', 'Memory', 'Disk IO', 'Database', 'WAL', 'System']) {
|
|
expect(screen.getByTestId(`metric-${label}`)).toHaveAttribute('data-has-tooltip', 'false')
|
|
}
|
|
expect(screen.getByTestId('metric-Disk')).toHaveTextContent('90%')
|
|
expect(screen.getByTestId('metric-Disk')).toHaveAttribute('data-status', 'negative')
|
|
expect(screen.getByTestId('chart-line-maxCpuUsage')).toHaveAttribute(
|
|
'data-keys',
|
|
'maxCpuUsage,ramUsage,diskIoConsumption'
|
|
)
|
|
expect(container.firstElementChild).toHaveClass(
|
|
'grid-cols-1',
|
|
'@[680px]:grid-cols-2',
|
|
'@[680px]:items-stretch'
|
|
)
|
|
expect(container.querySelector('#cpu')).toBeInTheDocument()
|
|
expect(container.querySelector('#ram')).toBeInTheDocument()
|
|
expect(container.querySelector('#disk_io')).toBeInTheDocument()
|
|
expect(container.querySelector('#disk')).toBeInTheDocument()
|
|
})
|
|
|
|
it('hides burst-only disk IO and excludes it from status on dedicated-I/O compute', () => {
|
|
mockUseProject.mockReturnValue({ data: { infra_compute_size: '4xlarge' } })
|
|
mockUseInfraMonitoringAttributesQuery.mockReturnValue({
|
|
data: buildUsageResponse({ cpu: 40, memory: 50, diskIo: 95 }),
|
|
isLoading: false,
|
|
isError: false,
|
|
})
|
|
|
|
render(<ComputeAndDiskUsageCharts />)
|
|
|
|
expect(screen.getByTestId('metric-Compute')).toHaveTextContent('50%')
|
|
expect(screen.getByTestId('metric-Compute')).toHaveAttribute('data-status', 'default')
|
|
expect(screen.queryByTestId('metric-Disk IO')).not.toBeInTheDocument()
|
|
expect(screen.getByTestId('chart-line-maxCpuUsage')).toHaveAttribute(
|
|
'data-keys',
|
|
'maxCpuUsage,ramUsage'
|
|
)
|
|
})
|
|
|
|
it('renders empty states without presenting missing disk metrics as zero', () => {
|
|
mockUseInfraMonitoringAttributesQuery.mockReturnValue({
|
|
data: undefined,
|
|
isLoading: false,
|
|
isError: false,
|
|
})
|
|
|
|
render(<ComputeAndDiskUsageCharts />)
|
|
|
|
expect(screen.getByText('No compute data')).toBeInTheDocument()
|
|
expect(screen.getByText('No disk data')).toBeInTheDocument()
|
|
expect(screen.getByTestId('metric-Database')).toHaveTextContent('—')
|
|
expect(screen.getByTestId('metric-WAL')).toHaveTextContent('—')
|
|
expect(screen.getByTestId('metric-System')).toHaveTextContent('—')
|
|
})
|
|
|
|
it.each([
|
|
{
|
|
state: 'loading',
|
|
queryState: { data: undefined, isLoading: true, isError: false },
|
|
expectedText: 'Loading chart',
|
|
},
|
|
{
|
|
state: 'error',
|
|
queryState: { data: undefined, isLoading: false, isError: true },
|
|
expectedText: 'Failed to load usage data',
|
|
},
|
|
])('renders both $state states', ({ queryState, expectedText }) => {
|
|
mockUseInfraMonitoringAttributesQuery.mockReturnValue(queryState)
|
|
|
|
render(<ComputeAndDiskUsageCharts />)
|
|
|
|
expect(screen.getAllByText(expectedText)).toHaveLength(2)
|
|
})
|
|
|
|
it('uses a fresh rolling seven-day window when the query refetches', async () => {
|
|
vi.useFakeTimers()
|
|
vi.setSystemTime(new Date('2026-07-20T12:00:00.000Z'))
|
|
|
|
render(<ComputeAndDiskUsageCharts />)
|
|
|
|
const [, options] = mockUseInfraMonitoringAttributesQuery.mock.calls[0]
|
|
vi.setSystemTime(new Date('2026-07-27T12:00:00.000Z'))
|
|
await options.queryFn({ signal: undefined })
|
|
|
|
expect(mockGetInfraMonitoringAttributes).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
projectRef: 'project-ref',
|
|
startDate: '2026-07-20T12:00:00.000Z',
|
|
endDate: '2026-07-27T12:00:00.000Z',
|
|
interval: '1d',
|
|
}),
|
|
undefined
|
|
)
|
|
})
|
|
})
|