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>
121 lines
4.4 KiB
TypeScript
121 lines
4.4 KiB
TypeScript
import * as supabaseJs from '@supabase/supabase-js'
|
|
import { describe, expect, it, vi } from 'vitest'
|
|
|
|
import { createProjectSupabaseClient } from './project-supabase-client'
|
|
import * as apiKeysUtils from '@/data/api-keys/temp-api-keys-utils'
|
|
|
|
vi.mock('@supabase/supabase-js', () => ({
|
|
createClient: vi.fn(),
|
|
}))
|
|
|
|
vi.mock('@/data/api-keys/temp-api-keys-utils', () => ({
|
|
getOrRefreshTemporaryApiKey: vi.fn(),
|
|
}))
|
|
|
|
describe('project-supabase-client', () => {
|
|
describe('createProjectSupabaseClient', () => {
|
|
it('should create a Supabase client with temporary API key', async () => {
|
|
const mockApiKey = 'sb_temp_nonce1234567890ab_payload1'
|
|
const mockClient = { from: vi.fn() }
|
|
const projectRef = 'test-project-ref'
|
|
const clientEndpoint = 'https://test.supabase.co'
|
|
|
|
vi.mocked(apiKeysUtils.getOrRefreshTemporaryApiKey).mockResolvedValue({
|
|
apiKey: mockApiKey,
|
|
expiryTimeMs: Date.now() + 3600000,
|
|
})
|
|
vi.mocked(supabaseJs.createClient).mockReturnValue(mockClient as any)
|
|
|
|
const result = await createProjectSupabaseClient(projectRef, clientEndpoint)
|
|
|
|
expect(apiKeysUtils.getOrRefreshTemporaryApiKey).toHaveBeenCalledWith(projectRef)
|
|
expect(supabaseJs.createClient).toHaveBeenCalledWith(clientEndpoint, mockApiKey, {
|
|
auth: {
|
|
persistSession: false,
|
|
autoRefreshToken: false,
|
|
detectSessionInUrl: false,
|
|
storage: {
|
|
getItem: expect.any(Function),
|
|
setItem: expect.any(Function),
|
|
removeItem: expect.any(Function),
|
|
},
|
|
},
|
|
})
|
|
expect(result).toBe(mockClient)
|
|
})
|
|
|
|
it('should configure storage to not persist session', async () => {
|
|
const mockApiKey = 'sb_temp_nonce1234567890ab_payload2'
|
|
const mockClient = { from: vi.fn() }
|
|
|
|
vi.mocked(apiKeysUtils.getOrRefreshTemporaryApiKey).mockResolvedValue({
|
|
apiKey: mockApiKey,
|
|
expiryTimeMs: Date.now() + 3600000,
|
|
})
|
|
vi.mocked(supabaseJs.createClient).mockReturnValue(mockClient as any)
|
|
|
|
await createProjectSupabaseClient('ref', 'https://example.com')
|
|
|
|
const config = vi.mocked(supabaseJs.createClient).mock.calls[0][2]
|
|
if (!config?.auth?.storage) throw new Error('storage config is missing')
|
|
const storage = config.auth.storage
|
|
|
|
// Test storage methods return expected values
|
|
expect(storage.getItem('any-key')).toBeNull()
|
|
expect(storage.setItem('key', 'value')).toBeUndefined()
|
|
expect(storage.removeItem('key')).toBeUndefined()
|
|
})
|
|
|
|
it('should throw error if API key retrieval fails', async () => {
|
|
const error = new Error('Failed to get API key')
|
|
vi.mocked(apiKeysUtils.getOrRefreshTemporaryApiKey).mockRejectedValue(error)
|
|
|
|
await expect(createProjectSupabaseClient('ref', 'https://example.com')).rejects.toThrow(
|
|
'Failed to get API key'
|
|
)
|
|
|
|
expect(supabaseJs.createClient).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should pass through different project refs and endpoints', async () => {
|
|
const mockApiKey = 'sb_temp_nonce1234567890ab_payload3'
|
|
const mockClient = { from: vi.fn() }
|
|
|
|
vi.mocked(apiKeysUtils.getOrRefreshTemporaryApiKey).mockResolvedValue({
|
|
apiKey: mockApiKey,
|
|
expiryTimeMs: Date.now() + 3600000,
|
|
})
|
|
vi.mocked(supabaseJs.createClient).mockReturnValue(mockClient as any)
|
|
|
|
await createProjectSupabaseClient('project-123', 'https://project123.supabase.co')
|
|
|
|
expect(apiKeysUtils.getOrRefreshTemporaryApiKey).toHaveBeenCalledWith('project-123')
|
|
expect(supabaseJs.createClient).toHaveBeenCalledWith(
|
|
'https://project123.supabase.co',
|
|
mockApiKey,
|
|
expect.any(Object)
|
|
)
|
|
})
|
|
|
|
it('should disable session persistence options', async () => {
|
|
const mockApiKey = 'sb_temp_nonce1234567890ab_payload4'
|
|
const mockClient = { from: vi.fn() }
|
|
|
|
vi.mocked(apiKeysUtils.getOrRefreshTemporaryApiKey).mockResolvedValue({
|
|
apiKey: mockApiKey,
|
|
expiryTimeMs: Date.now() + 3600000,
|
|
})
|
|
vi.mocked(supabaseJs.createClient).mockReturnValue(mockClient as any)
|
|
|
|
await createProjectSupabaseClient('ref', 'https://example.com')
|
|
|
|
const config = vi.mocked(supabaseJs.createClient).mock.calls[0][2]
|
|
if (!config?.auth) throw new Error('auth config is missing')
|
|
|
|
expect(config.auth.persistSession).toBe(false)
|
|
expect(config.auth.autoRefreshToken).toBe(false)
|
|
expect(config.auth.detectSessionInUrl).toBe(false)
|
|
})
|
|
})
|
|
})
|