mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +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>
216 lines
7.0 KiB
TypeScript
216 lines
7.0 KiB
TypeScript
import { fireEvent, screen, waitFor, within } from '@testing-library/react'
|
|
import userEvent from '@testing-library/user-event'
|
|
import { mockAnimationsApi } from 'jsdom-testing-mocks'
|
|
import { http, HttpResponse } from 'msw'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { AccountIdentities } from './AccountIdentities'
|
|
import { BASE_PATH } from '@/lib/constants'
|
|
import { customRender } from '@/tests/lib/custom-render'
|
|
import { mswServer } from '@/tests/lib/msw'
|
|
|
|
// Radix Dialog relies on the Web Animations API, which jsdom lacks.
|
|
mockAnimationsApi()
|
|
|
|
const { getUserMock, updateUserMock, refreshSessionMock, signOutMock, useFlagMock } = vi.hoisted(
|
|
() => ({
|
|
getUserMock: vi.fn(),
|
|
updateUserMock: vi.fn(),
|
|
refreshSessionMock: vi.fn(),
|
|
signOutMock: vi.fn(),
|
|
useFlagMock: vi.fn(),
|
|
})
|
|
)
|
|
|
|
// Overrides the global partial mock from vitestSetup, so re-apply `useParams` alongside `useFlag`.
|
|
vi.mock('common', async (importOriginal) => {
|
|
const actual = await importOriginal<typeof import('common')>()
|
|
return {
|
|
...actual,
|
|
useParams: () => ({ ref: 'default' }),
|
|
useFlag: useFlagMock,
|
|
}
|
|
})
|
|
|
|
vi.mock('@/lib/gotrue', () => ({
|
|
auth: {
|
|
getUser: getUserMock,
|
|
updateUser: updateUserMock,
|
|
refreshSession: refreshSessionMock,
|
|
signOut: signOutMock,
|
|
},
|
|
buildPathWithParams: (path: string) => path,
|
|
}))
|
|
|
|
const EMAIL = 'user@example.com'
|
|
const VALID_PASSWORD = 'Str0ng!password'
|
|
|
|
type IdentityFixture = {
|
|
identity_id: string
|
|
id: string
|
|
user_id: string
|
|
provider: string
|
|
identity_data: Record<string, string>
|
|
email: string
|
|
}
|
|
|
|
const githubIdentity: IdentityFixture = {
|
|
identity_id: 'github-identity-id',
|
|
id: 'github-user-id',
|
|
user_id: 'user-id',
|
|
provider: 'github',
|
|
identity_data: { user_name: 'testuser' },
|
|
email: EMAIL,
|
|
}
|
|
|
|
const emailIdentity: IdentityFixture = {
|
|
identity_id: 'email-identity-id',
|
|
id: 'user-id',
|
|
user_id: 'user-id',
|
|
provider: 'email',
|
|
identity_data: {},
|
|
email: EMAIL,
|
|
}
|
|
|
|
const ssoIdentity: IdentityFixture = {
|
|
identity_id: 'sso-identity-id',
|
|
id: 'sso-user-id',
|
|
user_id: 'user-id',
|
|
provider: 'sso:4d21b3cf-3a2f-44d3-b7d6-2b0dd393f671',
|
|
identity_data: {},
|
|
email: EMAIL,
|
|
}
|
|
|
|
const mockGetUser = (identities: IdentityFixture[]) => {
|
|
getUserMock.mockResolvedValue({
|
|
data: { user: { id: 'user-id', email: EMAIL, identities } },
|
|
error: null,
|
|
})
|
|
}
|
|
|
|
const renderAccountIdentities = () => {
|
|
mswServer.use(
|
|
http.get(`${BASE_PATH}/api/enabled-features-overrides`, () =>
|
|
HttpResponse.json({ disabled_features: [] })
|
|
)
|
|
)
|
|
|
|
return customRender(<AccountIdentities />)
|
|
}
|
|
|
|
const openAddPasswordDialog = async () => {
|
|
const openButton = await screen.findByRole('button', { name: 'Add password' })
|
|
fireEvent.click(openButton)
|
|
|
|
return await screen.findByRole('dialog')
|
|
}
|
|
|
|
describe('AccountIdentities', () => {
|
|
beforeEach(() => {
|
|
refreshSessionMock.mockResolvedValue({ data: {}, error: null })
|
|
signOutMock.mockResolvedValue({ error: null })
|
|
useFlagMock.mockImplementation((name: string) => name === 'enableAccountPassword')
|
|
})
|
|
|
|
it('offers to add a password when the user only has OAuth identities', async () => {
|
|
mockGetUser([githubIdentity])
|
|
|
|
renderAccountIdentities()
|
|
|
|
expect(await screen.findByRole('button', { name: 'Add password' })).toBeInTheDocument()
|
|
expect(screen.getByText('Email')).toBeInTheDocument()
|
|
expect(screen.queryByRole('link', { name: 'Change password' })).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('does not offer to add a password when an email identity exists', async () => {
|
|
mockGetUser([githubIdentity, emailIdentity])
|
|
|
|
renderAccountIdentities()
|
|
|
|
expect(await screen.findByRole('link', { name: 'Change password' })).toBeInTheDocument()
|
|
expect(screen.queryByRole('button', { name: 'Add password' })).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('does not offer to add a password when the feature flag is disabled', async () => {
|
|
useFlagMock.mockReturnValue(false)
|
|
mockGetUser([githubIdentity])
|
|
|
|
renderAccountIdentities()
|
|
|
|
expect(await screen.findByText('GitHub')).toBeInTheDocument()
|
|
expect(screen.queryByRole('button', { name: 'Add password' })).not.toBeInTheDocument()
|
|
expect(screen.queryByText('Email')).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('does not offer to add a password to SSO users', async () => {
|
|
mockGetUser([ssoIdentity])
|
|
|
|
renderAccountIdentities()
|
|
|
|
expect(await screen.findByText('SSO')).toBeInTheDocument()
|
|
expect(screen.queryByRole('button', { name: 'Add password' })).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('adds a password and flips the row to the email identity actions', async () => {
|
|
mockGetUser([githubIdentity])
|
|
updateUserMock.mockImplementation(async () => {
|
|
// GoTrue creates the email identity when the password is set, so the
|
|
// post-mutation refetch sees both identities.
|
|
mockGetUser([githubIdentity, emailIdentity])
|
|
return { data: { user: { id: 'user-id', email: EMAIL } }, error: null }
|
|
})
|
|
|
|
renderAccountIdentities()
|
|
const dialog = await openAddPasswordDialog()
|
|
|
|
const emailInput = within(dialog).getByLabelText('Email')
|
|
expect(emailInput).toBeDisabled()
|
|
expect(emailInput).toHaveValue(EMAIL)
|
|
|
|
await userEvent.type(within(dialog).getByPlaceholderText('••••••••'), VALID_PASSWORD)
|
|
fireEvent.click(within(dialog).getByRole('button', { name: 'Add password' }))
|
|
|
|
await waitFor(() => expect(screen.queryByRole('dialog')).not.toBeInTheDocument())
|
|
expect(updateUserMock).toHaveBeenCalledWith({ password: VALID_PASSWORD })
|
|
expect(signOutMock).toHaveBeenCalledWith({ scope: 'others' })
|
|
|
|
expect(await screen.findByRole('link', { name: 'Change password' })).toBeInTheDocument()
|
|
expect(screen.queryByRole('button', { name: 'Add password' })).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('keeps the dialog open when setting the password fails', async () => {
|
|
mockGetUser([githubIdentity])
|
|
updateUserMock.mockResolvedValue({
|
|
data: { user: null },
|
|
error: { message: 'Password update failed' },
|
|
})
|
|
|
|
renderAccountIdentities()
|
|
const dialog = await openAddPasswordDialog()
|
|
|
|
await userEvent.type(within(dialog).getByPlaceholderText('••••••••'), VALID_PASSWORD)
|
|
fireEvent.click(within(dialog).getByRole('button', { name: 'Add password' }))
|
|
|
|
await waitFor(() => expect(updateUserMock).toHaveBeenCalledWith({ password: VALID_PASSWORD }))
|
|
expect(screen.getByRole('dialog')).toBeInTheDocument()
|
|
expect(signOutMock).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('does not submit a password that fails validation', async () => {
|
|
mockGetUser([githubIdentity])
|
|
|
|
renderAccountIdentities()
|
|
const dialog = await openAddPasswordDialog()
|
|
|
|
await userEvent.type(within(dialog).getByPlaceholderText('••••••••'), 'weak')
|
|
fireEvent.click(within(dialog).getByRole('button', { name: 'Add password' }))
|
|
|
|
expect(
|
|
await within(dialog).findByText(
|
|
'Password must contain at least 8 characters, including uppercase, lowercase, number, and special character'
|
|
)
|
|
).toBeInTheDocument()
|
|
expect(updateUserMock).not.toHaveBeenCalled()
|
|
})
|
|
})
|