Files
supabase__supabase/apps/studio/lib/integration-utils.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

259 lines
8.3 KiB
TypeScript

import { describe, expect, it, vi } from 'vitest'
import {
getInitialMigrationSQLFromGitHubRepo,
getIntegrationConfigurationUrl,
} from './integration-utils'
import type {
GitHubAccount,
Integration,
VercelAccount,
VercelTeamAccount,
} from '@/data/integrations/integrations.types'
vi.mock('@/data/fetchers', () => ({
fetchHandler: vi.fn(),
}))
describe('integration-utils', () => {
describe('getInitialMigrationSQLFromGitHubRepo', () => {
it('should return null when no externalId is provided', async () => {
const result = await getInitialMigrationSQLFromGitHubRepo()
expect(result).toBeNull()
})
it('should fetch and combine migration files correctly', async () => {
const mockGitHubUrl = 'https://github.com/org/repo/tree/main/examples/with-supabase'
const mockSupabaseFiles = [{ name: 'seed.sql', download_url: 'https://github.com/seed.sql' }]
const mockMigrationFiles = [
{ name: '20230101000000_initial.sql', download_url: 'https://github.com/migration1.sql' },
{ name: '20230101000001_second.sql', download_url: 'https://github.com/migration2.sql' },
]
const mockMigrationContent1 = 'CREATE TABLE users (id serial PRIMARY KEY);'
const mockMigrationContent2 = 'CREATE TABLE posts (id serial PRIMARY KEY);'
const mockSeedContent = 'INSERT INTO users (id) VALUES (1);'
// Mock the fetch responses
const { fetchHandler } = await import('@/data/fetchers')
const mockFetchHandler = fetchHandler as unknown as ReturnType<typeof vi.fn>
mockFetchHandler
.mockResolvedValueOnce(
new Response(JSON.stringify(mockSupabaseFiles), {
status: 200,
statusText: 'OK',
headers: { 'Content-Type': 'application/json' },
})
)
.mockResolvedValueOnce(
new Response(JSON.stringify(mockMigrationFiles), {
status: 200,
statusText: 'OK',
headers: { 'Content-Type': 'application/json' },
})
)
.mockResolvedValueOnce(
new Response(mockSeedContent, {
status: 200,
statusText: 'OK',
headers: { 'Content-Type': 'text/plain' },
})
)
.mockResolvedValueOnce(
new Response(mockMigrationContent1, {
status: 200,
statusText: 'OK',
headers: { 'Content-Type': 'text/plain' },
})
)
.mockResolvedValueOnce(
new Response(mockMigrationContent2, {
status: 200,
statusText: 'OK',
headers: { 'Content-Type': 'text/plain' },
})
)
const result = await getInitialMigrationSQLFromGitHubRepo(mockGitHubUrl)
expect(result).toContain(mockMigrationContent1)
expect(result).toContain(mockMigrationContent2)
expect(result).toContain(mockSeedContent)
expect(result).toContain('create schema if not exists supabase_migrations')
expect(result).toContain('create table if not exists supabase_migrations.schema_migrations')
})
it('should handle GitHub API errors gracefully', async () => {
const mockGitHubUrl = 'https://github.com/org/repo/tree/main/examples/with-supabase'
const { fetchHandler } = await import('@/data/fetchers')
const mockFetchHandler = fetchHandler as unknown as ReturnType<typeof vi.fn>
mockFetchHandler
.mockResolvedValueOnce(
new Response(null, {
status: 404,
statusText: 'Not Found',
headers: { 'Content-Type': 'application/json' },
})
)
.mockResolvedValueOnce(
new Response(null, {
status: 404,
statusText: 'Not Found',
headers: { 'Content-Type': 'application/json' },
})
)
const result = await getInitialMigrationSQLFromGitHubRepo(mockGitHubUrl)
expect(result).toBeNull()
})
})
describe('getIntegrationConfigurationUrl', () => {
it('should return correct Vercel configuration URL for personal account', () => {
const vercelIntegration: Integration = {
id: '123',
added_by: {
username: 'testuser',
id: '123',
primary_email: 'test@example.com',
},
inserted_at: '2024-01-01',
updated_at: '2024-01-01',
connections: [],
organization: { slug: 'org' },
integration: { name: 'Vercel' },
metadata: {
account: {
type: 'Personal',
name: 'Test User',
avatar: 'test-avatar',
source: 'marketplace',
owner_id: '123',
} as VercelAccount,
configuration_id: '123',
},
}
const result = getIntegrationConfigurationUrl(vercelIntegration)
expect(result).toBe('https://vercel.com/dashboard/integrations/123')
})
it('should return correct Vercel configuration URL for team account', () => {
const vercelIntegration: Integration = {
id: '123',
added_by: {
username: 'testuser',
id: '123',
primary_email: 'test@example.com',
},
inserted_at: '2024-01-01',
updated_at: '2024-01-01',
connections: [],
organization: { slug: 'org' },
integration: { name: 'Vercel' },
metadata: {
account: {
type: 'Team',
name: 'Test Team',
avatar: 'test-avatar',
source: 'marketplace',
owner_id: '123',
team_id: 'team123',
team_slug: 'my-team',
} as VercelTeamAccount,
configuration_id: '123',
},
}
const result = getIntegrationConfigurationUrl(vercelIntegration)
expect(result).toBe('https://vercel.com/dashboard/my-team/integrations/123')
})
it('should return correct GitHub configuration URL for personal account', () => {
const githubIntegration: Integration = {
id: '456',
added_by: {
username: 'testuser',
id: '123',
primary_email: 'test@example.com',
},
inserted_at: '2024-01-01',
updated_at: '2024-01-01',
connections: [],
organization: { slug: 'org' },
integration: { name: 'GitHub' },
metadata: {
account: {
type: 'User',
name: 'Test User',
avatar: 'test-avatar',
installed_by_user_id: 123,
} as GitHubAccount,
installation_id: 456,
},
}
const result = getIntegrationConfigurationUrl(githubIntegration)
expect(result).toBe('https://github.com/settings/installations/456')
})
it('should return correct GitHub configuration URL for organization', () => {
const githubIntegration: Integration = {
id: '456',
added_by: {
username: 'testuser',
id: '123',
primary_email: 'test@example.com',
},
inserted_at: '2024-01-01',
updated_at: '2024-01-01',
connections: [],
organization: { slug: 'org' },
integration: { name: 'GitHub' },
metadata: {
account: {
type: 'Organization',
name: 'org-name',
avatar: 'test-avatar',
installed_by_user_id: 123,
} as GitHubAccount,
installation_id: 456,
},
}
const result = getIntegrationConfigurationUrl(githubIntegration)
expect(result).toBe('https://github.com/organizations/org-name/settings/installations/456')
})
it('should return empty string for unknown integration', () => {
const unknownIntegration = {
id: '789',
added_by: {
username: 'testuser',
id: '123',
primary_email: 'test@example.com',
},
inserted_at: '2024-01-01',
updated_at: '2024-01-01',
connections: [],
organization: { slug: 'org' },
integration: { name: 'Unknown' as any },
metadata: {
account: {
type: 'User',
name: 'Test User',
avatar: 'test-avatar',
installed_by_user_id: 123,
} as GitHubAccount,
installation_id: 789,
},
} as Integration
const result = getIntegrationConfigurationUrl(unknownIntegration)
expect(result).toBe('')
})
})
})