Skip to content

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

fix(studio): add return to Vercel escape hatch (#48311)

Danny Whitec9ed51c99ea0
diff --git a/apps/studio/components/interfaces/Integrations/Vercel/VercelIntegration.utils.test.ts b/apps/studio/components/interfaces/Integrations/Vercel/VercelIntegration.utils.test.ts
new file mode 100644
index 00000000000..00cd23ecbf7
--- /dev/null
+++ b/apps/studio/components/interfaces/Integrations/Vercel/VercelIntegration.utils.test.ts
@@ -0,0 +1,32 @@
+import { describe, expect, test } from 'vitest'
+
+import {
+ getValidVercelReturnUrl,
+ isVercelUrl,
+} from '@/components/interfaces/Integrations/Vercel/VercelIntegration.utils'
+
+describe('isVercelUrl', () => {
+ test('accepts https vercel.com urls', () => {
+ expect(isVercelUrl('https://vercel.com/callback')).toBe(true)
+ })
+
+ test('rejects non-vercel and invalid urls', () => {
+ expect(isVercelUrl('https://example.com')).toBe(false)
+ expect(isVercelUrl('http://vercel.com')).toBe(false)
+ expect(isVercelUrl('not-a-url')).toBe(false)
+ })
+})
+
+describe('getValidVercelReturnUrl', () => {
+ test('returns the url when it is a valid vercel return url', () => {
+ expect(getValidVercelReturnUrl('https://vercel.com/callback')).toBe(
+ 'https://vercel.com/callback'
+ )
+ })
+
+ test('returns undefined for missing or invalid next values', () => {
+ expect(getValidVercelReturnUrl(undefined)).toBeUndefined()
+ expect(getValidVercelReturnUrl('https://example.com')).toBeUndefined()
+ expect(getValidVercelReturnUrl('not-a-url')).toBeUndefined()
+ })
+})
diff --git a/apps/studio/components/interfaces/Integrations/Vercel/VercelIntegration.utils.ts b/apps/studio/components/interfaces/Integrations/Vercel/VercelIntegration.utils.ts
index a6802341ab7..05db949804d 100644
--- a/apps/studio/components/interfaces/Integrations/Vercel/VercelIntegration.utils.ts
+++ b/apps/studio/components/interfaces/Integrations/Vercel/VercelIntegration.utils.ts
@@ -10,6 +10,12 @@ export function isVercelUrl(url: string): boolean {
}
}
+/** Returns `next` when it is a safe Vercel return URL; otherwise undefined. */
+export function getValidVercelReturnUrl(next: string | undefined): string | undefined {
+ if (typeof next === 'string' && isVercelUrl(next)) return next
+ return undefined
+}
+
export function findVercelIntegrationByConfigurationId(
integrations: Integration[] | undefined,
configurationId: string | undefined
diff --git a/apps/studio/components/interfaces/ProjectCreation/FreeProjectLimitWarning.tsx b/apps/studio/components/interfaces/ProjectCreation/FreeProjectLimitWarning.tsx
index e3b8389232c..ba554365f5a 100644
--- a/apps/studio/components/interfaces/ProjectCreation/FreeProjectLimitWarning.tsx
+++ b/apps/studio/components/interfaces/ProjectCreation/FreeProjectLimitWarning.tsx
@@ -6,9 +6,13 @@ import type { MemberWithFreeProjectLimit } from '@/data/organizations/free-proje
interface FreeProjectLimitWarningProps {
membersExceededLimit: MemberWithFreeProjectLimit[]
+ showVercelReturnHint?: boolean
}
-export const FreeProjectLimitWarning = ({ membersExceededLimit }: FreeProjectLimitWarningProps) => {
+export const FreeProjectLimitWarning = ({
+ membersExceededLimit,
+ showVercelReturnHint = false,
+}: FreeProjectLimitWarningProps) => {
return (
<Panel.Content>
<Admonition
@@ -32,6 +36,11 @@ export const FreeProjectLimitWarning = ({ membersExceededLimit }: FreeProjectLim
These members will need to either delete, pause, or upgrade one or more of these
projects before you're able to create a free project within this organization.
</p>
+ {showVercelReturnHint && (
+ <p className="text-sm leading-normal">
+ Or return to Vercel and restart with a different organization.
+ </p>
+ )}
<UpgradePlanButton
source="freeProjectLimitWarning"
diff --git a/apps/studio/components/interfaces/ProjectCreation/ProjectCreationFooter.tsx b/apps/studio/components/interfaces/ProjectCreation/ProjectCreationFooter.tsx
index e01c2be3dd6..6c6706789dd 100644
--- a/apps/studio/components/interfaces/ProjectCreation/ProjectCreationFooter.tsx
+++ b/apps/studio/components/interfaces/ProjectCreation/ProjectCreationFooter.tsx
@@ -1,4 +1,4 @@
-import { useFlag } from 'common'
+import { useFlag, useParams } from 'common'
import { useRouter } from 'next/router'
import { UseFormReturn } from 'react-hook-form'
import {
@@ -16,12 +16,15 @@ import { InfoTooltip } from 'ui-patterns/info-tooltip'
import { CreateProjectForm } from './ProjectCreation.schema'
import { instanceLabel, monthlyInstancePrice } from './ProjectCreation.utils'
+import { getValidVercelReturnUrl } from '@/components/interfaces/Integrations/Vercel/VercelIntegration.utils'
import { InlineLink } from '@/components/ui/InlineLink'
import { OrgProject } from '@/data/projects/org-projects-infinite-query'
import { useLastVisitedOrganization } from '@/hooks/misc/useLastVisitedOrganization'
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
import { DOCS_URL } from '@/lib/constants'
+export type ProjectCreationCancelAction = 'studio' | 'vercel' | 'hidden'
+
interface ProjectCreationFooterProps {
form: UseFormReturn<CreateProjectForm>
canCreateProject: boolean
@@ -29,7 +32,7 @@ interface ProjectCreationFooterProps {
organizationProjects: OrgProject[]
isCreatingNewProject: boolean
isSuccessNewProject: boolean
- hideCancelButton: boolean
+ cancelAction?: ProjectCreationCancelAction
}
export const ProjectCreationFooter = ({
@@ -39,9 +42,10 @@ export const ProjectCreationFooter = ({
organizationProjects,
isCreatingNewProject,
isSuccessNewProject,
- hideCancelButton,
+ cancelAction = 'studio',
}: ProjectCreationFooterProps) => {
const router = useRouter()
+ const { next } = useParams()
const { data: currentOrg } = useSelectedOrganizationQuery()
const isFreePlan = currentOrg?.plan?.id === 'free'
const { lastVisitedOrganization } = useLastVisitedOrganization()
@@ -53,6 +57,9 @@ export const ProjectCreationFooter = ({
? 0
: monthlyInstancePrice(instanceSize) - availableComputeCredits
+ const vercelReturnUrl = getValidVercelReturnUrl(next)
+ const canReturnToVercel = cancelAction === 'vercel' && vercelReturnUrl !== undefined
+
// [kevin] This will eventually all be provided by a new API endpoint to preview and validate project creation, this is just for kaizen now
const monthlyComputeCosts =
// current project costs
@@ -66,6 +73,17 @@ export const ProjectCreationFooter = ({
// compute credits
10
+ const onCancel = () => {
+ if (canReturnToVercel && vercelReturnUrl) {
+ window.location.href = vercelReturnUrl
+ return
+ }
+
+ // Fall back to Studio when cancelAction is studio, or when vercel next is missing/invalid
+ if (!!lastVisitedOrganization) router.push(`/org/${lastVisitedOrganization}`)
+ else router.push('/organizations')
+ }
+
return (
<div key="panel-footer" className="grid grid-cols-12 w-full gap-4 items-center">
<div className="col-span-4">
@@ -169,16 +187,13 @@ export const ProjectCreationFooter = ({
</div>
<div className="flex items-end col-span-8 space-x-2 ml-auto">
- {!hideCancelButton && (
+ {cancelAction !== 'hidden' && (
<Button
variant="default"
disabled={isCreatingNewProject || isSuccessNewProject}
- onClick={() => {
- if (!!lastVisitedOrganization) router.push(`/org/${lastVisitedOrganization}`)
- else router.push('/organizations')
- }}
+ onClick={onCancel}
>
- Cancel
+ {canReturnToVercel ? 'Return to Vercel' : 'Cancel'}
</Button>
)}
<Button
diff --git a/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx b/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx
index 49e4ab3ecc3..8980495210c 100644
--- a/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx
+++ b/apps/studio/components/interfaces/ProjectCreation/ProjectCreationForm.tsx
@@ -35,6 +35,7 @@ import { ProjectNameInput } from './ProjectNameInput'
import { RegionSelector } from './RegionSelector'
import { SecurityOptions } from './SecurityOptions'
import { AUTO_ENABLE_RLS_EVENT_TRIGGER_SQL } from '@/components/interfaces/Database/Triggers/EventTriggersList/EventTriggers.constants'
+import { getValidVercelReturnUrl } from '@/components/interfaces/Integrations/Vercel/VercelIntegration.utils'
import {
GitHubRepositoryField,
useGitHubRepositoryOptions,
@@ -90,7 +91,7 @@ interface ProjectCreationFormProps {
* - "Internal configuration" section
* - "GitHub repository" field
* - "Free project info" at the bottom
- * - "Cancel" button
+ * - Shows Cancel as "Return to Vercel" (via `next`) instead of navigating into Studio
* - Shows the following:
* - "Data seeding" section
* - When embedded in the Vercel interstitial, flattens Panel chrome so the shared
@@ -105,7 +106,8 @@ export const ProjectCreationForm = ({
const track = useTrack()
const router = useRouter()
const { profile } = useProfile()
- const { slug, projectName, externalId } = useParams()
+ const { slug, projectName, externalId, next } = useParams()
+ const canReturnToVercel = getValidVercelReturnUrl(next) !== undefined
const trackFunnelError = useTrackFunnelError()
const defaultProvider = useDefaultProvider()
@@ -607,7 +609,7 @@ export const ProjectCreationForm = ({
organizationProjects={organizationProjects}
isCreatingNewProject={isCreatingNewProject}
isSuccessNewProject={isSuccessNewProject}
- hideCancelButton={isVercelIntegrationFlow}
+ cancelAction={isVercelIntegrationFlow ? 'vercel' : 'studio'}
/>
}
>
@@ -700,7 +702,10 @@ export const ProjectCreationForm = ({
{freePlanWithExceedingLimits ? (
isAdmin &&
slug && (
- <FreeProjectLimitWarning membersExceededLimit={membersExceededLimit || []} />
+ <FreeProjectLimitWarning
+ membersExceededLimit={membersExceededLimit || []}
+ showVercelReturnHint={isVercelIntegrationFlow && canReturnToVercel}
+ />
)
) : hasOutstandingInvoices ? (
<Panel.Content>
diff --git a/apps/studio/pages/integrations/vercel/install.tsx b/apps/studio/pages/integrations/vercel/install.tsx
index abc1c711021..7eea86d25b1 100644
--- a/apps/studio/pages/integrations/vercel/install.tsx
+++ b/apps/studio/pages/integrations/vercel/install.tsx
@@ -250,7 +250,7 @@ const VercelIntegration: NextPageWithLayout = () => {
<InterstitialLayout
logo={<VercelIntegrationLogo />}
- title="Install Vercel Integration"
+ title="Install Vercel integration"
description="Choose the Supabase organization Vercel can connect to"
footer={<VercelIntegrationFooter />}
>