Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

fix(studio): require an available project region FE-3884 (#51582)

Jordi Enric6f36fe879beb
diff --git a/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.schema.test.ts b/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.schema.test.ts
new file mode 100644
index 00000000000..d0758542baa
--- /dev/null
+++ b/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.schema.test.ts
@@ -0,0 +1,43 @@
+import { describe, expect, test } from 'vitest'
+
+import { FormSchema, type CreateProjectForm } from './ProjectCreation.schema'
+
+const validProject: CreateProjectForm = {
+ organization: 'default-org',
+ projectName: 'Region Project',
+ highAvailability: false,
+ postgresVersion: '',
+ dbRegion: 'Americas',
+ cloudProvider: 'AWS',
+ dbPass: 'strong-database-password',
+ dbPassStrength: 4,
+ dbPassStrengthMessage: '',
+ dbPassStrengthWarning: '',
+ githubRepositoryId: '',
+ githubRepositoryName: '',
+ dataApi: true,
+ dataApiDefaultPrivileges: true,
+ enableRlsEventTrigger: false,
+ postgresVersionSelection: '',
+ useOrioleDb: false,
+ shouldRunMigrations: true,
+}
+
+describe('project creation region validation', () => {
+ test.each([undefined, '', ' '])('rejects a missing region (%j)', (dbRegion) => {
+ const result = FormSchema.safeParse({ ...validProject, dbRegion })
+
+ expect(result.success).toBe(false)
+ if (result.success) throw new Error('Expected region validation to fail')
+ expect(result.error.issues).toEqual([
+ expect.objectContaining({ path: ['dbRegion'], message: 'Please select a region.' }),
+ ])
+ })
+
+ test.each(['Americas', 'East US (North Virginia)'])(
+ 'accepts a selected region (%s)',
+ (dbRegion) => {
+ expect(FormSchema.safeParse({ ...validProject, dbRegion }).success).toBe(true)
+ }
+ )
+})
diff --git a/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.schema.ts b/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.schema.ts
index 55f5ab2edbf..58c6c8487cb 100644
--- a/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.schema.ts
+++ b/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.schema.ts
@@ -24,9 +24,10 @@ export const FormSchema = z
.transform((value) => (value === '' ? undefined : value))
.optional(),
kubernetesClusterForce: z.boolean().optional(),
- dbRegion: z.string({
- required_error: 'Please select a region.',
- }),
+ dbRegion: z
+ .string({ required_error: 'Please select a region.' })
+ .trim()
+ .min(1, 'Please select a region.'),
cloudProvider: z.string({
required_error: 'Please select a cloud provider.',
}),
diff --git a/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx b/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx
index 1d520951c9f..a9b5cff24bc 100644
--- a/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx
+++ b/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx
@@ -177,7 +177,7 @@ export const ProjectCreationForm = ({
dbPass: '',
dbPassStrength: 0,
dbPassStrengthMessage: '',
- dbRegion: undefined,
+ dbRegion: '',
githubRepositoryId: '',
githubInstallationId: undefined,
githubRepositoryName: '',
@@ -337,6 +337,9 @@ export const ProjectCreationForm = ({
})
const canCreateProject = isAdmin && !freePlanWithExceedingLimits && !hasOutstandingInvoices
+ const hasAvailableRegions =
+ !smartRegionEnabled || (availableRegionsData !== undefined && !availableRegionsError)
+ const canSubmitProject = canCreateProject && hasAvailableRegions
const canConfigureGitHubOnCreate =
canCreateProject && hasAccessToGitHubIntegration && canCreateGitHubConnection
@@ -526,6 +529,18 @@ export const ProjectCreationForm = ({
)
}
+ const isRegionSelectionUnavailable =
+ smartRegionEnabled &&
+ (!selectedRegion || !!availableRegionsError || isFetchingAvailableRegions)
+ if (isRegionSelectionUnavailable) {
+ setError(
+ 'dbRegion',
+ { type: 'manual', message: 'Please select an available region.' },
+ { shouldFocus: true }
+ )
+ return
+ }
+
const selectedSpecificRegion = specific.find((x) => x.name === dbRegion)
const selectedStaticRegion = smartRegionEnabled
? undefined
@@ -679,10 +694,10 @@ export const ProjectCreationForm = ({
}, [defaultRegion, isDbRegionDirty, setValue])
useEffect(() => {
- if (regionError && fixedDefaultRegion) {
+ if (!smartRegionEnabled && regionError && fixedDefaultRegion) {
resetField('dbRegion', { defaultValue: fixedDefaultRegion })
}
- }, [regionError, resetField, fixedDefaultRegion])
+ }, [smartRegionEnabled, regionError, resetField, fixedDefaultRegion])
useEffect(() => {
if (watchedInstanceSize !== instanceSize) {
@@ -768,7 +783,7 @@ export const ProjectCreationForm = ({
footer={
<ProjectCreationFooter
form={form}
- canCreateProject={canCreateProject}
+ canCreateProject={canSubmitProject}
instanceSize={instanceSize}
highAvailability={highAvailability}
organizationProjects={organizationProjects}
diff --git a/apps/studio/components/interfaces/ProjectCreation/RegionSelector.tsx b/apps/studio/components/interfaces/ProjectCreation/RegionSelector.tsx
index 814b7e17854..30d3b7e58ab 100644
--- a/apps/studio/components/interfaces/ProjectCreation/RegionSelector.tsx
+++ b/apps/studio/components/interfaces/ProjectCreation/RegionSelector.tsx
@@ -293,7 +293,7 @@ export const RegionSelector = ({
: 'Select a region for your project..'
}
>
- {dbRegion !== undefined && (
+ {!!dbRegion && (
<div className="flex items-center gap-x-3">
{isLoading && <Loader2 size={14} className="animate-spin" />}
{selectedRegion?.code && (
diff --git a/apps/studio/tests/pages/new/[slug].test.tsx b/apps/studio/tests/pages/new/[slug].test.tsx
index 5baed270659..c59ac90e686 100644
--- a/apps/studio/tests/pages/new/[slug].test.tsx
+++ b/apps/studio/tests/pages/new/[slug].test.tsx
@@ -1,5 +1,5 @@
import { PermissionAction } from '@supabase/shared-types/out/constants'
-import { configure, fireEvent, screen, waitFor, within } from '@testing-library/react'
+import { act, configure, fireEvent, screen, waitFor, within } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { platformComponents as components } from 'api-types'
import { FeatureFlagContext } from 'common'
@@ -359,7 +359,6 @@ const submitAndReadRegionSelection = async (onRequest: ReturnType<typeof vi.fn>)
return onRequest.mock.calls[0][0].region_selection
}
-// Region is selected explicitly because the smart-region auto-fill is unreliable (FE-3884).
const selectRegion = async (optionName: string | RegExp) => {
await user.click(getSelectTriggerByLabel('Region'))
await user.click(await screen.findByRole('option', { name: optionName }))
@@ -482,6 +481,51 @@ describe('project creation wizard', () => {
})
describe('region selection', () => {
+ test('blocks submission until a region is selected', async () => {
+ mockWizardEndpoints({
+ availableRegions: {
+ ...DEFAULT_AVAILABLE_REGIONS,
+ recommendations: {
+ ...DEFAULT_AVAILABLE_REGIONS.recommendations,
+ smartGroup: { code: 'americas', name: '', type: 'smartGroup' },
+ },
+ },
+ })
+ const onRequest = vi.fn()
+ mockCreateProject(onRequest)
+
+ await renderWizard()
+
+ await fillProjectName('Region Required Project')
+ await generateAndWaitForStrongPassword()
+ expect(getSelectTriggerByLabel('Region')).toHaveTextContent('Select a region')
+
+ fireEvent.click(screen.getByRole('button', { name: 'Create new project' }))
+
+ expect(await screen.findByText('Please select a region.')).toBeInTheDocument()
+ expect(onRequest).not.toHaveBeenCalled()
+
+ await selectRegion(/Americas/)
+
+ const regionSelection = await submitAndReadRegionSelection(onRequest)
+ expect(regionSelection).toMatchObject({ name: 'Americas' })
+ })
+
+ test('submits the recommended region without manual selection', async () => {
+ mockWizardEndpoints()
+ const onRequest = vi.fn()
+ mockCreateProject(onRequest)
+
+ await renderWizard()
+
+ await fillProjectName('Recommended Region Project')
+ await generateAndWaitForStrongPassword()
+ expect(getSelectTriggerByLabel('Region')).toHaveTextContent('Americas')
+
+ const regionSelection = await submitAndReadRegionSelection(onRequest)
+ expect(regionSelection).toMatchObject({ name: 'Americas' })
+ })
+
test('surfaces the recommended smart region with a "Recommended" badge', async () => {
mockWizardEndpoints()
@@ -568,12 +612,55 @@ describe('project creation wizard', () => {
})
})
- test('shows an error state when available regions fail to load', async () => {
+ test('blocks submission when available regions fail to load', async () => {
mockWizardEndpoints({ availableRegions: 'error' })
+ const onRequest = vi.fn()
+ mockCreateProject(onRequest)
await renderWizard()
await screen.findByText('Error loading available regions')
+ await fillProjectName('Unavailable Regions Project')
+ await generateAndWaitForStrongPassword()
+
+ const submitButton = screen.getByRole('button', { name: 'Create new project' })
+ expect(submitButton).toBeDisabled()
+ const form = submitButton.closest('form')
+ if (!form) throw new Error('Project creation form not found')
+ await act(async () => {
+ fireEvent.submit(form)
+ })
+ expect(onRequest).not.toHaveBeenCalled()
+ })
+
+ test('blocks a previously selected region when regions fail to load for the new compute size', async () => {
+ mockWizardEndpoints()
+ const onRequest = vi.fn()
+ mockCreateProject(onRequest)
+
+ await renderWizard()
+
+ await fillProjectName('Changed Compute Project')
+ await generateAndWaitForStrongPassword()
+ await selectRegion(/Americas/)
+
+ addAPIMock({
+ method: 'get',
+ path: '/platform/projects/available-regions',
+ response: () => HttpResponse.error(),
+ })
+ await user.click(getSelectTriggerByLabel('Compute size'))
+ await user.click(await screen.findByRole('option', { name: /2 GB RAM/ }))
+ await screen.findByText('Error loading available regions')
+
+ const submitButton = screen.getByRole('button', { name: 'Create new project' })
+ expect(submitButton).toBeDisabled()
+ const form = submitButton.closest('form')
+ if (!form) throw new Error('Project creation form not found')
+ await act(async () => {
+ fireEvent.submit(form)
+ })
+ expect(onRequest).not.toHaveBeenCalled()
})
describe('free tier general region experiment', () => {