Skip to content

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

feat(dev-tools): add resource warnings tab to dev toolbar (#44857)

Jordi Enric1545df1fe60b
diff --git a/apps/studio/components/ui/DevToolbar/ResourceWarningsTab.tsx b/apps/studio/components/ui/DevToolbar/ResourceWarningsTab.tsx
new file mode 100644
index 00000000000..87ca4951cf1
--- /dev/null
+++ b/apps/studio/components/ui/DevToolbar/ResourceWarningsTab.tsx
@@ -0,0 +1,232 @@
+'use client'
+
+import { useQueryClient } from '@tanstack/react-query'
+import { useParams } from 'common'
+import { useEffect, useRef, useState } from 'react'
+import { cn } from 'ui'
+
+import { usageKeys } from '@/data/usage/keys'
+import type { ResourceWarning } from '@/data/usage/resource-warnings-query'
+import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
+
+type Severity = 'warning' | 'critical' | null
+
+const WARNING_TYPES = [
+ { key: 'disk_io_exhaustion', label: 'Disk IO', hasCritical: true },
+ { key: 'cpu_exhaustion', label: 'CPU', hasCritical: true },
+ { key: 'memory_and_swap_exhaustion', label: 'Memory & Swap', hasCritical: true },
+ { key: 'disk_space_exhaustion', label: 'Disk Space', hasCritical: true },
+ { key: 'auth_rate_limit_exhaustion', label: 'Auth Rate Limit', hasCritical: false },
+] as const
+
+type WarningKey = (typeof WARNING_TYPES)[number]['key']
+type WarningState = Record<WarningKey, Severity>
+
+const INITIAL_STATE: WarningState = {
+ disk_io_exhaustion: null,
+ cpu_exhaustion: null,
+ memory_and_swap_exhaustion: null,
+ disk_space_exhaustion: null,
+ auth_rate_limit_exhaustion: null,
+}
+
+export const ResourceWarningsTab = () => {
+ const { ref } = useParams()
+ const queryClient = useQueryClient()
+ const { data: selectedOrg, isLoading: isOrgLoading } = useSelectedOrganizationQuery()
+ const orgSlug = selectedOrg?.slug
+ const [isReadOnly, setIsReadOnly] = useState(false)
+ const [severities, setSeverities] = useState<WarningState>(INITIAL_STATE)
+
+ // Track latest ref/orgSlug so the unmount cleanup always invalidates the
+ // correct cache keys, even when orgSlug was still loading at mount time.
+ const latestValues = useRef({ ref, orgSlug })
+ useEffect(() => {
+ latestValues.current = { ref, orgSlug }
+ })
+
+ // Only invalidate on unmount if overrides were actually applied to avoid
+ // unnecessary refetches when the user opens the toolbar but never uses
+ // the Warnings tab.
+ const hasOverridesRef = useRef(false)
+
+ // Invalidate both cache keys on unmount so banners revert to real data
+ // when the toolbar sheet closes (which unmounts this component).
+ useEffect(() => {
+ return () => {
+ if (!hasOverridesRef.current) return
+ const { ref: latestRef, orgSlug: latestOrgSlug } = latestValues.current
+ queryClient.invalidateQueries({ queryKey: usageKeys.resourceWarnings(undefined, latestRef) })
+ if (latestOrgSlug) {
+ queryClient.invalidateQueries({
+ queryKey: usageKeys.resourceWarnings(latestOrgSlug, undefined),
+ })
+ }
+ }
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, [])
+
+ // When navigating to a different project: reset UI state and invalidate the
+ // departing project's cache keys (the cleanup closure captures the old ref).
+ // This component never unmounts during client-side navigation, so without
+ // this project A's mocked banners would linger on project B.
+ useEffect(() => {
+ return () => {
+ if (!hasOverridesRef.current) return
+ queryClient.invalidateQueries({ queryKey: usageKeys.resourceWarnings(undefined, ref) })
+ const { orgSlug: currentOrgSlug } = latestValues.current
+ if (currentOrgSlug) {
+ queryClient.invalidateQueries({
+ queryKey: usageKeys.resourceWarnings(currentOrgSlug, undefined),
+ })
+ }
+ setSeverities(INITIAL_STATE)
+ setIsReadOnly(false)
+ hasOverridesRef.current = false
+ }
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, [ref])
+
+ const applyOverrides = (nextSeverities: WarningState, nextIsReadOnly: boolean) => {
+ if (!orgSlug || !ref) return
+ const mockWarning: ResourceWarning = {
+ project: ref,
+ is_readonly_mode_enabled: nextIsReadOnly,
+ ...nextSeverities,
+ auth_email_offender: null,
+ auth_restricted_email_sending: null,
+ need_pitr: null,
+ }
+ // Write to both cache keys: ref-based (ResourceExhaustionWarningBanner) and
+ // slug-based (ProjectLayout, TopSection, ProjectList) consumers.
+ queryClient.setQueryData(usageKeys.resourceWarnings(undefined, ref), [mockWarning])
+ queryClient.setQueryData(usageKeys.resourceWarnings(orgSlug, undefined), [mockWarning])
+ hasOverridesRef.current = true
+ }
+
+ const handleSeverityChange = (key: WarningKey, value: Severity) => {
+ const next = { ...severities, [key]: value }
+ setSeverities(next)
+ applyOverrides(next, isReadOnly)
+ }
+
+ const handleReadOnlyChange = (value: boolean) => {
+ setIsReadOnly(value)
+ applyOverrides(severities, value)
+ }
+
+ const handleReset = () => {
+ setSeverities(INITIAL_STATE)
+ setIsReadOnly(false)
+ hasOverridesRef.current = false
+ queryClient.invalidateQueries({ queryKey: usageKeys.resourceWarnings(undefined, ref) })
+ if (orgSlug) {
+ queryClient.invalidateQueries({ queryKey: usageKeys.resourceWarnings(orgSlug, undefined) })
+ }
+ }
+
+ // Disabled when org is loading, org slug is unavailable, or we're not on a
+ // project page (ref is undefined on org-level pages like /org/[slug]/settings).
+ const isDisabled = isOrgLoading || !orgSlug || !ref
+
+ return (
+ <div className="p-6 space-y-4">
+ <div className="flex items-center justify-between">
+ <p className="text-sm text-foreground-light">
+ Override resource warning banners for the current project.
+ </p>
+ <button
+ onClick={handleReset}
+ disabled={isDisabled}
+ className="text-xs text-foreground-lighter hover:text-foreground transition underline disabled:opacity-50 disabled:cursor-not-allowed"
+ >
+ Reset to real data
+ </button>
+ </div>
+
+ {isDisabled && (
+ <p className="text-xs text-foreground-muted">
+ {!ref ? 'Navigate to a project page to use this tab.' : 'Loading org context...'}
+ </p>
+ )}
+
+ <div className={cn('space-y-3', isDisabled && 'opacity-50 pointer-events-none')}>
+ <div className="flex items-center justify-between py-2 border-b border-overlay">
+ <span className="text-sm font-medium">Read-only mode</span>
+ <div className="flex gap-1">
+ <SeverityButton
+ active={!isReadOnly}
+ variant="off"
+ onClick={() => handleReadOnlyChange(false)}
+ >
+ Off
+ </SeverityButton>
+ <SeverityButton
+ active={isReadOnly}
+ variant="critical"
+ onClick={() => handleReadOnlyChange(true)}
+ >
+ On
+ </SeverityButton>
+ </div>
+ </div>
+
+ {WARNING_TYPES.map(({ key, label, hasCritical }) => (
+ <div key={key} className="flex items-center justify-between">
+ <span className="text-sm text-foreground-light">{label}</span>
+ <div className="flex gap-1">
+ <SeverityButton
+ active={severities[key] === null}
+ variant="off"
+ onClick={() => handleSeverityChange(key, null)}
+ >
+ Off
+ </SeverityButton>
+ <SeverityButton
+ active={severities[key] === 'warning'}
+ variant="warning"
+ onClick={() => handleSeverityChange(key, 'warning')}
+ >
+ Warn
+ </SeverityButton>
+ {hasCritical && (
+ <SeverityButton
+ active={severities[key] === 'critical'}
+ variant="critical"
+ onClick={() => handleSeverityChange(key, 'critical')}
+ >
+ Crit
+ </SeverityButton>
+ )}
+ </div>
+ </div>
+ ))}
+ </div>
+ </div>
+ )
+}
+
+interface SeverityButtonProps {
+ active: boolean
+ variant: 'off' | 'warning' | 'critical'
+ onClick: () => void
+ children: React.ReactNode
+}
+
+const SeverityButton = ({ active, variant, onClick, children }: SeverityButtonProps) => (
+ <button
+ onClick={onClick}
+ className={cn(
+ 'px-1.5 py-0.5 rounded text-xs font-mono transition border',
+ active
+ ? variant === 'off'
+ ? 'bg-surface-300 text-foreground border-strong'
+ : variant === 'warning'
+ ? 'bg-warning/20 text-warning border-warning'
+ : 'bg-destructive/20 text-destructive border-destructive'
+ : 'bg-transparent text-foreground-muted border-transparent hover:border-border'
+ )}
+ >
+ {children}
+ </button>
+)
diff --git a/apps/studio/pages/_app.tsx b/apps/studio/pages/_app.tsx
index bbbf975b556..d753533394f 100644
--- a/apps/studio/pages/_app.tsx
+++ b/apps/studio/pages/_app.tsx
@@ -36,7 +36,8 @@ import duration from 'dayjs/plugin/duration'
import relativeTime from 'dayjs/plugin/relativeTime'
import timezone from 'dayjs/plugin/timezone'
import utc from 'dayjs/plugin/utc'
-import { DevToolbar, DevToolbarProvider, DevToolbarTrigger } from 'dev-tools'
+import { DevToolbar, DevToolbarProvider, DevToolbarTrigger, type ExtraTab } from 'dev-tools'
+import dynamic from 'next/dynamic'
import Head from 'next/head'
import { NuqsAdapter } from 'nuqs/adapters/next/pages'
import { ErrorInfo, useCallback, type ComponentProps } from 'react'
@@ -70,6 +71,20 @@ dayjs.extend(timezone)
dayjs.extend(relativeTime)
dayjs.extend(duration)
+// Keep dev-only components out of the production bundle
+const env = process.env.NEXT_PUBLIC_ENVIRONMENT
+const IS_DEV_TOOLBAR_ENABLED = env === 'local' || env === 'staging'
+
+const ResourceWarningsTab = IS_DEV_TOOLBAR_ENABLED
+ ? dynamic(() =>
+ import('@/components/ui/DevToolbar/ResourceWarningsTab').then((m) => m.ResourceWarningsTab)
+ )
+ : () => null
+
+const devToolbarExtraTabs: ExtraTab[] = IS_DEV_TOOLBAR_ENABLED
+ ? [{ id: 'warnings', label: 'Warnings', content: <ResourceWarningsTab /> }]
+ : []
+
const FeatureFlagProviderWithOrgContext = ({
children,
...props
@@ -190,7 +205,7 @@ function CustomApp({ Component, pageProps }: AppPropsWithLayout) {
<MonacoThemeProvider />
</CommandProvider>
</AiAssistantStateContextProvider>
- <DevToolbar />
+ <DevToolbar extraTabs={devToolbarExtraTabs} />
<DevToolbarTrigger />
</DevToolbarProvider>
</ThemeProvider>
diff --git a/packages/dev-tools/DevToolbar.tsx b/packages/dev-tools/DevToolbar.tsx
index 1a57be0399b..cede199d9fd 100644
--- a/packages/dev-tools/DevToolbar.tsx
+++ b/packages/dev-tools/DevToolbar.tsx
@@ -32,7 +32,7 @@ import {
} from 'ui'
import { useDevToolbar } from './DevToolbarContext'
-import type { DevTelemetryEvent } from './types'
+import type { DevTelemetryEvent, ExtraTab } from './types'
import {
CC_ORIGINALS_KEY,
deleteCookie,
@@ -204,7 +204,7 @@ function FlagRow({
)
}
-export function DevToolbar() {
+export function DevToolbar({ extraTabs = [] }: { extraTabs?: ExtraTab[] }) {
const { isEnabled, isOpen, setIsOpen, events, setEvents, dismissToolbar } = useDevToolbar()
const [activeTab, setActiveTab] = useState<string>('events')
const [flagsSubTab, setFlagsSubTab] = useState<'posthog' | 'configcat'>('posthog')
@@ -398,6 +398,15 @@ export function DevToolbar() {
>
Flags {totalOverrideCount > 0 && `(${totalOverrideCount})`}
</TabsTrigger>
+ {extraTabs.map((tab) => (
+ <TabsTrigger
+ key={tab.id}
+ value={tab.id}
+ className="text-xs py-3 border-b-[1px] font-mono uppercase"
+ >
+ {tab.label}
+ </TabsTrigger>
+ ))}
</TabsList>
<div className="ml-auto flex items-center gap-2">
<Tooltip>
@@ -553,6 +562,15 @@ export function DevToolbar() {
</div>
</div>
)}
+
+ {extraTabs.map((tab) => (
+ <div
+ key={tab.id}
+ className={cn('flex-1 min-h-0 overflow-y-auto', activeTab !== tab.id && 'hidden')}
+ >
+ {tab.content}
+ </div>
+ ))}
</div>
</Tabs>
</SheetContent>
diff --git a/packages/dev-tools/index.ts b/packages/dev-tools/index.ts
index ff32f4a13ff..e084b3902e3 100644
--- a/packages/dev-tools/index.ts
+++ b/packages/dev-tools/index.ts
@@ -31,10 +31,12 @@ export const useDevToolbar = !isToolbarEnabled
? () => noopContext
: DevToolbarContextModule.useDevToolbar
-export const DevToolbar = !isToolbarEnabled ? () => null : DevToolbarModule.DevToolbar
+export const DevToolbar = !isToolbarEnabled
+ ? (_props: { extraTabs?: import('./types').ExtraTab[] }) => null
+ : DevToolbarModule.DevToolbar
export const DevToolbarTrigger = !isToolbarEnabled
? () => null
: DevToolbarTriggerModule.DevToolbarTrigger
-export type { DevTelemetryEvent, DevToolbarConfig } from './types'
+export type { DevTelemetryEvent, DevToolbarConfig, ExtraTab } from './types'
diff --git a/packages/dev-tools/types.ts b/packages/dev-tools/types.ts
index a55dffe3933..87afb1a0abe 100644
--- a/packages/dev-tools/types.ts
+++ b/packages/dev-tools/types.ts
@@ -1,4 +1,4 @@
-import type { Dispatch, SetStateAction } from 'react'
+import type { Dispatch, ReactNode, SetStateAction } from 'react'
export interface DevTelemetryEvent {
id: string
@@ -25,6 +25,12 @@ export interface DevToolbarConfig {
apiUrl: string
}
+export interface ExtraTab {
+ id: string
+ label: string
+ content: ReactNode
+}
+
export interface DevTelemetryToolbarContextType {
isEnabled: boolean
isOpen: boolean