Files
supabase/apps/studio/components/layouts/ProjectNeedsSecuring/ProjectNeedsSecuring.test.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

272 lines
7.3 KiB
TypeScript

import { fireEvent, screen } from '@testing-library/react'
import { mockAnimationsApi } from 'jsdom-testing-mocks'
import type { MouseEventHandler, ReactNode } from 'react'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { ProjectNeedsSecuring } from './ProjectNeedsSecuring'
import { render } from '@/tests/helpers'
const {
mockUseFlag,
mockUseProjectLintsQuery,
mockUseSelectedProjectQuery,
mockUseTablesQuery,
mockUseProjectPostgrestConfigQuery,
mockUseTablePrivilegesQuery,
mockUseLocalStorageQuery,
mockUseRouter,
mockRouterPush,
} = vi.hoisted(() => ({
mockUseFlag: vi.fn(),
mockUseProjectLintsQuery: vi.fn(),
mockUseSelectedProjectQuery: vi.fn(),
mockUseTablesQuery: vi.fn(),
mockUseProjectPostgrestConfigQuery: vi.fn(),
mockUseTablePrivilegesQuery: vi.fn(),
mockUseLocalStorageQuery: vi.fn(),
mockUseRouter: vi.fn(),
mockRouterPush: vi.fn(),
}))
vi.mock('common', async () => {
const actual = await vi.importActual<typeof import('common')>('common')
return {
...actual,
useFlag: mockUseFlag,
useParams: () => ({ ref: 'project-ref' }),
}
})
vi.mock('next/router', () => ({
useRouter: () => mockUseRouter(),
}))
vi.mock('next/link', () => ({
default: ({
href,
children,
onClick,
...props
}: {
href: string
children: ReactNode
onClick?: MouseEventHandler<HTMLAnchorElement>
[key: string]: unknown
}) => (
<a href={href} onClick={onClick} {...props}>
{children}
</a>
),
}))
vi.mock('@/data/lint/lint-query', () => ({
useProjectLintsQuery: mockUseProjectLintsQuery,
}))
vi.mock('@/hooks/misc/useSelectedProject', () => ({
useSelectedProjectQuery: mockUseSelectedProjectQuery,
}))
vi.mock('@/data/tables/tables-query', () => ({
useTablesQuery: mockUseTablesQuery,
}))
vi.mock('@/data/config/project-postgrest-config-query', () => ({
parseDbSchemaString: vi.fn((value: string) => value.split(',').map((schema) => schema.trim())),
useProjectPostgrestConfigQuery: mockUseProjectPostgrestConfigQuery,
}))
vi.mock('@/data/privileges/table-privileges-query', () => ({
useTablePrivilegesQuery: mockUseTablePrivilegesQuery,
}))
vi.mock('@/hooks/misc/useLocalStorage', () => ({
useLocalStorageQuery: mockUseLocalStorageQuery,
}))
vi.mock('sonner', () => ({
toast: {
error: vi.fn(),
},
}))
const issueLint = {
cache_key: 'lint-1',
name: 'rls_disabled_in_public',
detail: 'RLS is disabled on public.invoices',
description: 'RLS disabled',
level: 'ERROR',
categories: ['SECURITY'],
metadata: {
schema: 'public',
name: 'invoices',
},
}
const tables = [
{
id: 1,
name: 'invoices',
schema: 'public',
rls_enabled: false,
},
{
id: 2,
name: 'profiles',
schema: 'public',
rls_enabled: false,
},
{
id: 3,
name: 'customers',
schema: 'public',
rls_enabled: true,
},
]
const tablePrivileges = [
{
schema: 'public',
name: 'invoices',
privileges: [
{
grantee: 'anon',
privilege_type: 'SELECT',
},
],
},
]
describe('ProjectNeedsSecuring', () => {
beforeEach(() => {
mockAnimationsApi()
mockUseFlag.mockReturnValue(true)
mockUseRouter.mockReturnValue({ pathname: '/project/[ref]', push: mockRouterPush })
mockUseSelectedProjectQuery.mockReturnValue({
data: { connectionString: 'postgresql://example' },
})
mockUseProjectLintsQuery.mockReturnValue({
data: [issueLint],
isPending: false,
isError: false,
})
mockUseTablesQuery.mockReturnValue({
data: tables,
isPending: false,
isError: false,
})
mockUseProjectPostgrestConfigQuery.mockReturnValue({
data: 'public',
isPending: false,
isError: false,
})
mockUseTablePrivilegesQuery.mockReturnValue({
data: tablePrivileges,
isPending: false,
isError: false,
})
mockUseLocalStorageQuery.mockReturnValue([null, vi.fn(), { isLoading: false }])
})
afterEach(() => {
vi.clearAllMocks()
window.localStorage.clear()
})
it('renders the security gate when an exposed table has RLS disabled and the project has not been dismissed', () => {
render(
<ProjectNeedsSecuring>
<div data-testid="project-children">Project content</div>
</ProjectNeedsSecuring>
)
expect(screen.getByText('Your project needs securing')).toBeInTheDocument()
expect(screen.getByText('Review and fix')).toBeInTheDocument()
expect(screen.getByRole('link', { name: 'Open Data API settings' })).toHaveAttribute(
'href',
'/project/project-ref/integrations/data_api/settings'
)
expect(screen.queryByRole('columnheader', { name: 'Action' })).not.toBeInTheDocument()
expect(screen.queryByRole('link', { name: 'View policies' })).not.toBeInTheDocument()
expect(screen.queryByText('profiles')).not.toBeInTheDocument()
expect(screen.queryByText('customers')).not.toBeInTheDocument()
expect(screen.getByText('Skip to home')).toBeInTheDocument()
expect(screen.queryByTestId('project-children')).not.toBeInTheDocument()
})
it('navigates to the table policies page when a table row is clicked', () => {
render(
<ProjectNeedsSecuring>
<div data-testid="project-children">Project content</div>
</ProjectNeedsSecuring>
)
fireEvent.click(screen.getByText('invoices'))
expect(mockRouterPush).toHaveBeenCalledWith(
'/project/project-ref/auth/policies?schema=public&search=invoices'
)
})
it('renders the project content when the security gate has been dismissed', () => {
mockUseLocalStorageQuery.mockReturnValue([
'2026-04-21T00:00:00.000Z',
vi.fn(),
{ isLoading: false },
])
render(
<ProjectNeedsSecuring>
<div data-testid="project-children">Project content</div>
</ProjectNeedsSecuring>
)
expect(screen.queryByText('Your project needs securing')).not.toBeInTheDocument()
expect(screen.getByTestId('project-children')).toBeInTheDocument()
})
it('renders the project content when there are no RLS issues', () => {
mockUseProjectLintsQuery.mockReturnValue({
data: [],
isPending: false,
isError: false,
})
render(
<ProjectNeedsSecuring>
<div data-testid="project-children">Project content</div>
</ProjectNeedsSecuring>
)
expect(screen.queryByText('Your project needs securing')).not.toBeInTheDocument()
expect(screen.getByTestId('project-children')).toBeInTheDocument()
})
it('renders the project content on non-home project routes', () => {
mockUseRouter.mockReturnValue({ pathname: '/project/[ref]/database/tables' })
render(
<ProjectNeedsSecuring>
<div data-testid="project-children">Project content</div>
</ProjectNeedsSecuring>
)
expect(screen.queryByText('Your project needs securing')).not.toBeInTheDocument()
expect(screen.getByTestId('project-children')).toBeInTheDocument()
})
it('renders the project content when the feature flag is disabled', () => {
mockUseFlag.mockReturnValue(false)
render(
<ProjectNeedsSecuring>
<div data-testid="project-children">Project content</div>
</ProjectNeedsSecuring>
)
expect(screen.queryByText('Your project needs securing')).not.toBeInTheDocument()
expect(screen.getByTestId('project-children')).toBeInTheDocument()
})
})