mirror of
https://github.com/supabase/supabase.git
synced 2026-10-10 11:55:05 +03:00
## Problem The pipeline creation sheet uses generic examples, inconsistent destination terminology, and Advanced settings copy that does not explain what is being overridden. Its Docs button also sends most destinations to the general Pipelines guide. This PR is stacked on #50719 so the shared copy builds on the focused Snowflake field improvements. ## Solution Adds destination-specific pipeline-name examples and field descriptions, clarifies destination summaries and Advanced settings, uses human-readable ClickHouse engine names, shortens the primary action to **Start pipeline**, and links the Docs button to the selected destination guide. ## Review instructions 1. Open **[Database Replication](https://studio-staging-git-dnywh-studiorefine-pipeline-1eaf59-supabase.vercel.app/dashboard/project/_/database/replication)** and click **Add pipeline**. 2. Switch between destination types and confirm the pipeline-name example, destination summary, and field descriptions update appropriately. 3. Open **Advanced settings** and confirm the batch wait-time default is shown in the description while the input placeholder is `10000`. 4. Select each supported destination and confirm **Docs** opens its matching destination guide. 5. Select ClickHouse and confirm the engine choices read **ReplacingMergeTree** and **MergeTree**. ## Checklist - [x] I have read [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) - [x] If I wrote a new docs topic or edited an existing topic, I used the `/write-the-docs` or `/edit-the-docs` skill, which references [WORD_LIST](https://github.com/supabase/supabase/blob/master/apps/docs/WORD_LIST.md) and the docs [CONTRIBUTING](https://github.com/supabase/supabase/blob/master/apps/docs/CONTRIBUTING.md) guide <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Updates** * Clarified replication settings, destination field descriptions, and batch wait-time guidance. * Added destination-specific pipeline name placeholders and updated the labels for ClickHouse engine options. * Clarified ClickHouse password guidance for new destinations. * Updated new-pipeline buttons to say “Start pipeline” or “Start pipeline anyway.” * Added destination-specific documentation links for BigQuery, ClickHouse, DuckLake, and Snowflake. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
218 lines
7.6 KiB
TypeScript
218 lines
7.6 KiB
TypeScript
import { useParams } from 'common'
|
|
import { ArrowUpRight } from 'lucide-react'
|
|
import Link from 'next/link'
|
|
import { parseAsInteger, parseAsStringEnum, useQueryState } from 'nuqs'
|
|
import { useEffect, useRef } from 'react'
|
|
import { toast } from 'sonner'
|
|
import {
|
|
Button,
|
|
cn,
|
|
DialogSectionSeparator,
|
|
Sheet,
|
|
SheetContent,
|
|
SheetDescription,
|
|
SheetHeader,
|
|
SheetSection,
|
|
SheetTitle,
|
|
} from 'ui'
|
|
import { Admonition } from 'ui-patterns/Admonition'
|
|
|
|
import { EnablePipelinesCallout } from '../EnablePipelinesCallout'
|
|
import { PipelineStatusName } from '../Replication.constants'
|
|
import { useDestinationInformation } from '../useDestinationInformation'
|
|
import { useIsETLPrivateAlpha } from '../useIsETLPrivateAlpha'
|
|
import { DestinationForm } from './DestinationForm'
|
|
import { DestinationType } from './DestinationPanel.types'
|
|
import { DestinationTypeSelection } from './DestinationTypeSelection'
|
|
import { DiscardChangesConfirmationDialog } from '@/components/ui-patterns/Dialogs/DiscardChangesConfirmationDialog'
|
|
import { DocsButton } from '@/components/ui/DocsButton'
|
|
import { useReplicationDestinationsQuery } from '@/data/replication/destinations-query'
|
|
import { checkLocalETLNotSetUp } from '@/data/replication/utils'
|
|
import { useConfirmOnClose } from '@/hooks/ui/useConfirmOnClose'
|
|
import { DOCS_URL } from '@/lib/constants'
|
|
|
|
const DESTINATION_DOCS_PATHS: Partial<Record<DestinationType, string>> = {
|
|
BigQuery: '/guides/database/replication/pipelines/bigquery#configure-bigquery-as-a-destination',
|
|
ClickHouse:
|
|
'/guides/database/replication/pipelines/clickhouse#configure-clickhouse-as-a-destination',
|
|
DuckLake: '/guides/database/replication/pipelines/ducklake#choose-a-configuration-mode',
|
|
Snowflake: '/guides/database/replication/pipelines/snowflake#prepare-snowflake-resources',
|
|
}
|
|
|
|
export const DestinationPanel = () => {
|
|
const { ref: projectRef } = useParams()
|
|
const enablePgReplicate = useIsETLPrivateAlpha()
|
|
const { error: destinationsError } = useReplicationDestinationsQuery({ projectRef })
|
|
const isLocalETLNotSetUp = checkLocalETLNotSetUp(destinationsError)
|
|
|
|
const [urlDestinationType, setDestinationType] = useQueryState(
|
|
'destinationType',
|
|
parseAsStringEnum<DestinationType>([
|
|
'BigQuery',
|
|
'Analytics Bucket',
|
|
'DuckLake',
|
|
'Snowflake',
|
|
'ClickHouse',
|
|
]).withOptions({
|
|
history: 'push',
|
|
clearOnDefault: true,
|
|
})
|
|
)
|
|
|
|
const [edit, setEdit] = useQueryState(
|
|
'edit',
|
|
parseAsInteger.withOptions({
|
|
history: 'push',
|
|
clearOnDefault: true,
|
|
})
|
|
)
|
|
|
|
const visible = urlDestinationType !== null || edit !== null
|
|
const editMode = edit !== null
|
|
|
|
const {
|
|
sourceId,
|
|
pipeline,
|
|
statusName,
|
|
replicationNotEnabled,
|
|
type: existingDestinationType,
|
|
destinationFetcher,
|
|
} = useDestinationInformation({ id: edit })
|
|
const destinationType = existingDestinationType ?? urlDestinationType
|
|
const invalidExistingDestination = destinationFetcher.error?.code === 404
|
|
|
|
const existingDestination = editMode
|
|
? {
|
|
sourceId,
|
|
destinationId: edit,
|
|
pipelineId: pipeline?.id,
|
|
statusName,
|
|
enabled:
|
|
statusName === PipelineStatusName.STARTED || statusName === PipelineStatusName.FAILED,
|
|
}
|
|
: undefined
|
|
|
|
const checkIsDirtyRef = useRef<() => boolean>(() => false)
|
|
|
|
const onClose = () => {
|
|
checkIsDirtyRef.current = () => false
|
|
setDestinationType(null)
|
|
setEdit(null)
|
|
}
|
|
|
|
const { confirmOnClose, handleOpenChange, modalProps } = useConfirmOnClose({
|
|
checkIsDirty: () => checkIsDirtyRef.current(),
|
|
onClose,
|
|
})
|
|
|
|
const docsUrl = `${DOCS_URL}${
|
|
(destinationType && DESTINATION_DOCS_PATHS[destinationType]) ??
|
|
'/guides/database/replication/pipelines#step-3-configure-a-destination'
|
|
}`
|
|
|
|
useEffect(() => {
|
|
if (edit !== null && invalidExistingDestination) {
|
|
toast(`Unable to find destination ID ${edit}`)
|
|
setEdit(null)
|
|
}
|
|
}, [edit, invalidExistingDestination, setEdit])
|
|
|
|
const typeSelection = (
|
|
<>
|
|
<DestinationTypeSelection />
|
|
<DialogSectionSeparator />
|
|
</>
|
|
)
|
|
|
|
const pipelinesTypeSelection = (
|
|
<>
|
|
{typeSelection}
|
|
{destinationType != null && isLocalETLNotSetUp && (
|
|
<SheetSection className="pb-0!">
|
|
<Admonition
|
|
type="warning"
|
|
title="Replication unavailable locally"
|
|
description="Configure the replication API to manage pipelines in local development."
|
|
/>
|
|
</SheetSection>
|
|
)}
|
|
</>
|
|
)
|
|
|
|
return (
|
|
<>
|
|
<Sheet open={visible} onOpenChange={handleOpenChange}>
|
|
<SheetContent size="lg" showClose={false} className="max-w-3xl">
|
|
<div className="flex flex-col h-full min-h-0" tabIndex={-1}>
|
|
<SheetHeader className="flex items-center justify-between">
|
|
<div>
|
|
<SheetTitle>{editMode ? 'Edit pipeline' : 'Add pipeline'}</SheetTitle>
|
|
<SheetDescription>
|
|
{editMode
|
|
? 'Update how this pipeline sends data to its destination.'
|
|
: 'Send tables to an external destination for analytics workloads.'}
|
|
</SheetDescription>
|
|
</div>
|
|
<DocsButton
|
|
href={docsUrl}
|
|
topic={`${destinationType ?? 'destination'} pipeline settings`}
|
|
/>
|
|
</SheetHeader>
|
|
|
|
{!enablePgReplicate ? (
|
|
<div className="grow overflow-auto min-h-0">
|
|
{pipelinesTypeSelection}
|
|
<SheetSection>
|
|
<div className={cn('border rounded-md p-6 flex flex-col gap-y-4')}>
|
|
<div className="flex flex-col gap-y-1">
|
|
<h4>Request Pipelines access</h4>
|
|
<p className="text-sm text-foreground-light">
|
|
Pipelines is in <span className="text-foreground">public alpha</span> and
|
|
being rolled out gradually. Request access below to join the waitlist.
|
|
</p>
|
|
</div>
|
|
<div className="flex gap-x-2">
|
|
<Button
|
|
asChild
|
|
variant="secondary"
|
|
iconRight={<ArrowUpRight size={16} strokeWidth={1.5} />}
|
|
>
|
|
<Link
|
|
target="_blank"
|
|
rel="noreferrer"
|
|
href="https://forms.supabase.com/pg_replicate"
|
|
>
|
|
Request Pipelines access
|
|
</Link>
|
|
</Button>
|
|
<DocsButton href={`${DOCS_URL}/guides/database/replication#pipelines`} />
|
|
</div>
|
|
</div>
|
|
</SheetSection>
|
|
</div>
|
|
) : replicationNotEnabled ? (
|
|
<div className="grow overflow-auto min-h-0">
|
|
{pipelinesTypeSelection}
|
|
<SheetSection>
|
|
<EnablePipelinesCallout className="p-6!" type={destinationType} />
|
|
</SheetSection>
|
|
</div>
|
|
) : (
|
|
<DestinationForm
|
|
visible={visible}
|
|
selectedType={destinationType ?? 'BigQuery'}
|
|
existingDestination={existingDestination}
|
|
typeSelection={pipelinesTypeSelection}
|
|
checkIsDirtyRef={checkIsDirtyRef}
|
|
onClose={onClose}
|
|
onCancel={confirmOnClose}
|
|
/>
|
|
)}
|
|
</div>
|
|
</SheetContent>
|
|
</Sheet>
|
|
<DiscardChangesConfirmationDialog {...modalProps} />
|
|
</>
|
|
)
|
|
}
|