Files
supabase/apps/studio/lib/api/self-hosted/mcp.test.ts
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

139 lines
4.3 KiB
TypeScript

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { getDebuggingOperations, getDevelopmentOperations } from './mcp'
vi.mock('./settings', () => ({
getProjectSettings: vi.fn(),
}))
vi.mock('./generate-types', () => ({
generateTypescriptTypes: vi.fn(),
}))
vi.mock('./logs', () => ({
retrieveAnalyticsData: vi.fn(),
}))
vi.mock('./lints', () => ({
getLints: vi.fn(),
}))
describe('api/self-hosted/mcp', () => {
describe('getDevelopmentOperations.getPublishableKeys', () => {
let getProjectSettingsMock: ReturnType<typeof vi.fn>
beforeEach(async () => {
vi.unstubAllEnvs()
const settings = await import('./settings')
getProjectSettingsMock = vi.mocked(settings.getProjectSettings)
})
afterEach(() => {
vi.unstubAllEnvs()
})
it('returns a publishable-typed key from SUPABASE_PUBLISHABLE_KEY when set', async () => {
vi.stubEnv('SUPABASE_PUBLISHABLE_KEY', 'sb_publishable_abc')
const ops = getDevelopmentOperations({})
const keys = await ops.getPublishableKeys('default')
expect(keys).toEqual([
{
api_key: 'sb_publishable_abc',
name: 'publishable',
type: 'publishable',
},
])
// When the env var is set we should short-circuit and never consult project settings.
expect(getProjectSettingsMock).not.toHaveBeenCalled()
})
it('falls back to the anon key from project settings with type "legacy" when env var is unset', async () => {
vi.stubEnv('SUPABASE_PUBLISHABLE_KEY', '')
getProjectSettingsMock.mockReturnValue({
service_api_keys: [
{ api_key: 'service-key-value', name: 'service_role key', tags: 'service_role' },
{ api_key: 'anon-key-value', name: 'anon key', tags: 'anon' },
],
})
const ops = getDevelopmentOperations({})
const keys = await ops.getPublishableKeys('default')
expect(keys).toEqual([
{
api_key: 'anon-key-value',
name: 'anon key',
type: 'legacy',
},
])
})
it('throws when env var is unset and the anon key is missing from project settings', async () => {
vi.stubEnv('SUPABASE_PUBLISHABLE_KEY', '')
getProjectSettingsMock.mockReturnValue({
service_api_keys: [
{ api_key: 'service-key-value', name: 'service_role key', tags: 'service_role' },
],
})
const ops = getDevelopmentOperations({})
await expect(ops.getPublishableKeys('default')).rejects.toThrow(
'Anon key not found in project settings'
)
})
})
describe('getDebuggingOperations', () => {
let retrieveAnalyticsDataMock: ReturnType<typeof vi.fn>
beforeEach(async () => {
vi.unstubAllEnvs()
const logs = await import('./logs')
retrieveAnalyticsDataMock = vi.mocked(logs.retrieveAnalyticsData)
})
afterEach(() => {
vi.unstubAllEnvs()
})
it('getLogs is not supported on self-hosted (query_logs supersedes it)', async () => {
const ops = getDebuggingOperations({})
// `get_logs` is hidden by the MCP server whenever `queryLogs` is present,
// so this method is unreachable over MCP and throws defensively.
await expect(ops.getLogs('default', { service: 'api' })).rejects.toThrow(
'get_logs is not supported on self-hosted'
)
expect(retrieveAnalyticsDataMock).not.toHaveBeenCalled()
})
it('queryLogs throws when logs are disabled (self-hosted default)', async () => {
vi.stubEnv('ENABLED_FEATURES_LOGS_ALL', 'false')
const ops = getDebuggingOperations({})
await expect(ops.queryLogs!('default', { sql: 'select 1' })).rejects.toThrow(
'Logs are disabled on this instance'
)
expect(retrieveAnalyticsDataMock).not.toHaveBeenCalled()
})
it('queryLogs passes the model-provided SQL straight through when logs are enabled', async () => {
vi.stubEnv('ENABLED_FEATURES_LOGS_ALL', 'true')
retrieveAnalyticsDataMock.mockResolvedValue({ data: ['log entry'], error: null })
const ops = getDebuggingOperations({})
await ops.queryLogs!('default', { sql: 'select * from edge_logs' })
expect(retrieveAnalyticsDataMock).toHaveBeenCalledWith(
expect.objectContaining({
params: expect.objectContaining({ sql: 'select * from edge_logs' }),
})
)
})
})
})