Files
Gildas GarciaandAlaister Young 737b8595f2 Update API types (#50234)
## Problem

platform, v1 and v2 have been already completely migrated and introduced
some changes.

Some types have been renamed, some outputs and inputs updated.

## Solution

- Update the API types
- Fix the TS errors

## Update

Taking this over to unblock #50134, which needs the new scoped token
permission ids from the regenerated types.

- Merged `master`.
- Regenerated `api-v2.d.ts` from the production spec. The previous files
came from a local API that exposed a webhook events endpoint production
doesn't have yet. Production has since added standardized 400 error
responses on the v2 organization endpoints. `api-v1.d.ts` and
`platform.d.ts` already matched production.
- Fixed `verify-production-types`. It formatted the regenerated files in
a temp directory outside the repository, so Prettier fell back to its
defaults and the comparison could never match the committed files. It
now passes the repository config explicitly. `pnpm api:verify-types`
passes on this branch.
- Verified locally: `pnpm typecheck`, `pnpm api:verify-types`, Studio
unit tests.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Bug Fixes**
* Preserved descriptions when saving, sharing, moving, or unsharing
notebooks, reports, SQL snippets, and saved queries.
* Improved handling of empty or null values across notebook
descriptions, billing usage, pooler settings, and infrastructure fields.
* Improved read-replica connection handling, including read-only
connection strings.
* Updated storage configuration and capability handling to match current
settings.

* **API and Compatibility**
* Updated organization, project, storage, OAuth, billing, and
infrastructure data handling to match current API responses.
  * OAuth app creation and updates now require scopes.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-09-11 12:17:49 +08:00

130 lines
4.4 KiB
TypeScript

import { screen, within } from '@testing-library/react'
import { platformComponents as components } from 'api-types'
import { http, HttpResponse } from 'msw'
import { describe, expect, test, vi } from 'vitest'
import { HaInstanceConfiguration } from './HaInstanceConfiguration'
import { API_URL } from '@/lib/constants'
import type { ProfileContextType } from '@/lib/profile'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock, mswServer, type APIErrorBody } from '@/tests/lib/msw'
type ProjectDetailResponse = components['schemas']['ProjectDetailResponse_Output']
vi.mock('@/lib/constants', async (importOriginal) => {
const actual = await importOriginal<typeof import('@/lib/constants')>()
return {
...actual,
IS_PLATFORM: true,
}
})
const PROFILE_CONTEXT: ProfileContextType = {
profile: {
id: 1,
auth0_id: 'auth0|test',
gotrue_id: 'gotrue-test',
username: 'testuser',
primary_email: 'test@example.com',
first_name: null,
last_name: null,
mobile: null,
is_alpha_user: false,
is_sso_user: false,
disabled_features: [],
free_project_limit: null,
},
error: null,
isLoading: false,
isError: false,
isSuccess: true,
}
const PROJECT: ProjectDetailResponse = {
cloud_provider: 'AWS_K8S',
connectionString: 'postgresql://postgres:password@db.default.supabase.co:5432/postgres',
db_host: 'db.default.supabase.co',
dbVersion: 'supabase-postgres-15.1.0',
high_availability: true,
id: 1,
infra_compute_size: 'large',
inserted_at: '2026-01-01T00:00:00.000Z',
integration_source: null,
is_branch_enabled: false,
is_physical_backups_enabled: false,
name: 'Production',
organization_id: 1,
ref: 'default',
region: 'us-east-1',
restUrl: 'https://default.supabase.co',
status: 'ACTIVE_HEALTHY',
subscription_id: 'subscription-1',
updated_at: '2026-01-01T00:00:00.000Z',
}
const mockProject = (status: ProjectDetailResponse['status']) => {
addAPIMock({
method: 'get',
path: '/platform/projects/:ref',
response: { ...PROJECT, status } satisfies ProjectDetailResponse,
})
}
// The /ha-admin passthrough paths are off-schema (see get-ha-admin.ts), so they
// can't go through the OpenAPI-typed addAPIMock.
const mockHaAdmin = ({ isHealthy }: { isHealthy: boolean }) => {
mswServer.use(
http.get(`${API_URL}/platform/projects/:ref/ha-admin/v1/gateways`, () =>
isHealthy
? HttpResponse.json({ gateways: [] })
: HttpResponse.json<APIErrorBody>({ message: 'upstream unavailable' }, { status: 500 })
),
http.get(`${API_URL}/platform/projects/:ref/ha-admin/v1/poolers`, () =>
isHealthy
? HttpResponse.json({ poolers: [] })
: HttpResponse.json<APIErrorBody>({ message: 'upstream unavailable' }, { status: 500 })
)
)
}
describe('HaInstanceConfiguration', () => {
test('shows the setup state instead of an error while the project is coming up', async () => {
mockProject('COMING_UP')
mockHaAdmin({ isHealthy: false })
customRender(<HaInstanceConfiguration />, { profileContext: PROFILE_CONTEXT })
const statusRegion = await screen.findByRole('status')
expect(await within(statusRegion).findByText('Setting up project')).toBeInTheDocument()
expect(screen.queryByText('Failed to retrieve cluster topology')).not.toBeInTheDocument()
})
test('shows the setup state instead of the unavailable state while the project is coming up with an empty topology', async () => {
mockProject('COMING_UP')
mockHaAdmin({ isHealthy: true })
customRender(<HaInstanceConfiguration />, { profileContext: PROFILE_CONTEXT })
expect(await screen.findByText('Setting up project')).toBeInTheDocument()
expect(screen.queryByText('Cluster topology unavailable')).not.toBeInTheDocument()
})
test('surfaces topology errors once the project is running', async () => {
mockProject('ACTIVE_HEALTHY')
mockHaAdmin({ isHealthy: false })
customRender(<HaInstanceConfiguration />, { profileContext: PROFILE_CONTEXT })
expect(await screen.findByText('Failed to retrieve cluster topology')).toBeInTheDocument()
})
test('shows the unavailable state for an empty topology once the project is running', async () => {
mockProject('ACTIVE_HEALTHY')
mockHaAdmin({ isHealthy: true })
customRender(<HaInstanceConfiguration />, { profileContext: PROFILE_CONTEXT })
expect(await screen.findByText('Cluster topology unavailable')).toBeInTheDocument()
})
})