Skip to content

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

feat(replication): Improve replication validation and fix scroll (#46943)

Riccardo Busetticb6c361f2553
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationsComboBox.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationsComboBox.tsx
index dd4e9fea9a3..a2a948e3262 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationsComboBox.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationsComboBox.tsx
@@ -81,11 +81,6 @@ export const PublicationsComboBox = ({
value={searchTerm}
onValueChange={setSearchTerm}
/>
- <div className="px-2 pt-2 pb-1">
- <p className="text-xs text-foreground-lighter">
- Publications with no tables are hidden
- </p>
- </div>
<CommandList>
<CommandEmpty>
{isLoadingPublications ? (
@@ -100,11 +95,15 @@ export const PublicationsComboBox = ({
<CommandGroup>
{publications.length === 0 && (
- <p className="text-foreground-lighter text-xs py-3 px-2">
- No publications available
- </p>
+ <div className="text-foreground-lighter text-xs py-3 px-2 space-y-0.5">
+ <p>No publications available</p>
+ <p className="text-foreground-muted">Publications with no tables are hidden</p>
+ </div>
)}
- <ScrollArea className={publications.length > 7 ? 'h-[210px]' : ''}>
+ <ScrollArea
+ className={publications.length > 7 ? 'h-[210px]' : ''}
+ onWheel={(e) => e.stopPropagation()}
+ >
{publications.map((pub) => (
<CommandItem
key={pub.name}
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ReplicationDisclaimerDialog.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ReplicationDisclaimerDialog.tsx
deleted file mode 100644
index 060e53892ca..00000000000
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ReplicationDisclaimerDialog.tsx
+++ /dev/null
@@ -1,73 +0,0 @@
-import {
- Button,
- Dialog,
- DialogContent,
- DialogFooter,
- DialogHeader,
- DialogSection,
- DialogSectionSeparator,
- DialogTitle,
-} from 'ui'
-
-interface ReplicationDisclaimerDialogProps {
- open: boolean
- isLoading: boolean
- onOpenChange: (value: boolean) => void
- onConfirm: () => void
-}
-
-export const ReplicationDisclaimerDialog = ({
- open,
- isLoading,
- onOpenChange,
- onConfirm,
-}: ReplicationDisclaimerDialogProps) => {
- return (
- <Dialog open={open} onOpenChange={onOpenChange}>
- <DialogContent className="sm:max-w-lg">
- <DialogHeader>
- <DialogTitle>Replication limitations</DialogTitle>
- </DialogHeader>
- <DialogSectionSeparator />
- <DialogSection className="space-y-4 text-sm">
- <p className="text-foreground">
- Creating this replication pipeline will immediately start syncing data from your
- publication into an external destination. Review the current limitations before
- proceeding.
- </p>
-
- <div className="text-foreground-light">
- <ul className="list-disc flex flex-col gap-y-1.5 pl-5 text-sm leading-snug">
- <li>
- <strong className="text-foreground">Custom data types replicate as strings.</strong>{' '}
- Check that the destination can interpret those string values correctly.
- </li>
- <li>
- <strong className="text-foreground">Generated columns are skipped.</strong> Replace
- them with triggers or materialized views if you need the derived values downstream.
- </li>
- <li>
- <strong className="text-foreground">
- FULL replica identity is strongly recommended.
- </strong>{' '}
- With FULL replica identity deletes and updates include the payload that is needed to
- correctly apply those changes.
- </li>
- </ul>
- </div>
- </DialogSection>
-
- <DialogSectionSeparator />
-
- <DialogFooter>
- <Button type="default" disabled={isLoading} onClick={() => onOpenChange(false)}>
- Cancel
- </Button>
- <Button loading={isLoading} onClick={onConfirm}>
- Understood, start replication
- </Button>
- </DialogFooter>
- </DialogContent>
- </Dialog>
- )
-}
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ValidationFailuresSection.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ValidationFailuresSection.tsx
index d0c4ac0c299..5389e1d2b4a 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ValidationFailuresSection.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ValidationFailuresSection.tsx
@@ -41,10 +41,14 @@ export const ValidationFailuresSection = ({
<Accordion type="multiple">
{validationIssues.map((failure, idx) => (
<AccordionItem key={idx} value={`${failure.name}+${idx}`} className="last:border-b-0">
- <AccordionTrigger className="text-sm px-3 text-foreground decoration-foreground-lighter">
+ <AccordionTrigger className="cursor-pointer text-sm px-3 text-foreground decoration-foreground-lighter [&>p]:mb-0!">
<p className="flex items-center gap-x-2">
{failure.name}
- {failure.failure_type === 'critical' && <Badge variant="warning">Required</Badge>}
+ {failure.failure_type === 'critical' ? (
+ <Badge variant="warning">Required</Badge>
+ ) : (
+ <Badge variant="default">Warning</Badge>
+ )}
</p>
</AccordionTrigger>
<AccordionContent className="px-3">
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ValidationWarningsDialog.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ValidationWarningsDialog.tsx
new file mode 100644
index 00000000000..ac9051a2848
--- /dev/null
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/ValidationWarningsDialog.tsx
@@ -0,0 +1,53 @@
+import {
+ AlertDialog,
+ AlertDialogAction,
+ AlertDialogCancel,
+ AlertDialogContent,
+ AlertDialogDescription,
+ AlertDialogFooter,
+ AlertDialogHeader,
+ AlertDialogTitle,
+} from 'ui'
+
+interface ValidationWarningsDialogProps {
+ open: boolean
+ isLoading: boolean
+ warningCount: number
+ onOpenChange: (value: boolean) => void
+ onConfirm: () => void
+}
+
+export const ValidationWarningsDialog = ({
+ open,
+ isLoading,
+ warningCount,
+ onOpenChange,
+ onConfirm,
+}: ValidationWarningsDialogProps) => {
+ return (
+ <AlertDialog open={open} onOpenChange={onOpenChange}>
+ <AlertDialogContent>
+ <AlertDialogHeader>
+ <AlertDialogTitle>
+ Create destination with {warningCount} {warningCount === 1 ? 'warning' : 'warnings'}?
+ </AlertDialogTitle>
+ <AlertDialogDescription>
+ Replication can start, but the warnings listed above may affect how some changes are
+ applied downstream. Review them before proceeding.
+ </AlertDialogDescription>
+ </AlertDialogHeader>
+ <AlertDialogFooter>
+ <AlertDialogCancel disabled={isLoading}>Cancel</AlertDialogCancel>
+ <AlertDialogAction
+ variant="warning"
+ disabled={isLoading}
+ loading={isLoading}
+ onClick={onConfirm}
+ >
+ Proceed to create
+ </AlertDialogAction>
+ </AlertDialogFooter>
+ </AlertDialogContent>
+ </AlertDialog>
+ )
+}
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/index.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/index.tsx
index c7902c1ae61..33ae182f427 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/index.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/index.tsx
@@ -35,8 +35,8 @@ import {
import { NewPublicationPanel } from './NewPublicationPanel'
import { NoDestinationsAvailable } from './NoDestinationsAvailable'
import { PublicationSelection } from './PublicationSelection'
-import { ReplicationDisclaimerDialog } from './ReplicationDisclaimerDialog'
import { ValidationFailuresSection } from './ValidationFailuresSection'
+import { ValidationWarningsDialog } from './ValidationWarningsDialog'
import { CreateAnalyticsBucketSheet } from '@/components/interfaces/Storage/AnalyticsBuckets/CreateAnalyticsBucketSheet'
import { useAPIKeys } from '@/data/api-keys/api-keys-query'
import { useProjectSettingsV2Query } from '@/data/config/project-settings-v2-query'
@@ -119,7 +119,7 @@ export const DestinationForm = ({
const { can: canReadAPIKeys } = useAsyncCheckPermissions(PermissionAction.SECRETS_READ, '*')
const [isFormInteracting, setIsFormInteracting] = useState(false)
- const [showDisclaimerDialog, setShowDisclaimerDialog] = useState(false)
+ const [showValidationWarningsDialog, setShowValidationWarningsDialog] = useState(false)
const [publicationPanelVisible, setPublicationPanelVisible] = useState(false)
const [newBucketSheetVisible, setNewBucketSheetVisible] = useState(false)
const [pendingFormValues, setPendingFormValues] = useState<z.infer<typeof FormSchema> | null>(
@@ -339,6 +339,7 @@ export const DestinationForm = ({
const allValidationFailures = [...destinationValidationFailures, ...pipelineValidationFailures]
const hasValidationFailures = allValidationFailures.some((f) => f.failure_type === 'critical')
+ const validationWarnings = allValidationFailures.filter((f) => f.failure_type === 'warning')
const isSaving =
creatingDestinationPipeline ||
@@ -377,7 +378,7 @@ export const DestinationForm = ({
// Helper function to validate configuration
const validateConfiguration = async (data: z.infer<typeof FormSchema>) => {
- if (!projectRef || !sourceId) return false
+ if (!projectRef || !sourceId) return { canContinue: false, warnings: [] }
setHasRunValidation(true)
@@ -387,6 +388,12 @@ export const DestinationForm = ({
validateDestination({
projectRef,
destinationConfig: buildDestinationConfigForValidation({ projectRef, selectedType, data }),
+ sourceId,
+ publicationName: data.publicationName,
+ maxFillMs: data.maxFillMs,
+ maxTableSyncWorkers: data.maxTableSyncWorkers,
+ maxCopyConnectionsPerTable: data.maxCopyConnectionsPerTable,
+ invalidatedSlotBehavior: data.invalidatedSlotBehavior,
}),
validatePipeline({
projectRef,
@@ -413,7 +420,7 @@ export const DestinationForm = ({
rejected?.reason instanceof Error ? rejected.reason.message : 'Please try again.'
toast.error(`Failed to validate configuration: ${reason}`)
setHasRunValidation(false)
- return false
+ return { canContinue: false, warnings: [] }
}
// Both requests succeeded, extract validation failures
@@ -432,15 +439,16 @@ export const DestinationForm = ({
]
const hasCriticalFailures = allFailures.some((f) => f.failure_type === 'critical')
const hasAnyFailures = allFailures.length > 0
+ const warnings = allFailures.filter((f) => f.failure_type === 'warning')
- // Scroll to validation section if there are any failures
+ // Scroll to validation section so the user sees failures (both critical and warnings) inline
if (hasAnyFailures) {
setTimeout(() => {
validationSectionRef.current?.scrollIntoView({ behavior: 'smooth', block: 'start' })
}, 100)
}
- return !hasCriticalFailures
+ return { canContinue: !hasCriticalFailures, warnings }
}
const submitPipeline = async (data: z.infer<typeof FormSchema>) => {
@@ -529,39 +537,48 @@ export const DestinationForm = ({
const onSubmit = async (data: z.infer<typeof FormSchema>) => {
if (!editMode) {
- // For new pipelines, validate configuration first if not already validated
- // OR if user has critical failures and clicks "Validate again"
if (!hasRunValidation || isValidating || hasValidationFailures) {
- const isValid = await validateConfiguration(data)
- if (!isValid) {
- // Validation failed with critical errors, show inline and stop
+ const validationResult = await validateConfiguration(data)
+ if (!validationResult.canContinue) {
+ // Critical failures shown inline — stop so user can fix them
return
}
- // Validation passed or only has warnings, continue to disclaimer
+ if (validationResult.warnings.length > 0) {
+ // Warnings shown inline — stop so user can review, then re-submit to confirm
+ return
+ }
+ await submitPipeline(data)
+ return
}
- // Validation passed or only warnings, proceed to disclaimer
- setPendingFormValues(data)
- setShowDisclaimerDialog(true)
+ // Validation already passed; warnings are visible inline — ask user to confirm
+ if (validationWarnings.length > 0) {
+ setPendingFormValues(data)
+ setShowValidationWarningsDialog(true)
+ return
+ }
+
+ await submitPipeline(data)
return
}
await submitPipeline(data)
}
- const handleDisclaimerDialogChange = (open: boolean) => {
- setShowDisclaimerDialog(open)
+ const handleValidationWarningsDialogChange = (open: boolean) => {
+ setShowValidationWarningsDialog(open)
if (!open) {
setPendingFormValues(null)
+ setHasRunValidation(false)
}
}
- const handleDisclaimerConfirm = async () => {
+ const handleValidationWarningsConfirm = async () => {
if (!pendingFormValues) return
const values = pendingFormValues
setPendingFormValues(null)
- setShowDisclaimerDialog(false)
+ setShowValidationWarningsDialog(false)
await submitPipeline(values)
}
@@ -689,11 +706,12 @@ export const DestinationForm = ({
onOpenChange={setNewBucketSheetVisible}
/>
- <ReplicationDisclaimerDialog
- open={showDisclaimerDialog}
- onOpenChange={handleDisclaimerDialogChange}
+ <ValidationWarningsDialog
+ open={showValidationWarningsDialog}
+ onOpenChange={handleValidationWarningsDialogChange}
isLoading={isSaving}
- onConfirm={handleDisclaimerConfirm}
+ warningCount={validationWarnings.length}
+ onConfirm={handleValidationWarningsConfirm}
/>
</>
)
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationPanel.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationPanel.tsx
index eee3e2f9b0e..be1c0ac86a6 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationPanel.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationPanel.tsx
@@ -97,7 +97,7 @@ export const DestinationPanel = ({ onSuccessCreateReadReplica }: DestinationPane
return (
<>
<Sheet open={visible} onOpenChange={onClose}>
- <SheetContent size="default" showClose={false} className="md:w-[850px]!">
+ <SheetContent size="lg" showClose={false}>
<div className="flex flex-col h-full" tabIndex={-1}>
<SheetHeader>
<SheetTitle>{editMode ? 'Edit destination' : 'Create a new destination'}</SheetTitle>
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationTypeSelection.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationTypeSelection.tsx
index 01abedb6c6b..14dfc1b8b0c 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationTypeSelection.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationTypeSelection.tsx
@@ -10,6 +10,7 @@ import {
SelectLabel,
SelectTrigger,
} from 'ui'
+import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import { useDestinationInformation } from '../useDestinationInformation'
import {
@@ -135,14 +136,23 @@ export const DestinationTypeSelection = () => {
.find((option) => option.value === destinationType)
return (
- <div className="flex flex-col gap-y-2 p-5">
- <div className="flex flex-col gap-y-1">
- <p className="text-sm font-medium text-foreground">Type</p>
- <p className="text-sm text-foreground-light">
- The destination type cannot be changed after creation.
- </p>
- </div>
-
+ <FormItemLayout
+ isReactForm={false}
+ layout="horizontal"
+ className="p-5 [&>div]:gap-y-1 [&>div>span]:text-foreground-lighter"
+ label="Type"
+ labelOptional="Destination type cannot be changed after creation"
+ description={
+ selectedOption?.isAlpha && (
+ <p className="text-sm text-foreground-light mb-1">
+ This destination type is in alpha and may change while we iterate.{' '}
+ <InlineLink href="https://github.com/orgs/supabase/discussions/39416">
+ Leave feedback
+ </InlineLink>
+ </p>
+ )
+ }
+ >
<Select
disabled={editMode}
value={destinationType ?? undefined}
@@ -161,7 +171,7 @@ export const DestinationTypeSelection = () => {
<span className="text-foreground-lighter">Select a destination type</span>
)}
</SelectTrigger>
- <SelectContent>
+ <SelectContent align="end">
{visibleGroups.map((group) => (
<SelectGroup key={group.label}>
<SelectLabel>{group.label}</SelectLabel>
@@ -183,15 +193,6 @@ export const DestinationTypeSelection = () => {
))}
</SelectContent>
</Select>
-
- {selectedOption?.isAlpha && (
- <p className="text-sm text-foreground-light">
- This destination type is in alpha and may change while we iterate.{' '}
- <InlineLink href="https://github.com/orgs/supabase/discussions/39416">
- Leave feedback
- </InlineLink>
- </p>
- )}
- </div>
+ </FormItemLayout>
)
}
diff --git a/apps/studio/data/replication/validate-destination-mutation.ts b/apps/studio/data/replication/validate-destination-mutation.ts
index 1bd7aeaecd0..848879e6e50 100644
--- a/apps/studio/data/replication/validate-destination-mutation.ts
+++ b/apps/studio/data/replication/validate-destination-mutation.ts
@@ -8,13 +8,28 @@ import type { ResponseError, UseCustomMutationOptions } from '@/types'
type ValidateDestinationParams = {
projectRef: string
destinationConfig: DestinationConfig
+ sourceId?: number
+ publicationName?: string
+ maxFillMs?: number
+ maxTableSyncWorkers?: number
+ maxCopyConnectionsPerTable?: number
+ invalidatedSlotBehavior?: 'error' | 'recreate'
}
type ValidateDestinationResponse = components['schemas']['ValidateDestinationResponse']
export type ValidationFailure = ValidateDestinationResponse['validation_failures'][number]
async function validateDestination(
- { projectRef, destinationConfig }: ValidateDestinationParams,
+ {
+ projectRef,
+ destinationConfig,
+ sourceId,
+ publicationName,
+ maxFillMs,
+ maxTableSyncWorkers,
+ maxCopyConnectionsPerTable,
+ invalidatedSlotBehavior,
+ }: ValidateDestinationParams,
signal?: AbortSignal
): Promise<ValidateDestinationResponse> {
if (!projectRef) throw new Error('projectRef is required')
@@ -108,9 +123,25 @@ async function validateDestination(
)
}
+ const batchConfig = maxFillMs !== undefined ? { max_fill_ms: maxFillMs } : undefined
+ const pipelineConfig =
+ publicationName === undefined
+ ? undefined
+ : {
+ publication_name: publicationName,
+ max_table_sync_workers: maxTableSyncWorkers,
+ max_copy_connections_per_table: maxCopyConnectionsPerTable,
+ invalidated_slot_behavior: invalidatedSlotBehavior,
+ batch: batchConfig,
+ }
+
const { data, error } = await post('/platform/replication/{ref}/destinations/validate', {
params: { path: { ref: projectRef } },
- body: { config },
+ body: {
+ config,
+ source_id: sourceId,
+ pipeline_config: pipelineConfig,
+ },
signal,
})
diff --git a/packages/api-types/types/platform.d.ts b/packages/api-types/types/platform.d.ts
index 1c0146a8ea0..71533fadd4a 100644
--- a/packages/api-types/types/platform.d.ts
+++ b/packages/api-types/types/platform.d.ts
@@ -12818,6 +12818,37 @@ export interface components {
user: string
}
}
+ /** @description Pipeline configuration */
+ pipeline_config?: {
+ /** @description Batch configuration */
+ batch?: {
+ /**
+ * @description Maximum fill time in milliseconds
+ * @example 200
+ */
+ max_fill_ms?: number
+ }
+ /**
+ * @description Behavior when the replication slot is invalidated
+ * @example error
+ * @enum {string}
+ */
+ invalidated_slot_behavior?: 'error' | 'recreate'
+ /** @description Maximum number of copy connections per table */
+ max_copy_connections_per_table?: number
+ /** @description Maximum number of table sync workers */
+ max_table_sync_workers?: number
+ /**
+ * @description Publication name
+ * @example pub_orders
+ */
+ publication_name: string
+ }
+ /**
+ * @description Source id
+ * @example 1
+ */
+ source_id?: number
}
ValidateReplicationPipelineBody: {
/** @description Pipeline configuration */