Files
supabase__supabase/apps/studio/lib/ai/tools/incident-tools.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

226 lines
7.4 KiB
TypeScript

import { beforeEach, describe, expect, it, vi } from 'vitest'
import { getIncidentTools } from './incident-tools'
// Mock IS_PLATFORM
vi.mock('common', () => ({
IS_PLATFORM: true,
}))
describe('ai/tools/incident-tools', () => {
let mockFetch: ReturnType<typeof vi.fn>
let mockAbortSignal: AbortSignal
beforeEach(() => {
mockFetch = vi.fn()
global.fetch = mockFetch as typeof fetch
// Mock AbortSignal.timeout
mockAbortSignal = new AbortController().signal
if (!AbortSignal.timeout) {
AbortSignal.timeout = vi.fn(() => mockAbortSignal) as any
}
})
describe('getIncidentTools', () => {
it('should return an object with get_active_incidents tool', () => {
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
expect(tools).toBeDefined()
expect(tools.get_active_incidents).toBeDefined()
})
it('should have correct description for get_active_incidents', () => {
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
expect(tools.get_active_incidents.description).toContain('Check for active incidents')
expect(tools.get_active_incidents.description).toContain('Supabase service')
})
it('should have empty input schema', () => {
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
const schema = tools.get_active_incidents.inputSchema
// The schema is a Zod object that accepts empty object
expect(schema).toBeDefined()
expect((schema as any)._def.typeName).toBe('ZodObject')
})
describe('execute function', () => {
it('should return empty incidents when not on platform', async () => {
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(false)
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
const result = await (tools.get_active_incidents.execute as any)({})
expect(result).toEqual({
incidents: [],
message: 'Incident checking is only available on Supabase platform.',
})
expect(mockFetch).not.toHaveBeenCalled()
})
it('should fetch incidents from correct URL', async () => {
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(true)
mockFetch.mockResolvedValue({
ok: true,
json: async () => [],
})
const tools = getIncidentTools({ baseUrl: 'https://example.com/dashboard' })
if (!tools.get_active_incidents.execute) throw new Error('execute is undefined')
await tools.get_active_incidents.execute(
{},
{ toolCallId: 'test', messages: [], context: {} }
)
expect(mockFetch).toHaveBeenCalledWith(
'https://example.com/dashboard/api/incident-status',
{
signal: expect.any(AbortSignal),
}
)
})
it('should return message when no incidents', async () => {
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(true)
mockFetch.mockResolvedValue({
ok: true,
json: async () => [],
})
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
const result = await (tools.get_active_incidents.execute as any)({})
expect(result).toEqual({
incidents: [],
message: expect.stringContaining('No active incidents'),
})
})
it('should return incident summaries when incidents exist', async () => {
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(true)
const mockIncidents = [
{
name: 'Database slowness',
status: 'investigating',
impact: 'minor',
active_since: '2024-01-01T10:00:00Z',
extra_field: 'should be filtered',
},
]
mockFetch.mockResolvedValue({
ok: true,
json: async () => mockIncidents,
})
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
const result = await (tools.get_active_incidents.execute as any)({})
expect((result as any).incidents).toEqual([
{
name: 'Database slowness',
status: 'investigating',
impact: 'minor',
active_since: '2024-01-01T10:00:00Z',
},
])
expect((result as any).message).toContain('1 active incident')
expect((result as any).message).toContain('status.supabase.com')
})
it('should handle multiple incidents', async () => {
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(true)
const mockIncidents = [
{
name: 'Database issue',
status: 'investigating',
impact: 'major',
active_since: '2024-01-01T10:00:00Z',
},
{
name: 'Storage issue',
status: 'identified',
impact: 'minor',
active_since: '2024-01-01T11:00:00Z',
},
]
mockFetch.mockResolvedValue({
ok: true,
json: async () => mockIncidents,
})
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
const result = await (tools.get_active_incidents.execute as any)({})
expect((result as any).incidents).toHaveLength(2)
expect((result as any).message).toContain('2 active incidents')
})
it('should handle fetch errors', async () => {
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(true)
mockFetch.mockRejectedValue(new Error('Network error'))
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
const result = await (tools.get_active_incidents.execute as any)({})
expect(result).toEqual({
incidents: [],
error: 'Unable to check incident status at this time.',
})
})
it('should handle non-ok responses', async () => {
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(true)
mockFetch.mockResolvedValue({
ok: false,
status: 500,
})
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
const result = await (tools.get_active_incidents.execute as any)({})
expect(result).toEqual({
incidents: [],
error: 'Unable to check incident status at this time.',
})
})
it('should use timeout signal', async () => {
const common = await import('common')
vi.spyOn(common, 'IS_PLATFORM', 'get').mockReturnValue(true)
mockFetch.mockResolvedValue({
ok: true,
json: async () => [],
})
const tools = getIncidentTools({ baseUrl: 'https://supabase.com/dashboard' })
if (!tools.get_active_incidents.execute) throw new Error('execute is undefined')
await tools.get_active_incidents.execute(
{},
{ toolCallId: 'test', messages: [], context: {} }
)
const callArgs = mockFetch.mock.calls[0]
expect(callArgs[1].signal).toBeInstanceOf(AbortSignal)
})
})
})
})