import { zodResolver } from '@hookform/resolvers/zod' import { useQueryClient } from '@tanstack/react-query' import { Edit, Trash } from 'lucide-react' import { useEffect, useMemo, useState } from 'react' import { SubmitHandler, useFieldArray, useForm, useWatch } from 'react-hook-form' import { toast } from 'sonner' import { Button, Form, FormControl, FormField, Input, RadioGroupStacked, RadioGroupStackedItem, Separator, SheetFooter, SheetHeader, SheetTitle, Tooltip, TooltipContent, TooltipTrigger, WarningIcon, } from 'ui' import { Admonition } from 'ui-patterns/Admonition' import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout' import * as z from 'zod' import InputField from './InputField' import { WrapperMeta } from './Wrappers.types' import { FormattedWrapperTable, getRequiredExtensionsToInstall, getWrapperCreationFormSchema, hasForeignSchemaSupport, NewTable, } from './Wrappers.utils' import WrapperTableEditor from './WrapperTableEditor' import { useIsMarketplaceEnabled } from '@/components/interfaces/App/FeaturePreview/FeaturePreviewContext' import { getExtensionDefaultSchema } from '@/components/interfaces/Integrations/Integration/IntegrationOverviewTabV2/IntegrationOverviewTabV2.utils' import { RequiredExtensionsSection } from '@/components/interfaces/Integrations/Integration/RequiredExtensionsSection' import { useIntegrationDetail } from '@/components/interfaces/Integrations/Landing/useIntegrationDetail' import { FormSection, FormSectionContent, FormSectionLabel, } from '@/components/ui/Forms/FormSection' import { useDatabaseExtensionEnableMutation } from '@/data/database-extensions/database-extension-enable-mutation' import { useDatabaseExtensionsQuery } from '@/data/database-extensions/database-extensions-query' import { useSchemaCreateMutation } from '@/data/database/schema-create-mutation' import { invalidateSchemasQuery, useSchemasQuery } from '@/data/database/schemas-query' import { useFDWCreateMutation } from '@/data/fdw/fdw-create-mutation' import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject' import { useTrack } from '@/lib/telemetry/track' import type { ResponseError } from '@/types' const FORM_ID = 'create-wrapper-form' export interface CreateWrapperSheetProps { wrapperMeta: WrapperMeta onDirty: (isDirty: boolean) => void onClose: () => void onCloseWithConfirmation: () => void } export const CreateWrapperSheet = ({ wrapperMeta, onDirty, onClose, onCloseWithConfirmation, }: CreateWrapperSheetProps) => { const queryClient = useQueryClient() const isMarketplaceEnabled = useIsMarketplaceEnabled() const { integration } = useIntegrationDetail() const { data: project } = useSelectedProjectQuery() const track = useTrack() const { data: extensions } = useDatabaseExtensionsQuery({ projectRef: project?.ref, connectionString: project?.connectionString, }) // null while the query is in flight — distinct from [] which means "all installed" const requiredExtensionsToInstall = useMemo( () => getRequiredExtensionsToInstall(extensions, integration?.requiredExtensions ?? []), [extensions, integration?.requiredExtensions] ) const wrappersExtension = extensions?.find((ext) => ext.name === 'wrappers') const hasRequiredVersionForeignSchema = hasForeignSchemaSupport(wrappersExtension) const needsExtensions = isMarketplaceEnabled && (requiredExtensionsToInstall?.length ?? 0) > 0 const isExtensionDataLoading = isMarketplaceEnabled && requiredExtensionsToInstall === null const { data: schemas } = useSchemasQuery({ projectRef: project?.ref!, connectionString: project?.connectionString, }) const initialValues = { wrapper_name: '', server_name: '', mode: wrapperMeta.tables.length > 0 ? 'tables' : 'schema', source_schema: wrapperMeta.sourceSchemaOption?.defaultValue ?? '', target_schema: '', ...Object.fromEntries( wrapperMeta.server.options.map((option) => [option.name, option.defaultValue ?? '']) ), tables: [] as Array, } const formSchema = getWrapperCreationFormSchema(wrapperMeta) type FormSchema = z.infer const form = useForm({ defaultValues: initialValues, resolver: zodResolver(formSchema), }) const { getValues, setError } = form const { errors, isDirty, isSubmitting } = form.formState useEffect(() => { onDirty(isDirty) }, [onDirty, isDirty]) const { fields: tablesField, append: appendTable, remove: removeTable, insert: insertTable, } = useFieldArray({ control: form.control, name: 'tables', }) const [selectedTableToEdit, setSelectedTableToEdit] = useState( undefined ) const { mutateAsync: enableExtension } = useDatabaseExtensionEnableMutation({ onError: () => {} }) const { mutateAsync: createSchema } = useSchemaCreateMutation({ onError: () => {} }) const { mutateAsync: createFDW } = useFDWCreateMutation({ onError: () => {} }) const installRequiredExtensions = async () => { if (!project) return const { ref: projectRef, connectionString } = project const results = await Promise.allSettled( (requiredExtensionsToInstall ?? []).map((ext) => { const schema = getExtensionDefaultSchema(ext) ?? 'extensions' return enableExtension({ projectRef, connectionString, schema, name: ext.name, version: ext.default_version, cascade: true, createSchema: false, }) }) ) const failure = results.find((r) => r.status === 'rejected') if (failure) throw new Error((failure as PromiseRejectedResult).reason.message) } const onUpdateTable = (values: FormattedWrapperTable) => { if (values.index !== undefined) { removeTable(values.index) insertTable(values.index, values) } else { appendTable(values) } setSelectedTableToEdit(undefined) } const onSubmit: SubmitHandler = async (values) => { const { mode, tables = [], ...wrapperValues } = values if (mode === 'tables' && tables.length === 0) { setError('tables', { type: 'validate', message: 'Please provide at least one table.', }) return } if (mode === 'schema') { const foundSchema = schemas?.find((s) => s.name === wrapperValues.target_schema) if (foundSchema) { setError('target_schema', { type: 'validate', message: 'This schema already exists. Please specify a unique schema name.', }) return } } if (isExtensionDataLoading) return const toastId = toast.loading( needsExtensions ? `Installing extensions ${(requiredExtensionsToInstall ?? []).map((e) => e.name).join(', ')}…` : `Creating ${wrapperMeta.label} wrapper…` ) try { if (needsExtensions) { await installRequiredExtensions() toast.loading(`Creating ${wrapperMeta.label} wrapper…`, { id: toastId }) } if (mode === 'schema') { toast.loading(`Creating schema "${wrapperValues.target_schema}"…`, { id: toastId }) await createSchema({ projectRef: project?.ref, connectionString: project?.connectionString, name: wrapperValues.target_schema, }) toast.loading(`Creating ${wrapperMeta.label} wrapper…`, { id: toastId }) } await createFDW({ projectRef: project?.ref, connectionString: project?.connectionString, wrapperMeta, formState: { ...wrapperValues, server_name: `${wrapperValues.wrapper_name}_server`, supabase_target_schema: mode === 'schema' ? wrapperValues.target_schema : undefined, }, mode: mode === 'schema' ? (wrapperMeta.sourceSchemaOption ? 'schema' : 'skip') : 'tables', tables, sourceSchema: wrapperValues.source_schema, targetSchema: wrapperValues.target_schema, }) const { tables: formTables } = getValues() const hasNewSchema = (formTables as Record[]).some((t) => t.is_new_schema) if (hasNewSchema) invalidateSchemasQuery(queryClient, project?.ref) track('foreign_data_wrapper_created', { wrapperType: wrapperMeta.label }) toast.success(`Successfully created ${wrapperMeta.label} foreign data wrapper`, { id: toastId, }) onClose() form.reset() } catch (error) { toast.error( `Failed to create ${wrapperMeta.label} wrapper: ${(error as ResponseError).message}`, { id: toastId } ) } } const wrapper_name = useWatch({ name: 'wrapper_name', control: form.control }) const mode = useWatch({ name: 'mode', control: form.control }) return ( <>
Create a {wrapperMeta.label} wrapper
{isMarketplaceEnabled && (
{needsExtensions && ( )}
)} Wrapper Configuration}> ( 0 ? ( <> Your wrapper's server name will be{' '} {wrapper_name}_server ) : ( '' ) } > )} /> {wrapperMeta.label} Configuration} > {wrapperMeta.server.options .filter((option) => !option.hidden) .map((option) => ( ))} Data target}> (

Create foreign tables to query data from {wrapperMeta.label}.

{wrapperMeta.tables.length === 0 ? (
This wrapper doesn't support using foreign tables.
) : null}

Create all foreign tables from {wrapperMeta.label} in a specified schema.

{wrapperMeta.canTargetSchema ? ( hasRequiredVersionForeignSchema ? null : (
This feature requires the{' '} wrappers extension to be of minimum version of 0.5.0.
) ) : (
This wrapper doesn't support using a foreign schema.
)}
)} />
{mode === 'tables' && (

Foreign Tables

You can query your data from these foreign tables after the wrapper is created

} >
{tablesField.map((t, tableIndex) => { // FIXME: make inference work const table = t as unknown as FormattedWrapperTable return (

{table.schema_name}.{table.table_name}

Columns:{' '} {(table.columns ?? []).map((column: any) => column.name).join(', ')}

) })}
{tablesField.length === 0 && errors.tables && (

{errors.tables.message?.toString()}

)}
)} {mode === 'schema' && (

Foreign Schema

You can query your data from the foreign tables in the specified schema after the wrapper is created.

} > {wrapperMeta.sourceSchemaOption && !wrapperMeta.sourceSchemaOption?.readOnly && ( // Hide the field if the source schema is read-only )}
)}
{ setSelectedTableToEdit(undefined) }} onSave={onUpdateTable} initialData={selectedTableToEdit} /> ) }