The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
import { LOCAL_STORAGE_KEYS, useParams } from 'common'
import { ShieldCheckIcon, XIcon } from 'lucide-react'
import { useMemo, useState } from 'react'
import { toast } from 'sonner'
import {
Button,
Dialog,
DialogContent,
DialogDescription,
DialogFooter,
DialogHeader,
DialogSection,
DialogSectionSeparator,
DialogTitle,
DialogTrigger,
} from 'ui'
import { Admonition } from 'ui-patterns/Admonition'
import { CodeBlock } from 'ui-patterns/CodeBlock'
import { AUTO_ENABLE_RLS_EVENT_TRIGGER_SQL } from '@/components/interfaces/Database/Triggers/EventTriggersList/EventTriggers.constants'
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
import { useDatabaseEventTriggerCreateMutation } from '@/data/database-event-triggers/database-event-trigger-create-mutation'
import { useDatabaseEventTriggersQuery } from '@/data/database-event-triggers/database-event-triggers-query'
import { FGA_PERMISSIONS, useAsyncCheckPermissionsV2 } from '@/hooks/misc/useCheckPermissionsV2'
import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { useTrack } from '@/lib/telemetry/track'
export const AutoEnableRLSNotice = ({ iconOnly }: { iconOnly?: boolean }) => {
const { ref } = useParams()
const { data: project } = useSelectedProjectQuery()
const projectRef = ref ?? project?.ref
// [Joshen] Changing the behaviour of this to not be dismissible, only minimized
// Given that its a security measure that we highly advise. Otherwise there's no way for users to revisit this
const [, setIsMinimized] = useLocalStorageQuery(
LOCAL_STORAGE_KEYS.RLS_EVENT_TRIGGER_BANNER_DISMISSED(projectRef ?? 'unknown'),
false
)
const { data: eventTriggers = [], isLoading: isLoadingEventTriggers } =
useDatabaseEventTriggersQuery({
projectRef: project?.ref,
connectionString: project?.connectionString,
})
const hasDefaultTrigger = useMemo(
() =>
eventTriggers.some(
(trigger) => trigger.name === 'ensure_rls' || trigger.function_name === 'rls_auto_enable'
),
[eventTriggers]
)
if (!projectRef || isLoadingEventTriggers || hasDefaultTrigger) return null
if (iconOnly) {
return <CreateEnsureRLSTriggerDialog iconOnly />
}
return (
<Admonition
type="note"
layout="responsive"
title="Automatically enable Row Level Security (RLS) on new tables"
description="Protect future tables by automatically enabling RLS whenever a table is created."
actions={
<>
<CreateEnsureRLSTriggerDialog />
<ButtonTooltip
icon={<XIcon />}
variant="text"
className="w-6"
tooltip={{ content: { side: 'bottom', text: 'Dismiss' } }}
aria-label="Dismiss RLS notice"
onClick={() => setIsMinimized(true)}
/>
</>
}
/>
)
}
const CreateEnsureRLSTriggerDialog = ({ iconOnly }: { iconOnly?: boolean }) => {
const track = useTrack()
const { data: project } = useSelectedProjectQuery()
const [open, setOpen] = useState(false)
const { can: canCreateTriggers } = useAsyncCheckPermissionsV2(
FGA_PERMISSIONS.PROJECT.DATABASE_WRITE
)
const { mutate: createEventTrigger, isPending: isCreating } =
useDatabaseEventTriggerCreateMutation({
onSuccess: () => {
toast.success(
'Successfully set up database trigger to automatically enable RLS on all new tables'
)
setOpen(false)
},
})
const handleCreateTrigger = () => {
if (!project) return
track('rls_event_trigger_banner_create_button_clicked')
createEventTrigger({
projectRef: project.ref,
connectionString: project.connectionString,
sql: AUTO_ENABLE_RLS_EVENT_TRIGGER_SQL,
})
}
return (
<Dialog open={open} onOpenChange={setOpen}>
<DialogTrigger asChild>
{iconOnly ? (
<ButtonTooltip
icon={<ShieldCheckIcon />}
className="w-7"
tooltip={{ content: { side: 'bottom', text: 'Auto-enable RLS for new tables' } }}
/>
) : (
<Button>Set up trigger</Button>
)}
</DialogTrigger>
<DialogContent size="large">
<DialogHeader>
<DialogTitle>Automatically enable RLS for new tables</DialogTitle>
<DialogDescription>
Protect future tables with a built-in database trigger.
</DialogDescription>
</DialogHeader>
<DialogSectionSeparator />
<DialogSection className="text-sm flex flex-col gap-y-2">
<p>
Tables in exposed schemas such as <code>public</code> are reachable through your
project’s API. Enable Row Level Security (RLS) on these tables so access is governed by
the policies you define, not just the project API key.
</p>
<p>
This trigger automatically enables RLS whenever a new table is created. Review the SQL
before creating it:
</p>
</DialogSection>
<CodeBlock
language="sql"
className="language-sql px-0 border-x-0 border-b-0 rounded-none h-64"
>
{AUTO_ENABLE_RLS_EVENT_TRIGGER_SQL.trim()}
</CodeBlock>
<DialogFooter>
<Button disabled={isCreating} onClick={() => setOpen(false)}>
Cancel
</Button>
<ButtonTooltip
variant="primary"
disabled={!canCreateTriggers}
loading={isCreating}
onClick={handleCreateTrigger}
tooltip={{
content: {
side: 'bottom',
text: !canCreateTriggers
? 'You need additional permissions to create triggers'
: undefined,
},
}}
>
Create trigger
</ButtonTooltip>
</DialogFooter>
</DialogContent>
</Dialog>
)
}