Skip to content

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

Shift auto enable rls to a minimisable banner instead (#45410)

Joshen Lim09be492bbf8d
diff --git a/apps/studio/components/ui/BannerStack/Banners/BannerRlsEventTrigger.tsx b/apps/studio/components/ui/AutoEnableRLSNotice.tsx
similarity index 59%
rename from apps/studio/components/ui/BannerStack/Banners/BannerRlsEventTrigger.tsx
rename to apps/studio/components/ui/AutoEnableRLSNotice.tsx
index 6bd05b6eb88..e739e8bdc7e 100644
--- a/apps/studio/components/ui/BannerStack/Banners/BannerRlsEventTrigger.tsx
+++ b/apps/studio/components/ui/AutoEnableRLSNotice.tsx
@@ -1,13 +1,12 @@
import { PermissionAction } from '@supabase/shared-types/out/constants'
-import { LOCAL_STORAGE_KEYS } from 'common'
-import { useParams } from 'common/hooks'
-import { ShieldCheck } from 'lucide-react'
-import Link from 'next/link'
-import { useEffect, useMemo, useState } from 'react'
+import { LOCAL_STORAGE_KEYS, useParams } from 'common'
+import { ShieldCheck, X } from 'lucide-react'
+import { useMemo, useState } from 'react'
import { toast } from 'sonner'
import {
Button,
- cn,
+ Card,
+ CardContent,
Dialog,
DialogContent,
DialogDescription,
@@ -20,8 +19,6 @@ import {
} from 'ui'
import { CodeBlock } from 'ui-patterns/CodeBlock'
-import { BannerCard } from '../BannerCard'
-import { useBannerStack } from '../BannerStackProvider'
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'
@@ -31,14 +28,14 @@ import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { useTrack } from '@/lib/telemetry/track'
-export const BannerRlsEventTrigger = () => {
+export const AutoEnableRLSNotice = ({ iconOnly }: { iconOnly?: boolean }) => {
const { ref } = useParams()
- const { dismissBanner } = useBannerStack()
const { data: project } = useSelectedProjectQuery()
const projectRef = ref ?? project?.ref
- const [hasCreated, setHasCreated] = useState(false)
- const [, setIsDismissed] = useLocalStorageQuery(
+ // [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
)
@@ -48,7 +45,6 @@ export const BannerRlsEventTrigger = () => {
projectRef: project?.ref,
connectionString: project?.connectionString,
})
-
const hasDefaultTrigger = useMemo(
() =>
eventTriggers.some(
@@ -57,57 +53,43 @@ export const BannerRlsEventTrigger = () => {
[eventTriggers]
)
- useEffect(() => {
- if (hasDefaultTrigger) {
- setHasCreated(true)
- }
- }, [hasDefaultTrigger])
+ if (!projectRef || isLoadingEventTriggers || hasDefaultTrigger) return null
- if (!projectRef || isLoadingEventTriggers) return null
+ if (iconOnly) {
+ return <CreateEnsureRLSTriggerDialog iconOnly />
+ }
return (
- <BannerCard
- onDismiss={() => {
- setIsDismissed(true)
- dismissBanner('rls-event-trigger-banner')
- }}
- >
- <div className="flex flex-col gap-y-4">
- <div className="flex flex-col gap-y-2 items-start">
- <div
- className={cn(
- 'p-2 rounded-lg bg-muted text-foreground-light',
- hasCreated && 'bg-brand-200 dark:bg-brand-400 text-brand'
- )}
- >
- <ShieldCheck size={16} />
+ <Card>
+ <CardContent className="flex items-center justify-between">
+ <div className="flex items-center gap-x-4">
+ <div className="rounded-lg bg-surface-300 text-foreground-light w-10 h-10 flex items-center justify-center">
+ <ShieldCheck size={18} />
+ </div>
+ <div className="text-sm">
+ <p>Auto-enable RLS for new tables</p>
+ <p className="text-foreground-lighter">
+ Create an event trigger that enables Row Level Security on all new tables
+ </p>
</div>
</div>
- <div className="flex flex-col gap-y-1 mb-2">
- <p className="text-sm font-medium">
- {hasCreated ? 'RLS auto-enable trigger is active' : 'Auto-enable RLS for new tables'}
- </p>
- <p className="text-xs text-foreground-lighter text-balance">
- {hasCreated
- ? 'New tables will have Row Level Security enabled automatically.'
- : 'Create an event trigger that enables Row Level Security on all new tables'}
- </p>
- </div>
- <div className="flex gap-2">
- {hasCreated ? (
- <Button asChild type="default" size="tiny">
- <Link href={`/project/${projectRef}/database/triggers/event`}>View triggers</Link>
- </Button>
- ) : (
- <CreateEnsureRLSTriggerDialog onCreateSuccess={() => setHasCreated(true)} />
- )}
+
+ <div className="flex items-center gap-x-2">
+ <CreateEnsureRLSTriggerDialog />
+ <ButtonTooltip
+ icon={<X />}
+ type="text"
+ className="w-7"
+ tooltip={{ content: { side: 'bottom', text: 'Minimize' } }}
+ onClick={() => setIsMinimized(true)}
+ />
</div>
- </div>
- </BannerCard>
+ </CardContent>
+ </Card>
)
}
-const CreateEnsureRLSTriggerDialog = ({ onCreateSuccess }: { onCreateSuccess: () => void }) => {
+const CreateEnsureRLSTriggerDialog = ({ iconOnly }: { iconOnly?: boolean }) => {
const track = useTrack()
const { data: project } = useSelectedProjectQuery()
@@ -124,7 +106,6 @@ const CreateEnsureRLSTriggerDialog = ({ onCreateSuccess }: { onCreateSuccess: ()
toast.success(
'Successfully set up database trigger to automatically enable RLS on all new tables'
)
- onCreateSuccess()
setOpen(false)
},
})
@@ -142,21 +123,16 @@ const CreateEnsureRLSTriggerDialog = ({ onCreateSuccess }: { onCreateSuccess: ()
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>
+ {iconOnly ? (
+ <ButtonTooltip
+ type="default"
+ icon={<ShieldCheck />}
+ className="w-7"
+ tooltip={{ content: { side: 'bottom', text: 'Auto-enable RLS for new tables' } }}
+ />
+ ) : (
+ <Button type="primary">Learn more</Button>
+ )}
</DialogTrigger>
<DialogContent size="large">
<DialogHeader>
@@ -186,9 +162,21 @@ const CreateEnsureRLSTriggerDialog = ({ onCreateSuccess }: { onCreateSuccess: ()
<Button type="default" disabled={isCreating} onClick={() => setOpen(false)}>
Close
</Button>
- <Button loading={isCreating} onClick={handleCreateTrigger}>
+ <ButtonTooltip
+ disabled={!canCreateTriggers}
+ loading={isCreating}
+ onClick={handleCreateTrigger}
+ tooltip={{
+ content: {
+ side: 'bottom',
+ text: !canCreateTriggers
+ ? 'You need additional permissions to create triggers'
+ : undefined,
+ },
+ }}
+ >
Create ensure_rls trigger
- </Button>
+ </ButtonTooltip>
</DialogFooter>
</DialogContent>
</Dialog>
diff --git a/apps/studio/pages/project/[ref]/auth/policies.tsx b/apps/studio/pages/project/[ref]/auth/policies.tsx
index c9850e38bb3..5d2802cafde 100644
--- a/apps/studio/pages/project/[ref]/auth/policies.tsx
+++ b/apps/studio/pages/project/[ref]/auth/policies.tsx
@@ -31,7 +31,7 @@ import AuthLayout from '@/components/layouts/AuthLayout/AuthLayout'
import { DefaultLayout } from '@/components/layouts/DefaultLayout'
import { SIDEBAR_KEYS } from '@/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
import { AlertError } from '@/components/ui/AlertError'
-import { BannerRlsEventTrigger } from '@/components/ui/BannerStack/Banners/BannerRlsEventTrigger'
+import { AutoEnableRLSNotice } from '@/components/ui/AutoEnableRLSNotice'
import { BannerRlsTester } from '@/components/ui/BannerStack/Banners/BannerRlsTester'
import { useBannerStack } from '@/components/ui/BannerStack/BannerStackProvider'
import { DocsButton } from '@/components/ui/DocsButton'
@@ -132,7 +132,7 @@ const AuthPoliciesPage: NextPageWithLayout = () => {
const { isSchemaLocked } = useIsProtectedSchema({ schema: schema, excludedSchemas: ['realtime'] })
const { addBanner, dismissBanner } = useBannerStack()
- const [isRlsBannerDismissed] = useLocalStorageQuery(
+ const [isAutoEnableRLSMinimized] = useLocalStorageQuery(
LOCAL_STORAGE_KEYS.RLS_EVENT_TRIGGER_BANNER_DISMISSED(projectRef ?? ''),
false
)
@@ -177,12 +177,11 @@ const AuthPoliciesPage: NextPageWithLayout = () => {
.map((schema) => schema.trim())
.filter((schema) => schema.length > 0)
}, [postgrestConfig?.db_schema])
+
const { can: canReadPolicies, isSuccess: isPermissionsLoaded } = useAsyncCheckPermissions(
PermissionAction.TENANT_SQL_ADMIN_READ,
'policies'
)
- const { can: canCreateTriggers, isSuccess: isTriggerPermissionsLoaded } =
- useAsyncCheckPermissions(PermissionAction.TENANT_SQL_ADMIN_WRITE, 'triggers')
const handleSelectCreatePolicy = useCallback(
(table: string) => {
@@ -254,31 +253,6 @@ const AuthPoliciesPage: NextPageWithLayout = () => {
}
}, [addBanner, dismissBanner, isRlsTesterBannerDismissed, rlsTesterEnabled])
- useEffect(() => {
- if (!isTriggerPermissionsLoaded) return
-
- if (canCreateTriggers && !isRlsBannerDismissed) {
- addBanner({
- id: 'rls-event-trigger-banner',
- isDismissed: false,
- content: <BannerRlsEventTrigger />,
- priority: 2,
- })
- } else {
- dismissBanner('rls-event-trigger-banner')
- }
-
- return () => {
- dismissBanner('rls-event-trigger-banner')
- }
- }, [
- addBanner,
- dismissBanner,
- canCreateTriggers,
- isTriggerPermissionsLoaded,
- isRlsBannerDismissed,
- ])
-
useEffect(() => {
if (selectedIdToEdit && isPoliciesSuccess && !selectedPolicyToEdit) {
toast(`Policy ID ${selectedIdToEdit} cannot be found`)
@@ -303,13 +277,17 @@ const AuthPoliciesPage: NextPageWithLayout = () => {
</PageHeaderDescription>
</PageHeaderSummary>
<PageHeaderAside>
+ {isAutoEnableRLSMinimized && <AutoEnableRLSNotice iconOnly />}
<DocsButton href={`${DOCS_URL}/learn/auth-deep-dive/auth-row-level-security`} />
{rlsTesterEnabled && <RLSTesterSheet handleSelectEditPolicy={handleSelectEditPolicy} />}
</PageHeaderAside>
</PageHeaderMeta>
</PageHeader>
+
<PageContainer size="large">
<PageSection>
+ {!isAutoEnableRLSMinimized && <AutoEnableRLSNotice />}
+
<PageSectionContent>
<div className="mb-4 flex flex-row gap-x-2">
<SchemaSelector
diff --git a/apps/studio/pages/project/[ref]/database/tables/index.tsx b/apps/studio/pages/project/[ref]/database/tables/index.tsx
index 725217f5d80..ffc53651194 100644
--- a/apps/studio/pages/project/[ref]/database/tables/index.tsx
+++ b/apps/studio/pages/project/[ref]/database/tables/index.tsx
@@ -1,5 +1,5 @@
import { PostgresTable } from '@supabase/postgres-meta'
-import { useParams } from 'common'
+import { LOCAL_STORAGE_KEYS, useParams } from 'common'
import { useState } from 'react'
import { PageContainer } from 'ui-patterns/PageContainer'
import { PageSection, PageSectionContent } from 'ui-patterns/PageSection'
@@ -10,7 +10,9 @@ import { SidePanelEditor } from '@/components/interfaces/TableGridEditor/SidePan
import DatabaseLayout from '@/components/layouts/DatabaseLayout/DatabaseLayout'
import DefaultLayout from '@/components/layouts/DefaultLayout'
import { PageLayout } from '@/components/layouts/PageLayout/PageLayout'
+import { AutoEnableRLSNotice } from '@/components/ui/AutoEnableRLSNotice'
import { Entity, isTableLike, postgresTableToEntity } from '@/data/table-editor/table-editor-types'
+import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'
import { useTableEditorStateSnapshot } from '@/state/table-editor'
import { TableEditorTableStateContextProvider } from '@/state/table-editor-table'
import type { NextPageWithLayout } from '@/types'
@@ -20,11 +22,22 @@ const DatabaseTables: NextPageWithLayout = () => {
const snap = useTableEditorStateSnapshot()
const [selectedTableToEdit, setSelectedTableToEdit] = useState<Entity>()
+ const [isAutoEnableRLSMinimized] = useLocalStorageQuery(
+ LOCAL_STORAGE_KEYS.RLS_EVENT_TRIGGER_BANNER_DISMISSED(projectRef ?? ''),
+ false
+ )
+
return (
<>
- <PageLayout title="Database Tables" size="large">
+ <PageLayout
+ title="Database Tables"
+ size="large"
+ primaryActions={isAutoEnableRLSMinimized && <AutoEnableRLSNotice iconOnly />}
+ >
<PageContainer size="large">
<PageSection>
+ {!isAutoEnableRLSMinimized && <AutoEnableRLSNotice />}
+
<PageSectionContent>
<TableList
onAddTable={snap.onAddTable}