Skip to content

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

feat(studio): update unhealthy project guards (#44855)

kemal.earth5a66d00c5efb
diff --git a/apps/studio/components/interfaces/Settings/General/Infrastructure/PauseProjectButton.tsx b/apps/studio/components/interfaces/Settings/General/Infrastructure/PauseProjectButton.tsx
index b2d812943cd..76b2c30b283 100644
--- a/apps/studio/components/interfaces/Settings/General/Infrastructure/PauseProjectButton.tsx
+++ b/apps/studio/components/interfaces/Settings/General/Infrastructure/PauseProjectButton.tsx
@@ -21,6 +21,7 @@ const PauseProjectButton = () => {
const { setProjectStatus } = useSetProjectStatus()
const isProjectActive = useIsProjectActive()
+ const isProjectUnhealthy = project?.status === PROJECT_STATUS.ACTIVE_UNHEALTHY
const [isModalOpen, setIsModalOpen] = useState(false)
const projectRef = project?.ref ?? ''
@@ -60,6 +61,18 @@ const PauseProjectButton = () => {
!canPauseProject ||
!isProjectActive
+ function getTooltipText() {
+ if (isPaused) return 'Your project is already paused'
+ if (!canPauseProject) return 'You need additional permissions to pause this project'
+ if (isProjectUnhealthy)
+ return 'Your project is unhealthy — restart it instead to restore normal operation'
+ if (!isProjectActive) return 'Unable to pause project as project is not active'
+ if (isBranch) return 'Branch projects cannot be paused'
+ if (!projectPausingAllowedInOrg && !isFreePlan)
+ return 'Projects on a paid plan will always be running'
+ return undefined
+ }
+
return (
<>
<ButtonTooltip
@@ -71,17 +84,7 @@ const PauseProjectButton = () => {
tooltip={{
content: {
side: 'bottom',
- text: isPaused
- ? 'Your project is already paused'
- : !canPauseProject
- ? 'You need additional permissions to pause this project'
- : !isProjectActive
- ? 'Unable to pause project as project is not active'
- : isBranch
- ? 'Branch projects cannot be paused'
- : !projectPausingAllowedInOrg && !isFreePlan
- ? 'Projects on a paid plan will always be running'
- : undefined,
+ text: getTooltipText(),
},
}}
>
diff --git a/apps/studio/components/interfaces/Settings/General/Infrastructure/RestartServerButton.tsx b/apps/studio/components/interfaces/Settings/General/Infrastructure/RestartServerButton.tsx
index 022fc8c4cbb..f6b72a1f691 100644
--- a/apps/studio/components/interfaces/Settings/General/Infrastructure/RestartServerButton.tsx
+++ b/apps/studio/components/interfaces/Settings/General/Infrastructure/RestartServerButton.tsx
@@ -31,6 +31,7 @@ const RestartServerButton = () => {
const router = useRouter()
const { data: project } = useSelectedProjectQuery()
const isProjectActive = useIsProjectActive()
+ const canRestart = isProjectActive || project?.status === PROJECT_STATUS.ACTIVE_UNHEALTHY
const isAwsK8s = useIsAwsK8sCloudProvider()
const { setProjectStatus } = useSetProjectStatus()
@@ -103,12 +104,12 @@ const RestartServerButton = () => {
type="default"
className={cn(
'px-3 hover:z-10',
- canRestartProject && isProjectActive ? 'rounded-r-none' : ''
+ canRestartProject && canRestart ? 'rounded-r-none' : ''
)}
disabled={
project === undefined ||
!canRestartProject ||
- !isProjectActive ||
+ !canRestart ||
projectRestartDisabled ||
isAwsK8s
}
@@ -120,7 +121,7 @@ const RestartServerButton = () => {
? 'Project restart is currently disabled'
: !canRestartProject
? 'You need additional permissions to restart this project'
- : !isProjectActive
+ : !canRestart
? 'Unable to restart project as project is not active'
: isAwsK8s
? 'Project restart is not supported for AWS (Revamped) projects'
@@ -130,7 +131,7 @@ const RestartServerButton = () => {
>
Restart project
</ButtonTooltip>
- {canRestartProject && isProjectActive && !projectRestartDisabled && (
+ {canRestartProject && canRestart && !projectRestartDisabled && (
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button
diff --git a/apps/studio/components/layouts/ProjectLayout/UnhealthyState.tsx b/apps/studio/components/layouts/ProjectLayout/UnhealthyState.tsx
new file mode 100644
index 00000000000..7d9d8c6f7cc
--- /dev/null
+++ b/apps/studio/components/layouts/ProjectLayout/UnhealthyState.tsx
@@ -0,0 +1,97 @@
+import { PermissionAction } from '@supabase/shared-types/out/constants'
+import { useParams } from 'common'
+import { AlertTriangle } from 'lucide-react'
+import { useRouter } from 'next/router'
+import { useState } from 'react'
+import { toast } from 'sonner'
+import { Button } from 'ui'
+import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
+
+import { useProjectDetailQuery, useSetProjectStatus } from '@/data/projects/project-detail-query'
+import { useProjectRestartMutation } from '@/data/projects/project-restart-mutation'
+import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
+import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
+import { PROJECT_STATUS } from '@/lib/constants'
+
+export const UnhealthyState = () => {
+ const router = useRouter()
+ const { ref } = useParams()
+ const { data: project } = useSelectedProjectQuery()
+ const { setProjectStatus } = useSetProjectStatus()
+ const [showConfirm, setShowConfirm] = useState(false)
+
+ const { can: canRestartProject } = useAsyncCheckPermissions(
+ PermissionAction.INFRA_EXECUTE,
+ 'reboot'
+ )
+
+ useProjectDetailQuery(
+ { ref },
+ {
+ // Poll until the project recovers, which will dismiss this guard automatically
+ refetchInterval: (query) => {
+ const data = query.state.data
+ return data?.status === PROJECT_STATUS.ACTIVE_UNHEALTHY ? 4000 : false
+ },
+ }
+ )
+
+ const { mutate: restartProject, isPending: isRestarting } = useProjectRestartMutation({
+ onSuccess: () => {
+ setProjectStatus({ ref: project?.ref ?? '', status: PROJECT_STATUS.RESTARTING })
+ toast.success('Restarting project...')
+ router.push(`/project/${ref}`)
+ },
+ onError: (error) => {
+ toast.error(`Failed to restart project: ${error.message}`)
+ },
+ })
+
+ 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 py-6">
+ <div className="flex px-8 space-x-8">
+ <div className="mt-1">
+ <AlertTriangle className="text-warning" size={18} strokeWidth={1.5} />
+ </div>
+ <div className="flex flex-col gap-3">
+ <div className="space-y-1">
+ <p>Project {project?.name} is unhealthy</p>
+ <p className="text-sm text-foreground-light">
+ Your project is experiencing health issues and is not fully operational.
+ Restarting the project will attempt to restore normal operation.
+ </p>
+ </div>
+ <div>
+ <Button
+ type="default"
+ size="tiny"
+ disabled={!canRestartProject}
+ loading={isRestarting}
+ onClick={() => setShowConfirm(true)}
+ >
+ Restart project
+ </Button>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <ConfirmationModal
+ visible={showConfirm}
+ variant="destructive"
+ title="Restart project"
+ description="Are you sure you want to restart your project? There will be a few minutes of downtime."
+ confirmLabel="Restart"
+ confirmLabelLoading="Restarting"
+ loading={isRestarting}
+ onCancel={() => setShowConfirm(false)}
+ onConfirm={() => restartProject({ ref: ref ?? '' })}
+ />
+ </>
+ )
+}
diff --git a/apps/studio/components/layouts/ProjectLayout/index.tsx b/apps/studio/components/layouts/ProjectLayout/index.tsx
index 67cb820ec9b..615020057be 100644
--- a/apps/studio/components/layouts/ProjectLayout/index.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/index.tsx
@@ -35,6 +35,7 @@ import { ResizingState } from './ResizingState'
import RestartingState from './RestartingState'
import { RestoreFailedState } from './RestoreFailedState'
import { RestoringState } from './RestoringState'
+import { UnhealthyState } from './UnhealthyState'
import { UpgradingState } from './UpgradingState'
import { CreateBranchModal } from '@/components/interfaces/BranchManagement/CreateBranchModal'
import { ProjectAPIDocs } from '@/components/interfaces/ProjectAPIDocs/ProjectAPIDocs'
@@ -358,8 +359,14 @@ const ContentWrapper = ({ isLoading, isBlocking = true, children }: ContentWrapp
selectedProject?.status === PROJECT_STATUS.UNKNOWN
const isProjectPausing = selectedProject?.status === PROJECT_STATUS.PAUSING
const isProjectPauseFailed = selectedProject?.status === PROJECT_STATUS.PAUSE_FAILED
+ const isProjectUnhealthy = selectedProject?.status === PROJECT_STATUS.ACTIVE_UNHEALTHY
const isProjectOffline = selectedProject?.postgrestStatus === 'OFFLINE'
+ const ignoreUnhealthyState =
+ isHomePage ||
+ router.pathname.includes('/project/[ref]/settings') ||
+ router.pathname.includes('/project/[ref]/logs')
+
const shouldRedirectToHomeForBuilding = isProjectBuilding && requiresDbConnection && !isHomePage
// Don't show building state on the home page — it handles building state inline
@@ -399,6 +406,10 @@ const ContentWrapper = ({ isLoading, isBlocking = true, children }: ContentWrapp
return <PauseFailedState />
}
+ if (isProjectUnhealthy && !ignoreUnhealthyState) {
+ return <UnhealthyState />
+ }
+
if (requiresPostgrestConnection && isProjectOffline) {
return <ConnectingState project={selectedProject} />
}