Skip to content

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

feat(studio): map error codes to docs (#43140)

kemal.earth9b028f6fd5fb
diff --git a/apps/studio/components/interfaces/Auth/Overview/OverviewMetrics.tsx b/apps/studio/components/interfaces/Auth/Overview/OverviewMetrics.tsx
index a4e7b33dd3a..d9619760498 100644
--- a/apps/studio/components/interfaces/Auth/Overview/OverviewMetrics.tsx
+++ b/apps/studio/components/interfaces/Auth/Overview/OverviewMetrics.tsx
@@ -41,6 +41,8 @@ import {
getMetricValues,
} from './OverviewUsage.constants'
import { getStatusColor } from 'components/ui/DataTable/DataTable.utils'
+import { ErrorCodeTooltip } from '../../Settings/Logs/ErrorCodeTooltip'
+import { Service } from 'data/graphql/graphql'
import { AiIconAnimation } from 'ui'
import { SIDEBAR_KEYS } from 'components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
import { useAiAssistantStateSnapshot } from 'state/ai-assistant-state'
@@ -398,9 +400,11 @@ export const OverviewMetrics = ({ metrics, isLoading, error }: OverviewMetricsPr
header: 'Error code',
className: 'w-full',
render: (row) => (
- <span className="line-clamp-1 font-mono uppercase text-xs inline-flex text-foreground-light">
- {row.error_code}
- </span>
+ <ErrorCodeTooltip errorCode={row.error_code} service={Service.Auth}>
+ <span className="line-clamp-1 font-mono uppercase text-xs inline-flex text-foreground-light cursor-default">
+ {row.error_code}
+ </span>
+ </ErrorCodeTooltip>
),
},
{
diff --git a/apps/studio/components/interfaces/Settings/Logs/ErrorCodeTooltip.tsx b/apps/studio/components/interfaces/Settings/Logs/ErrorCodeTooltip.tsx
new file mode 100644
index 00000000000..3cb4bb0766b
--- /dev/null
+++ b/apps/studio/components/interfaces/Settings/Logs/ErrorCodeTooltip.tsx
@@ -0,0 +1,144 @@
+import Image from 'next/image'
+import Link from 'next/link'
+import { useState } from 'react'
+import { useTheme } from 'next-themes'
+import { ExternalLink } from 'lucide-react'
+
+import { useErrorCodesQuery } from 'data/content-api/docs-error-codes-query'
+import { Service } from 'data/graphql/graphql'
+import { BASE_PATH } from 'lib/constants'
+import { SIDEBAR_KEYS } from 'components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
+import { AiAssistantDropdown } from 'components/ui/AiAssistantDropdown'
+import { useAiAssistantStateSnapshot } from 'state/ai-assistant-state'
+import { useSidebarManagerSnapshot } from 'state/sidebar-manager-state'
+import {
+ cn,
+ DropdownMenuItem,
+ DropdownMenuSeparator,
+ HoverCard_Shadcn_,
+ HoverCardContent_Shadcn_,
+ HoverCardTrigger_Shadcn_,
+ InfoIcon,
+} from 'ui'
+import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
+
+const SERVICE_DOCS_URLS: Partial<Record<Service, string>> = {
+ [Service.Auth]: 'https://supabase.com/docs/guides/auth/debugging/error-codes',
+}
+
+interface ErrorCodeTooltipProps {
+ errorCode: string
+ service?: Service
+ children: React.ReactNode
+}
+
+export const ErrorCodeTooltip = ({ errorCode, service, children }: ErrorCodeTooltipProps) => {
+ const [isOpen, setIsOpen] = useState(false)
+ const { resolvedTheme } = useTheme()
+ const snap = useAiAssistantStateSnapshot()
+ const { openSidebar } = useSidebarManagerSnapshot()
+
+ const { data, isPending } = useErrorCodesQuery({ code: errorCode, service }, { enabled: isOpen })
+
+ const errors = data?.errors?.nodes?.filter((e) => !!e.message) ?? []
+
+ const docsUrl =
+ errors.map((e) => SERVICE_DOCS_URLS[e.service]).find(Boolean) ??
+ (service ? SERVICE_DOCS_URLS[service] : undefined)
+
+ const buildPrompt = () => {
+ const description = errors[0]?.message
+ const servicePart = service ? ` in Supabase ${service}` : ''
+ const descriptionPart = description ? `\n\nError description: ${description}` : ''
+ return `I'm encountering error code \`${errorCode}\`${servicePart}.${descriptionPart}\n\nCan you explain what this error means and suggest steps to fix it?`
+ }
+
+ const handleOpenAssistant = () => {
+ openSidebar(SIDEBAR_KEYS.AI_ASSISTANT)
+ snap.newChat({
+ name: `Fix error ${errorCode}`,
+ initialMessage: buildPrompt(),
+ })
+ }
+
+ return (
+ <HoverCard_Shadcn_ open={isOpen} onOpenChange={setIsOpen} openDelay={200} closeDelay={100}>
+ <HoverCardTrigger_Shadcn_ asChild>
+ <span className="inline-flex items-center gap-1 cursor-default">
+ {children}
+ <InfoIcon hideBackground className="w-3.5 h-3.5 shrink-0 fill-foreground-muted" />
+ </span>
+ </HoverCardTrigger_Shadcn_>
+ <HoverCardContent_Shadcn_ side="top" align="center" className="w-[360px] p-0 overflow-hidden">
+ <div className="flex flex-col">
+ <div className="px-4 pt-3 pb-2.5 border-b border-border">
+ <p className="font-mono text-xs uppercase text-foreground-light truncate max-w-[40ch]">
+ {errorCode}
+ </p>
+ </div>
+
+ <div className="px-4 py-3 space-y-2">
+ {isPending ? (
+ <div className="space-y-1.5">
+ <ShimmeringLoader className="w-full" />
+ <ShimmeringLoader className="w-4/5" />
+ <ShimmeringLoader className="w-3/5" />
+ </div>
+ ) : errors.length === 0 ? (
+ <p className="text-sm text-foreground-lighter">
+ No description available for this error code.
+ </p>
+ ) : (
+ <p className="text-sm text-foreground leading-relaxed">{errors[0].message}</p>
+ )}
+ </div>
+
+ <div
+ className={cn(
+ 'border-t border-border px-4 py-2.5 flex items-center',
+ docsUrl ? 'justify-between' : 'justify-end'
+ )}
+ >
+ {docsUrl && (
+ <div className="flex items-center gap-1.5">
+ <Image
+ src={
+ resolvedTheme?.includes('dark')
+ ? `${BASE_PATH}/img/supabase-dark.svg`
+ : `${BASE_PATH}/img/supabase-light.svg`
+ }
+ alt="Supabase"
+ height={14}
+ width={72}
+ />
+ <span className="font-mono text-[11px] font-semibold text-brand tracking-wide">
+ DOCS
+ </span>
+ </div>
+ )}
+ <AiAssistantDropdown
+ label="Fix with AI"
+ buildPrompt={buildPrompt}
+ onOpenAssistant={handleOpenAssistant}
+ copyLabel="Copy Markdown"
+ showExternalAI
+ extraDropdownItems={
+ docsUrl ? (
+ <>
+ <DropdownMenuItem asChild className="gap-2">
+ <Link href={docsUrl} target="_blank" rel="noreferrer">
+ <ExternalLink size={14} />
+ Go to Docs
+ </Link>
+ </DropdownMenuItem>
+ <DropdownMenuSeparator />
+ </>
+ ) : undefined
+ }
+ />
+ </div>
+ </div>
+ </HoverCardContent_Shadcn_>
+ </HoverCard_Shadcn_>
+ )
+}
diff --git a/apps/studio/components/interfaces/Settings/Logs/LogColumnRenderers/DatabaseApiColumnRender.tsx b/apps/studio/components/interfaces/Settings/Logs/LogColumnRenderers/DatabaseApiColumnRender.tsx
index 9f3b12f0a6f..36b5331e6c4 100644
--- a/apps/studio/components/interfaces/Settings/Logs/LogColumnRenderers/DatabaseApiColumnRender.tsx
+++ b/apps/studio/components/interfaces/Settings/Logs/LogColumnRenderers/DatabaseApiColumnRender.tsx
@@ -1,8 +1,10 @@
import { Column } from 'react-data-grid'
+import { Service } from 'data/graphql/graphql'
import type { LogData } from '../Logs.types'
import { ResponseCodeFormatter, RowLayout, TextFormatter } from '../LogsFormatters'
import { defaultRenderCell } from './DefaultPreviewColumnRenderer'
import { TimestampInfo } from 'ui-patterns/TimestampInfo'
+import { ErrorCodeTooltip } from '../ErrorCodeTooltip'
const columns: Column<LogData>[] = [
{
@@ -13,12 +15,24 @@ const columns: Column<LogData>[] = [
if (!props.row.status_code && !props.row.method && !props.row.path) {
return defaultRenderCell(props)
}
+ const error_code = props.row.metadata?.[0]?.response?.[0]?.headers?.[0]?.x_sb_error_code
+ const service =
+ typeof props.row.path === 'string' && props.row.path.startsWith('/auth/')
+ ? Service.Auth
+ : undefined
return (
<RowLayout>
<TimestampInfo utcTimestamp={props.row.timestamp!} />
<ResponseCodeFormatter value={String(props.row.status_code)} />
<TextFormatter value={String(props.row.method)} />
<TextFormatter value={String(props.row.path)} />
+ {error_code && (
+ <ErrorCodeTooltip errorCode={String(error_code)} service={service}>
+ <span className="font-mono text-xs text-destructive-600 truncate shrink-0">
+ {error_code}
+ </span>
+ </ErrorCodeTooltip>
+ )}
</RowLayout>
)
},
diff --git a/apps/studio/components/interfaces/Settings/Logs/LogSelectionRenderers/DefaultPreviewSelectionRenderer.tsx b/apps/studio/components/interfaces/Settings/Logs/LogSelectionRenderers/DefaultPreviewSelectionRenderer.tsx
index bebee70eaf2..8bab271b1c0 100644
--- a/apps/studio/components/interfaces/Settings/Logs/LogSelectionRenderers/DefaultPreviewSelectionRenderer.tsx
+++ b/apps/studio/components/interfaces/Settings/Logs/LogSelectionRenderers/DefaultPreviewSelectionRenderer.tsx
@@ -15,6 +15,7 @@ import {
import { TimestampInfo } from 'ui-patterns'
import { ErrorCodeDialog } from '../ErrorCodeDialog'
+import { ErrorCodeTooltip } from '../ErrorCodeTooltip'
import type { LogSearchCallback, PreviewLogData } from '../Logs.types'
import { ResponseCodeFormatter } from '../LogsFormatters'
@@ -60,6 +61,7 @@ const PropertyRow = ({
const isUserAgent = keyName === 'user_agent'
const isEventMessage = keyName === 'event_message'
const isPath = keyName === 'path'
+ const isErrorCode = keyName === 'error_code'
function getSearchPairs() {
if (isSearch && typeof value === 'string') {
@@ -163,6 +165,10 @@ const PropertyRow = ({
<div className="flex items-center gap-1 justify-end">
<ResponseCodeFormatter value={value} />
</div>
+ ) : isErrorCode ? (
+ <ErrorCodeTooltip errorCode={String(value)} service={service}>
+ <div className="truncate">{value}</div>
+ </ErrorCodeTooltip>
) : (
<div className="truncate">{value}</div>
)}
diff --git a/apps/studio/components/interfaces/UnifiedLogs/components/Columns.tsx b/apps/studio/components/interfaces/UnifiedLogs/components/Columns.tsx
index 421bcd8935e..64e0e756627 100644
--- a/apps/studio/components/interfaces/UnifiedLogs/components/Columns.tsx
+++ b/apps/studio/components/interfaces/UnifiedLogs/components/Columns.tsx
@@ -5,6 +5,7 @@ import { DataTableColumnLevelIndicator } from 'components/ui/DataTable/DataTable
import { DataTableColumnStatusCode } from 'components/ui/DataTable/DataTableColumn/DataTableColumnStatusCode'
import { Tooltip, TooltipContent, TooltipTrigger } from 'ui'
import { ColumnFilterSchema, ColumnSchema } from '../UnifiedLogs.schema'
+import { STATUS_CODE_LABELS } from '../UnifiedLogs.constants'
import { AuthUserHoverCard } from './AuthUserHoverCard'
import { HoverCardTimestamp } from './HoverCardTimestamp'
import { LogTypeIcon } from './LogTypeIcon'
@@ -109,6 +110,11 @@ export function generateDynamicColumns(data: ColumnSchema[]): {
header: '',
cell: ({ row }) => {
const value = row.getValue<ColumnSchema['status']>('status')
+ const label =
+ value != null
+ ? STATUS_CODE_LABELS[String(value) as keyof typeof STATUS_CODE_LABELS] ??
+ 'Unknown status'
+ : null
return (
<div className="flex items-center gap-1">
{/* {row.original.auth_user && (
@@ -117,10 +123,24 @@ export function generateDynamicColumns(data: ColumnSchema[]): {
<AuthUserHoverCard authUser={row.original.auth_user} />
</div>
)} */}
- <DataTableColumnStatusCode
- value={value}
- level={row.getValue<ColumnSchema['level']>('level')}
- />
+ {label ? (
+ <Tooltip>
+ <TooltipTrigger asChild>
+ <span>
+ <DataTableColumnStatusCode
+ value={value}
+ level={row.getValue<ColumnSchema['level']>('level')}
+ />
+ </span>
+ </TooltipTrigger>
+ <TooltipContent>{label}</TooltipContent>
+ </Tooltip>
+ ) : (
+ <DataTableColumnStatusCode
+ value={value}
+ level={row.getValue<ColumnSchema['level']>('level')}
+ />
+ )}
</div>
)
},
diff --git a/apps/studio/components/ui/AiAssistantDropdown.tsx b/apps/studio/components/ui/AiAssistantDropdown.tsx
index 84e17b0e396..009d83d6ba8 100644
--- a/apps/studio/components/ui/AiAssistantDropdown.tsx
+++ b/apps/studio/components/ui/AiAssistantDropdown.tsx
@@ -1,6 +1,9 @@
import { AiPromptCopiedEvent } from 'common/telemetry-constants'
+import { BASE_PATH } from 'lib/constants'
import { useTrack } from 'lib/telemetry/track'
import { Check, ChevronDown, Copy } from 'lucide-react'
+import { useTheme } from 'next-themes'
+import Image from 'next/image'
import { ComponentProps, ReactNode, useEffect, useState } from 'react'
import {
AiIconAnimation,
@@ -19,6 +22,24 @@ import {
type TelemetrySource = AiPromptCopiedEvent['properties']['source']
+const EXTERNAL_AI_TOOLS = [
+ {
+ label: 'Open in ChatGPT',
+ url: 'https://chatgpt.com/',
+ promptParam: 'q',
+ icon: {
+ light: '/img/mcp-clients/openai-icon.svg',
+ dark: '/img/mcp-clients/openai-icon-dark.svg',
+ },
+ },
+ {
+ label: 'Open in Claude.ai',
+ url: 'https://claude.ai/new',
+ promptParam: 'q',
+ icon: { light: '/img/mcp-clients/claude-icon.svg', dark: '/img/mcp-clients/claude-icon.svg' },
+ },
+]
+
export interface AiAssistantDropdownItem {
label: string
icon?: ReactNode
@@ -37,6 +58,9 @@ export interface AiAssistantDropdownProps {
loading?: boolean
className?: string
tooltip?: string
+ copyLabel?: string
+ showExternalAI?: boolean
+ extraDropdownItems?: ReactNode
additionalDropdownItems?: AiAssistantDropdownItem[]
}
@@ -52,9 +76,13 @@ export function AiAssistantDropdown({
loading = false,
className,
tooltip,
+ copyLabel = 'Copy prompt',
+ showExternalAI = false,
+ extraDropdownItems,
additionalDropdownItems,
}: AiAssistantDropdownProps) {
const track = useTrack()
+ const { resolvedTheme } = useTheme()
const [showCopied, setShowCopied] = useState(false)
const [isOpen, setIsOpen] = useState(false)
@@ -75,6 +103,15 @@ export function AiAssistantDropdown({
}
}
+ const handleOpenExternalAI = (tool: (typeof EXTERNAL_AI_TOOLS)[number]) => {
+ const prompt = buildPrompt()
+ window.open(
+ `${tool.url}?${tool.promptParam}=${encodeURIComponent(prompt)}`,
+ '_blank',
+ 'noreferrer'
+ )
+ }
+
const handleOpenAssistant = () => {
onOpenAssistant()
}
@@ -105,10 +142,31 @@ export function AiAssistantDropdown({
/>
</DropdownMenuTrigger>
<DropdownMenuContent align="end" className="w-44">
+ {extraDropdownItems}
<DropdownMenuItem onClick={handleCopyPrompt} className="gap-2">
{showCopied ? <Check size={14} className="text-brand" /> : <Copy size={14} />}
- {showCopied ? 'Copied!' : 'Copy prompt'}
+ {showCopied ? 'Copied!' : copyLabel}
</DropdownMenuItem>
+ {showExternalAI && (
+ <>
+ <DropdownMenuSeparator />
+ {EXTERNAL_AI_TOOLS.map((tool) => (
+ <DropdownMenuItem
+ key={tool.url}
+ className="gap-2"
+ onClick={() => handleOpenExternalAI(tool)}
+ >
+ <Image
+ src={`${BASE_PATH}${resolvedTheme?.includes('dark') ? tool.icon.dark : tool.icon.light}`}
+ alt={tool.label}
+ width={14}
+ height={14}
+ />
+ {tool.label}
+ </DropdownMenuItem>
+ ))}
+ </>
+ )}
{additionalDropdownItems && additionalDropdownItems.length > 0 && (
<>
<DropdownMenuSeparator />
diff --git a/apps/studio/data/content-api/docs-error-codes-query.ts b/apps/studio/data/content-api/docs-error-codes-query.ts
index 878c7beef26..21dec4f800e 100644
--- a/apps/studio/data/content-api/docs-error-codes-query.ts
+++ b/apps/studio/data/content-api/docs-error-codes-query.ts
@@ -40,6 +40,8 @@ export const useErrorCodesQuery = <TData = ErrorCodeDescriptionsData>(
queryKey: contentApiKeys.errorCodes(variables),
queryFn: ({ signal }) => getErrorCodeDescriptions(variables, signal),
enabled,
+ retry: false,
+ staleTime: Infinity,
...options,
})
}
diff --git a/apps/studio/data/graphql/execute.ts b/apps/studio/data/graphql/execute.ts
index 3305e1ba5d6..58230278163 100644
--- a/apps/studio/data/graphql/execute.ts
+++ b/apps/studio/data/graphql/execute.ts
@@ -1,14 +1,12 @@
import { handleError } from 'data/fetchers'
import type { TypedDocumentString } from './graphql'
-const CONTENT_API_URL = process.env.NEXT_PUBLIC_CONTENT_API_URL!
-
export async function executeGraphQL<TResult, TVariables>(
query: TypedDocumentString<TResult, TVariables>,
{ variables, signal }: { variables?: TVariables; signal?: AbortSignal }
) {
try {
- const response = await fetch(CONTENT_API_URL, {
+ const response = await fetch('/api/content/graphql', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
diff --git a/apps/studio/pages/api/content/graphql.ts b/apps/studio/pages/api/content/graphql.ts
new file mode 100644
index 00000000000..a053ad28715
--- /dev/null
+++ b/apps/studio/pages/api/content/graphql.ts
@@ -0,0 +1,26 @@
+import { NextApiRequest, NextApiResponse } from 'next'
+
+const CONTENT_API_URL = process.env.NEXT_PUBLIC_CONTENT_API_URL!
+
+// Default export needed by Next.js convention
+// eslint-disable-next-line no-restricted-exports
+export default async function handler(req: NextApiRequest, res: NextApiResponse) {
+ if (req.method !== 'POST') {
+ res.setHeader('Allow', ['POST'])
+ return res.status(405).json({ error: `Method ${req.method} Not Allowed` })
+ }
+
+ try {
+ const response = await fetch(CONTENT_API_URL, {
+ method: 'POST',
+ headers: { 'Content-Type': 'application/json' },
+ body: JSON.stringify(req.body),
+ })
+
+ const data = await response.json()
+ return res.status(response.status).json(data)
+ } catch (error) {
+ console.error('Content API proxy error:', error)
+ return res.status(500).json({ error: 'Failed to reach Content API' })
+ }
+}
diff --git a/apps/studio/proxy.ts b/apps/studio/proxy.ts
index 27c941fb1c1..d19ef58baf7 100644
--- a/apps/studio/proxy.ts
+++ b/apps/studio/proxy.ts
@@ -26,6 +26,7 @@ const HOSTED_SUPPORTED_API_URLS = [
'/generate-attachment-url',
'/incident-status',
'/api/integrations/stripe-sync',
+ '/content/graphql',
]
export function proxy(request: NextRequest) {