mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 18:11:51 +08:00
a66dae48f2
## Problem When the table editor showed a "Failed to load tables" or "Failed to load schemas" error (for example, when the underlying database or API gateway is unhealthy), there was no working way to restart the project from that error state. Restarting only worked by navigating to Project Settings. ## Fix "Failed to load tables" goes through the existing `ErrorMatcher` classification system, which only showed troubleshooting steps (including a restart action) for connection-timeout errors. Added an `ERROR_MAPPINGS` entry for the unclassified/generic API error case, reusing the existing `RestartDatabaseTroubleshootingSection` and `RestartProjectDialog` components already used for connection timeouts. "Failed to load schemas" (in the shared `SchemaSelector`, used across the table editor and several Database pages) only offered a retry. Added a "Restart database" button next to it, wired to the same `RestartProjectDialog`. ## How to test - In the table editor, trigger a table-load failure that isn't a connection timeout (any generic API error). The error card should now show a "Try restarting your project" step with a working restart action. - Open the schema selector while schemas fail to load (e.g. mock a 503 from the schemas query). A "Restart database" button should appear next to "Reload schemas" and open the restart confirmation dialog. - `apps/studio/components/interfaces/ErrorHandling/ErrorMatcher.test.tsx` and `apps/studio/components/ui/SchemaSelector.test.tsx` cover both cases. FE-4054 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added database restart guidance when schema loading fails. * Added options to reload schemas or restart the database, including a confirmation prompt. * Added troubleshooting guidance for unclassified table-loading errors. * **Bug Fixes** * Improved error handling by displaying relevant fallback guidance for unknown errors while preserving classified troubleshooting instructions. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
106 lines
3.2 KiB
TypeScript
106 lines
3.2 KiB
TypeScript
import { screen } from '@testing-library/react'
|
|
import userEvent from '@testing-library/user-event'
|
|
import { mockAnimationsApi } from 'jsdom-testing-mocks'
|
|
import { HttpResponse } from 'msw'
|
|
import { describe, expect, it, vi } from 'vitest'
|
|
|
|
import { SchemaSelector } from './SchemaSelector'
|
|
import { customRender } from '@/tests/lib/custom-render'
|
|
import { addAPIMock, APIErrorBody } from '@/tests/lib/msw'
|
|
|
|
mockAnimationsApi()
|
|
|
|
const mockProjectAndSchemas = ({ highAvailability }: { highAvailability: boolean }) => {
|
|
// useSelectedProjectQuery
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/projects/:ref',
|
|
// @ts-expect-error partial project response
|
|
response: {
|
|
cloud_provider: 'localhost',
|
|
id: 1,
|
|
inserted_at: '2021-08-02T06:40:40.646Z',
|
|
name: 'Default Project',
|
|
organization_id: 1,
|
|
ref: 'default',
|
|
region: 'local',
|
|
status: 'ACTIVE_HEALTHY',
|
|
high_availability: highAvailability,
|
|
},
|
|
})
|
|
// useSchemasQuery (schemas list SQL via pg-meta)
|
|
addAPIMock({
|
|
method: 'post',
|
|
path: '/platform/pg-meta/:ref/query',
|
|
response: () =>
|
|
HttpResponse.json([
|
|
{ id: 1, name: 'public' },
|
|
{ id: 2, name: 'multigres' },
|
|
{ id: 3, name: 'other' },
|
|
]),
|
|
})
|
|
}
|
|
|
|
const mockProjectAndFailingSchemas = () => {
|
|
addAPIMock({
|
|
method: 'get',
|
|
path: '/platform/projects/:ref',
|
|
// @ts-expect-error partial project response
|
|
response: {
|
|
cloud_provider: 'localhost',
|
|
id: 1,
|
|
inserted_at: '2021-08-02T06:40:40.646Z',
|
|
name: 'Default Project',
|
|
organization_id: 1,
|
|
ref: 'default',
|
|
region: 'local',
|
|
status: 'ACTIVE_HEALTHY',
|
|
},
|
|
})
|
|
addAPIMock({
|
|
method: 'post',
|
|
path: '/platform/pg-meta/:ref/query',
|
|
response: () =>
|
|
HttpResponse.json<APIErrorBody>({ message: 'Service unavailable' }, { status: 503 }),
|
|
})
|
|
}
|
|
|
|
const renderAndOpenSelector = async () => {
|
|
customRender(<SchemaSelector selectedSchemaName="public" onSelectSchema={vi.fn()} />)
|
|
|
|
await userEvent.click(await screen.findByTestId('schema-selector'))
|
|
// Wait for the list to be populated before asserting absence
|
|
await screen.findByRole('option', { name: 'public' })
|
|
}
|
|
|
|
describe('SchemaSelector', () => {
|
|
it('hides the multigres schema on high availability projects', async () => {
|
|
mockProjectAndSchemas({ highAvailability: true })
|
|
|
|
await renderAndOpenSelector()
|
|
|
|
expect(screen.getByRole('option', { name: 'other' })).toBeInTheDocument()
|
|
expect(screen.queryByRole('option', { name: 'multigres' })).not.toBeInTheDocument()
|
|
})
|
|
|
|
it('shows the multigres schema on non high availability projects', async () => {
|
|
mockProjectAndSchemas({ highAvailability: false })
|
|
|
|
await renderAndOpenSelector()
|
|
|
|
expect(screen.getByRole('option', { name: 'multigres' })).toBeInTheDocument()
|
|
})
|
|
|
|
it('offers to restart the database when schemas fail to load', async () => {
|
|
mockProjectAndFailingSchemas()
|
|
|
|
customRender(<SchemaSelector selectedSchemaName="public" onSelectSchema={vi.fn()} />)
|
|
|
|
await userEvent.click(await screen.findByRole('button', { name: 'Restart database' }))
|
|
|
|
expect(
|
|
await screen.findByText(/are you sure you want to restart your database/i)
|
|
).toBeInTheDocument()
|
|
})
|
|
})
|