Skip to content

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

fix: Filter the version selector in the new project form by the chosen project type (#51490)

Ivan Vasilovec2657e4f7b7
diff --git a/apps/studio/components/interfaces/Project/ResumeProjectButton.tsx b/apps/studio/components/interfaces/Project/ResumeProjectButton.tsx
index 281f70a41cc..9dd094eff49 100644
--- a/apps/studio/components/interfaces/Project/ResumeProjectButton.tsx
+++ b/apps/studio/components/interfaces/Project/ResumeProjectButton.tsx
@@ -22,10 +22,8 @@ import {
import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
import { z } from 'zod'
-import {
- extractPostgresVersionDetails,
- PostgresVersionSelector,
-} from '@/components/interfaces/ProjectCreation/PostgresVersionSelector'
+import { PostgresVersionSelector } from '@/components/interfaces/ProjectCreation/PostgresVersionSelector'
+import { extractPostgresVersionDetails } from '@/components/interfaces/ProjectCreation/ProjectCreation.utils'
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
import { useFreeProjectLimitCheckQuery } from '@/data/organizations/free-project-limit-check-query'
import { useSetProjectStatus } from '@/data/projects/project-detail-query'
diff --git a/apps/studio/components/interfaces/ProjectCreation/InternalOnlyConfiguration.tsx b/apps/studio/components/interfaces/ProjectCreation/InternalOnlyConfiguration.tsx
index 67d7f3a2bf1..afb64bebcf1 100644
--- a/apps/studio/components/interfaces/ProjectCreation/InternalOnlyConfiguration.tsx
+++ b/apps/studio/components/interfaces/ProjectCreation/InternalOnlyConfiguration.tsx
@@ -30,6 +30,7 @@ export const InternalOnlyConfiguration = ({ form }: InternalOnlyConfigurationPro
const highAvailability = useWatch({ control: form.control, name: 'highAvailability' })
const cloudProvider = useWatch({ control: form.control, name: 'cloudProvider' })
const kubernetesClusterId = useWatch({ control: form.control, name: 'kubernetesClusterId' })
+ const useOrioleDbForCreate = useWatch({ control: form.control, name: 'useOrioleDb' })
const isK8sProvider = cloudProvider === 'AWS_K8S' || cloudProvider === 'AWS_NIMBUS'
// Held here (outside the collapsible content) so the selector's last valid
// selection survives the section being collapsed and reopened.
@@ -56,6 +57,12 @@ export const InternalOnlyConfiguration = ({ form }: InternalOnlyConfigurationPro
disabled={highAvailability}
highAvailability={highAvailability}
lastValidSelectionRef={lastValidPostgresVersionSelection}
+ useOrioleDbForCreate={useOrioleDbForCreate}
+ description={
+ useOrioleDbForCreate
+ ? undefined
+ : 'Choose OrioleDB in the advanced configuration if you want to use it'
+ }
/>
)}
/>
diff --git a/apps/studio/components/interfaces/ProjectCreation/PostgresVersionSelector.tsx b/apps/studio/components/interfaces/ProjectCreation/PostgresVersionSelector.tsx
index 583e488008c..072605a1c6a 100644
--- a/apps/studio/components/interfaces/ProjectCreation/PostgresVersionSelector.tsx
+++ b/apps/studio/components/interfaces/ProjectCreation/PostgresVersionSelector.tsx
@@ -15,14 +15,8 @@ import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import { smartRegionToExactRegion } from './ProjectCreation.utils'
import { useProjectCreationPostgresVersionsQuery } from '@/data/config/project-creation-postgres-versions-query'
import { useProjectUnpausePostgresVersionsQuery } from '@/data/config/project-unpause-postgres-versions-query'
-import { PostgresEngine, ReleaseChannel } from '@/data/projects/new-project.constants'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
-interface PostgresVersionDetails {
- postgresEngine?: Exclude<PostgresEngine, '13' | '14'>
- releaseChannel?: ReleaseChannel
-}
-
interface PostgresVersionSelectorProps {
cloudProvider: CloudProvider
dbRegion: string
@@ -37,9 +31,16 @@ interface PostgresVersionSelectorProps {
* closes. Create it with useRef('') alongside the form.
*/
lastValidSelectionRef: { current: string }
+ /**
+ * Used when creating a project. If true, it will filter all versions to only OrioleDB versions (or exclude them if false).
+ *
+ * Defaults to undefined, which is not filtering.
+ */
+ useOrioleDbForCreate?: boolean
type?: 'create' | 'unpause'
layout?: 'vertical' | 'horizontal'
label?: string
+ description?: string
}
const formatValue = ({
@@ -52,15 +53,6 @@ const formatValue = ({
return `${postgres_engine}|${release_channel}`
}
-export const extractPostgresVersionDetails = (value: string): PostgresVersionDetails => {
- if (!value) {
- return { postgresEngine: undefined, releaseChannel: undefined }
- }
-
- const [postgresEngine, releaseChannel] = value.split('|')
- return { postgresEngine, releaseChannel } as PostgresVersionDetails
-}
-
export const PostgresVersionSelector = ({
cloudProvider,
dbRegion,
@@ -71,8 +63,10 @@ export const PostgresVersionSelector = ({
form,
lastValidSelectionRef,
type = 'create',
+ useOrioleDbForCreate = undefined,
layout = 'horizontal',
label = 'Postgres version',
+ description,
}: PostgresVersionSelectorProps) => {
const { data: project } = useSelectedProjectQuery()
@@ -89,7 +83,19 @@ export const PostgresVersionSelector = ({
organizationSlug,
highAvailability,
},
- { enabled: type === 'create' }
+ {
+ enabled: type === 'create',
+ select: (data) => {
+ if (useOrioleDbForCreate === undefined) return data
+ return {
+ available_versions: data?.available_versions.filter((version) =>
+ useOrioleDbForCreate
+ ? version.postgres_engine.endsWith('oriole')
+ : !version.postgres_engine.endsWith('oriole')
+ ),
+ }
+ },
+ }
)
const { data: unpauseVersions, isPending: isLoadingProjectUnpauseVersions } =
@@ -136,7 +142,7 @@ export const PostgresVersionSelector = ({
}, [isSuccess, availableVersions, postgresVersionSelection, lastValidSelectionRef, form])
return (
- <FormItemLayout id={field.name} label={label} layout={layout}>
+ <FormItemLayout id={field.name} label={label} layout={layout} description={description}>
<Select
value={postgresVersionSelection}
onValueChange={field.onChange}
diff --git a/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.utils.test.ts b/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.utils.test.ts
index e2b9efb621b..fc95460cda0 100644
--- a/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.utils.test.ts
+++ b/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.utils.test.ts
@@ -8,6 +8,7 @@ import {
} from './ProjectCreation.constants'
import type { AvailableRegions } from './ProjectCreation.utils'
import {
+ extractPostgresVersionDetails,
filterHighAvailabilityRegions,
getAvailableRegions,
getFreeTierGeneralRegionExperimentVariant,
@@ -15,7 +16,9 @@ import {
getRegionSelectionType,
getSpecificRegionsLinkVariant,
resolveDefaultDbRegion,
+ resolvePostgresVersion,
} from './ProjectCreation.utils'
+import type { PostgresEngine, ReleaseChannel } from '@/data/projects/new-project.constants'
describe('resolveDefaultDbRegion', () => {
const base = {
@@ -255,3 +258,76 @@ describe('getSpecificRegionsLinkVariant', () => {
expect(getSpecificRegionsLinkVariant({ ...base, smartRegionEnabled: false })).toBeUndefined()
})
})
+
+describe('extractPostgresVersionDetails', () => {
+ it('splits engine and release channel', () => {
+ expect(extractPostgresVersionDetails('17|ga')).toEqual({
+ postgresEngine: '17',
+ releaseChannel: 'ga',
+ })
+ })
+
+ it('returns undefined fields for an empty value', () => {
+ expect(extractPostgresVersionDetails('')).toEqual({
+ postgresEngine: undefined,
+ releaseChannel: undefined,
+ })
+ })
+})
+
+describe('resolvePostgresVersion', () => {
+ const availableOrioleVersion: {
+ postgres_engine: PostgresEngine
+ release_channel: ReleaseChannel
+ } = { postgres_engine: '17-oriole', release_channel: 'preview' }
+
+ it('uses the selection for OrioleDB when it is an OrioleDB version', () => {
+ expect(
+ resolvePostgresVersion({
+ postgresVersionSelection: '17-oriole|ga',
+ useOrioleDb: true,
+ availableOrioleVersion,
+ })
+ ).toEqual({ postgresEngine: '17-oriole', releaseChannel: 'ga' })
+ })
+
+ it('falls back to the available OrioleDB image when there is no selection', () => {
+ expect(
+ resolvePostgresVersion({
+ postgresVersionSelection: '',
+ useOrioleDb: true,
+ availableOrioleVersion,
+ })
+ ).toEqual({ postgresEngine: '17-oriole', releaseChannel: 'preview' })
+ })
+
+ it('falls back to the available OrioleDB image when the selection is a stale Postgres version', () => {
+ expect(
+ resolvePostgresVersion({
+ postgresVersionSelection: '17|ga',
+ useOrioleDb: true,
+ availableOrioleVersion,
+ })
+ ).toEqual({ postgresEngine: '17-oriole', releaseChannel: 'preview' })
+ })
+
+ it('uses the selection for Postgres', () => {
+ expect(
+ resolvePostgresVersion({
+ postgresVersionSelection: '17|ga',
+ useOrioleDb: false,
+ availableOrioleVersion,
+ })
+ ).toEqual({ postgresEngine: '17', releaseChannel: 'ga' })
+ })
+
+ it('ignores a stale OrioleDB selection when OrioleDB is off', () => {
+ expect(
+ resolvePostgresVersion({
+ postgresVersionSelection: '17-oriole|ga',
+ useOrioleDb: false,
+ availableOrioleVersion,
+ })
+ ).toEqual({})
+ })
+})
diff --git a/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.utils.ts b/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.utils.ts
index 17ec27470b8..0973f51eebf 100644
--- a/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.utils.ts
+++ b/apps/studio/components/interfaces/ProjectCreation/ProjectCreation.utils.ts
@@ -3,7 +3,12 @@ import { AWS_REGIONS } from 'shared-data'
import { SMART_REGION_TO_EXACT_REGION_MAP } from 'shared-data/regions'
import type { OrganizationAvailableRegionsData } from '@/data/organizations/organization-available-regions-query'
-import { DesiredInstanceSize, instanceSizeSpecs } from '@/data/projects/new-project.constants'
+import {
+ DesiredInstanceSize,
+ instanceSizeSpecs,
+ PostgresEngine,
+ ReleaseChannel,
+} from '@/data/projects/new-project.constants'
export function smartRegionToExactRegion(smartOrExactRegion: string) {
return SMART_REGION_TO_EXACT_REGION_MAP.get(smartOrExactRegion) ?? smartOrExactRegion
@@ -184,3 +189,49 @@ export function getSpecificRegionsLinkVariant({
if (!isFreePlan || !smartRegionEnabled) return undefined
return linkFlag === true ? 'test' : 'control'
}
+
+export interface PostgresVersionDetails {
+ postgresEngine?: Exclude<PostgresEngine, '13' | '14'>
+ releaseChannel?: ReleaseChannel
+}
+
+export const extractPostgresVersionDetails = (value: string): PostgresVersionDetails => {
+ if (!value) {
+ return { postgresEngine: undefined, releaseChannel: undefined }
+ }
+
+ const [postgresEngine, releaseChannel] = value.split('|')
+ return { postgresEngine, releaseChannel } as PostgresVersionDetails
+}
+
+/**
+ * Picks the engine + release channel to submit on project creation. The selector's value is used
+ * only when it matches the selected Postgres Type in Advanced Config. Otherwise, OrioleDB falls
+ * back to the available OrioleDB image, and Postgres falls back to the API default
+ */
+export function resolvePostgresVersion({
+ postgresVersionSelection,
+ useOrioleDb,
+ availableOrioleVersion,
+}: {
+ postgresVersionSelection: string
+ useOrioleDb: boolean
+ availableOrioleVersion?: {
+ postgres_engine: Exclude<PostgresEngine, '13' | '14'>
+ release_channel: ReleaseChannel
+ }
+}): PostgresVersionDetails {
+ const selection = extractPostgresVersionDetails(postgresVersionSelection)
+ const isSelectionOriole = !!selection.postgresEngine?.endsWith('oriole')
+
+ if (useOrioleDb) {
+ if (isSelectionOriole) return selection
+ return {
+ postgresEngine: availableOrioleVersion?.postgres_engine,
+ releaseChannel: availableOrioleVersion?.release_channel,
+ }
+ }
+
+ if (isSelectionOriole) return {}
+ return selection
+}
diff --git a/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx b/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx
index 226544b4575..1d520951c9f 100644
--- a/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx
+++ b/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx
@@ -22,7 +22,6 @@ import { FreeProjectLimitWarning } from './FreeProjectLimitWarning'
import { HighAvailabilityInput } from './HighAvailabilityInput'
import { InternalOnlyConfiguration } from './InternalOnlyConfiguration'
import { OrganizationSelector } from './OrganizationSelector'
-import { extractPostgresVersionDetails } from './PostgresVersionSelector'
import {
HIGH_AVAILABILITY_POSTGRES_ENGINE,
HIGH_AVAILABILITY_RELEASE_CHANNEL,
@@ -38,6 +37,7 @@ import {
instanceLabel,
monthlyInstancePrice,
resolveDefaultDbRegion,
+ resolvePostgresVersion,
smartRegionToExactRegion,
} from './ProjectCreation.utils'
import { ProjectCreationFooter } from './ProjectCreationFooter'
@@ -509,8 +509,11 @@ export const ProjectCreationForm = ({
return
}
- const { postgresEngine, releaseChannel } =
- extractPostgresVersionDetails(postgresVersionSelection)
+ const { postgresEngine, releaseChannel } = resolvePostgresVersion({
+ postgresVersionSelection,
+ useOrioleDb,
+ availableOrioleVersion,
+ })
const { smartGroup = [], specific = [] } = availableRegionsData?.all ?? {}
const selectedRegion = smartRegionEnabled
@@ -589,16 +592,8 @@ export const ProjectCreationForm = ({
dataApiExposedSchemas: !dataApi ? [] : undefined,
dataApiUseApiSchema: false,
dataApiRevokeDefaultPrivileges: dataApi && !dataApiDefaultPrivileges,
- postgresEngine: highAvailability
- ? HIGH_AVAILABILITY_POSTGRES_ENGINE
- : useOrioleDb
- ? availableOrioleVersion?.postgres_engine
- : postgresEngine,
- releaseChannel: highAvailability
- ? HIGH_AVAILABILITY_RELEASE_CHANNEL
- : useOrioleDb
- ? availableOrioleVersion?.release_channel
- : releaseChannel,
+ postgresEngine: highAvailability ? HIGH_AVAILABILITY_POSTGRES_ENGINE : postgresEngine,
+ releaseChannel: highAvailability ? HIGH_AVAILABILITY_RELEASE_CHANNEL : releaseChannel,
...(smartRegionEnabled ? { regionSelection: selectedRegion } : { dbRegion }),
...(shouldIncludeGitHubFields
? {
@@ -852,12 +847,12 @@ export const ProjectCreationForm = ({
<SecurityOptions form={form} surface={surface} />
- {showInternalOnlyConfiguration && <InternalOnlyConfiguration form={form} />}
-
{showAdvancedConfig &&
!!availableOrioleVersion &&
highAvailability !== true && <AdvancedConfiguration form={form} />}
+ {showInternalOnlyConfiguration && <InternalOnlyConfiguration form={form} />}
+
{shouldShowFreeProjectInfo ? (
<Admonition
className="rounded-none border-0"
diff --git a/apps/studio/components/interfaces/Settings/General/Infrastructure/ProjectUpgradeAlert.tsx b/apps/studio/components/interfaces/Settings/General/Infrastructure/ProjectUpgradeAlert.tsx
index dbf350220dc..b8c550ff733 100644
--- a/apps/studio/components/interfaces/Settings/General/Infrastructure/ProjectUpgradeAlert.tsx
+++ b/apps/studio/components/interfaces/Settings/General/Infrastructure/ProjectUpgradeAlert.tsx
@@ -36,7 +36,7 @@ import { z } from 'zod'
import { PLAN_DETAILS } from '@/components/interfaces/DiskManagement/ui/DiskManagement.constants'
import { Markdown } from '@/components/interfaces/Markdown'
-import { extractPostgresVersionDetails } from '@/components/interfaces/ProjectCreation/PostgresVersionSelector'
+import { extractPostgresVersionDetails } from '@/components/interfaces/ProjectCreation/ProjectCreation.utils'
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
import { useDiskAttributesQuery } from '@/data/config/disk-attributes-query'
import {
diff --git a/apps/studio/tests/pages/new/[slug].test.tsx b/apps/studio/tests/pages/new/[slug].test.tsx
index 65c5dc9eb7b..5baed270659 100644
--- a/apps/studio/tests/pages/new/[slug].test.tsx
+++ b/apps/studio/tests/pages/new/[slug].test.tsx
@@ -130,6 +130,7 @@ const AVAILABLE_REGIONS_WITH_FRANKFURT: RegionsInfo = {
const DEFAULT_AVAILABLE_VERSIONS: { available_versions: AvailableVersion[] } = {
available_versions: [
{ postgres_engine: '15', release_channel: 'ga', version: 'supabase-postgres-15.6.1.139' },
+ { postgres_engine: '17', release_channel: 'beta', version: 'supabase-postgres-17.9.9.999' },
{
postgres_engine: '17-oriole',
release_channel: 'beta',