Skip to content

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

fix(studio): clarify pipeline validation feedback (#52055)

Danny Whited4584290813a
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 ca03b833c47..341e69668ff 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.test.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.test.tsx
@@ -225,6 +225,84 @@ describe('PipelineCreationFlow', () => {
return { requests, starts, destinationRequests, pipelineRequests }
}
+ it.each([
+ [false, false],
+ [true, false],
+ [false, true],
+ [true, true],
+ ])(
+ 'places review failures and keeps the current position (connection: %s, warnings: %s)',
+ async (hasConnectionFailure, hasWarnings) => {
+ const { requests } = mockCreation()
+ await reachReview()
+ const validationStatus = screen.getByRole('status', { name: 'Pipeline validation status' })
+ expect(validationStatus).toBeEmptyDOMElement()
+ const scrollIntoView = vi.fn()
+ vi.spyOn(HTMLElement.prototype, 'scrollIntoView').mockImplementation(scrollIntoView)
+ addAPIMock({
+ method: 'post',
+ path: '/platform/replication/:ref/destinations/validate',
+ response: () =>
+ HttpResponse.json<components['schemas']['ValidateDestinationResponse_Output']>({
+ validation_failures: hasConnectionFailure
+ ? [
+ {
+ name: 'Credentials',
+ reason: 'Check destination credentials.',
+ failure_type: 'critical',
+ },
+ ]
+ : [],
+ }),
+ })
+ addAPIMock({
+ method: 'post',
+ path: '/platform/replication/:ref/pipelines/validate',
+ response: () =>
+ HttpResponse.json<components['schemas']['ValidatePipelineResponse_Output']>({
+ validation_failures: [
+ {
+ name: 'Publication',
+ reason: 'Check publication settings.',
+ failure_type: 'critical',
+ },
+ ...(hasWarnings
+ ? [
+ {
+ name: 'Retention',
+ reason: 'Review retention settings.',
+ failure_type: 'warning' as const,
+ },
+ ]
+ : []),
+ ],
+ }),
+ })
+ fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
+ await screen.findByText('Check publication settings.')
+ expect(screen.getByRole('status', { name: 'Pipeline validation status' })).toBe(
+ validationStatus
+ )
+ const connection = withinRegion('Connection review')
+ const data = withinRegion('Data review')
+ if (hasConnectionFailure)
+ expect(connection.getByText('Check destination credentials.')).toBeInTheDocument()
+ expect(connection.getByRole('button', { name: 'Edit connection' })).toBeInTheDocument()
+ expect(connection.queryByText('Check publication settings.')).not.toBeInTheDocument()
+ expect(data.getByText('Check publication settings.')).toBeInTheDocument()
+ expect(data.getByRole('button', { name: 'Edit data' })).toBeInTheDocument()
+ expect(
+ screen.getByText(
+ hasWarnings
+ ? 'Fix the above issues and review warnings before starting the pipeline.'
+ : 'Fix the above issues before starting the pipeline.'
+ )
+ ).toBeInTheDocument()
+ expect(scrollIntoView).not.toHaveBeenCalled()
+ expect(requests).toHaveLength(0)
+ }
+ )
+
it.each([false, true])(
'leaves after one committed creation, including start failure: %s',
async (failStart) => {
@@ -340,6 +418,9 @@ describe('PipelineCreationFlow', () => {
)
fireEvent.click(screen.getByRole('button', { name: 'Start pipeline' }))
await screen.findByRole('button', { name: 'Start pipeline anyway' })
+ expect(
+ screen.getByText('Review the warnings above before starting the pipeline.')
+ ).toBeInTheDocument()
await waitFor(() =>
expect(screen.getByRole('button', { name: 'Start pipeline anyway' })).toBeEnabled()
)
@@ -712,6 +793,82 @@ describe('PipelineCreationFlow', () => {
expect(screen.getByDisplayValue('Warehouse')).toBeInTheDocument()
})
+ it('shows one publication loading failure before Continue and clears it after a successful retry', async () => {
+ let shouldFail = true
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/v2/:ref/sources/:source_id/publications/:publication_name',
+ response: () =>
+ shouldFail
+ ? HttpResponse.json<{ message: string }>({ message: 'Unavailable' }, { status: 503 })
+ : HttpResponse.json<components['schemas']['PublicationDetailsResponse_Output']>({
+ name: 'analytics',
+ config: {
+ type: 'tables',
+ tables: [],
+ operations: ['insert'],
+ publish_via_partition_root: false,
+ },
+ tables: [],
+ }),
+ })
+ customRender(<PipelineCreationFlow availableDestinations={['BigQuery']} onClose={vi.fn()} />, {
+ nuqs: { hasMemory: true },
+ })
+ next()
+ fillConnection()
+ await continueToData()
+ await selectPublication()
+ await screen.findByText('Publication tables could not be loaded')
+ fireEvent.click(withinRegion('Data').getByRole('button', { name: /Advanced settings/ }))
+ expect(screen.queryByText('Table settings could not be loaded')).not.toBeInTheDocument()
+ expect(screen.queryByText(/Partition handling could not be loaded/)).not.toBeInTheDocument()
+ await waitFor(() =>
+ expect(screen.getAllByText('Publication tables could not be loaded')).toHaveLength(1)
+ )
+ expect(screen.getByText('Click Continue to try again.')).toBeInTheDocument()
+ expect(screen.queryByText(/Refresh the page before changing/)).not.toBeInTheDocument()
+ next()
+ await waitFor(() => expect(screen.getByRole('button', { name: 'Continue' })).toBeEnabled())
+ await waitFor(() =>
+ expect(screen.getAllByText('Publication tables could not be loaded')).toHaveLength(1)
+ )
+ shouldFail = false
+ next()
+ await waitForStep(4)
+ expect(screen.queryByText('Publication tables could not be loaded')).not.toBeInTheDocument()
+ })
+
+ it('asks for another publication when the selected publication was deleted', async () => {
+ customRender(<PipelineCreationFlow availableDestinations={['BigQuery']} onClose={vi.fn()} />, {
+ nuqs: { hasMemory: true },
+ })
+ next()
+ fillConnection()
+ await continueToData()
+ await selectPublication()
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/v2/:ref/sources/:source_id/publications',
+ response: () =>
+ HttpResponse.json<components['schemas']['ReadPublicationsResponse_Output']>({
+ publications: [],
+ }),
+ })
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/v2/:ref/sources/:source_id/publications/:publication_name',
+ response: () =>
+ HttpResponse.json<{ message: string }>({ message: 'Not found' }, { status: 404 }),
+ })
+ next()
+ await screen.findByText('The publication analytics was not found.')
+ await screen.findByText('Select an available publication.')
+ expect(screen.queryByText('Publication tables could not be loaded')).not.toBeInTheDocument()
+ expect(screen.queryByText('Click Continue to try again.')).not.toBeInTheDocument()
+ expect(stepStatus()).toHaveTextContent('Step 3 of 4')
+ })
+
it('blocks incomplete data, retries metadata failures, and reveals invalid advanced settings', async () => {
const onUrlUpdate = vi.fn()
customRender(<PipelineCreationFlow availableDestinations={['BigQuery']} onClose={vi.fn()} />, {
@@ -756,9 +913,7 @@ describe('PipelineCreationFlow', () => {
})
next()
await waitFor(() =>
- expect(
- screen.queryByText('Publication tables could not be loaded. Click Continue to try again.')
- ).toBeInTheDocument()
+ expect(screen.queryByText('Click Continue to try again.')).toBeInTheDocument()
)
shouldFail = false
next()
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.tsx
index 897fc621564..4075e6422b0 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineCreationFlow.tsx
@@ -20,7 +20,10 @@ import { PipelineDataSection } from './PipelineDataSection'
import { PipelineDestinationReview } from './PipelineDestinationReview'
import { PipelineDestinationSelection } from './PipelineDestinationSelection'
import { PipelineReviewCosts } from './PipelineReviewCosts'
-import { PipelineValidationAdmonition } from './PipelineValidationAdmonition'
+import {
+ PipelineValidationAdmonition,
+ SANDWICHED_ADMONITION_CLASS,
+} from './PipelineValidationAdmonition'
import { usePipelineConnectionValidation } from './usePipelineConnectionValidation'
import { usePipelineCreationSubmission } from './usePipelineCreationSubmission'
import { usePipelineDataValidation } from './usePipelineDataValidation'
@@ -71,12 +74,19 @@ export const PipelineCreationFlow = ({
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 {
+ validateData,
+ isValidatingData,
+ isDataVerified,
+ dataError,
+ hasPublicationLoadError,
+ publication,
+ } = usePipelineDataValidation({ projectRef, sourceId, type, form })
const {
handleSubmit,
isSubmitting,
- failures: submissionFailures,
+ destinationValidationFailures,
+ pipelineValidationFailures,
submitLabel,
} = usePipelineCreationSubmission({
type,
@@ -84,6 +94,17 @@ export const PipelineCreationFlow = ({
validateData,
onCreated: () => completeNavigation(onClose),
})
+ const submissionFailures = [...destinationValidationFailures, ...pipelineValidationFailures]
+ const hasCriticalFailures = submissionFailures.some(
+ ({ failure_type }) => failure_type === 'critical'
+ )
+ const hasWarnings = submissionFailures.some(({ failure_type }) => failure_type === 'warning')
+ let validationMessage = 'Review the warnings above before starting the pipeline.'
+ if (hasCriticalFailures) {
+ validationMessage = hasWarnings
+ ? 'Fix the above issues and review warnings before starting the pipeline.'
+ : 'Fix the above issues before starting the pipeline.'
+ }
const isBusy = isValidating || isValidatingData || isSubmitting
const accessibleStep = (() => {
if (isSubmitting) return step
@@ -178,15 +199,21 @@ export const PipelineCreationFlow = ({
form={form}
onSelectNewPublication={() => setIsPublicationPanelVisible(true)}
revealInvalidSettings
+ showLoadError={false}
/>
- {dataError && (
+ {(hasPublicationLoadError || dataError) && (
<Admonition
- type="destructive"
- title="Check data settings"
- className="mb-0 rounded-none border-x-0 border-t border-b-0 border-default"
- >
- {dataError}
- </Admonition>
+ type="danger"
+ title={
+ hasPublicationLoadError
+ ? 'Publication tables could not be loaded'
+ : 'Check data settings'
+ }
+ description={
+ hasPublicationLoadError ? 'Click Continue to try again.' : dataError
+ }
+ className={SANDWICHED_ADMONITION_CLASS}
+ />
)}
</>
)}
@@ -197,6 +224,7 @@ export const PipelineCreationFlow = ({
control={form.control}
onEditDestination={() => void setStep('destination')}
onEditConnection={() => void setStep('connection')}
+ validationFailures={destinationValidationFailures}
/>
<Separator />
<PipelineDataReview
@@ -204,10 +232,19 @@ export const PipelineCreationFlow = ({
control={form.control}
publication={publication}
onEdit={() => void setStep('data')}
+ validationFailures={pipelineValidationFailures}
/>
<Separator />
<PipelineReviewCosts control={form.control} publication={publication} />
- <PipelineValidationAdmonition failures={submissionFailures} />
+ <div role="status" aria-label="Pipeline validation status">
+ {submissionFailures.length > 0 && (
+ <Admonition
+ className={SANDWICHED_ADMONITION_CLASS}
+ type={hasCriticalFailures ? 'danger' : 'warning'}
+ description={validationMessage}
+ />
+ )}
+ </div>
</>
)}
</SteppedFlow>
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDataReview.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDataReview.tsx
index 6eb3bc89b00..fc616957b04 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDataReview.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDataReview.tsx
@@ -12,18 +12,22 @@ import {
} from '../DestinationPanel/DestinationForm/DestinationFormFieldCopy'
import type { DestinationType } from '../DestinationPanel/DestinationPanel.types'
import { describeBigQueryTableLayout } from './PipelineReviewSummary.utils'
+import { DATA_VALIDATION_HINT, PipelineValidationAdmonition } from './PipelineValidationAdmonition'
import type { ReplicationPublicationData } from '@/data/replication/publication-query'
+import type { ValidationFailure } from '@/data/replication/validate-destination-mutation'
export const PipelineDataReview = ({
type,
control,
publication,
onEdit,
+ validationFailures = [],
}: {
type: DestinationType
control: Control<DestinationPanelSchemaType>
publication?: ReplicationPublicationData
onEdit?: () => void
+ validationFailures?: ValidationFailure[]
}) => {
const [publicationName, mode, ids, workers, copies, slot, batch, options] = useWatch({
control,
@@ -113,47 +117,53 @@ export const PipelineDataReview = ({
)
: []
return (
- <section aria-label="Data review" className="space-y-6 p-5">
- <div className="flex items-center justify-between gap-2">
- <h3 className="text-sm font-medium text-foreground">Data</h3>
- {onEdit && (
- <Button
- type="button"
- icon={<EditIcon />}
- size="tiny"
- aria-label="Edit data"
- onClick={onEdit}
+ <section aria-label="Data review">
+ <div className="space-y-6 p-5">
+ <div className="flex items-center justify-between gap-2">
+ <h3 className="text-sm font-medium text-foreground">Data</h3>
+ {onEdit && (
+ <Button
+ type="button"
+ icon={<EditIcon />}
+ size="tiny"
+ aria-label="Edit data"
+ onClick={onEdit}
+ >
+ Edit
+ </Button>
+ )}
+ </div>
+ {rows.map((row) => (
+ <ReviewField key={row.label} {...row} />
+ ))}
+ {layouts.length > 0 && (
+ <FormItemLayout
+ isReactForm={false}
+ layout="horizontal"
+ label="Table layout"
+ description="Partitioning and clustering applied when destination tables are first created or reset."
>
- Edit
- </Button>
+ <div className="min-w-0 space-y-3">
+ {layouts.map((option) => {
+ const table = tables?.find(({ id }) => id === option.tableId)
+ const name = table ? `${table.schema}.${table.name}` : `Table ${option.tableId}`
+ return (
+ <div
+ key={option.tableId}
+ className="min-w-0 rounded-md border bg-surface-200 p-3"
+ >
+ <p className="break-all text-sm text-foreground">{name}</p>
+ <p className="mt-1 break-words text-sm text-foreground-light">
+ {describeBigQueryTableLayout(option)}
+ </p>
+ </div>
+ )
+ })}
+ </div>
+ </FormItemLayout>
)}
</div>
- {rows.map((row) => (
- <ReviewField key={row.label} {...row} />
- ))}
- {layouts.length > 0 && (
- <FormItemLayout
- isReactForm={false}
- layout="horizontal"
- label="Table layout"
- description="Partitioning and clustering applied when destination tables are first created or reset."
- >
- <div className="min-w-0 space-y-3">
- {layouts.map((option) => {
- const table = tables?.find(({ id }) => id === option.tableId)
- const name = table ? `${table.schema}.${table.name}` : `Table ${option.tableId}`
- return (
- <div key={option.tableId} className="min-w-0 rounded-md border bg-surface-200 p-3">
- <p className="break-all text-sm text-foreground">{name}</p>
- <p className="mt-1 break-words text-sm text-foreground-light">
- {describeBigQueryTableLayout(option)}
- </p>
- </div>
- )
- })}
- </div>
- </FormItemLayout>
- )}
+ <PipelineValidationAdmonition failures={validationFailures} hint={DATA_VALIDATION_HINT} />
</section>
)
}
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDataSection.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDataSection.tsx
index 5e991f73382..00b7393e405 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDataSection.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDataSection.tsx
@@ -11,18 +11,24 @@ export const PipelineDataSection = ({
form,
onSelectNewPublication,
revealInvalidSettings = false,
+ showLoadError = true,
}: {
type: DestinationType
form: UseFormReturn<DestinationPanelSchemaType>
onSelectNewPublication: () => void
revealInvalidSettings?: boolean
+ showLoadError?: boolean
}) => (
<section aria-label="Data">
<div className="p-5 flex flex-col gap-y-6">
<h3 className="text-sm font-medium text-foreground">Data</h3>
<div className="flex flex-col gap-y-4">
- <PublicationSelection form={form} onSelectNewPublication={onSelectNewPublication} />
- <TableCopySelection form={form} editMode={false} />
+ <PublicationSelection
+ form={form}
+ onSelectNewPublication={onSelectNewPublication}
+ showLoadError={showLoadError}
+ />
+ <TableCopySelection form={form} editMode={false} showLoadError={showLoadError} />
</div>
</div>
<AdvancedSettings
@@ -30,6 +36,7 @@ export const PipelineDataSection = ({
form={form}
group="data"
revealInvalidSettings={revealInvalidSettings}
+ showLoadError={showLoadError}
/>
</section>
)
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDestinationReview.tsx b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDestinationReview.tsx
index 434be5de377..e44e3984247 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDestinationReview.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/PipelineDestinationReview.tsx
@@ -26,6 +26,8 @@ import {
import { PipelineRegionReadonly } from '../DestinationPanel/DestinationForm/PipelineRegionField'
import type { DestinationType } from '../DestinationPanel/DestinationPanel.types'
import { PipelineConnectionReview } from './PipelineConnectionReview'
+import { PipelineValidationAdmonition } from './PipelineValidationAdmonition'
+import type { ValidationFailure } from '@/data/replication/validate-destination-mutation'
const MaskedUrl = ({ value, label }: { value: string; label: string }) => {
const [isVisible, setIsVisible] = useState(false)
@@ -51,11 +53,13 @@ export const PipelineDestinationReview = ({
control,
onEditDestination,
onEditConnection,
+ validationFailures = [],
}: {
type: DestinationType
control: Control<DestinationPanelSchemaType>
onEditDestination?: () => void
onEditConnection?: () => void
+ validationFailures?: ValidationFailure[]
}) => {
const [
name,
@@ -175,46 +179,49 @@ export const PipelineDestinationReview = ({
</FormItemLayout>
</div>
<Separator />
- <div className="space-y-6 p-5">
- <div className="flex items-center justify-between gap-2">
- <h3 className="text-sm font-medium text-foreground">Connection</h3>
- {onEditConnection && (
- <Button
- type="button"
- icon={<EditIcon />}
- size="tiny"
- aria-label="Edit connection"
- onClick={onEditConnection}
+ <section aria-label="Connection review">
+ <div className="space-y-6 p-5">
+ <div className="flex items-center justify-between gap-2">
+ <h3 className="text-sm font-medium text-foreground">Connection</h3>
+ {onEditConnection && (
+ <Button
+ type="button"
+ icon={<EditIcon />}
+ size="tiny"
+ aria-label="Edit connection"
+ onClick={onEditConnection}
+ >
+ Edit
+ </Button>
+ )}
+ </div>
+ {[{ ...PIPELINE_NAME_FIELD_COPY, value: name }, ...rows].map((row) => (
+ <FormItemLayout
+ key={row.label}
+ isReactForm={false}
+ layout="horizontal"
+ label={row.label}
+ description={row.description}
>
- Edit
- </Button>
- )}
- </div>
- {[{ ...PIPELINE_NAME_FIELD_COPY, value: name }, ...rows].map((row) => (
+ {row.isMasked ? (
+ <MaskedUrl key={`${type}-${row.value}`} value={row.value ?? ''} label={row.label} />
+ ) : (
+ <Input readOnly aria-label={row.label} value={row.value || 'Not set'} />
+ )}
+ </FormItemLayout>
+ ))}
+ <PipelineConnectionReview type={type} control={control} />
<FormItemLayout
- key={row.label}
isReactForm={false}
layout="horizontal"
- label={row.label}
- description={row.description}
+ label="Pipeline region"
+ description={`All pipelines run from this region. ${type} connections originate here.`}
>
- {row.isMasked ? (
- <MaskedUrl key={`${type}-${row.value}`} value={row.value ?? ''} label={row.label} />
- ) : (
- <Input readOnly aria-label={row.label} value={row.value || 'Not set'} />
- )}
+ <PipelineRegionReadonly />
</FormItemLayout>
- ))}
- <PipelineConnectionReview type={type} control={control} />
- <FormItemLayout
- isReactForm={false}
- layout="horizontal"
- label="Pipeline region"
- description={`All pipelines run from this region. ${type} connections originate here.`}
- >
- <PipelineRegionReadonly />
- </FormItemLayout>
- </div>
+ </div>
+ <PipelineValidationAdmonition failures={validationFailures} />
+ </section>
</section>
)
}
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineCreationSubmission.ts b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineCreationSubmission.ts
index 3e24d259d7b..d6cbd8b4631 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineCreationSubmission.ts
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineCreationSubmission.ts
@@ -89,7 +89,8 @@ export const usePipelineCreationSubmission = ({
return {
handleSubmit,
isSubmitting,
- failures,
+ destinationValidationFailures,
+ pipelineValidationFailures,
submitLabel:
failures.length > 0 && failures.every(({ failure_type }) => failure_type === 'warning')
? 'Start pipeline anyway'
diff --git a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineDataValidation.ts b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineDataValidation.ts
index e40fa4cf6d7..5ed0b6dd850 100644
--- a/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineDataValidation.ts
+++ b/apps/studio/components/interfaces/Database/Replication/CreatePipeline/usePipelineDataValidation.ts
@@ -19,18 +19,27 @@ export const usePipelineDataValidation = ({
}) => {
const values = useWatch({ control: form.control, name: dataFieldNames })
const publicationName = useWatch({ control: form.control, name: 'publicationName' })
+
const snapshot = JSON.stringify([type, ...values])
const currentSnapshot = useRef(snapshot)
currentSnapshot.current = snapshot
+
const [verifiedSnapshot, setVerifiedSnapshot] = useState<string>()
const [isValidatingData, setIsValidatingData] = useState(false)
const isValidatingRef = useRef(false)
+
const [dataErrorState, setDataErrorState] = useState<{ snapshot: string; message: string }>()
const setDataError = (message?: string) =>
setDataErrorState(message ? { snapshot, message } : undefined)
const dataError = dataErrorState?.snapshot === snapshot ? dataErrorState.message : undefined
+
const names = useReplicationPublicationNamesQuery({ projectRef, sourceId })
const publication = useReplicationPublicationQuery({ projectRef, sourceId, publicationName })
+ const isSelectedPublicationMissing =
+ names.isSuccess && !names.data.some(({ name }) => name === publicationName)
+ const hasPublicationLoadError =
+ !!publicationName && (names.isError || (publication.isError && !isSelectedPublicationMissing))
+
const isDataVerified =
verifiedSnapshot === JSON.stringify([snapshot, publication.data]) &&
names.isSuccess &&
@@ -45,20 +54,28 @@ export const usePipelineDataValidation = ({
setVerifiedSnapshot(undefined)
isValidatingRef.current = true
setIsValidatingData(true)
+
try {
if (!projectRef || sourceId === undefined || !publicationName) {
form.setError('publicationName', { message: 'Select an available publication.' })
return false
}
+
const [freshNames, freshPublication] = await Promise.all([
names.refetch(),
publication.refetch(),
])
if (currentSnapshot.current !== snapshot) return false
+ if (freshNames.isSuccess && !freshNames.data.some(({ name }) => name === publicationName)) {
+ form.setError('publicationName', { message: 'Select an available publication.' })
+ form.setFocus('publicationName')
+ return false
+ }
if (freshNames.isError || freshPublication.isError) {
setDataError('Publication tables could not be loaded. Click Continue to try again.')
return false
}
+
const selected = freshNames.data?.some(({ name }) => name === publicationName)
? freshPublication.data
: undefined
@@ -76,11 +93,13 @@ export const usePipelineDataValidation = ({
setIsValidatingData(false)
}
}
+
return {
validateData,
isValidatingData,
isDataVerified,
dataError,
+ hasPublicationLoadError,
publication: publication.data,
}
}
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/AdvancedSettings.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/AdvancedSettings.tsx
index 014de9941d5..a6a9912635b 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/AdvancedSettings.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/AdvancedSettings.tsx
@@ -15,9 +15,11 @@ export const AdvancedSettings = ({
form,
group = 'all',
revealInvalidSettings = false,
+ showLoadError = true,
}: {
group?: 'all' | 'connection' | 'data'
revealInvalidSettings?: boolean
+ showLoadError?: boolean
type: DestinationType
form: UseFormReturn<DestinationPanelSchemaType>
}) => {
@@ -81,7 +83,7 @@ export const AdvancedSettings = ({
destination table is first created or reset.
</p>
</div>
- <TableOptions control={form.control} />
+ <TableOptions control={form.control} showLoadError={showLoadError} />
</div>
)}
</>
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/BigQuery/TableOptions.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/BigQuery/TableOptions.tsx
index 037f2b2522d..f7d5a3cc2af 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/BigQuery/TableOptions.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/BigQuery/TableOptions.tsx
@@ -73,9 +73,10 @@ const TableOptionsSkeleton = () => (
interface TableOptionsProps {
control: Control<DestinationPanelSchemaType>
+ showLoadError?: boolean
}
-export const TableOptions = ({ control }: TableOptionsProps) => {
+export const TableOptions = ({ control, showLoadError = true }: TableOptionsProps) => {
const { ref: projectRef } = useParams()
const sourceId = useReplicationSourceId({ projectRef })
const publicationName = useWatch({ control, name: 'publicationName' })
@@ -158,6 +159,8 @@ export const TableOptions = ({ control }: TableOptionsProps) => {
}
if (isPublicationError) {
+ if (!showLoadError) return null
+
return (
<Admonition
type="warning"
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationSelection.test.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationSelection.test.tsx
index 3172c7c4c17..33d519347d8 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationSelection.test.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationSelection.test.tsx
@@ -60,22 +60,58 @@ const mockPublicationRequests = (publishViaPartitionRoot: boolean) => {
})
}
-const PublicationSelectionHarness = () => {
+const PublicationSelectionHarness = ({ showLoadError = true }: { showLoadError?: boolean }) => {
const form = useForm<DestinationPanelSchemaType>({
defaultValues: { publicationName: 'analytics' },
})
return (
<Form {...form}>
- <PublicationSelection form={form} onSelectNewPublication={vi.fn()} />
+ <PublicationSelection
+ form={form}
+ onSelectNewPublication={vi.fn()}
+ showLoadError={showLoadError}
+ />
</Form>
)
}
describe('PublicationSelection', () => {
+ it.each([true, false])(
+ 'controls the publication error helper when showLoadError is %s',
+ async (showLoadError) => {
+ mockPublicationRequests(false)
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/v2/:ref/sources/:source_id/publications/:publication_name',
+ response: () =>
+ HttpResponse.json<APIErrorBody>({ message: 'Unavailable' }, { status: 500 }),
+ })
+ customRender(<PublicationSelectionHarness showLoadError={showLoadError} />)
+
+ await waitFor(() =>
+ expect(screen.getByRole('status')).not.toHaveTextContent('Loading partition handling...')
+ )
+ if (showLoadError) {
+ expect(screen.getByRole('status')).toHaveTextContent(
+ 'Partition handling could not be loaded.'
+ )
+ } else {
+ expect(screen.getByRole('status')).toBeEmptyDOMElement()
+ }
+ if (!showLoadError) {
+ expect(
+ screen.getByText(
+ 'Tables in the selected publication will be replicated to this destination.'
+ )
+ ).toBeInTheDocument()
+ }
+ }
+ )
+
it('includes parent-table partition handling in the publication description', async () => {
mockPublicationRequests(true)
- customRender(<PublicationSelectionHarness />)
+ customRender(<PublicationSelectionHarness showLoadError={false} />)
expect(screen.getByRole('status')).toHaveTextContent('Loading partition handling...')
@@ -115,7 +151,7 @@ describe('PublicationSelection', () => {
sources: [{ ...mockSources.sources[0], name: 'another-project' }],
}),
})
- customRender(<PublicationSelectionHarness />)
+ customRender(<PublicationSelectionHarness showLoadError={false} />)
expect(
await screen.findByText(
@@ -135,7 +171,7 @@ describe('PublicationSelection', () => {
{ status: 503 }
),
})
- customRender(<PublicationSelectionHarness />)
+ customRender(<PublicationSelectionHarness showLoadError={false} />)
expect(
await screen.findByText(
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationSelection.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationSelection.tsx
index e0d653f8283..31ab6d00ec1 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationSelection.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/PublicationSelection.tsx
@@ -14,11 +14,13 @@ import { useReplicationSourcesQuery } from '@/data/replication/sources-query'
type PublicationSelectionProps = {
form: UseFormReturn<DestinationPanelSchemaType>
onSelectNewPublication: () => void
+ showLoadError?: boolean
}
export const PublicationSelection = ({
form,
onSelectNewPublication,
+ showLoadError = true,
}: PublicationSelectionProps) => {
const { ref: projectRef } = useParams()
const publicationName = useWatch({ control: form.control, name: 'publicationName' })
@@ -50,7 +52,9 @@ export const PublicationSelection = ({
? 'Partitioned tables use the parent table identity.'
: 'Each partition is replicated separately.'
} else if (isPublicationError || isSourceUnavailable) {
- partitionHandlingMessage = 'Partition handling could not be loaded.'
+ if (showLoadError || isSourceUnavailable) {
+ partitionHandlingMessage = 'Partition handling could not be loaded.'
+ }
} else {
isPartitionHandlingLoading = true
}
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/TableCopySelection.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/TableCopySelection.tsx
index 94cab32ce9f..0102ac313bb 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/TableCopySelection.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/TableCopySelection.tsx
@@ -22,6 +22,7 @@ import { useReplicationSourceId } from '@/data/replication/sources-query'
import { useReplicationTablesQuery } from '@/data/replication/tables-query'
interface TableCopySelectionProps {
+ showLoadError?: boolean
form: UseFormReturn<DestinationPanelSchemaType>
editMode: boolean
}
@@ -31,7 +32,11 @@ const isSelectiveMode = (mode: DestinationPanelSchemaType['tableSyncCopyMode'])
const tableLabel = ({ schema, name }: { schema: string; name: string }) => `${schema}.${name}`
-export const TableCopySelection = ({ form, editMode }: TableCopySelectionProps) => {
+export const TableCopySelection = ({
+ form,
+ editMode,
+ showLoadError = true,
+}: TableCopySelectionProps) => {
const { ref: projectRef } = useParams()
const sourceId = useReplicationSourceId({ projectRef })
@@ -126,7 +131,7 @@ export const TableCopySelection = ({ form, editMode }: TableCopySelectionProps)
)}
/>
- {isErrorPublications && (
+ {isErrorPublications && showLoadError && (
<Admonition type="warning" title="Publication tables could not be loaded">
<p className="leading-normal!">
Refresh the page before changing or saving the initial sync settings.