Skip to content

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

feat(studio): create pipelines from wizard review (#51900)

Danny Whitee7b1f6895622
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCostEstimate.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCostEstimate.tsx
index d77ea52701a..5bb087fc883 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCostEstimate.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCostEstimate.tsx
@@ -54,7 +54,7 @@ export const PipelineCostEstimate = ({
const copyTableCount = copyTargets.length
return (
- <CardContent className="space-y-6">
+ <CardContent className="space-y-6 border-b-0">
<header className="space-y-1">
<h3 className="text-sm text-foreground">Estimated costs</h3>
<p className="text-sm text-foreground-light">
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.test.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.test.tsx
index 2b89453fc8c..c58a7e8a1e7 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.test.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.test.tsx
@@ -5,8 +5,9 @@ import { delay, HttpResponse } from 'msw'
import { NuqsAdapter } from 'nuqs/adapters/react'
import { beforeEach, describe, expect, it, vi } from 'vitest'
-import { PipelineCreationFlow } from './PipelineCreationFlow'
+import { PipelineCreationFlow as CreationFlow } from './PipelineCreationFlow'
import type { ReplicationCostEstimateData } from '@/data/replication/cost-estimate-query'
+import { PipelineRequestStatusProvider } from '@/state/replication-pipeline-request-status'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
@@ -27,6 +28,12 @@ vi.mock('@/components/layouts/AppLayout/ProjectDropdown', () => ({
ProjectDropdown: () => <span>Project</span>,
}))
+const PipelineCreationFlow = (props: Parameters<typeof CreationFlow>[0]) => (
+ <PipelineRequestStatusProvider>
+ <CreationFlow {...props} />
+ </PipelineRequestStatusProvider>
+)
+
mockAnimationsApi()
beforeEach(() => {
addAPIMock({
@@ -128,6 +135,250 @@ const selectPublication = async () => {
const back = () => fireEvent.click(within(stepCard()).getByRole('button', { name: 'Back' }))
describe('PipelineCreationFlow', () => {
+ const reachReview = async (onClose = vi.fn()) => {
+ customRender(<PipelineCreationFlow availableDestinations={['BigQuery']} onClose={onClose} />, {
+ nuqs: { hasMemory: true },
+ })
+ next()
+ fillConnection()
+ await continueToData()
+ await selectPublication()
+ next()
+ await screen.findByText(/Step 4 of 4/)
+ }
+
+ const mockCreation = ({ failCreate = false, failStart = false } = {}) => {
+ const requests: unknown[] = []
+ const starts = vi.fn()
+ const destinationRequests: unknown[] = []
+ const pipelineRequests: unknown[] = []
+ addAPIMock({
+ method: 'post',
+ path: '/platform/replication/:ref/destinations/validate',
+ response: async ({ request }) => {
+ destinationRequests.push(await request.json())
+ return HttpResponse.json<components['schemas']['ValidateDestinationResponse_Output']>({
+ validation_failures: [],
+ })
+ },
+ })
+ addAPIMock({
+ method: 'post',
+ path: '/platform/replication/:ref/pipelines/validate',
+ response: async ({ request }) => {
+ pipelineRequests.push(await request.json())
+ return HttpResponse.json<components['schemas']['ValidatePipelineResponse_Output']>({
+ validation_failures: [],
+ })
+ },
+ })
+ addAPIMock({
+ method: 'post',
+ path: '/platform/replication/:ref/destinations-pipelines',
+ response: async ({ request }) => {
+ requests.push(await request.json())
+ return failCreate && requests.length === 1
+ ? HttpResponse.json<{ message: string }>(
+ { message: 'Create unavailable' },
+ { status: 503 }
+ )
+ : HttpResponse.json<components['schemas']['CreateDestinationPipelineResponse_Output']>({
+ destination_id: 7,
+ pipeline_id: 8,
+ })
+ },
+ })
+ addAPIMock({
+ method: 'post',
+ path: '/platform/replication/:ref/pipelines/:pipeline_id/start',
+ response: () => {
+ starts()
+ return failStart
+ ? HttpResponse.json<{ message: string }>(
+ { message: 'Start unavailable' },
+ { status: 503 }
+ )
+ : HttpResponse.json<Record<string, never>>({})
+ },
+ })
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/pipelines/:pipeline_id/status',
+ response: () =>
+ HttpResponse.json<components['schemas']['PipelineStatusResponse_Output']>({
+ pipeline_id: 8,
+ status: { name: 'stopped' },
+ }),
+ })
+ return { requests, starts, destinationRequests, pipelineRequests }
+ }
+
+ it.each([false, true])(
+ 'leaves after one committed creation, including start failure: %s',
+ async (failStart) => {
+ const { requests, starts, destinationRequests, pipelineRequests } = mockCreation({
+ failStart,
+ })
+ const onClose = vi.fn()
+ await reachReview(onClose)
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ expect(screen.getByRole('button', { name: 'Back' })).toBeDisabled()
+ expect(screen.getByDisplayValue('Warehouse')).toBeDisabled()
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ await waitFor(() => expect(onClose).toHaveBeenCalledOnce())
+ // Stay locked until the document leaves, even when starting failed.
+ expect(screen.getByRole('button', { name: 'Start pipeline' })).toBeDisabled()
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ expect(requests).toEqual([
+ expect.objectContaining({
+ source_id: 1,
+ destination_name: 'Warehouse',
+ destination_config: expect.objectContaining({
+ big_query: expect.objectContaining({ project_id: 'my-project', dataset_id: 'dataset' }),
+ }),
+ pipeline_config: expect.objectContaining({ publication_name: 'analytics' }),
+ }),
+ ])
+ expect(destinationRequests.at(-1)).toMatchObject({
+ source_id: 1,
+ pipeline_config: expect.objectContaining({ publication_name: 'analytics' }),
+ })
+ expect(pipelineRequests).toEqual([
+ { source_id: 1, config: expect.objectContaining({ publication_name: 'analytics' }) },
+ ])
+ expect(starts).toHaveBeenCalledOnce()
+ expect(screen.queryByRole('alertdialog')).not.toBeInTheDocument()
+ const unload = new Event('beforeunload', { cancelable: true })
+ window.dispatchEvent(unload)
+ expect(unload.defaultPrevented).toBe(false)
+ }
+ )
+
+ it('preserves reviewed values when creation fails and retries safely', async () => {
+ const { requests, starts } = mockCreation({ failCreate: true })
+ const onClose = vi.fn()
+ await reachReview(onClose)
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ await waitFor(() => expect(requests).toHaveLength(1))
+ await waitFor(() =>
+ expect(screen.getByRole('button', { name: 'Start pipeline' })).toBeEnabled()
+ )
+ expect(onClose).not.toHaveBeenCalled()
+ expect(screen.getByDisplayValue('Warehouse')).toBeInTheDocument()
+ expect(starts).not.toHaveBeenCalled()
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ await waitFor(() => expect(onClose).toHaveBeenCalledOnce())
+ expect(requests).toHaveLength(2)
+ expect(requests[1]).toEqual(requests[0])
+ expect(starts).toHaveBeenCalledOnce()
+ })
+
+ it('blocks critical final validation and requires confirmation for warnings', async () => {
+ const { requests, destinationRequests } = mockCreation()
+ const onClose = vi.fn()
+ await reachReview(onClose)
+ let validationRequests = 0
+ let failure_type: 'critical' | 'warning' = 'critical'
+ let reason = 'Check the publication.'
+ addAPIMock({
+ method: 'post',
+ path: '/platform/replication/:ref/pipelines/validate',
+ response: () => {
+ validationRequests++
+ return HttpResponse.json<components['schemas']['ValidatePipelineResponse_Output']>({
+ validation_failures: [{ name: 'Publication issue', reason, failure_type }],
+ })
+ },
+ })
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ expect(await screen.findByText('Check the publication.')).toBeInTheDocument()
+ expect(requests).toHaveLength(0)
+ expect(onClose).not.toHaveBeenCalled()
+ failure_type = 'warning'
+ await waitFor(() =>
+ expect(screen.getByRole('button', { name: 'Start pipeline' })).toBeEnabled()
+ )
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ await screen.findByRole('button', { name: 'Start pipeline anyway' })
+ await waitFor(() =>
+ expect(screen.getByRole('button', { name: 'Start pipeline anyway' })).toBeEnabled()
+ )
+ expect(screen.getByText('Check the publication.')).toBeInTheDocument()
+ expect(requests).toHaveLength(0)
+ back()
+ back()
+ fireEvent.change(screen.getByRole('textbox', { name: 'Pipeline name' }), {
+ target: { value: 'Updated warehouse' },
+ })
+ next()
+ await screen.findByText(/Step 3 of 4/)
+ next()
+ await screen.findByText(/Step 4 of 4/)
+ expect(screen.queryByText('Check the publication.')).not.toBeInTheDocument()
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ await waitFor(() =>
+ expect(screen.getByRole('button', { name: 'Start pipeline anyway' })).toBeEnabled()
+ )
+ const validatedDestinations = destinationRequests.length
+ const validatedPipelines = validationRequests
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline anyway' }))
+ expect(screen.getByText('Check the publication.')).toBeInTheDocument()
+ await waitFor(() => expect(onClose).toHaveBeenCalledOnce())
+ expect(requests).toHaveLength(1)
+ expect(destinationRequests).toHaveLength(validatedDestinations)
+ expect(validationRequests).toBe(validatedPipelines)
+ })
+
+ it('retains Review and retries after a final validation request fails', async () => {
+ const { requests } = mockCreation()
+ const onClose = vi.fn()
+ await reachReview(onClose)
+ let shouldFail = true
+ addAPIMock({
+ method: 'post',
+ path: '/platform/replication/:ref/pipelines/validate',
+ response: () =>
+ shouldFail
+ ? HttpResponse.json<{ message: string }>(
+ { message: 'Validation unavailable' },
+ { status: 503 }
+ )
+ : HttpResponse.json<components['schemas']['ValidatePipelineResponse_Output']>({
+ validation_failures: [],
+ }),
+ })
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ await waitFor(() =>
+ expect(screen.getByRole('button', { name: 'Start pipeline' })).toBeDisabled()
+ )
+ await waitFor(() =>
+ expect(screen.getByRole('button', { name: 'Start pipeline' })).toBeEnabled()
+ )
+ expect(screen.getByText(/Step 4 of 4/)).toBeInTheDocument()
+ expect(screen.getByDisplayValue('Warehouse')).toBeInTheDocument()
+ expect(requests).toHaveLength(0)
+ shouldFail = false
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ await waitFor(() => expect(onClose).toHaveBeenCalledOnce())
+ expect(requests).toHaveLength(1)
+ })
+
+ it('returns to Data when a publication is removed after review', async () => {
+ const { requests } = mockCreation()
+ await reachReview()
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/v2/:ref/sources/:source_id/publications',
+ response: () =>
+ HttpResponse.json<components['schemas']['ReadPublicationsResponse_Output']>({
+ publications: [],
+ }),
+ })
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ await screen.findByText(/Step 3 of 4/)
+ expect(requests).toHaveLength(0)
+ })
+
it('requires connection fields and reveals invalid advanced settings', async () => {
customRender(<PipelineCreationFlow availableDestinations={['BigQuery']} onClose={vi.fn()} />, {
nuqs: { hasMemory: true },
@@ -415,7 +666,7 @@ describe('PipelineCreationFlow', () => {
await selectPublication()
next()
await waitForStep(4)
- expect(within(stepCard()).getByRole('button', { name: 'Start pipeline' })).toBeDisabled()
+ expect(within(stepCard()).getByRole('button', { name: 'Start pipeline' })).toBeEnabled()
expect(screen.getByDisplayValue('Warehouse')).toBeInTheDocument()
})
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.tsx
index 700b7afd61a..d9600a90676 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.tsx
@@ -1,6 +1,6 @@
import { useParams } from 'common'
import { parseAsStringEnum, useQueryState } from 'nuqs'
-import { useEffect, useId, useRef, useState } from 'react'
+import { useEffect, useRef, useState } from 'react'
import { useForm } from 'react-hook-form'
import { Form, Separator } from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
@@ -22,6 +22,7 @@ import { PipelineDestinationSelection } from './PipelineDestinationSelection'
import { PipelineReviewCosts } from './PipelineReviewCosts'
import { PipelineValidationAdmonition } from './PipelineValidationAdmonition'
import { usePipelineConnectionValidation } from './usePipelineConnectionValidation'
+import { usePipelineCreationSubmission } from './usePipelineCreationSubmission'
import { usePipelineDataValidation } from './usePipelineDataValidation'
import { usePipelineNavigationGuard } from './usePipelineNavigationGuard'
import { DiscardChangesConfirmationDialog } from '@/components/ui-patterns/Dialogs/DiscardChangesConfirmationDialog'
@@ -52,24 +53,39 @@ export const PipelineCreationFlow = ({
const [type, setType] = useState<FlowDestination>(availableDestinations[0] ?? 'BigQuery')
const [isPublicationPanelVisible, setIsPublicationPanelVisible] = useState(false)
- const formId = useId()
const form = useForm<DestinationPanelSchemaType>({
defaultValues: generateDefaultValues({ catalogToken: '', editMode: false }),
shouldUnregister: false,
})
const initialTypeRef = useRef(type)
const { isDirty } = form.formState
- const { requestNavigation, modalProps } = usePipelineNavigationGuard(
- isDirty || type !== initialTypeRef.current
+ const { requestNavigation, completeNavigation, modalProps } = usePipelineNavigationGuard(
+ isDirty || type !== initialTypeRef.current,
+ () => isSubmitting
)
- const handleClose = () => requestNavigation(onClose)
+ const handleClose = () => {
+ if (!isSubmitting) requestNavigation(onClose)
+ }
const { ref: projectRef } = useParams()
const { validateConnection, resetValidation, isValidating, isConnectionVerified, failures } =
usePipelineConnectionValidation({ projectRef, type, form })
const sourceId = useReplicationSourceId({ projectRef })
const { validateData, isValidatingData, isDataVerified, dataError, publication } =
usePipelineDataValidation({ projectRef, sourceId, type, form })
+ const {
+ handleSubmit,
+ isSubmitting,
+ failures: submissionFailures,
+ submitLabel,
+ } = usePipelineCreationSubmission({
+ type,
+ form,
+ validateData,
+ onCreated: () => completeNavigation(onClose),
+ })
+ const isBusy = isValidating || isValidatingData || isSubmitting
const accessibleStep = (() => {
+ if (isSubmitting) return step
if ((step === 'data' || step === 'review') && !isConnectionVerified) return 'connection'
if (step === 'review' && !isDataVerified) return 'data'
return step
@@ -98,23 +114,27 @@ export const PipelineCreationFlow = ({
<PipelineCreationHeader
onClose={handleClose}
onNavigate={(href) => {
- requestNavigation(() => window.location.assign(href))
+ if (!isSubmitting) requestNavigation(() => window.location.assign(href))
}}
/>
<main className="flex-1">
<Form {...form}>
- <form id={formId} onSubmit={(event) => event.preventDefault()}>
+ <fieldset disabled={isSubmitting} className="contents">
<SteppedFlow
steps={steps}
currentStep={accessibleStep}
onStepChange={setStep}
onNext={handleNext}
- nextLoading={isValidating || isValidatingData}
- navigationDisabled={isValidating || isValidatingData}
+ nextLoading={isBusy}
+ navigationDisabled={isBusy}
nextLabel="Continue"
nextDisabled={accessibleStep === 'destination' && !canSelectDestination}
onCancel={handleClose}
- finalAction={{ label: 'Start pipeline', disabled: true }}
+ finalAction={{
+ label: submitLabel,
+ onClick: handleSubmit,
+ loading: isSubmitting,
+ }}
>
<SteppedFlowHeader title={currentStep.title} />
{accessibleStep === 'destination' && (
@@ -172,14 +192,13 @@ export const PipelineCreationFlow = ({
control={form.control}
publication={publication}
/>
+ <Separator />
<PipelineReviewCosts control={form.control} publication={publication} />
- <p className="p-5 text-sm text-foreground-light">
- Pipeline creation is not available in this preview yet.
- </p>
+ <PipelineValidationAdmonition failures={submissionFailures} />
</>
)}
</SteppedFlow>
- </form>
+ </fieldset>
</Form>
</main>
<NewPublicationPanel
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationPage.test.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationPage.test.tsx
index 78d5cf47964..a601f33c436 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationPage.test.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationPage.test.tsx
@@ -1,10 +1,11 @@
-import { screen } from '@testing-library/react'
+import { fireEvent, screen } from '@testing-library/react'
import { beforeEach, expect, it, vi } from 'vitest'
import PipelineCreationPage from '@/pages/project/[ref]/database/pipelines/new'
import { customRender } from '@/tests/lib/custom-render'
const state = vi.hoisted(() => ({
+ push: vi.fn(),
enabled: false,
loading: false,
flagsLoaded: true,
@@ -12,8 +13,13 @@ const state = vi.hoisted(() => ({
isHighAvailability: false,
canUseReplication: true,
}))
+vi.mock('next/router', async (importOriginal) => ({
+ ...(await importOriginal<typeof import('next/router')>()),
+ useRouter: () => ({ push: state.push, events: { on: vi.fn(), off: vi.fn() } }),
+}))
vi.mock('common', async (importOriginal) => ({
...(await importOriginal<typeof import('common')>()),
+ useParams: () => ({ ref: 'default' }),
useFeatureFlags: () => ({ hasLoaded: state.flagsLoaded }),
}))
vi.mock('@/hooks/misc/withAuth', () => ({ withAuth: (component: unknown) => component }))
@@ -35,7 +41,13 @@ vi.mock('@/components/interfaces/Database/Replication/useIsETLPrivateAlpha', ()
useIsETLSnowflakePrivateAlpha: () => false,
useIsETLClickHousePrivateAlpha: () => false,
}))
-vi.mock('./PipelineCreationFlow', () => ({ PipelineCreationFlow: () => <div>Wizard form</div> }))
+vi.mock('./PipelineCreationFlow', () => ({
+ PipelineCreationFlow: ({ onClose }: { onClose: () => void }) => (
+ <button tabIndex={0} onClick={onClose}>
+ Wizard form
+ </button>
+ ),
+}))
beforeEach(() => {
Object.assign(state, {
@@ -82,3 +94,9 @@ it('falls back when the preview is off even if organisation and project queries
customRender(<PipelineCreationPage />)
expect(screen.getByRole('status')).toHaveTextContent('Returning to Pipelines')
})
+
+it('returns through the shared router without reloading the toast host', () => {
+ customRender(<PipelineCreationPage />)
+ fireEvent.click(screen.getByRole('button', { name: 'Wizard form' }))
+ expect(state.push).toHaveBeenCalledWith('/project/default/database/pipelines')
+})
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDestinationReview.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDestinationReview.tsx
index f5e6d126fd7..3e0044a591b 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDestinationReview.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDestinationReview.tsx
@@ -151,7 +151,7 @@ export const PipelineDestinationReview = ({
label="Type"
description={`Destination type cannot be changed after creation. ${type === 'Analytics Bucket' ? 'Analytics Bucket is deprecated.' : `${type} support is in public alpha.`}`}
>
- <div className="flex items-center gap-3 rounded-md border bg-surface-200 p-3">
+ <div className="flex h-11 min-w-0 items-center gap-2 rounded-md border bg-surface-200 px-3">
<DestinationLogo type={type} />
<span className="text-sm text-foreground">{type}</span>
</div>
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineValidationAdmonition.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineValidationAdmonition.tsx
index 1c08cc77f47..afaa6f49de2 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineValidationAdmonition.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineValidationAdmonition.tsx
@@ -73,7 +73,7 @@ export const PipelineValidationAdmonition = forwardRef<
: ''}
</p>
) : null}
- <Markdown className="text-sm text-foreground-light [&>p]:inline [&>p+p]:before:content-[' ']">
+ <Markdown className="text-sm text-foreground-light [&>p]:mb-2 [&>p:last-child]:mb-0">
{failure.reason}
</Markdown>
</div>
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineCreationSubmission.ts b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineCreationSubmission.ts
new file mode 100644
index 00000000000..3e24d259d7b
--- /dev/null
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineCreationSubmission.ts
@@ -0,0 +1,98 @@
+import { useLayoutEffect, useRef, useState } from 'react'
+import { useWatch, type UseFormReturn } from 'react-hook-form'
+
+import {
+ DestinationPanelFormSchema,
+ type DestinationPanelSchemaType,
+} from '../DestinationPanel/DestinationForm/DestinationForm.schema'
+import { useDestinationForm } from '../DestinationPanel/DestinationForm/useDestinationForm'
+import type { DestinationType } from '../DestinationPanel/DestinationPanel.types'
+
+export const usePipelineCreationSubmission = ({
+ type,
+ form,
+ validateData,
+ onCreated,
+}: {
+ type: DestinationType
+ form: UseFormReturn<DestinationPanelSchemaType>
+ validateData: () => Promise<boolean>
+ onCreated: () => void
+}) => {
+ const {
+ validateConfiguration,
+ submitPipeline,
+ destinationValidationFailures,
+ pipelineValidationFailures,
+ resetValidation,
+ } = useDestinationForm({ selectedType: type })
+ const [isSubmitting, setIsSubmitting] = useState(false)
+ const isSubmittingRef = useRef(false)
+ const hasCreated = useRef(false)
+ const warningSnapshot = useRef<string | undefined>(undefined)
+ const values = useWatch({
+ control: form.control,
+ name: DestinationPanelFormSchema.keyof().options,
+ })
+ const configurationSnapshot = JSON.stringify([type, values])
+ const failures = [...destinationValidationFailures, ...pipelineValidationFailures]
+
+ const createPipeline = async (data: DestinationPanelSchemaType) => {
+ await submitPipeline({
+ data,
+ onSuccess: () => {},
+ // Wait for the start attempt before navigating: leaving the document earlier
+ // can interrupt its request. A committed create must never be retried here.
+ onClose: () => {
+ hasCreated.current = true
+ },
+ })
+ if (hasCreated.current) onCreated()
+ }
+
+ const runSubmission = async (action: () => Promise<void>) => {
+ if (isSubmittingRef.current) return
+ isSubmittingRef.current = true
+ setIsSubmitting(true)
+ try {
+ await action()
+ } finally {
+ if (!hasCreated.current) {
+ isSubmittingRef.current = false
+ setIsSubmitting(false)
+ }
+ }
+ }
+ const handleSubmit = () =>
+ runSubmission(async () => {
+ const data = form.getValues()
+ if (warningSnapshot.current === configurationSnapshot) {
+ await createPipeline(data)
+ return
+ }
+ resetValidation()
+ if (!(await validateData())) return
+ const result = await validateConfiguration({ data, onValidationFail: () => {} })
+ if (!result.canContinue) return
+ if (result.warnings.length > 0) {
+ warningSnapshot.current = configurationSnapshot
+ return
+ }
+ await createPipeline(data)
+ })
+
+ useLayoutEffect(() => {
+ resetValidation()
+ warningSnapshot.current = undefined
+ }, [configurationSnapshot, resetValidation])
+
+ return {
+ handleSubmit,
+ isSubmitting,
+ failures,
+ submitLabel:
+ failures.length > 0 && failures.every(({ failure_type }) => failure_type === 'warning')
+ ? 'Start pipeline anyway'
+ : 'Start pipeline',
+ }
+}
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineNavigationGuard.test.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineNavigationGuard.test.tsx
index 3fc70718798..9e809cf8200 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineNavigationGuard.test.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineNavigationGuard.test.tsx
@@ -56,8 +56,17 @@ describe('usePipelineNavigationGuard', () => {
const wrapper = ({ children }: { children: ReactNode }) => (
<RouterContextProvider router={router}>{children}</RouterContextProvider>
)
- const { result, unmount } = renderHook(() => usePipelineNavigationGuard(true), { wrapper })
+ let isLocked = true
+ const { result, unmount } = renderHook(() => usePipelineNavigationGuard(true, () => isLocked), {
+ wrapper,
+ })
try {
+ await act(async () => history.push('/blocked-during-submission'))
+ expect(history.location.pathname).toBe(wizard)
+ expect(result.current.modalProps.visible).toBe(false)
+ await act(async () => history.push(`${wizard}?step=review`))
+ expect(history.location.search).toBe('')
+ isLocked = false
await act(async () => {
history.push(`${wizard}?step=connection`)
})
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineNavigationGuard.ts b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineNavigationGuard.ts
index da5d7966ebc..56d689df2af 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineNavigationGuard.ts
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineNavigationGuard.ts
@@ -4,7 +4,10 @@ import { useEffect, useRef } from 'react'
import { useLatest } from '@/hooks/misc/useLatest'
import { useConfirmOnClose } from '@/hooks/ui/useConfirmOnClose'
-export const usePipelineNavigationGuard = (hasChanges: boolean) => {
+export const usePipelineNavigationGuard = (
+ hasChanges: boolean,
+ isNavigationLocked: () => boolean = () => false
+) => {
const router = useTanStackRouter({ warn: false })
const canLeave = useRef(false)
const pending = useRef<(() => void) | undefined>(undefined)
@@ -18,7 +21,7 @@ export const usePipelineNavigationGuard = (hasChanges: boolean) => {
})
const requestNavigation = (proceed: () => void, cancel?: () => void) => {
// Keep the first requested destination while its confirmation is open.
- if (pending.current) {
+ if (isNavigationLocked() || pending.current) {
cancel?.()
return
}
@@ -26,7 +29,7 @@ export const usePipelineNavigationGuard = (hasChanges: boolean) => {
cancelPending.current = cancel
confirmOnClose()
}
- const latest = useLatest({ hasChanges, requestNavigation })
+ const latest = useLatest({ hasChanges, requestNavigation, isNavigationLocked })
useEffect(() => {
const handleBeforeUnload = (event: BeforeUnloadEvent) => {
@@ -43,6 +46,7 @@ export const usePipelineNavigationGuard = (hasChanges: boolean) => {
return router.history.block({
enableBeforeUnload: false,
blockerFn: ({ currentLocation, nextLocation }) => {
+ if (latest.current.isNavigationLocked() && !canLeave.current) return true
if (
!latest.current.hasChanges ||
canLeave.current ||
@@ -61,6 +65,10 @@ export const usePipelineNavigationGuard = (hasChanges: boolean) => {
return {
requestNavigation,
+ completeNavigation: (proceed: () => void) => {
+ canLeave.current = true
+ proceed()
+ },
modalProps: {
...modalProps,
onCancel: () => {
diff --git a/apps/studio/pages/project/[ref]/database/pipelines/new.tsx b/apps/studio/pages/project/[ref]/database/pipelines/new.tsx
index 1795de9d6f7..4548b43d27c 100644
--- a/apps/studio/pages/project/[ref]/database/pipelines/new.tsx
+++ b/apps/studio/pages/project/[ref]/database/pipelines/new.tsx
@@ -1,5 +1,6 @@
import { useFeatureFlags, useParams } from 'common'
import Head from 'next/head'
+import { useRouter } from 'next/router'
import { useEffect } from 'react'
import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'
@@ -16,9 +17,12 @@ import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
import { withAuth } from '@/hooks/misc/withAuth'
import { BASE_PATH } from '@/lib/constants'
+import { PipelineRequestStatusProvider } from '@/state/replication-pipeline-request-status'
+import type { NextPageWithLayout } from '@/types'
-const PipelineCreationPage = () => {
+const PipelineCreationPage: NextPageWithLayout<Record<string, never>> = () => {
const { ref } = useParams()
+ const router = useRouter()
const { hasLoaded } = useFeatureFlags()
const { isPending: isOrganizationPending } = useSelectedOrganizationQuery()
const { isEnabled, isLoading } = usePipelineCreationPreview()
@@ -53,10 +57,17 @@ const PipelineCreationPage = () => {
...(snowflake ? ['Snowflake' as const] : []),
...(clickHouse ? ['ClickHouse' as const] : []),
]}
- onClose={() => window.location.assign(listHref)}
+ onClose={() => {
+ if (!ref) return
+ void router.push(`/project/${ref}/database/pipelines`)
+ }}
/>
</>
)
}
+PipelineCreationPage.getLayout = (page) => (
+ <PipelineRequestStatusProvider>{page}</PipelineRequestStatusProvider>
+)
+
export default withAuth(PipelineCreationPage)