Skip to content

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

fix(studio): preserve unsaved columns in table editor across refetches (#46073)

Charis1e113a8a01ed
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.tsx
index a313d55eb3c..b7ce16ddcb2 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.tsx
@@ -1,5 +1,5 @@
import { isEmpty, noop } from 'lodash'
-import { useContext, useEffect, useMemo, useState } from 'react'
+import { useContext, useEffect, useMemo, useRef, useState } from 'react'
import { toast } from 'sonner'
import { Badge, Checkbox, Input, SidePanel } from 'ui'
import { Admonition } from 'ui-patterns'
@@ -23,6 +23,7 @@ import {
formatImportedContentToColumnFields,
generateTableField,
generateTableFieldFromPGTable,
+ mergeForeignKeyMeta,
validateFields,
} from './TableEditor.utils'
import { DocsButton } from '@/components/ui/DocsButton'
@@ -89,6 +90,14 @@ export const TableEditor = ({
const [errors, setErrors] = useState<PlainObject>({})
const [tableFields, setTableFields] = useState<TableField>()
const [fkRelations, setFkRelations] = useState<ForeignKey[]>([])
+ // Tracks whether tableFields has been initialized with fully-loaded server data
+ // for the current panel session. Prevents background refetches from resetting
+ // local edits (e.g. unsaved newly-added columns) while the panel is open.
+ const hasInitializedRef = useRef(false)
+ // Set true the moment the user makes any field change within the panel session.
+ // Used to switch the late FK-hydration paths from wholesale replace → merge so
+ // unsaved edits (e.g. a column added before foreignKeyMeta resolves) survive.
+ const hasUserEditsRef = useRef(false)
const [isDuplicateRows, setIsDuplicateRows] = useState<boolean>(false)
const [importContent, setImportContent] = useState<ImportContent>()
@@ -149,6 +158,7 @@ export const TableEditor = ({
const updatedTableFields = { ...tableFields, ...changes } as TableField
setTableFields(updatedTableFields)
updateEditorDirty()
+ hasUserEditsRef.current = true
const updatedErrors = { ...errors }
for (const key of Object.keys(changes)) {
@@ -190,6 +200,7 @@ export const TableEditor = ({
}),
}
setTableFields(updatedTableFields)
+ hasUserEditsRef.current = true
}
setFkRelations(relations)
}
@@ -290,15 +301,29 @@ export const TableEditor = ({
setTableFields(tableFields)
}
setFkRelations([])
+ hasInitializedRef.current = true
} else {
- const tableFields = generateTableFieldFromPGTable(
+ const serverTableFields = generateTableFieldFromPGTable(
table,
foreignKeyMeta ?? [],
isDuplicating,
isRealtimeEnabled
)
- setTableFields(tableFields)
+ // Defensive: if a prior session somehow left edits in place, merge
+ // FK metadata in instead of clobbering. In normal flow this branch is
+ // pristine because the close handler resets hasUserEditsRef.
+ setTableFields((current) =>
+ hasUserEditsRef.current && current !== undefined
+ ? mergeForeignKeyMeta(current, serverTableFields)
+ : serverTableFields
+ )
+ // Only mark fully initialized once FK meta has loaded — otherwise we'll
+ // re-init below when it arrives.
+ hasInitializedRef.current = isSuccessForeignKeyMeta
}
+ } else if (visibleChanged && !visible) {
+ hasInitializedRef.current = false
+ hasUserEditsRef.current = false
}
}, [
visible,
@@ -309,19 +334,39 @@ export const TableEditor = ({
isDuplicating,
table,
visibleChanged,
+ isSuccessForeignKeyMeta,
])
useEffect(() => {
- if (!isNewRecord) {
- const tableFields = generateTableFieldFromPGTable(
+ // Re-init tableFields once if foreignKeyMeta arrives after the panel opened.
+ // After this fires (or after the panel-open effect above sets it true),
+ // subsequent background refetches must not clobber the user's local edits.
+ if (!isNewRecord && visible && isSuccessForeignKeyMeta && !hasInitializedRef.current) {
+ const serverTableFields = generateTableFieldFromPGTable(
table,
foreignKeyMeta ?? [],
isDuplicating,
isRealtimeEnabled
)
- setTableFields(tableFields)
+ // If the user has already started editing before FK meta resolved, only
+ // merge FK metadata in — never replace, or we'd lose their work
+ // (e.g. a column added while the FK section was still loading).
+ setTableFields((current) =>
+ hasUserEditsRef.current && current !== undefined
+ ? mergeForeignKeyMeta(current, serverTableFields)
+ : serverTableFields
+ )
+ hasInitializedRef.current = true
}
- }, [isNewRecord, table, foreignKeyMeta, isDuplicating, isRealtimeEnabled])
+ }, [
+ isNewRecord,
+ visible,
+ isSuccessForeignKeyMeta,
+ table,
+ foreignKeyMeta,
+ isDuplicating,
+ isRealtimeEnabled,
+ ])
useEffect(() => {
if (isSuccessForeignKeyMeta) setFkRelations(formatForeignKeys(foreignKeys))
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.utils.ts b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.utils.ts
index 469c8d718d6..99a771ead45 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.utils.ts
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.utils.ts
@@ -58,6 +58,24 @@ export const generateTableFieldFromPGTable = (
}
}
+// Merges only foreign-key metadata from a freshly server-derived TableField into
+// the existing (possibly user-edited) one. Preserves user-added columns and any
+// edits to existing columns; only injects `foreignKey` onto matching server-
+// originated columns. Used when foreignKeyMeta resolves after the user has
+// already started editing the panel.
+export const mergeForeignKeyMeta = (existing: TableField, fromServer: TableField): TableField => {
+ const serverColumnsById = new Map(fromServer.columns.map((col) => [col.id, col]))
+ return {
+ ...existing,
+ columns: existing.columns.map((col) => {
+ if (col.isNewColumn) return col
+ const serverCol = serverColumnsById.get(col.id)
+ if (!serverCol) return col
+ return { ...col, foreignKey: serverCol.foreignKey }
+ }),
+ }
+}
+
export const formatImportedContentToColumnFields = (importContent: ImportContent) => {
const { headers, selectedHeaders, columnTypeMap } = importContent
const columnFields = headers