Files
supabase__supabase/apps/studio/lib/api/self-hosted/settings.test.ts
Alaister Young 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

130 lines
4.2 KiB
TypeScript

import { beforeEach, describe, expect, it, vi } from 'vitest'
import { getProjectSettings } from './settings'
vi.mock('./util', () => ({
assertSelfHosted: vi.fn(),
}))
vi.mock('@/lib/constants/api', () => ({
PROJECT_ENDPOINT: 'localhost:8000',
PROJECT_ENDPOINT_PROTOCOL: 'http',
PROJECT_DB_HOST: 'localhost',
}))
describe('api/self-hosted/settings', () => {
let mockAssertSelfHosted: ReturnType<typeof vi.fn>
beforeEach(async () => {
vi.resetModules()
const util = await import('./util')
mockAssertSelfHosted = vi.mocked(util.assertSelfHosted)
})
describe('getProjectSettings', () => {
it('should call assertSelfHosted', () => {
getProjectSettings()
expect(mockAssertSelfHosted).toHaveBeenCalled()
})
it('should return project settings with correct structure', () => {
const settings = getProjectSettings()
expect(settings).toHaveProperty('app_config')
expect(settings).toHaveProperty('cloud_provider')
expect(settings).toHaveProperty('db_dns_name')
expect(settings).toHaveProperty('db_host')
expect(settings).toHaveProperty('db_name')
expect(settings).toHaveProperty('jwt_secret')
expect(settings).toHaveProperty('service_api_keys')
})
it('should return correct default values', () => {
const settings = getProjectSettings()
expect(settings.cloud_provider).toBe('AWS')
expect(settings.db_host).toBe('localhost')
expect(settings.db_name).toBe('postgres')
expect(settings.db_port).toBe(5432)
expect(settings.db_user).toBe('postgres')
expect(settings.ref).toBe('default')
expect(settings.region).toBe('local')
expect(settings.status).toBe('ACTIVE_HEALTHY')
expect(settings.ssl_enforced).toBe(false)
})
it('should include app_config with endpoint and protocol', () => {
const settings = getProjectSettings()
expect(settings.app_config).toEqual({
db_schema: 'public',
endpoint: 'localhost:8000',
storage_endpoint: 'localhost:8000',
protocol: 'http',
})
})
it('should include service_api_keys array', () => {
const settings = getProjectSettings()
expect(settings.service_api_keys).toHaveLength(2)
expect(settings.service_api_keys[0].name).toBe('anon key')
expect(settings.service_api_keys[0].tags).toBe('anon')
expect(settings.service_api_keys[1].name).toBe('service_role key')
expect(settings.service_api_keys[1].tags).toBe('service_role')
})
it('should use environment variables when set', async () => {
vi.stubEnv('AUTH_JWT_SECRET', 'custom-jwt-secret-with-at-least-32-chars')
vi.stubEnv('DEFAULT_PROJECT_NAME', 'My Custom Project')
vi.stubEnv('SUPABASE_SERVICE_KEY', 'custom-service-key')
vi.stubEnv('SUPABASE_ANON_KEY', 'custom-anon-key')
// Need to re-import to pick up new env vars
vi.resetModules()
const { getProjectSettings: getSettings } = await import('./settings')
const settings = getSettings()
expect(settings.jwt_secret).toBe('custom-jwt-secret-with-at-least-32-chars')
expect(settings.name).toBe('My Custom Project')
expect(settings.service_api_keys[0].api_key).toBe('custom-anon-key')
expect(settings.service_api_keys[1].api_key).toBe('custom-service-key')
})
it('should use default JWT secret when not set', async () => {
vi.unstubAllEnvs()
vi.resetModules()
const { getProjectSettings: getSettings } = await import('./settings')
const settings = getSettings()
expect(settings.jwt_secret).toBe('super-secret-jwt-token-with-at-least-32-characters-long')
})
it('should use default project name when not set', async () => {
vi.unstubAllEnvs()
vi.resetModules()
const { getProjectSettings: getSettings } = await import('./settings')
const settings = getSettings()
expect(settings.name).toBe('Default Project')
})
it('should have correct db_ip_addr_config', () => {
const settings = getProjectSettings()
expect(settings.db_ip_addr_config).toBe('legacy')
})
it('should have correct inserted_at timestamp', () => {
const settings = getProjectSettings()
expect(settings.inserted_at).toBe('2021-08-02T06:40:40.646Z')
})
})
})