Files
supabase/apps/studio/components/ui/BannerStack/Banners/BannerRlsEventTrigger.tsx

131 lines
4.5 KiB
TypeScript

import { ShieldCheck } from 'lucide-react'
import { useEffect, useMemo, useState } from 'react'
import { PermissionAction } from '@supabase/shared-types/out/constants'
import { LOCAL_STORAGE_KEYS } from 'common'
import { useParams } from 'common/hooks'
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 { useAsyncCheckPermissions } from 'hooks/misc/useCheckPermissions'
import { useLocalStorageQuery } from 'hooks/misc/useLocalStorage'
import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
import { useTrack } from 'lib/telemetry/track'
import Link from 'next/link'
import { Button, cn } from 'ui'
import { BannerCard } from '../BannerCard'
import { useBannerStack } from '../BannerStackProvider'
export const BannerRlsEventTrigger = () => {
const { ref } = useParams()
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,
connectionString: project?.connectionString,
})
const hasDefaultTrigger = useMemo(
() =>
eventTriggers.some(
(trigger) => trigger.name === 'ensure_rls' || trigger.function_name === 'rls_auto_enable'
),
[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 (
<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} />
</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>
) : (
<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>
)}
</div>
</div>
</BannerCard>
)
}