The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
import { zodResolver } from '@hookform/resolvers/zod'
import { Monaco } from '@monaco-editor/react'
import {
acceptUntrustedSql,
ident,
joinSqlFragments,
safeSql,
untrustedSql,
type DisplayableSqlFragment,
type SafeSqlFragment,
} from '@supabase/pg-meta/src/pg-format'
import { useQueryClient } from '@tanstack/react-query'
import { useParams } from 'common'
import { memo, useCallback, useEffect, useRef, useState } from 'react'
import { useForm, useWatch } from 'react-hook-form'
import { toast } from 'sonner'
import {
Button,
Checkbox,
cn,
Form,
Label,
ScrollArea,
Sheet,
SheetContent,
SheetFooter,
Tabs,
TabsContent,
TabsList,
TabsTrigger,
} from 'ui'
import * as z from 'zod'
import { LockedCreateQuerySection, LockedRenameQuerySection } from './LockedQuerySection'
import { PolicyDetailsV2 } from './PolicyDetailsV2'
import {
checkIfPolicyHasChanged,
generateCreatePolicyQuery,
generateUpdatePolicyPayload,
} from './PolicyEditorPanel.utils'
import { PolicyEditorPanelHeader } from './PolicyEditorPanelHeader'
import { PolicyTemplates } from './PolicyTemplates'
import { QueryError } from './QueryError'
import { RLSCodeEditor } from './RLSCodeEditor'
import type { Policy } from '@/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils'
import { IStandaloneCodeEditor } from '@/components/interfaces/SQLEditor/SQLEditor.types'
import { DiscardChangesConfirmationDialog } from '@/components/ui-patterns/Dialogs/DiscardChangesConfirmationDialog'
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
import { useDatabasePolicyUpdateMutation } from '@/data/database-policies/database-policy-update-mutation'
import { databasePoliciesKeys } from '@/data/database-policies/keys'
import { QueryResponseError, useExecuteSqlMutation } from '@/data/sql/execute-sql-mutation'
import { FGA_PERMISSIONS, useAsyncCheckPermissionsV2 } from '@/hooks/misc/useCheckPermissionsV2'
import { useLatest } from '@/hooks/misc/useLatest'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { useConfirmOnClose } from '@/hooks/ui/useConfirmOnClose'
interface PolicyEditorPanelProps {
visible: boolean
schema: string
searchString?: string
selectedTable?: string
selectedPolicy?: Policy
onSelectCancel: () => void
authContext: 'database' | 'realtime'
}
const FORM_ID = 'rls-editor'
const FormSchema = z.object({
name: z.string().min(1, 'Please provide a name'),
table: z.string(),
behavior: z.string(),
command: z.string(),
roles: z.string(),
})
const defaultValues = {
name: '',
table: '',
behavior: 'permissive',
command: 'select',
roles: '',
}
/**
* Using memo for this component because everything rerenders on window focus because of outside fetches
*/
export const PolicyEditorPanel = memo(function ({
visible,
schema,
searchString,
selectedTable,
selectedPolicy,
onSelectCancel,
authContext,
}: PolicyEditorPanelProps) {
const { ref } = useParams()
const queryClient = useQueryClient()
const { data: selectedProject } = useSelectedProjectQuery()
const { can: canUpdatePolicies } = useAsyncCheckPermissionsV2(
FGA_PERMISSIONS.PROJECT.DATABASE_WRITE
)
// [Joshen] Hyrid form fields, just spit balling to get a decent POC out
const [using, setUsing] = useState<DisplayableSqlFragment | undefined>(undefined)
const [check, setCheck] = useState<DisplayableSqlFragment | undefined>(undefined)
const [rolesFragment, setRolesFragment] = useState<SafeSqlFragment>(safeSql`public`)
const [fieldError, setFieldError] = useState<string>()
const [showCheckBlock, setShowCheckBlock] = useState(true)
const monacoOneRef = useRef<Monaco | null>(null)
const editorOneRef = useRef<IStandaloneCodeEditor | null>(null)
const [expOneLineCount, setExpOneLineCount] = useState(1)
const [expOneContentHeight, setExpOneContentHeight] = useState(0)
const monacoTwoRef = useRef<Monaco | null>(null)
const editorTwoRef = useRef<IStandaloneCodeEditor | null>(null)
const [expTwoLineCount, setExpTwoLineCount] = useState(1)
const [expTwoContentHeight, setExpTwoContentHeight] = useState(0)
const [error, setError] = useState<QueryResponseError>()
const [errorPanelOpen, setErrorPanelOpen] = useState<boolean>(true)
const [showDetails, setShowDetails] = useState<boolean>(false)
const [selectedDiff, setSelectedDiff] = useState<string>()
const [showTools, setShowTools] = useState<boolean>(false)
const form = useForm<z.infer<typeof FormSchema>>({
mode: 'onBlur',
reValidateMode: 'onBlur',
resolver: zodResolver(FormSchema),
defaultValues,
})
const [name, table, behavior, command, roles] = useWatch({
control: form.control,
name: ['name', 'table', 'behavior', 'command', 'roles'],
})
const supportWithCheck = ['update', 'all'].includes(command)
const isRenamingPolicy = selectedPolicy !== undefined && name !== selectedPolicy.name
const { mutate: executeMutation, isPending: isExecuting } = useExecuteSqlMutation({
onSuccess: async () => {
// refresh all policies
await queryClient.invalidateQueries({ queryKey: databasePoliciesKeys.list(ref) })
toast.success('Successfully created new policy')
onSelectCancel()
},
onError: (error) => setError(error),
})
const { mutate: updatePolicy, isPending: isUpdating } = useDatabasePolicyUpdateMutation({
onSuccess: () => {
toast.success('Successfully updated policy')
onSelectCancel()
},
})
const hasUnsavedChanges = useCallback(() => {
const editorOneValue = editorOneRef.current?.getValue().trim() ?? null
const editorOneFormattedValue = !editorOneValue ? null : editorOneValue
const editorTwoValue = editorTwoRef.current?.getValue().trim() ?? null
const editorTwoFormattedValue = !editorTwoValue ? null : editorTwoValue
const policyCreateUnsaved =
selectedPolicy === undefined &&
(name.length > 0 ||
roles.length > 0 ||
!!editorOneFormattedValue ||
!!editorTwoFormattedValue)
const policyUpdateUnsaved =
selectedPolicy !== undefined
? checkIfPolicyHasChanged(selectedPolicy, {
name,
roles: roles.length === 0 ? ['public'] : roles.split(', '),
definition: editorOneFormattedValue,
check:
selectedPolicy.command === 'INSERT'
? editorOneFormattedValue
: editorTwoFormattedValue,
})
: false
return policyCreateUnsaved || policyUpdateUnsaved
}, [name, roles, selectedPolicy])
const { confirmOnClose, handleOpenChange, modalProps } = useConfirmOnClose({
checkIsDirty: hasUnsavedChanges,
onClose: onSelectCancel,
})
const onSubmit = (data: z.infer<typeof FormSchema>) => {
const { name, table, behavior, command, roles } = data
// For INSERT: editor one holds the check expression (not using)
// For others: editor one = using, editor two = optional check
const usingExpr = command !== 'insert' ? using : undefined
const checkExpr = command === 'insert' ? using : check
if (selectedPolicy === undefined) {
if (command === 'insert' && !checkExpr?.trim()) {
return setFieldError('Please provide a SQL expression for the WITH CHECK statement')
} else if (command !== 'insert' && !usingExpr?.trim()) {
return setFieldError('Please provide a SQL expression for the USING statement')
}
setFieldError(undefined)
const sql = generateCreatePolicyQuery({
name,
schema,
table,
behavior,
command,
roles: rolesFragment,
using: usingExpr ? acceptUntrustedSql(usingExpr) : undefined,
check: checkExpr ? acceptUntrustedSql(checkExpr) : undefined,
})
setError(undefined)
executeMutation({
sql,
projectRef: selectedProject?.ref,
connectionString: selectedProject?.connectionString,
handleError: (error) => {
throw error
},
})
} else if (selectedProject !== undefined) {
const updatedRoles = roles.length === 0 ? ['public'] : roles.split(', ')
// A null definition/check is valid (the policy was created without that clause), so
// updates only require an expression where the policy already has one — ALTER POLICY
// can only replace an expression, not remove it.
if (selectedPolicy.command === 'INSERT') {
if (selectedPolicy.check !== null && !using?.trim()) {
return setFieldError(
'The WITH CHECK expression cannot be removed. Provide a new expression, or delete and recreate the policy without it.'
)
}
} else {
if (selectedPolicy.definition !== null && !using?.trim()) {
return setFieldError(
'The USING expression cannot be removed. Provide a new expression, or delete and recreate the policy without it.'
)
}
if (selectedPolicy.check !== null && !check?.trim()) {
return setFieldError(
'The WITH CHECK expression cannot be removed. Provide a new expression, or delete and recreate the policy without it.'
)
}
}
setFieldError(undefined)
const payload = generateUpdatePolicyPayload(selectedPolicy, {
name,
roles: updatedRoles,
using,
check,
})
if (Object.keys(payload).length === 0) return onSelectCancel()
updatePolicy({
projectRef: selectedProject.ref,
connectionString: selectedProject?.connectionString,
originalPolicy: selectedPolicy,
// The Save click is the explicit user gesture that promotes editor content
// to executable SQL.
payload: {
name: payload.name,
roles: payload.roles,
definition:
payload.definition === undefined ? undefined : acceptUntrustedSql(payload.definition),
check: payload.check === undefined ? undefined : acceptUntrustedSql(payload.check),
},
})
}
}
const resetStateRef = useLatest(() => {
if (!visible) {
editorOneRef.current?.setValue('')
editorTwoRef.current?.setValue('')
setShowTools(false)
setError(undefined)
setShowDetails(false)
setSelectedDiff(undefined)
setUsing(undefined)
setCheck(undefined)
setRolesFragment(safeSql`public`)
setShowCheckBlock(false)
setFieldError(undefined)
form.reset(defaultValues)
} else {
if (canUpdatePolicies) setShowTools(true)
if (selectedPolicy !== undefined) {
const { name, action, table, command, roles } = selectedPolicy
form.reset({
name,
table,
behavior: action.toLowerCase(),
command: command.toLowerCase(),
roles: roles.length === 1 && roles[0] === 'public' ? '' : roles.join(', '),
})
if (selectedPolicy.definition) setUsing(safeSql` ${selectedPolicy.definition}`)
if (selectedPolicy.check && selectedPolicy.command === 'INSERT')
setUsing(safeSql` ${selectedPolicy.check}`)
if (selectedPolicy.check && selectedPolicy.command !== 'INSERT') {
setCheck(safeSql` ${selectedPolicy.check}`)
setShowCheckBlock(true)
}
setRolesFragment(
roles.length === 1 && roles[0] === 'public'
? safeSql`public`
: joinSqlFragments(
roles.map((r) => ident(r)),
', '
)
)
} else if (selectedTable !== undefined) {
form.reset({ ...defaultValues, table: selectedTable })
}
}
})
// when the panel is closed, reset all values
useEffect(() => {
resetStateRef.current()
}, [visible, resetStateRef])
// whenever the deps (current policy details, new error or error panel opens) change, recalculate
// the height of the editor
useEffect(() => {
editorOneRef.current?.layout({ width: 0, height: 0 })
window.requestAnimationFrame(() => {
editorOneRef.current?.layout()
})
}, [showDetails, error, errorPanelOpen])
return (
<>
<Form {...form}>
<form id={FORM_ID} onSubmit={form.handleSubmit(onSubmit)}>
<Sheet open={visible} onOpenChange={handleOpenChange}>
<SheetContent
showClose={false}
size={showTools ? 'lg' : 'default'}
className={cn(
'bg-popover p-0 flex flex-row gap-0',
showTools ? 'min-w-screen! lg:min-w-[1000px]!' : 'min-w-screen! lg:min-w-[600px]!'
)}
>
<div className={cn('flex flex-col grow w-full', showTools && 'w-[60%]')}>
<PolicyEditorPanelHeader
selectedPolicy={selectedPolicy}
showTools={showTools}
setShowTools={setShowTools}
/>
<div className="flex flex-col h-full w-full justify-between overflow-y-auto">
<PolicyDetailsV2
schema={schema}
searchString={searchString}
selectedTable={selectedTable}
isEditing={selectedPolicy !== undefined}
form={form}
onUpdateCommand={(command: string) => {
setFieldError(undefined)
if (!['update', 'all'].includes(command)) {
setShowCheckBlock(false)
} else {
setShowCheckBlock(true)
}
}}
onRolesChange={(frag) => setRolesFragment(frag)}
authContext={authContext}
/>
<div className="h-full">
<LockedCreateQuerySection
schema={schema}
selectedPolicy={selectedPolicy}
isRenamingPolicy={isRenamingPolicy}
formFields={{ name, table, behavior, command, roles }}
/>
<div
className="mt-1 relative block"
style={{
height:
expOneContentHeight <= 100 ? `${8 + expOneContentHeight}px` : '108px',
}}
>
<RLSCodeEditor
readOnly={!canUpdatePolicies}
id="rls-exp-one-editor"
placeholder={
command === 'insert'
? '-- Provide a SQL expression for the with check statement'
: '-- Provide a SQL expression for the using statement'
}
defaultValue={using}
value={using}
editorRef={editorOneRef}
monacoRef={monacoOneRef as any}
lineNumberStart={6}
onInputChange={(value) => setUsing(untrustedSql(value ?? ''))}
onChange={() => {
setExpOneContentHeight(editorOneRef.current?.getContentHeight() ?? 0)
setExpOneLineCount(editorOneRef.current?.getModel()?.getLineCount() ?? 1)
}}
onMount={() => {
setTimeout(() => {
setExpOneContentHeight(editorOneRef.current?.getContentHeight() ?? 0)
setExpOneLineCount(
editorOneRef.current?.getModel()?.getLineCount() ?? 1
)
}, 200)
}}
/>
</div>
<div className="bg-surface-300 py-1">
<div className="flex items-center" style={{ fontSize: '14px' }}>
<div className="w-[57px]">
<p className="w-[31px] flex justify-end font-mono text-sm text-foreground-light select-none">
{7 + expOneLineCount}
</p>
</div>
<p className="font-mono tracking-tighter">
{showCheckBlock ? (
<>
{supportWithCheck && showCheckBlock && (
<span className="text-[#ffd700]">) </span>
)}
<span className="text-[#569cd6]">with check</span>{' '}
<span className="text-[#ffd700]">(</span>
</>
) : (
<>
<span className="text-[#ffd700]">)</span>;
</>
)}
</p>
</div>
</div>
{showCheckBlock && (
<>
<div
className="mt-1 min-h-[28px] relative block"
style={{
height:
expTwoContentHeight <= 100 ? `${8 + expTwoContentHeight}px` : '108px',
}}
>
<RLSCodeEditor
readOnly={!canUpdatePolicies}
id="rls-exp-two-editor"
placeholder="-- Provide a SQL expression for the with check statement"
defaultValue={check}
value={check}
editorRef={editorTwoRef}
monacoRef={monacoTwoRef as any}
lineNumberStart={7 + expOneLineCount}
onInputChange={(value) => setCheck(untrustedSql(value ?? ''))}
onChange={() => {
setExpTwoContentHeight(editorTwoRef.current?.getContentHeight() ?? 0)
setExpTwoLineCount(
editorTwoRef.current?.getModel()?.getLineCount() ?? 1
)
}}
onMount={() => {
setTimeout(() => {
setExpTwoContentHeight(
editorTwoRef.current?.getContentHeight() ?? 0
)
setExpTwoLineCount(
editorTwoRef.current?.getModel()?.getLineCount() ?? 1
)
}, 200)
}}
/>
</div>
<div className="bg-surface-300 py-1">
<div className="flex items-center" style={{ fontSize: '14px' }}>
<div className="w-[57px]">
<p className="w-[31px] flex justify-end font-mono text-sm text-foreground-light select-none">
{8 + expOneLineCount + expTwoLineCount}
</p>
</div>
<p className="font-mono tracking-tighter">
<span className="text-[#ffd700]">)</span>;
</p>
</div>
</div>
</>
)}
{isRenamingPolicy && (
<LockedRenameQuerySection
oldName={selectedPolicy.name}
newName={name}
schema={schema}
table={table}
lineNumber={8 + expOneLineCount + (showCheckBlock ? expTwoLineCount : 0)}
/>
)}
{fieldError !== undefined && (
<p className="px-5 py-2 pb-0 text-sm text-red-900">{fieldError}</p>
)}
{supportWithCheck && (
<div className="px-5 py-3 flex items-center gap-x-2">
<Checkbox
id="use-check"
name="use-check"
checked={showCheckBlock}
onCheckedChange={() => {
setFieldError(undefined)
setShowCheckBlock(!showCheckBlock)
}}
/>
<Label className="text-xs cursor-pointer" htmlFor="use-check">
Use check expression
</Label>
</div>
)}
</div>
<div className="flex flex-col">
{error !== undefined && (
<QueryError error={error} open={errorPanelOpen} setOpen={setErrorPanelOpen} />
)}
<SheetFooter className="flex items-center justify-end! px-5 py-4 w-full border-t">
<Button disabled={isExecuting || isUpdating} onClick={confirmOnClose}>
Cancel
</Button>
<ButtonTooltip
variant="primary"
form={FORM_ID}
type="submit"
loading={isExecuting || isUpdating}
disabled={!canUpdatePolicies || isExecuting || isUpdating}
tooltip={{
content: {
side: 'top',
text: !canUpdatePolicies
? 'You need additional permissions to update policies'
: undefined,
},
}}
>
Save policy
</ButtonTooltip>
</SheetFooter>
</div>
</div>
</div>
{showTools && (
<div
className={cn(
'border-l shadow-[rgba(0,0,0,0.13)_-4px_0px_6px_0px] z-10',
showTools && 'w-[50%]',
'bg-studio overflow-auto'
)}
>
<Tabs defaultValue="templates" className="flex flex-col h-full w-full">
<TabsList className="flex gap-4 px-content pt-2">
<TabsTrigger
key="templates"
value="templates"
className="px-0 data-[state=active]:bg-transparent"
>
Templates
</TabsTrigger>
</TabsList>
<TabsContent
value="templates"
className={cn(
'mt-0! overflow-y-auto',
'data-[state=active]:flex data-[state=active]:grow'
)}
>
<ScrollArea className="h-full w-full">
<PolicyTemplates
schema={schema}
table={table}
selectedPolicy={selectedPolicy}
selectedTemplate={selectedDiff}
onSelectTemplate={(value) => {
form.setValue('name', value.name)
form.setValue('behavior', 'permissive')
form.setValue('command', value.command.toLowerCase())
form.setValue('roles', value.roles.join(', ') ?? '')
setUsing(safeSql` ${value.definition}`)
if (value.check) {
if (value.command === 'INSERT') {
setUsing(safeSql` ${value.check}`)
} else {
setCheck(safeSql` ${value.check}`)
}
}
setRolesFragment(
value.roles.length === 0 ||
(value.roles.length === 1 && value.roles[0] === 'public')
? safeSql`public`
: joinSqlFragments(
value.roles.map((r: string) => ident(r)),
', '
)
)
setExpOneLineCount(1)
setExpTwoLineCount(1)
setFieldError(undefined)
if (!['update', 'all'].includes(value.command.toLowerCase())) {
setShowCheckBlock(false)
} else if (value.check.length > 0) {
setShowCheckBlock(true)
} else {
setShowCheckBlock(false)
}
}}
/>
</ScrollArea>
</TabsContent>
</Tabs>
</div>
)}
</SheetContent>
</Sheet>
</form>
</Form>
<DiscardChangesConfirmationDialog
{...modalProps}
description="Are you sure you want to close the editor? Any unsaved changes on your policy and conversations with the Assistant will be lost."
/>
</>
)
})
PolicyEditorPanel.displayName = 'PolicyEditorPanel'