The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
[FE-3034] feat(studio): render multi-line SQL error HINTs (#45038)
Alaister Young45fc6094711d
diff --git a/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.tsx b/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.tsxindex e6832c34abf..4dd9ab97572 100644--- a/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.tsx+++ b/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.tsx@@ -5,6 +5,7 @@ import { forwardRef } from 'react'import { Button, cn, Tooltip, TooltipContent, TooltipTrigger } from 'ui'import Results from './Results'+import { getSqlErrorLines } from './UtilityTabResults.utils'import { subscriptionHasHipaaAddon } from '@/components/interfaces/Billing/Subscription/Subscription.utils'import { AiAssistantDropdown } from '@/components/ui/AiAssistantDropdown'import CopyButton from '@/components/ui/CopyButton'@@ -55,9 +56,7 @@ const UtilityTabResults = forwardRef<HTMLDivElement, UtilityTabResultsProps>(</div>)} else if (result?.error) {- const formattedError = (result.error?.formattedError?.split('\n') ?? []).filter(- (x: string) => x.length > 0- )+ const errorLines = getSqlErrorLines(result.error)const readReplicaError =state.selectedDatabaseId !== ref &&result.error.message.includes('in a read-only transaction')@@ -96,8 +95,8 @@ const UtilityTabResults = forwardRef<HTMLDivElement, UtilityTabResultsProps>(</div>) : (<div className="flex flex-col gap-y-1">- {formattedError.length > 0 ? (- formattedError.map((x: string, i: number) => (+ {errorLines.length > 0 ? (+ errorLines.map((x: string, i: number) => (<pre key={`error-${i}`} className="font-mono text-sm text-wrap">{x}</pre>@@ -146,10 +145,10 @@ const UtilityTabResults = forwardRef<HTMLDivElement, UtilityTabResultsProps>(Switch to primary database</Button>)}- {formattedError.length > 0 && (+ {errorLines.length > 0 && (<Tooltip><TooltipTrigger>- <CopyButton iconOnly type="default" text={formattedError.join('\n')} />+ <CopyButton iconOnly type="default" text={errorLines.join('\n')} /></TooltipTrigger><TooltipContent side="bottom" align="center"><span>Copy error</span>diff --git a/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.utils.test.ts b/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.utils.test.tsnew file mode 100644index 00000000000..779e4a635c5--- /dev/null+++ b/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.utils.test.ts@@ -0,0 +1,80 @@+import { describe, expect, it } from 'vitest'++import { getSqlErrorLines } from './UtilityTabResults.utils'++describe('getSqlErrorLines', () => {+ it('returns formattedError lines when present', () => {+ const lines = getSqlErrorLines({+ message: 'permission denied for table users',+ formattedError:+ 'ERROR: 42501: permission denied for table users\n' ++ 'HINT: To grant access to anon on a specific table:\n' ++ ' GRANT SELECT ON TABLE public.users TO anon;',+ })++ expect(lines).toEqual([+ 'ERROR: 42501: permission denied for table users',+ 'HINT: To grant access to anon on a specific table:',+ ' GRANT SELECT ON TABLE public.users TO anon;',+ ])+ })++ it('strips empty lines from formattedError', () => {+ const lines = getSqlErrorLines({+ formattedError: 'ERROR: boom\n\nHINT: retry\n',+ })++ expect(lines).toEqual(['ERROR: boom', 'HINT: retry'])+ })++ it('falls back to message lines when formattedError is missing and message is multi-line', () => {+ const lines = getSqlErrorLines({+ message:+ 'ERROR: 42501: permission denied for table users\n' ++ 'HINT: To grant access to anon on a specific table:\n' ++ ' GRANT SELECT ON TABLE public.users TO anon;',+ })++ expect(lines).toEqual([+ 'ERROR: 42501: permission denied for table users',+ 'HINT: To grant access to anon on a specific table:',+ ' GRANT SELECT ON TABLE public.users TO anon;',+ ])+ })++ it('returns empty array for a single-line message so callers render the fallback', () => {+ const lines = getSqlErrorLines({ message: 'permission denied for table users' })+ expect(lines).toEqual([])+ })++ it('returns empty array when both fields are missing', () => {+ expect(getSqlErrorLines({})).toEqual([])+ })++ it('returns empty array when message is an empty string', () => {+ expect(getSqlErrorLines({ message: '' })).toEqual([])+ })++ it('returns empty array when message only contains whitespace newlines', () => {+ // Only empty segments after filtering — treated as single-line+ expect(getSqlErrorLines({ message: '\n\n' })).toEqual([])+ })++ it('prefers formattedError even when message is also multi-line', () => {+ const lines = getSqlErrorLines({+ message: 'message line 1\nmessage line 2',+ formattedError: 'formatted line 1\nformatted line 2',+ })++ expect(lines).toEqual(['formatted line 1', 'formatted line 2'])+ })++ it('falls through to message when formattedError is empty string', () => {+ const lines = getSqlErrorLines({+ message: 'ERROR: line 1\nHINT: line 2',+ formattedError: '',+ })++ expect(lines).toEqual(['ERROR: line 1', 'HINT: line 2'])+ })+})diff --git a/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.utils.ts b/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.utils.tsnew file mode 100644index 00000000000..583568ec02a--- /dev/null+++ b/apps/studio/components/interfaces/SQLEditor/UtilityPanel/UtilityTabResults.utils.ts@@ -0,0 +1,18 @@+/**+ * Pick which lines to render for a SQL editor error.+ *+ * pg-meta returns `formattedError` with multi-line ERROR/HINT/LINE output from Postgres.+ * Historically only `message` was reliably populated end-to-end, which is why the UI also+ * falls back to splitting `message` on newlines — e.g. the enhanced permission-denied HINT+ * added by supabase/postgres#2084 arrives in the message body on some paths.+ *+ * Returns an empty array when the error is single-line (message only) — callers fall back to+ * a plain "Error: {message}" rendering in that case.+ */+export function getSqlErrorLines(error: { message?: string; formattedError?: string }): string[] {+ const formattedLines = (error.formattedError?.split('\n') ?? []).filter((x) => x.length > 0)+ if (formattedLines.length > 0) return formattedLines++ const messageLines = (error.message?.split('\n') ?? []).filter((x) => x.length > 0)+ return messageLines.length > 1 ? messageLines : []+}diff --git a/apps/studio/data/fetchers.ts b/apps/studio/data/fetchers.tsindex 20f7fd5c0fb..51cae29595a 100644--- a/apps/studio/data/fetchers.ts+++ b/apps/studio/data/fetchers.ts@@ -172,6 +172,10 @@ export const handleError = (error: unknown, options: HandleErrorOptions = {}): n'metadata' in error && typeof error.metadata === 'object' && !!error.metadata? (error.metadata as ErrorMetadata): undefined+ const formattedError =+ 'formattedError' in error && typeof error.formattedError === 'string'+ ? error.formattedError+ : undefinedif (errorMessage) {const matched = ERROR_PATTERNS.find(({ pattern }) => pattern.test(errorMessage))@@ -182,7 +186,8 @@ export const handleError = (error: unknown, options: HandleErrorOptions = {}): nrequestId,retryAfter,requestPathname,- metadata+ metadata,+ formattedError): new UnknownAPIResponseError(errorMessage,@@ -190,7 +195,8 @@ export const handleError = (error: unknown, options: HandleErrorOptions = {}): nrequestId,retryAfter,requestPathname,- metadata+ metadata,+ formattedError)}}diff --git a/apps/studio/data/handleError.test.ts b/apps/studio/data/handleError.test.tsindex 7bed59443da..40f53679f43 100644--- a/apps/studio/data/handleError.test.ts+++ b/apps/studio/data/handleError.test.ts@@ -95,5 +95,39 @@ describe('handleError — error classification', () => {const err = throwAndCatch({ msg: 'from msg field', message: 'from message field' })expect(err.message).toBe('from msg field')})++ it('preserves formattedError on classified errors', () => {+ const err = throwAndCatch({+ message: 'CONNECTION TERMINATED DUE TO CONNECTION TIMEOUT',+ formattedError: 'ERROR: 08000: CONNECTION TERMINATED\nHINT: retry later',+ })+ expect(err).toBeInstanceOf(ConnectionTimeoutError)+ expect(err.formattedError).toBe('ERROR: 08000: CONNECTION TERMINATED\nHINT: retry later')+ })++ it('preserves formattedError on unclassified errors (permission denied with HINT)', () => {+ const err = throwAndCatch({+ message: 'permission denied for table users',+ code: 400,+ formattedError:+ 'ERROR: 42501: permission denied for table users\n' ++ 'HINT: To grant access to anon on a specific table:\n' ++ ' GRANT SELECT ON TABLE public.users TO anon;',+ })+ expect(err).toBeInstanceOf(UnknownAPIResponseError)+ expect(err.formattedError).toContain('ERROR:')+ expect(err.formattedError).toContain('HINT:')+ expect(err.formattedError?.split('\n').length).toBeGreaterThan(1)+ })++ it('leaves formattedError undefined when raw error omits it', () => {+ const err = throwAndCatch({ message: 'some error' })+ expect(err.formattedError).toBeUndefined()+ })++ it('ignores non-string formattedError values', () => {+ const err = throwAndCatch({ message: 'some error', formattedError: 42 })+ expect(err.formattedError).toBeUndefined()+ })})})diff --git a/apps/studio/types/api-errors.ts b/apps/studio/types/api-errors.tsindex 3b902510801..9da18975bf0 100644--- a/apps/studio/types/api-errors.ts+++ b/apps/studio/types/api-errors.ts@@ -12,9 +12,10 @@ export class ConnectionTimeoutError extends ResponseError {requestId?: string,retryAfter?: number,requestPathname?: string,- metadata?: ErrorMetadata+ metadata?: ErrorMetadata,+ formattedError?: string) {- super(message, code, requestId, retryAfter, requestPathname, metadata)+ super(message, code, requestId, retryAfter, requestPathname, metadata, formattedError)}}@@ -27,9 +28,10 @@ export class UnknownAPIResponseError extends ResponseError {requestId?: string,retryAfter?: number,requestPathname?: string,- metadata?: ErrorMetadata+ metadata?: ErrorMetadata,+ formattedError?: string) {- super(message, code, requestId, retryAfter, requestPathname, metadata)+ super(message, code, requestId, retryAfter, requestPathname, metadata, formattedError)}}diff --git a/apps/studio/types/base.ts b/apps/studio/types/base.tsindex d198cdccb43..089e876b3fa 100644--- a/apps/studio/types/base.ts+++ b/apps/studio/types/base.ts@@ -102,6 +102,7 @@ export class ResponseError extends Error {requestPathname?: stringmetadata?: CostMetadataerrorType?: string+ formattedError?: stringconstructor(message: string | undefined,@@ -109,7 +110,8 @@ export class ResponseError extends Error {requestId?: string,retryAfter?: number,requestPathname?: string,- metadata?: CostMetadata+ metadata?: CostMetadata,+ formattedError?: string) {super(message || 'API error happened while trying to communicate with the server.')this.code = code@@ -117,6 +119,7 @@ export class ResponseError extends Error {this.retryAfter = retryAfterthis.requestPathname = requestPathnamethis.metadata = metadata+ this.formattedError = formattedError}}