Skip to content

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

Auto enable RLS trigger shift into confirmation dialog (#45407)

Joshen Lim66a99dce81f4
diff --git a/apps/studio/components/ui/BannerStack/Banners/BannerRlsEventTrigger.tsx b/apps/studio/components/ui/BannerStack/Banners/BannerRlsEventTrigger.tsx
index 1f0e87bf392..6bd05b6eb88 100644
--- a/apps/studio/components/ui/BannerStack/Banners/BannerRlsEventTrigger.tsx
+++ b/apps/studio/components/ui/BannerStack/Banners/BannerRlsEventTrigger.tsx
@@ -4,7 +4,21 @@ import { useParams } from 'common/hooks'
import { ShieldCheck } from 'lucide-react'
import Link from 'next/link'
import { useEffect, useMemo, useState } from 'react'
-import { Button, cn } from 'ui'
+import { toast } from 'sonner'
+import {
+ Button,
+ cn,
+ Dialog,
+ DialogContent,
+ DialogDescription,
+ DialogFooter,
+ DialogHeader,
+ DialogSection,
+ DialogSectionSeparator,
+ DialogTitle,
+ DialogTrigger,
+} from 'ui'
+import { CodeBlock } from 'ui-patterns/CodeBlock'
import { BannerCard } from '../BannerCard'
import { useBannerStack } from '../BannerStackProvider'
@@ -22,18 +36,13 @@ export const BannerRlsEventTrigger = () => {
const { dismissBanner } = useBannerStack()
const { data: project } = useSelectedProjectQuery()
const projectRef = ref ?? project?.ref
+
const [hasCreated, setHasCreated] = useState(false)
- const track = useTrack()
const [, setIsDismissed] = useLocalStorageQuery(
LOCAL_STORAGE_KEYS.RLS_EVENT_TRIGGER_BANNER_DISMISSED(projectRef ?? 'unknown'),
false
)
- const { can: canCreateTriggers } = useAsyncCheckPermissions(
- PermissionAction.TENANT_SQL_ADMIN_WRITE,
- 'triggers'
- )
-
const { data: eventTriggers = [], isLoading: isLoadingEventTriggers } =
useDatabaseEventTriggersQuery({
projectRef: project?.ref,
@@ -48,27 +57,12 @@ export const BannerRlsEventTrigger = () => {
[eventTriggers]
)
- const { mutate: createEventTrigger, isPending: isCreating } =
- useDatabaseEventTriggerCreateMutation({
- onSuccess: () => setHasCreated(true),
- })
-
useEffect(() => {
if (hasDefaultTrigger) {
setHasCreated(true)
}
}, [hasDefaultTrigger])
- 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,
- })
- }
-
if (!projectRef || isLoadingEventTriggers) return null
return (
@@ -105,26 +99,98 @@ export const BannerRlsEventTrigger = () => {
<Link href={`/project/${projectRef}/database/triggers/event`}>View triggers</Link>
</Button>
) : (
- <ButtonTooltip
- type="primary"
- size="tiny"
- loading={isCreating}
- disabled={!canCreateTriggers}
- onClick={handleCreateTrigger}
- tooltip={{
- content: {
- side: 'bottom',
- text: !canCreateTriggers
- ? 'You need additional permissions to create triggers'
- : undefined,
- },
- }}
- >
- Create ensure_rls trigger
- </ButtonTooltip>
+ <CreateEnsureRLSTriggerDialog onCreateSuccess={() => setHasCreated(true)} />
)}
</div>
</div>
</BannerCard>
)
}
+
+const CreateEnsureRLSTriggerDialog = ({ onCreateSuccess }: { onCreateSuccess: () => void }) => {
+ const track = useTrack()
+ const { data: project } = useSelectedProjectQuery()
+
+ const [open, setOpen] = useState(false)
+
+ const { can: canCreateTriggers } = useAsyncCheckPermissions(
+ PermissionAction.TENANT_SQL_ADMIN_WRITE,
+ 'triggers'
+ )
+
+ const { mutate: createEventTrigger, isPending: isCreating } =
+ useDatabaseEventTriggerCreateMutation({
+ onSuccess: () => {
+ toast.success(
+ 'Successfully set up database trigger to automatically enable RLS on all new tables'
+ )
+ onCreateSuccess()
+ 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>
+ <ButtonTooltip
+ type="primary"
+ size="tiny"
+ disabled={!canCreateTriggers}
+ tooltip={{
+ content: {
+ side: 'bottom',
+ text: !canCreateTriggers
+ ? 'You need additional permissions to create triggers'
+ : undefined,
+ },
+ }}
+ >
+ Learn more
+ </ButtonTooltip>
+ </DialogTrigger>
+ <DialogContent size="large">
+ <DialogHeader>
+ <DialogTitle>Automatically enable RLS for newly created tables</DialogTitle>
+ <DialogDescription>Secure your data using Postgres Row Level Security</DialogDescription>
+ </DialogHeader>
+
+ <DialogSectionSeparator />
+
+ <DialogSection className="text-sm flex flex-col gap-y-2">
+ <p>
+ Tables in exposed schemas (default being the{' '}
+ <code className="text-code-inline">public</code> schema) are accessible to anyone.
+ Hence, we highly recommend enabling RLS on all such tables.
+ </p>
+ <p>
+ You can set up a database trigger to enable RLS automatically on all new tables with the
+ following SQL:
+ </p>
+ </DialogSection>
+
+ <CodeBlock language="sql" className="language-sql px-0 border-x-0 rounded-none h-64">
+ {AUTO_ENABLE_RLS_EVENT_TRIGGER_SQL.trim()}
+ </CodeBlock>
+
+ <DialogFooter>
+ <Button type="default" disabled={isCreating} onClick={() => setOpen(false)}>
+ Close
+ </Button>
+ <Button loading={isCreating} onClick={handleCreateTrigger}>
+ Create ensure_rls trigger
+ </Button>
+ </DialogFooter>
+ </DialogContent>
+ </Dialog>
+ )
+}