Files
supabase/apps/studio/components/layouts/ProjectNeedsSecuring/ProjectNeedsSecuringView.tsx
Saxon Fletcher 3b756e4d9f Chore/project secure (#45108)
<img width="2652" height="830" alt="image"
src="https://github.com/user-attachments/assets/3c3921e7-c255-4e59-a9c3-c5f97da87788"
/>

Adds a full screen alert behind a feature flag `projectNeedsSecuring`
that prompts for fixing RLS issues.

Adjusts a few other small styles to add more prominence to critical
advisor issues.

To test:

- Enable the flag
- Make sure you have a table with RLS disabled
- Open project home and note the fade in of full page review
- Click "copy prompt" or "fix" and note the prompt
- Click skip to home and refresh the page, note it doesn't appear
anymore


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Project-level security gate on project home with AI assistant prompts,
table details, per-project dismissible notice, and a new telemetry event
for CTA interactions.

* **Improvements**
* Stronger visual treatment for critical advisor items and advisor CTA
when critical issues exist.
* Assistant dropdown supports a copy-prompt callback; added
local-storage key and utilities/types to support project security
workflows.

* **Tests**
  * Added tests covering gate behavior, navigation, and dismissal logic.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2026-04-29 04:08:09 +00:00

235 lines
8.2 KiB
TypeScript

import { ArrowRight, Check, ExternalLink, Lightbulb, X } from 'lucide-react'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { useMemo } from 'react'
import {
Button,
Button_Shadcn_,
Card,
Table,
TableBody,
TableCell,
TableHead,
TableHeader,
TableRow,
} from 'ui'
import { PageContainer } from 'ui-patterns/PageContainer'
import {
PageHeader,
PageHeaderAside,
PageHeaderDescription,
PageHeaderIcon,
PageHeaderMeta,
PageHeaderSummary,
PageHeaderTitle,
} from 'ui-patterns/PageHeader'
import {
PageSection,
PageSectionAside,
PageSectionContent,
PageSectionMeta,
PageSectionSummary,
PageSectionTitle,
} from 'ui-patterns/PageSection'
import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'
import type {
ProjectSecurityActionDetails,
ProjectSecurityActionType,
ProjectSecurityTable,
} from './ProjectNeedsSecuring.types'
import {
buildSecurityPromptMarkdown,
formatRlsDescription,
getTableKey,
} from './ProjectNeedsSecuring.utils'
import { SIDEBAR_KEYS } from '@/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
import { AiAssistantDropdown } from '@/components/ui/AiAssistantDropdown'
import AlertError from '@/components/ui/AlertError'
import { createNavigationHandler } from '@/lib/navigation'
import { useAiAssistantStateSnapshot } from '@/state/ai-assistant-state'
import { useSidebarManagerSnapshot } from '@/state/sidebar-manager-state'
const StatusCell = ({ enabled, label }: { enabled: boolean; label: string }) => (
<div className="flex items-center gap-2 text-sm">
{enabled ? (
<Check size={14} className="text-brand" aria-hidden="true" />
) : (
<X size={14} className="text-destructive" aria-hidden="true" />
)}
<span>{label}</span>
</div>
)
export const ProjectNeedsSecuringView = ({
projectRef,
issueCount,
tables,
isLoading,
error,
onDismiss,
onTrackAction,
}: {
projectRef: string
issueCount: number
tables: ProjectSecurityTable[]
isLoading: boolean
error?: { message: string } | null
onDismiss: () => void
onTrackAction: (type: ProjectSecurityActionType, details?: ProjectSecurityActionDetails) => void
}) => {
const router = useRouter()
const aiSnap = useAiAssistantStateSnapshot()
const { openSidebar } = useSidebarManagerSnapshot()
const promptMarkdown = useMemo(
() => buildSecurityPromptMarkdown(issueCount, tables),
[issueCount, tables]
)
const handleOpenAssistant = () => {
onTrackAction('ask_assistant')
openSidebar(SIDEBAR_KEYS.AI_ASSISTANT)
aiSnap.newChat({
name: 'Review project security',
initialInput: promptMarkdown,
})
}
return (
<div className="flex flex-1 flex-col overflow-y-auto">
<PageHeader size="default">
<PageHeaderMeta>
<PageHeaderIcon>
<div className="shrink-0 w-14 h-14 relative bg-destructive-200 border border-destructive-400 rounded-md flex items-center justify-center">
<Lightbulb size={20} strokeWidth={1.5} className="text-destructive" />
</div>
</PageHeaderIcon>
<PageHeaderSummary>
<PageHeaderTitle>Your project needs securing</PageHeaderTitle>
<PageHeaderDescription>{formatRlsDescription(issueCount)}</PageHeaderDescription>
</PageHeaderSummary>
<PageHeaderAside>
<Button asChild type="text" iconRight={<ArrowRight />}>
<Link
href={`/project/${projectRef}`}
onClick={() => {
onTrackAction('skip_to_home')
onDismiss()
}}
>
Skip to home
</Link>
</Button>
</PageHeaderAside>
</PageHeaderMeta>
</PageHeader>
<PageContainer size="default" className="pb-12">
<PageSection>
<PageSectionMeta>
<PageSectionSummary>
<PageSectionTitle>Review and fix</PageSectionTitle>
</PageSectionSummary>
<PageSectionAside>
<AiAssistantDropdown
label="Ask Assistant"
size="tiny"
buildPrompt={() => promptMarkdown}
onOpenAssistant={handleOpenAssistant}
onCopyPrompt={() => onTrackAction('copy_prompt')}
copyLabel="Copy Markdown"
disabled={isLoading}
/>
</PageSectionAside>
</PageSectionMeta>
<PageSectionContent>
{isLoading ? (
<GenericSkeletonLoader />
) : error ? (
<AlertError
projectRef={projectRef}
error={error}
subject="Failed to retrieve project tables"
/>
) : (
<Card>
<Table>
<TableHeader>
<TableRow>
<TableHead>Name</TableHead>
<TableHead>Schema</TableHead>
<TableHead>
<div className="flex items-center gap-1.5">
<span>Accessible via Data API</span>
<Button_Shadcn_ asChild variant="ghost" size="icon" className="h-6 w-6">
<Link
href={`/project/${projectRef}/integrations/data_api/settings`}
target="_blank"
rel="noreferrer"
aria-label="Open Data API settings"
>
<ExternalLink size={14} aria-hidden="true" />
</Link>
</Button_Shadcn_>
</div>
</TableHead>
<TableHead>RLS</TableHead>
</TableRow>
</TableHeader>
<TableBody>
{tables.map((table) => {
const policiesHref = `/project/${projectRef}/auth/policies?schema=${table.schema}&search=${table.name}`
const handleNavigation = createNavigationHandler(policiesHref, router)
const trackViewPolicies = () =>
onTrackAction('view_policies', {
schema: table.schema,
tableName: table.name,
})
return (
<TableRow
key={getTableKey(table)}
className="relative cursor-pointer inset-focus"
onClick={(event) => {
trackViewPolicies()
handleNavigation(event)
}}
onAuxClick={(event) => {
if (event.button === 1) trackViewPolicies()
handleNavigation(event)
}}
onKeyDown={(event) => {
if (event.key === 'Enter' || event.key === ' ') trackViewPolicies()
handleNavigation(event)
}}
tabIndex={0}
>
<TableCell className="font-medium">{table.name}</TableCell>
<TableCell>{table.schema}</TableCell>
<TableCell>
<StatusCell
enabled={table.dataApiAccessible}
label={table.dataApiAccessible ? 'Accessible' : 'Not accessible'}
/>
</TableCell>
<TableCell>
<StatusCell
enabled={table.rlsEnabled}
label={table.rlsEnabled ? 'Enabled' : 'Disabled'}
/>
</TableCell>
</TableRow>
)
})}
</TableBody>
</Table>
</Card>
)}
</PageSectionContent>
</PageSection>
</PageContainer>
</div>
)
}