Files
supabase/apps/studio/components/interfaces/Integrations/Wrappers/WrapperTableEditor.tsx
Alaister Young 0fe2366659 [FE-3790] fix(studio): hide Multigres from user-facing surfaces (#48191)
Hides the "Multigres" term from user-facing surfaces — it's the tech
powering High Availability projects, but "High Availability" is the only
term users should see for now (per Slack discussion with Saxon/Ivan).

**Changed:**
- High Availability badge hover card (project overview) no longer says
"Driven by Multigres"
- Project creation HA toggle description drops the Multigres name +
multigres.com link, keeps the informational copy
- All schema dropdowns now hide the `multigres` schema on HA projects,
by wiring in the previously-unused `filterSchemasForHighAvailability`
helper:
- `SchemaSelector` (shared — Table Editor, Functions, Indexes, Triggers,
Schema Visualizer, etc.)
  - `ExposedSchemaSelector` (API settings → exposed schemas)
- `EnableExtensionModal`, `CreateIndexSidePanel`, `ForeignKeySelector`,
`WrapperTableEditor`, Integrations install sheet `AdvancedSettings`
  - SQL editor schema autocomplete (`useAddDefinitions`)
- Schema list computations in the touched components are now memoized
(incl. stabilizing `SchemaSelector`'s `excludedSchemas` default so the
memo actually holds)

**Added:**
- Unit tests for `filterSchemasForHighAvailability` /
`resolveHighAvailability`
- MSW component test for `SchemaSelector` asserting `multigres` is
hidden on HA projects and still shown on non-HA projects

The filter is HA-gated on purpose: a self-hosted/non-HA user with their
own schema named `multigres` still sees it. The flag-gated Multigres
option in Logs is intentionally untouched — that exposure is kept for
the Multigres team's debugging (separate track).

## To test

- On an HA project (`high_availability: true`): hover the High
Availability badge on project overview — no "Multigres" mention; open
schema dropdowns in Table Editor / Database pages / SQL editor
autocomplete — no `multigres` schema
- Project creation with HA entitlement: toggle description has no
Multigres wording/link
- On a non-HA project: schema dropdowns behave as before

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Improvements**
* Made schema dropdowns and related selectors high-availability aware
across extensions, indexes, integrations, SQL editing, API exposed
schemas, and relationship editors.
* Updated project high-availability UI text and badge hover description
to remove outdated branding and clarify horizontally scalable Postgres
architecture.
* **Tests**
* Added coverage to ensure the schema “multigres” option is hidden/shown
correctly based on high availability, and validated high-availability
value handling.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-07-23 00:08:11 +08:00

522 lines
17 KiB
TypeScript

import { zodResolver } from '@hookform/resolvers/zod'
import { Check, ChevronsUpDown, XIcon } from 'lucide-react'
import { useEffect, useId, useMemo, useState } from 'react'
import {
Control,
FieldValues,
SubmitHandler,
useFieldArray,
useForm,
useWatch,
} from 'react-hook-form'
import {
Button,
cn,
Command,
CommandEmpty,
CommandGroup,
CommandInput,
CommandItem,
CommandList,
Form,
FormControl,
FormField,
Input,
Label,
Popover,
PopoverContent,
PopoverTrigger,
ScrollArea,
Select,
SelectContent,
SelectItem,
SelectSeparator,
SelectTrigger,
SelectValue,
SidePanel,
} from 'ui'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import {
MultiSelector,
MultiSelectorContent,
MultiSelectorItem,
MultiSelectorList,
MultiSelectorTrigger,
} from 'ui-patterns/multi-select'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
import * as z from 'zod'
import { ColumnType } from './ColumnType'
import type { AvailableColumn, Table, TableOption } from './Wrappers.types'
import { getTableFormSchema } from './Wrappers.utils'
import { ActionBar } from '@/components/interfaces/TableGridEditor/SidePanelEditor/ActionBar'
import { useSchemasQuery } from '@/data/database/schemas-query'
import { useSchemasFilteredForHighAvailability } from '@/hooks/misc/useHighAvailability'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
export type WrapperTableEditorProps = {
visible: boolean
onCancel: () => void
onSave: (values: any) => void
tables: Table[]
initialData: any
}
const WrapperTableEditor = ({
visible,
onCancel,
onSave,
tables,
initialData,
}: WrapperTableEditorProps) => {
const [open, setOpen] = useState(false)
const listboxId = useId()
const [selectedTableIndex, setSelectedTableIndex] = useState<string>('')
useEffect(() => {
if (initialData && Object.keys(initialData).length > 0) {
setSelectedTableIndex(String(initialData.index))
}
}, [initialData])
const selectedTable = selectedTableIndex === '' ? undefined : tables[parseInt(selectedTableIndex)]
const handleCancel = () => {
setSelectedTableIndex('')
onCancel()
}
const onSubmit: SubmitHandler<FieldValues> = (values) => {
onSave({
...values,
index: parseInt(selectedTableIndex),
schema_name: values.schema === 'custom' ? values.schema_name : values.schema,
is_new_schema: values.schema === 'custom',
})
setSelectedTableIndex('')
}
return (
<SidePanel
key="WrapperTableEditor"
size="medium"
visible={visible}
onCancel={handleCancel}
header={<span>Edit foreign table</span>}
customFooter={
<ActionBar
backButtonLabel="Cancel"
applyButtonLabel="Save"
formId="wrapper-table-editor-form"
closePanel={handleCancel}
/>
}
>
<SidePanel.Content>
<div className="my-4 flex flex-col gap-y-6">
<div className="flex flex-col gap-y-2">
<Label className="text-foreground-light">Select a target the table will point to</Label>
<Popover open={open} onOpenChange={setOpen}>
<PopoverTrigger asChild>
<Button
variant="default"
role="combobox"
aria-expanded={open}
aria-controls={listboxId}
className={cn(
'w-full justify-between',
!selectedTableIndex && 'text-muted-foreground'
)}
size="small"
iconRight={
<ChevronsUpDown className="ml-2 h-4 w-4 shrink-0 opacity-50" strokeWidth={1} />
}
>
{!!selectedTableIndex ? tables[Number(selectedTableIndex)].label : '---'}
</Button>
</PopoverTrigger>
<PopoverContent id={listboxId} className="p-0" sameWidthAsTrigger>
<Command>
<CommandInput placeholder="Find a table..." />
<CommandList>
<CommandEmpty>No targets found</CommandEmpty>
<CommandGroup>
<ScrollArea className={(tables ?? []).length > 7 ? 'h-[200px]' : ''}>
{(tables ?? []).map((table, i) => (
<CommandItem
key={table.label}
className="cursor-pointer flex items-center justify-between space-x-2 w-full"
onSelect={() => {
setSelectedTableIndex(String(i))
setOpen(false)
}}
onClick={() => {
setSelectedTableIndex(String(i))
setOpen(false)
}}
>
<div className="space-y-1">
<p>{table.label}</p>
<p className="text-foreground-lighter">{table.description}</p>
</div>
{String(i) === selectedTableIndex && (
<Check className={cn('mr-2 h-4 w-4')} />
)}
</CommandItem>
))}
</ScrollArea>
</CommandGroup>
</CommandList>
</Command>
</PopoverContent>
</Popover>
</div>
{selectedTable && (
<TableForm table={selectedTable} onSubmit={onSubmit} initialData={initialData} />
)}
</div>
</SidePanel.Content>
</SidePanel>
)
}
export default WrapperTableEditor
const Option = ({ option, control }: { option: TableOption; control: Control<FieldValues> }) => {
if (option.type === 'select') {
return (
<FormField
control={control}
name={option.name}
defaultValue={option.defaultValue}
render={({ field }) => (
<FormItemLayout layout="vertical" label={option.label} name={option.name}>
<FormControl>
<Select value={field.value} onValueChange={field.onChange}>
<SelectTrigger>
<SelectValue placeholder="Select an option" />
</SelectTrigger>
<SelectContent>
<SelectSeparator />
{option.options.map((subOption) => (
<SelectItem key={subOption.value} value={subOption.value}>
{subOption.label}
</SelectItem>
))}
</SelectContent>
</Select>
</FormControl>
</FormItemLayout>
)}
/>
)
}
return (
<FormField
control={control}
name={option.name}
defaultValue={option.defaultValue ?? ''}
render={({ field }) => (
<FormItemLayout layout="vertical" label={option.label} name={option.name}>
<FormControl>
<Input {...field} id={option.name} placeholder={option.placeholder ?? ''} />
</FormControl>
</FormItemLayout>
)}
/>
)
}
const TableForm = ({
table,
onSubmit,
initialData,
}: {
table: Table
onSubmit: SubmitHandler<FieldValues>
initialData: any
}) => {
const { data: project } = useSelectedProjectQuery()
const { data: allSchemas, isPending: isLoading } = useSchemasQuery({
projectRef: project?.ref,
connectionString: project?.connectionString,
})
const schemas = useSchemasFilteredForHighAvailability(allSchemas)
const requiredOptions: TableOption[] = []
const optionalOptions: TableOption[] = []
const nonEditableOptions: TableOption[] = []
table.options.forEach((option) => {
if (option.editable) {
if (option.required && !option.defaultValue) {
requiredOptions.push(option)
return
}
optionalOptions.push(option)
return
}
nonEditableOptions.push(option)
})
const defaultValues = useMemo(() => {
if (initialData && Object.keys(initialData).length > 0) {
const { schema } = initialData
const existingSchema = schemas?.find((s) => s.name === schema)
return {
schema_name: existingSchema ? '' : schema,
schema: existingSchema ? existingSchema.name : 'custom',
...Object.fromEntries(
table.options.map((option) => [option.name, option.defaultValue ?? ''])
),
...initialData,
}
}
return {
table_name: '',
columns: table.availableColumns ?? [],
schema: 'public',
...Object.fromEntries(
table.options.map((option) => [option.name, option.defaultValue ?? ''])
),
}
}, [initialData, table, schemas])
const formSchema = getTableFormSchema(table)
type FormSchema = z.infer<typeof formSchema>
const form = useForm<FormSchema>({
defaultValues,
resolver: zodResolver(formSchema),
shouldUnregister: true,
})
const {
fields: columnFields,
append: appendColumn,
replace: replaceColumns,
remove: removeColumn,
} = useFieldArray({
control: form.control,
name: 'columns',
})
const { reset } = form
useEffect(() => {
reset(defaultValues)
// Workaround bug in react-hook-form
replaceColumns(defaultValues.columns ?? [])
}, [reset, replaceColumns, defaultValues])
const handleSubmit: SubmitHandler<FieldValues> = (values) => {
const { schema_name, schema, ...valuesWithoutSchema } = values
onSubmit({
...valuesWithoutSchema,
// Ensure all options are accounted for.
...Object.fromEntries(
table.options.map((option) => [
option.name,
values[option.name] ?? option.defaultValue ?? '',
])
),
schema,
schema_name: schema === 'custom' ? schema_name : schema,
is_new_schema: schema === 'custom',
})
reset()
}
const { errors } = form.formState
const schema = useWatch({ name: 'schema', control: form.control })
return (
<Form {...form}>
<form
id="wrapper-table-editor-form"
onSubmit={form.handleSubmit(handleSubmit)}
className="space-y-4"
>
{isLoading && <ShimmeringLoader className="py-4" />}
<FormField
control={form.control}
name="schema"
render={({ field }) => (
<FormItemLayout layout="vertical" label="Select a schema for the foreign table">
<FormControl>
<Select
name="schema"
value={field.value}
onValueChange={(schema) => {
field.onChange(schema)
form.resetField('schema_name')
}}
>
<SelectTrigger>
<SelectValue placeholder="Select an option" />
</SelectTrigger>
<SelectContent>
<SelectItem value="custom">Create a new schema</SelectItem>
<SelectSeparator />
{(schemas ?? [])?.map((schema) => {
return (
<SelectItem key={schema.name} value={schema.name}>
{schema.name}
</SelectItem>
)
})}
</SelectContent>
</Select>
</FormControl>
</FormItemLayout>
)}
/>
{schema === 'custom' && (
<FormField
control={form.control}
name="schema_name"
render={({ field }) => (
<FormItemLayout name="schema_name" layout="vertical" label="Schema name">
<FormControl>
<Input {...field} id="schema_name" />
</FormControl>
</FormItemLayout>
)}
/>
)}
<FormField
control={form.control}
name="table_name"
render={({ field }) => (
<FormItemLayout
layout="vertical"
name="table_name"
label="Table name"
description="You can query from this table after the wrapper is enabled."
>
<FormControl>
<Input {...field} id="table_name" />
</FormControl>
</FormItemLayout>
)}
/>
{requiredOptions.map((option) => (
<Option key={option.name} option={option} control={form.control} />
))}
{nonEditableOptions.map((option) => (
<input key={option.name} type="hidden" {...form.register(option.name)} />
))}
{table.availableColumns != null ? (
<FormField
control={form.control}
name="selected_columns"
render={() => (
<FormItemLayout
layout="vertical"
label="Select the columns to be added to your table."
>
<div>
<MultiSelector
onValuesChange={(selectedColumns) => {
const newColumnFieldsValue: AvailableColumn[] = []
table.availableColumns!.forEach((availableColumn) => {
if (selectedColumns.includes(availableColumn.name)) {
newColumnFieldsValue.push(availableColumn)
}
})
replaceColumns(newColumnFieldsValue)
}}
values={columnFields.map(
(column) =>
// @ts-expect-error FIXME: cannot make inference work properly
column.name
)}
size="small"
className="w-full"
>
<MultiSelectorTrigger
mode="inline-combobox"
badgeLimit="wrap"
showIcon={false}
deletableBadge
className="w-full"
/>
<MultiSelectorContent>
<MultiSelectorList>
{table.availableColumns!.map((availableColumn) => (
<MultiSelectorItem
key={availableColumn.name}
value={availableColumn.name}
>
{availableColumn.name}
</MultiSelectorItem>
))}
</MultiSelectorList>
</MultiSelectorContent>
</MultiSelector>
</div>
</FormItemLayout>
)}
/>
) : (
<div className="flex flex-col gap-y-2">
{columnFields.map((column, columnIndex) => (
<div key={column.id} className="flex items-center gap-x-2">
<FormField
control={form.control}
name={`columns.${columnIndex}.name`}
render={({ field }) => (
<FormItemLayout
layout="vertical"
name={`columns.${columnIndex}.name`}
label="Name"
>
<FormControl>
<Input {...field} id={`columns.${columnIndex}.name`} />
</FormControl>
</FormItemLayout>
)}
/>
<ColumnType
control={form.control}
className="w-1/2"
name={`columns.${columnIndex}.type`}
enumTypes={[]}
/>
<Button
variant="outline"
icon={<XIcon strokeWidth={1.5} />}
onClick={() => removeColumn(columnIndex)}
className="self-end -translate-y-1.5 px-1.5"
// @ts-expect-error FIXME: cannot make inference work
aria-label={`Remove column ${column.name}`}
/>
</div>
))}
<Button
variant="default"
onClick={() => appendColumn({ name: '', type: 'text' })}
className="self-start"
>
Add column
</Button>
{errors.columns != null && errors.columns.message != null && (
<span className="text-red-900 text-sm mt-2">{errors.columns.message.toString()}</span>
)}
</div>
)}
{optionalOptions.map((option) => (
<Option key={option.name} option={option} control={form.control} />
))}
</form>
</Form>
)
}