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 Warehouse status and navigation (#50554)

Danny Whitea4be1674911d
diff --git a/apps/studio/components/interfaces/ConnectSheet/WarehouseTab.test.tsx b/apps/studio/components/interfaces/ConnectSheet/WarehouseTab.test.tsx
index 8f54f2279d7..2e22abdc2b0 100644
--- a/apps/studio/components/interfaces/ConnectSheet/WarehouseTab.test.tsx
+++ b/apps/studio/components/interfaces/ConnectSheet/WarehouseTab.test.tsx
@@ -78,8 +78,35 @@ describe('WarehouseTab', () => {
expect(screen.getByRole('link', { name: 'View progress' })).toBeInTheDocument()
})
+ test('shows connection details once the first table is live while setup continues', async () => {
+ mockSetupStatus({
+ setup_status: 'copying',
+ tables: [
+ { schema: 'public', name: 'orders', copy_name: 'public.orders', state: 'live' },
+ { schema: 'public', name: 'customers', copy_name: 'public.customers', state: 'syncing' },
+ ],
+ })
+
+ customRender(<WarehouseTab />)
+
+ expect(await screen.findByText('Warehouse setup is still running')).toBeInTheDocument()
+ expect(
+ screen.getByText(
+ 'Some tables are ready to query. The remaining tables will become available as their backfills finish.'
+ )
+ ).toBeInTheDocument()
+ expect(screen.getByDisplayValue('default.warehouse.supabase.io')).toBeInTheDocument()
+ expect(screen.getByRole('link', { name: 'View progress' })).toHaveAttribute(
+ 'href',
+ '/project/default/integrations/warehouse/overview'
+ )
+ })
+
test('points to the integration when setup reports an error', async () => {
- mockSetupStatus({ setup_status: 'error' })
+ mockSetupStatus({
+ setup_status: 'error',
+ tables: [{ schema: 'public', name: 'orders', copy_name: 'public.orders', state: 'live' }],
+ })
customRender(<WarehouseTab />)
@@ -91,6 +118,7 @@ describe('WarehouseTab', () => {
'href',
'/project/default/integrations/warehouse/overview'
)
+ expect(screen.queryByDisplayValue('default.warehouse.supabase.io')).not.toBeInTheDocument()
})
test('renders connection details and offers catalog access only for DuckDB', async () => {
@@ -112,6 +140,10 @@ describe('WarehouseTab', () => {
'flightsql://postgres:[YOUR-PASSWORD]@default.warehouse.supabase.io:443?tls=enabled'
)
).toBeInTheDocument()
+ expect(screen.getByRole('link', { name: 'Manage Warehouse' })).toHaveAttribute(
+ 'href',
+ '/project/default/integrations/warehouse/overview'
+ )
// FlightSQL is the default engine and needs no catalog access, so nothing here provisions.
expect(screen.queryByRole('switch')).not.toBeInTheDocument()
diff --git a/apps/studio/components/interfaces/ConnectSheet/WarehouseTab.tsx b/apps/studio/components/interfaces/ConnectSheet/WarehouseTab.tsx
index 211238e0ccf..d979623a1c5 100644
--- a/apps/studio/components/interfaces/ConnectSheet/WarehouseTab.tsx
+++ b/apps/studio/components/interfaces/ConnectSheet/WarehouseTab.tsx
@@ -50,6 +50,9 @@ export const WarehouseTab = () => {
const { data, isPending, isFetching, isError, error, refetch } = useWarehouseSetupStatusQuery({
projectRef,
})
+ const hasLiveTables = data?.tables.some((table) => table.state === 'live') ?? false
+ const canShowConnectionDetails =
+ data?.setup_status !== 'error' && (isWarehouseProvisioned(data?.setup_status) || hasLiveTables)
let content: React.ReactNode
@@ -76,7 +79,7 @@ export const WarehouseTab = () => {
}
/>
)
- } else if (!isWarehouseProvisioned(data?.setup_status)) {
+ } else if (!canShowConnectionDetails) {
const { type, title, description, action } = getNotProvisionedContent(data?.setup_status)
content = (
@@ -93,7 +96,35 @@ export const WarehouseTab = () => {
/>
)
} else {
- return <WarehouseConnectionCard variant="sheet" />
+ return (
+ <div>
+ {isWarehouseSettingUp(data?.setup_status) && (
+ <div className="px-8 pt-8">
+ <Admonition
+ type="default"
+ layout="responsive"
+ title="Warehouse setup is still running"
+ description="Some tables are ready to query. The remaining tables will become available as their backfills finish."
+ actions={[
+ <Button key="view-progress" asChild variant="default">
+ <Link href={`/project/${projectRef}/integrations/warehouse/overview`}>
+ View progress
+ </Link>
+ </Button>,
+ ]}
+ />
+ </div>
+ )}
+ <WarehouseConnectionCard variant="sheet" />
+ <div className="border-t px-8 py-4">
+ <Button asChild variant="default" size="tiny">
+ <Link href={`/project/${projectRef}/integrations/warehouse/overview`}>
+ Manage Warehouse
+ </Link>
+ </Button>
+ </div>
+ </div>
+ )
}
return <div className="p-8">{content}</div>
diff --git a/apps/studio/components/interfaces/ConnectSheet/connect.schema.ts b/apps/studio/components/interfaces/ConnectSheet/connect.schema.ts
index 07ae4cee27c..ffb2b5f014c 100644
--- a/apps/studio/components/interfaces/ConnectSheet/connect.schema.ts
+++ b/apps/studio/components/interfaces/ConnectSheet/connect.schema.ts
@@ -291,7 +291,7 @@ export const connectSchema: ConnectSchema = {
{
id: 'warehouse',
label: 'Warehouse',
- description: 'Connect to Warehouse',
+ description: 'Analytical endpoint',
fields: [],
},
],
diff --git a/apps/studio/components/interfaces/Database/Replication/PipelineStatePill.tsx b/apps/studio/components/interfaces/Database/Replication/PipelineStatePill.tsx
index bc2bcec7b78..86f5de20ae2 100644
--- a/apps/studio/components/interfaces/Database/Replication/PipelineStatePill.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/PipelineStatePill.tsx
@@ -5,7 +5,7 @@ import { TOOLTIP_UNDERLINE_CLASS_NAME } from './DetailSubtext'
import { getPipelineDisplayState, getStatusName } from './Pipeline.utils'
import type { PipelineDisplayType } from './Pipeline.utils'
import { PipelineStatusName } from './Replication.constants'
-import { StateDot, type StateDotVariant } from './StateDot'
+import { StateDot, type StateDotVariant } from '@/components/ui/StateDot'
import { ReplicationPipelineStatusData } from '@/data/replication/pipeline-status-query'
import { PipelineStatusRequestStatus } from '@/state/replication-pipeline-request-status'
import type { ResponseError } from '@/types'
diff --git a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.utils.tsx b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.utils.tsx
index 32401d89afb..45d750e67fd 100644
--- a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.utils.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.utils.tsx
@@ -2,13 +2,13 @@ import dayjs from 'dayjs'
import duration from 'dayjs/plugin/duration'
import { getPipelineDisplayState, normalizePipelineStatusName } from '../Pipeline.utils'
-import type { StateDotVariant } from '../StateDot'
import {
RetryPolicy,
SlotLagMetrics,
SlotWalStatus,
TableState,
} from './ReplicationPipelineStatus.types'
+import type { StateDotVariant } from '@/components/ui/StateDot'
import { ReplicationPipelineStatusData } from '@/data/replication/pipeline-status-query'
import { formatBytes } from '@/lib/helpers'
import { PipelineStatusRequestStatus } from '@/state/replication-pipeline-request-status'
diff --git a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/SlotStatus.tsx b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/SlotStatus.tsx
index a136fca8efb..fd4d1361fc0 100644
--- a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/SlotStatus.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/SlotStatus.tsx
@@ -1,6 +1,6 @@
-import { StateDot } from '../StateDot'
import { SlotWalStatus } from './ReplicationPipelineStatus.types'
import { getWalStatusMeta } from './ReplicationPipelineStatus.utils'
+import { StateDot } from '@/components/ui/StateDot'
export const SLOT_STATUS_TOOLTIP =
'How safely your database is keeping the changes this pipeline’s main replication slot still needs'
diff --git a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/TableReplicationRow.tsx b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/TableReplicationRow.tsx
index 836efe04319..580393ffccb 100644
--- a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/TableReplicationRow.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/TableReplicationRow.tsx
@@ -13,10 +13,10 @@ import {
} from 'ui'
import { ErroredTableDetails } from '../ErroredTableDetails'
-import { StateDot } from '../StateDot'
import { SlotLagMetrics as SlotLagMetricsType, TableState } from './ReplicationPipelineStatus.types'
import { getStatusConfig, getTableSyncLagLabel } from './ReplicationPipelineStatus.utils'
import { DropdownMenuItemTooltip } from '@/components/ui/DropdownMenuItemTooltip'
+import { StateDot } from '@/components/ui/StateDot'
import { ReplicationPipelineTableStatus } from '@/data/replication/pipeline-replication-status-query'
interface TableReplicationRowProps {
@@ -62,7 +62,10 @@ export const TableReplicationRow = ({
return (
<TableRow>
- <TableCell>{tableName}</TableCell>
+ <TableCell>
+ <span className="text-foreground-lighter">{table.schema}.</span>
+ <span className="text-foreground">{table.name}</span>
+ </TableCell>
<TableCell>
{isRestarting ? (
diff --git a/apps/studio/components/interfaces/Integrations/Warehouse/OverviewTab.test.tsx b/apps/studio/components/interfaces/Integrations/Warehouse/OverviewTab.test.tsx
index 041580125ce..ec9a4ef3254 100644
--- a/apps/studio/components/interfaces/Integrations/Warehouse/OverviewTab.test.tsx
+++ b/apps/studio/components/interfaces/Integrations/Warehouse/OverviewTab.test.tsx
@@ -255,6 +255,7 @@ describe('WarehouseOverviewTab', () => {
name: 'customers',
copy_name: 'public.customers',
state: 'syncing',
+ lag_ms: 0,
},
]
: [],
@@ -270,6 +271,7 @@ describe('WarehouseOverviewTab', () => {
).toBeInTheDocument()
expect(screen.getByText('orders')).toBeInTheDocument()
expect(screen.getByText('customers')).toBeInTheDocument()
+ expect(screen.queryByText('Caught up')).not.toBeInTheDocument()
}
}
)
@@ -341,9 +343,13 @@ describe('WarehouseOverviewTab', () => {
expect(await screen.findByRole('heading', { name })).toBeInTheDocument()
}
expect(screen.getByText('Replicated tables picker')).toBeInTheDocument()
- expect(screen.getByText('Synced')).toBeInTheDocument()
+ expect(screen.getByText('Live')).toBeInTheDocument()
expect(screen.getByText('Backfilling')).toBeInTheDocument()
expect(screen.getByText('Error')).toBeInTheDocument()
+ expect(screen.getByText('Caught up')).toBeInTheDocument()
+ expect(screen.queryByText(/behind$/)).not.toBeInTheDocument()
+ expect(screen.getByRole('columnheader', { name: 'Lag' })).toBeInTheDocument()
+ expect(screen.queryByRole('columnheader', { name: 'Size' })).not.toBeInTheDocument()
const headings = screen
.getAllByRole('heading')
diff --git a/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseSchemaTablePicker.test.tsx b/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseSchemaTablePicker.test.tsx
index 43c186a22e2..2b89fb49a35 100644
--- a/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseSchemaTablePicker.test.tsx
+++ b/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseSchemaTablePicker.test.tsx
@@ -192,6 +192,7 @@ describe('WarehouseSchemaTablePicker', () => {
expect(await screen.findByText('0 tables selected')).toBeInTheDocument()
expect(screen.getByRole('button', { name: 'Enable Warehouse' })).toBeDisabled()
+ expect(screen.queryByRole('button', { name: 'Cancel' })).not.toBeInTheDocument()
fireEvent.click(screen.getByRole('combobox', { name: 'Select tables to replicate' }))
await userEvent.click(screen.getAllByText('Select all')[1])
@@ -211,10 +212,19 @@ describe('WarehouseSchemaTablePicker', () => {
customRender(<WarehousePickerHarness isEditing />)
expect(await screen.findByText('2 tables selected')).toBeInTheDocument()
+ expect(screen.queryByRole('button', { name: 'Cancel' })).not.toBeInTheDocument()
fireEvent.click(screen.getByRole('combobox', { name: 'Select tables to replicate' }))
await userEvent.click(screen.getByText('customers'))
expect(screen.getByText('1 table selected')).toBeInTheDocument()
+ expect(screen.getByRole('button', { name: 'Cancel' })).toBeInTheDocument()
+ await userEvent.click(screen.getByRole('button', { name: 'Cancel' }))
+ expect(screen.getByText('2 tables selected')).toBeInTheDocument()
+ expect(screen.queryByRole('button', { name: 'Cancel' })).not.toBeInTheDocument()
+
+ fireEvent.click(screen.getByRole('combobox', { name: 'Select tables to replicate' }))
+ await userEvent.click(screen.getByText('customers'))
+
await userEvent.click(screen.getByRole('button', { name: 'Update replicated tables' }))
await waitFor(() =>
diff --git a/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseSchemaTablePicker.tsx b/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseSchemaTablePicker.tsx
index 9a81f3788ad..db8ca6b914e 100644
--- a/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseSchemaTablePicker.tsx
+++ b/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseSchemaTablePicker.tsx
@@ -304,12 +304,21 @@ export const WarehouseSchemaTablePicker = ({
</MultiSelector>
</FormLayout>
</CardContent>
- <CardFooter className="justify-end">
+ <CardFooter className="justify-end gap-2">
{/*
An empty selection is a valid request that tears Warehouse down, so submitting one
from here would destroy a project's Warehouse with no confirmation. Disabling keeps
teardown on the dedicated action, which asks first.
*/}
+ {isEditing && hasChanges && (
+ <Button
+ variant="default"
+ disabled={isSubmitting}
+ onClick={() => setSelectionOverride(null)}
+ >
+ Cancel
+ </Button>
+ )}
<Button
variant="primary"
disabled={selectedCount === 0 || !hasChanges}
diff --git a/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseTableStatusList.tsx b/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseTableStatusList.tsx
index 04a3719a3b5..97f588fb598 100644
--- a/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseTableStatusList.tsx
+++ b/apps/studio/components/interfaces/Integrations/Warehouse/WarehouseTableStatusList.tsx
@@ -1,5 +1,17 @@
import dayjs from 'dayjs'
-import { Badge, Card, CardContent, Tooltip, TooltipContent, TooltipTrigger } from 'ui'
+import {
+ Card,
+ CardContent,
+ Table,
+ TableBody,
+ TableCell,
+ TableHead,
+ TableHeader,
+ TableRow,
+ Tooltip,
+ TooltipContent,
+ TooltipTrigger,
+} from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
import {
PageSection,
@@ -11,15 +23,15 @@ import {
} from 'ui-patterns/PageSection'
import type { WarehouseSetupTable } from './Warehouse.utils'
+import { StateDot, type StateDotVariant } from '@/components/ui/StateDot'
import type { WarehouseSetupStatusResponse } from '@/data/warehouse/warehouse-setup-status-query'
-import { formatBytes } from '@/lib/helpers'
-const TABLE_STATE_BADGE: Record<
+const TABLE_STATE: Record<
WarehouseSetupTable['state'],
- { label: string; variant: 'warning' | 'success' | 'destructive' }
+ { label: string; variant: StateDotVariant; isPulsing?: boolean }
> = {
- syncing: { label: 'Backfilling', variant: 'warning' },
- live: { label: 'Synced', variant: 'success' },
+ syncing: { label: 'Backfilling', variant: 'warning', isPulsing: true },
+ live: { label: 'Live', variant: 'success' },
error: { label: 'Error', variant: 'destructive' },
}
@@ -35,7 +47,7 @@ const getLagLabel = (lagMs: number) => {
}
const TableLag = ({ table }: { table: WarehouseSetupTable }) => {
- if (table.lag_ms === undefined) return null
+ if (table.state !== 'live' || table.lag_ms === undefined) return null
const label = getLagLabel(table.lag_ms)
if (!table.last_synced_at) {
@@ -61,33 +73,44 @@ interface WarehouseTableStatusListProps {
const WarehouseTableStatusList = ({ tables }: WarehouseTableStatusListProps) => {
return (
<Card>
- <CardContent className="p-0 divide-y">
- {tables.map((table) => {
- const badge = TABLE_STATE_BADGE[table.state]
- return (
- <div
- key={`${table.schema}.${table.name}`}
- className="flex items-center gap-4 px-3 py-2.5"
- >
- <span className="flex-1 truncate text-sm">
- <span className="text-foreground-lighter">{table.schema}.</span>
- <span className="text-foreground">{table.name}</span>
- </span>
- <TableLag table={table} />
- {table.warehouse_size_bytes !== undefined && (
- <span className="text-sm text-foreground-light tabular-nums">
- {formatBytes(table.warehouse_size_bytes)}
- </span>
- )}
- <Badge variant={badge.variant}>{badge.label}</Badge>
- </div>
- )
- })}
- {tables.length === 0 && (
- <p className="px-3 py-2.5 text-sm text-foreground-lighter">
- No tables are being copied yet.
- </p>
- )}
+ <CardContent className="p-0">
+ <Table>
+ <TableHeader>
+ <TableRow>
+ <TableHead>Table</TableHead>
+ <TableHead className="w-48">Lag</TableHead>
+ <TableHead className="w-36">Status</TableHead>
+ </TableRow>
+ </TableHeader>
+ <TableBody>
+ {tables.map((table) => {
+ const state = TABLE_STATE[table.state]
+ return (
+ <TableRow key={`${table.schema}.${table.name}`}>
+ <TableCell>
+ <span className="text-foreground-lighter">{table.schema}.</span>
+ <span className="text-foreground">{table.name}</span>
+ </TableCell>
+ <TableCell className="whitespace-nowrap">
+ <TableLag table={table} />
+ </TableCell>
+ <TableCell>
+ <StateDot variant={state.variant} isPulsing={state.isPulsing}>
+ {state.label}
+ </StateDot>
+ </TableCell>
+ </TableRow>
+ )
+ })}
+ {tables.length === 0 && (
+ <TableRow>
+ <TableCell colSpan={3} className="text-foreground-lighter">
+ No tables are being copied yet.
+ </TableCell>
+ </TableRow>
+ )}
+ </TableBody>
+ </Table>
</CardContent>
</Card>
)
diff --git a/apps/studio/components/interfaces/Database/Replication/StateDot.tsx b/apps/studio/components/ui/StateDot.tsx
similarity index 84%
rename from apps/studio/components/interfaces/Database/Replication/StateDot.tsx
rename to apps/studio/components/ui/StateDot.tsx
index 01eb98bb2db..058c181b355 100644
--- a/apps/studio/components/interfaces/Database/Replication/StateDot.tsx
+++ b/apps/studio/components/ui/StateDot.tsx
@@ -20,12 +20,7 @@ interface StateDotProps extends ComponentPropsWithoutRef<'span'> {
labelClassName?: string
}
-/**
- * A coloured dot with a label: the one way a state is shown across Replication. Green means
- * streaming or healthy, red means broken, amber means in motion or at risk, grey means waiting.
- *
- * Forwards its ref and spreads props so it can be the child of a Radix `asChild` trigger.
- */
+/** A coloured dot with a label for compact operational states. */
export const StateDot = forwardRef<HTMLSpanElement, StateDotProps>(
(
{ variant, children, isPulsing = false, pulseDelayMs = 0, className, labelClassName, ...props },