mirror of
https://github.com/supabase/supabase.git
synced 2026-06-14 23:25:16 +08:00
## Problem When a project is paused, in a failed state, or about to be deleted, users have no obvious way to take a logical backup of their data before proceeding. This is particularly risky at deletion time — once deleted, data is gone. ## Solution Introduce a new `LogicalBackupCliInstructions` component that surfaces ready-to-run `supabase db dump` commands pre-filled with the project's direct connection details. ### Where it appears | State | How | |---|---| | Project paused (restorable) | Inline in `ProjectPausedState` with a note to resume first | | Pause failed | Dialog via "Download backup" button when no backup is available | | Restore failed | Dialog via "Download backup" button when no backup is available | | Delete project modal | Inline in `DeleteProjectModal` for all plans | Not shown in `PauseDisabledState` (project paused 90+ days, compute stopped — `pg_dump` would fail anyway). ### What the component does - Fetches the project's direct connection settings via `useProjectSettingsV2Query` - Builds a connection URI with a `[YOUR-PASSWORD]` placeholder (password is never stored or displayed) - Shows three shell commands to dump roles, schema, and data separately — mirroring the [logical backup docs](https://supabase.com/docs/guides/platform/backups) - Optionally shows a **Reset database password** button (gated on `UPDATE projects` permission); shown in the paused state, hidden elsewhere via `showResetPassword={false}` - Includes inline guidance to percent-encode special characters in the password ### Shell safety The generated `--db-url` values are wrapped in single quotes to prevent shell metacharacter expansion when users paste and run the commands. `npx supabase login` is intentionally omitted — the `--db-url` flag authenticates directly against Postgres and does not require a Supabase account. ### Backup button behaviour in failed states The "Download backup" button in `PauseFailedState` and `RestoreFailedState` now always stays enabled: - **Backup available** — downloads immediately (unchanged) - **No backup / physical backups** — opens a dialog with CLI instructions instead of silently failing ## How to test **Delete project flow** 1. Open any project → Settings → General → Delete project 2. Verify the CLI backup section appears with the project's host, port, user, and db name pre-filled 3. Verify no Reset database password button is shown **Paused project** 1. Open a paused project (`ProjectPausedState`) — verify CLI instructions appear with the "Your project must be resumed before running these commands." note 2. Open a project paused for 90+ days (`PauseDisabledState`) — verify CLI instructions do not appear **Failed states** 1. Simulate a pause-failed or restore-failed state 2. If a downloadable backup exists — "Download backup" downloads it directly 3. Block the backup API or use a project with physical backups — "Download backup" should open the CLI instructions dialog **Error state** 1. Block the project settings API call (DevTools → Network → block request) 2. Verify an error message appears with a link to Database settings 3. Verify a loading skeleton shows while the request is in flight --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
169 lines
6.5 KiB
TypeScript
169 lines
6.5 KiB
TypeScript
import { PermissionAction, SupportCategories } from '@supabase/shared-types/out/constants'
|
|
import { useParams } from 'common'
|
|
import { Download, MoreVertical, Trash } from 'lucide-react'
|
|
import { useState } from 'react'
|
|
import {
|
|
Button,
|
|
CriticalIcon,
|
|
Dialog,
|
|
DialogContent,
|
|
DialogHeader,
|
|
DialogSection,
|
|
DialogTitle,
|
|
DropdownMenu,
|
|
DropdownMenuContent,
|
|
DropdownMenuTrigger,
|
|
} from 'ui'
|
|
|
|
import { DeleteProjectModal } from '@/components/interfaces/Settings/General/DeleteProjectPanel/DeleteProjectModal'
|
|
import { SupportLink } from '@/components/interfaces/Support/SupportLink'
|
|
import { LogicalBackupCliInstructions } from '@/components/layouts/ProjectLayout/LogicalBackupCliInstructions'
|
|
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
|
|
import { DropdownMenuItemTooltip } from '@/components/ui/DropdownMenuItemTooltip'
|
|
import { InlineLink } from '@/components/ui/InlineLink'
|
|
import { useBackupDownloadMutation } from '@/data/database/backup-download-mutation'
|
|
import { useDownloadableBackupQuery } from '@/data/database/backup-query'
|
|
import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
|
|
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
|
|
|
|
export const PauseFailedState = () => {
|
|
const { ref } = useParams()
|
|
const { data: project } = useSelectedProjectQuery()
|
|
const [visible, setVisible] = useState(false)
|
|
const [showCliBackup, setShowCliBackup] = useState(false)
|
|
|
|
const { can: canDeleteProject } = useAsyncCheckPermissions(PermissionAction.UPDATE, 'projects', {
|
|
resource: { project_id: project?.id },
|
|
})
|
|
|
|
const { data, isPending: isLoadingBackups } = useDownloadableBackupQuery({ projectRef: ref })
|
|
const backups = data?.backups ?? []
|
|
|
|
const { mutate: downloadBackup, isPending: isDownloading } = useBackupDownloadMutation({
|
|
onSuccess: (res) => {
|
|
const { fileUrl } = res
|
|
|
|
// Trigger browser download by create,trigger and remove tempLink
|
|
const tempLink = document.createElement('a')
|
|
tempLink.href = fileUrl
|
|
document.body.appendChild(tempLink)
|
|
tempLink.click()
|
|
document.body.removeChild(tempLink)
|
|
},
|
|
})
|
|
|
|
const onClickDownloadBackup = () => {
|
|
if (!ref) return console.error('Project ref is required')
|
|
if (backups.length === 0 || data?.status === 'physical-backups-enabled')
|
|
return setShowCliBackup(true)
|
|
downloadBackup({ ref, backup: backups[0] })
|
|
}
|
|
|
|
const downloadBackupTooltipText = isLoadingBackups
|
|
? undefined
|
|
: data?.status === 'physical-backups-enabled'
|
|
? 'Project uses physical backups — click to see CLI backup instructions'
|
|
: backups.length === 0
|
|
? 'No downloadable backup available — click to see CLI backup instructions'
|
|
: undefined
|
|
|
|
return (
|
|
<>
|
|
<div className="flex items-center justify-center h-full">
|
|
<div className="bg-surface-100 border border-overlay rounded-md w-3/4 lg:w-1/2">
|
|
<div className="space-y-6 pt-6">
|
|
<div className="flex px-8 space-x-8">
|
|
<div className="mt-1">
|
|
<CriticalIcon className="w-5 h-5" />
|
|
</div>
|
|
<div className="space-y-1">
|
|
<p>Something went wrong while pausing your project</p>
|
|
<p className="text-sm text-foreground-light">
|
|
Your project's data is intact, but your project is inaccessible due to the failure
|
|
while pausing. Database backups for this project can still be accessed{' '}
|
|
<InlineLink href={`/project/${ref}/database/backups/scheduled`}>here</InlineLink>.
|
|
</p>
|
|
<p className="text-sm text-foreground-light">
|
|
Please contact support for assistance.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div className="border-t border-overlay flex items-center justify-end gap-x-2 py-4 px-8">
|
|
<Button asChild type="default">
|
|
<SupportLink
|
|
queryParams={{
|
|
category: SupportCategories.DATABASE_UNRESPONSIVE,
|
|
projectRef: project?.ref,
|
|
subject: 'Pausing failed for project',
|
|
}}
|
|
>
|
|
Contact support
|
|
</SupportLink>
|
|
</Button>
|
|
<ButtonTooltip
|
|
type="default"
|
|
icon={<Download />}
|
|
disabled={isLoadingBackups}
|
|
loading={isDownloading || isLoadingBackups}
|
|
tooltip={{
|
|
content: {
|
|
side: 'bottom',
|
|
text: downloadBackupTooltipText,
|
|
},
|
|
}}
|
|
onClick={onClickDownloadBackup}
|
|
>
|
|
Download backup
|
|
</ButtonTooltip>
|
|
<DropdownMenu>
|
|
<DropdownMenuTrigger>
|
|
<Button type="default" className="px-1.5" icon={<MoreVertical />} />
|
|
</DropdownMenuTrigger>
|
|
<DropdownMenuContent className="w-72" align="end">
|
|
<DropdownMenuItemTooltip
|
|
onClick={() => setVisible(true)}
|
|
className="items-start gap-x-2"
|
|
disabled={!canDeleteProject}
|
|
tooltip={{
|
|
content: {
|
|
side: 'right',
|
|
text: !canDeleteProject
|
|
? 'You need additional permissions to delete this project'
|
|
: undefined,
|
|
},
|
|
}}
|
|
>
|
|
<div className="translate-y-0.5">
|
|
<Trash size={14} />
|
|
</div>
|
|
<div className="">
|
|
<p>Delete project</p>
|
|
<p className="text-foreground-lighter">
|
|
Project cannot be restored once it is deleted
|
|
</p>
|
|
</div>
|
|
</DropdownMenuItemTooltip>
|
|
</DropdownMenuContent>
|
|
</DropdownMenu>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<Dialog open={showCliBackup} onOpenChange={setShowCliBackup}>
|
|
<DialogContent size="medium">
|
|
<DialogHeader>
|
|
<DialogTitle>Back up your database</DialogTitle>
|
|
</DialogHeader>
|
|
<DialogSection>
|
|
<LogicalBackupCliInstructions showResetPassword={false} />
|
|
</DialogSection>
|
|
</DialogContent>
|
|
</Dialog>
|
|
|
|
<DeleteProjectModal visible={visible} onClose={() => setVisible(false)} />
|
|
</>
|
|
)
|
|
}
|