Skip to content

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

Joshen/fe 3879 schema not exposed warning is unnecessarily repeated in (#47868)

Joshen Lim7f8fb85caf7e
diff --git a/apps/studio/components/interfaces/Database/Policies/Policies.tsx b/apps/studio/components/interfaces/Database/Policies/Policies.tsx
index b841b160ab4..6914e380755 100644
--- a/apps/studio/components/interfaces/Database/Policies/Policies.tsx
+++ b/apps/studio/components/interfaces/Database/Policies/Policies.tsx
@@ -4,8 +4,10 @@ import Link from 'next/link'
import { useCallback, useState } from 'react'
import { toast } from 'sonner'
import { Button, Card, CardContent } from 'ui'
+import { Admonition } from 'ui-patterns/admonition'
import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
+import { usePoliciesData } from './PoliciesDataContext'
import {
PolicyTableRow,
PolicyTableRowProps,
@@ -13,6 +15,7 @@ import {
import type { Policy } from '@/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils'
import { ProtectedSchemaWarning } from '@/components/interfaces/Database/ProtectedSchemaWarning'
import { RLSToggleDialog } from '@/components/interfaces/Database/RLSToggleDialog'
+import { InlineLink } from '@/components/ui/InlineLink'
import { NoSearchResults } from '@/components/ui/NoSearchResults'
import { useDatabasePolicyDeleteMutation } from '@/data/database-policies/database-policy-delete-mutation'
import { useTableUpdateMutation } from '@/data/tables/table-update-mutation'
@@ -43,6 +46,9 @@ export const Policies = ({
}: PoliciesProps) => {
const { ref } = useParams()
const { data: project } = useSelectedProjectQuery()
+ const { exposedSchemas } = usePoliciesData()
+
+ const isSchemaExposedAPI = exposedSchemas.has(schema)
const [selectedTableToToggleRLS, setSelectedTableToToggleRLS] = useState<{
id: number
@@ -148,6 +154,21 @@ export const Policies = ({
<>
<div className="flex flex-col gap-y-4 pb-4">
{isLocked && <ProtectedSchemaWarning schema={schema} entity="policies" />}
+
+ {!isSchemaExposedAPI && (
+ <Admonition
+ variant="warning"
+ title="No data from any table in this schema will be selectable via Supabase APIs"
+ >
+ This schema is not exposed via the Supabase APIs. You may configure this in your
+ project’s{' '}
+ <InlineLink href={`/project/${ref}/integrations/data_api/settings`}>
+ Data API settings
+ </InlineLink>
+ .
+ </Admonition>
+ )}
+
{tables.length > 0 ? (
<>
{tables.map((table) => {
diff --git a/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.test.ts b/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.test.ts
index d2722dca028..7f048bd877f 100644
--- a/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.test.ts
+++ b/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.test.ts
@@ -1,6 +1,9 @@
+import { render } from '@testing-library/react'
+import type { ReactElement } from 'react'
import { describe, expect, it } from 'vitest'
import { getTableAdmonitionMessage, getTableDataApiStatus } from './PolicyTableRow.utils'
+import type { TableDataApiStatus } from './PolicyTableRow.utils'
import type { TableApiAccessData } from '@/data/privileges/table-api-access-query'
import type { ApiPrivilegesByRole } from '@/lib/data-api-types'
@@ -32,19 +35,8 @@ const noGrants: TableApiAccessData = { apiAccessType: 'exposed-schema-no-grants'
const schemaNotExposedData: TableApiAccessData = { apiAccessType: 'none' }
describe('getTableDataApiStatus', () => {
- it('returns schema-not-exposed when the schema is not in the exposed list', () => {
- const status = getTableDataApiStatus({
- isSchemaExposed: false,
- apiAccessData: grantedAccess,
- isRLSEnabled: true,
- policiesCount: 1,
- })
- expect(status).toBe('schema-not-exposed')
- })
-
it('returns no-grants when schema is exposed but no API roles have privileges', () => {
const status = getTableDataApiStatus({
- isSchemaExposed: true,
apiAccessData: noGrants,
isRLSEnabled: true,
policiesCount: 0,
@@ -54,7 +46,6 @@ describe('getTableDataApiStatus', () => {
it('returns custom-grants for partial/non-standard grants — even if RLS is off', () => {
const status = getTableDataApiStatus({
- isSchemaExposed: true,
apiAccessData: customAccess,
isRLSEnabled: false,
policiesCount: 0,
@@ -64,7 +55,6 @@ describe('getTableDataApiStatus', () => {
it('returns publicly-readable when fully granted and RLS is off', () => {
const status = getTableDataApiStatus({
- isSchemaExposed: true,
apiAccessData: grantedAccess,
isRLSEnabled: false,
policiesCount: 3,
@@ -74,7 +64,6 @@ describe('getTableDataApiStatus', () => {
it('returns locked-by-rls when fully granted + RLS on + no policies', () => {
const status = getTableDataApiStatus({
- isSchemaExposed: true,
apiAccessData: grantedAccess,
isRLSEnabled: true,
policiesCount: 0,
@@ -84,7 +73,6 @@ describe('getTableDataApiStatus', () => {
it('returns secured when fully granted + RLS on + policies exist', () => {
const status = getTableDataApiStatus({
- isSchemaExposed: true,
apiAccessData: grantedAccess,
isRLSEnabled: true,
policiesCount: 2,
@@ -97,7 +85,6 @@ describe('getTableDataApiStatus', () => {
// but data stays undefined). We must not fall through to 'schema-not-exposed' — that
// would tell the user to reconfigure API settings for a schema that is in fact exposed.
const status = getTableDataApiStatus({
- isSchemaExposed: true,
apiAccessData: undefined,
isRLSEnabled: true,
policiesCount: 0,
@@ -109,7 +96,6 @@ describe('getTableDataApiStatus', () => {
// Defensive: the query shouldn't emit apiAccessType=none when schema is exposed,
// but if it does we still don't want the false "schema not exposed" admonition.
const status = getTableDataApiStatus({
- isSchemaExposed: true,
apiAccessData: schemaNotExposedData,
isRLSEnabled: true,
policiesCount: 0,
@@ -117,25 +103,13 @@ describe('getTableDataApiStatus', () => {
expect(status).toBe('unknown')
})
- it('isSchemaExposed=false wins over any apiAccessData value', () => {
- const status = getTableDataApiStatus({
- isSchemaExposed: false,
- apiAccessData: noGrants,
- isRLSEnabled: true,
- policiesCount: 0,
- })
- expect(status).toBe('schema-not-exposed')
- })
-
it('custom-grants wins over RLS state — we never claim public-readable for partial grants', () => {
const rlsOff = getTableDataApiStatus({
- isSchemaExposed: true,
apiAccessData: customAccess,
isRLSEnabled: false,
policiesCount: 0,
})
const rlsOnNoPolicies = getTableDataApiStatus({
- isSchemaExposed: true,
apiAccessData: customAccess,
isRLSEnabled: true,
policiesCount: 0,
@@ -145,40 +119,48 @@ describe('getTableDataApiStatus', () => {
})
})
+const renderAdmonitionText = (status: TableDataApiStatus) => {
+ const message = getTableAdmonitionMessage({ status })
+ return render(message as ReactElement).container.textContent
+}
+
describe('getTableAdmonitionMessage', () => {
it('returns the custom-grants copy', () => {
- expect(getTableAdmonitionMessage('custom-grants')).toBe(
+ expect(renderAdmonitionText('custom-grants')).toBe(
'This table has custom Data API permissions — access may be restricted for some roles or operations.'
)
})
- it('returns the no-grants copy', () => {
- expect(getTableAdmonitionMessage('no-grants')).toBe(
+ it('returns the no-grants copy, linking to the Data API settings for the given project ref', () => {
+ const message = getTableAdmonitionMessage({ status: 'no-grants', ref: 'my-project' })
+ const { container, getByRole } = render(message as ReactElement)
+
+ expect(container.textContent).toBe(
'This table cannot be accessed via the Data API. Enable access in your project’s Data API settings.'
)
+ expect(getByRole('link', { name: 'Data API settings' })).toHaveAttribute(
+ 'href',
+ '/project/my-project/integrations/data_api/settings'
+ )
})
it('returns the publicly-readable copy', () => {
- expect(getTableAdmonitionMessage('publicly-readable')).toBe(
+ expect(renderAdmonitionText('publicly-readable')).toBe(
'This table can be accessed by anyone via the Data API as RLS is disabled.'
)
})
it('returns the locked-by-rls copy', () => {
- expect(getTableAdmonitionMessage('locked-by-rls')).toBe(
+ expect(renderAdmonitionText('locked-by-rls')).toBe(
'No data will be returned via the Data API as no RLS policies exist on this table.'
)
})
it('returns null for secured — no admonition needed', () => {
- expect(getTableAdmonitionMessage('secured')).toBeNull()
- })
-
- it('returns null for schema-not-exposed — handled by a separate admonition with a link', () => {
- expect(getTableAdmonitionMessage('schema-not-exposed')).toBeNull()
+ expect(getTableAdmonitionMessage({ status: 'secured' })).toBeNull()
})
it('returns null for unknown — caller should stay silent during loading/errored state', () => {
- expect(getTableAdmonitionMessage('unknown')).toBeNull()
+ expect(getTableAdmonitionMessage({ status: 'unknown' })).toBeNull()
})
})
diff --git a/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.ts b/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.tsx
similarity index 76%
rename from apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.ts
rename to apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.tsx
index 5dcf3033906..54ef31d3175 100644
--- a/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.ts
+++ b/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/PolicyTableRow.utils.tsx
@@ -1,6 +1,8 @@
import { ident, joinSqlFragments, safeSql, type SafeSqlFragment } from '@supabase/pg-meta'
import type { PGPolicy } from '@supabase/pg-meta'
+import { ReactNode } from 'react'
+import { InlineLink } from '@/components/ui/InlineLink'
import type { TableApiAccessData } from '@/data/privileges/table-api-access-query'
export type Policy = Omit<PGPolicy, 'definition' | 'check'> & {
@@ -14,7 +16,6 @@ export type Policy = Omit<PGPolicy, 'definition' | 'check'> & {
* page's ExposedTableSelector so the two views agree on what counts as exposed.
*/
export type TableDataApiStatus =
- | 'schema-not-exposed' // schema isn't in the PostgREST exposed list
| 'no-grants' // schema exposed, no API roles have any privileges (revoked)
| 'custom-grants' // schema exposed, partial / non-standard grants
| 'publicly-readable' // fully granted + RLS disabled (dangerous)
@@ -23,17 +24,14 @@ export type TableDataApiStatus =
| 'unknown' // privileges query is still loading or errored — caller should stay silent
export function getTableDataApiStatus({
- isSchemaExposed,
apiAccessData,
isRLSEnabled,
policiesCount,
}: {
- isSchemaExposed: boolean
apiAccessData: TableApiAccessData | undefined
isRLSEnabled: boolean
policiesCount: number
}): TableDataApiStatus {
- if (!isSchemaExposed) return 'schema-not-exposed'
if (apiAccessData?.apiAccessType === 'exposed-schema-no-grants') return 'no-grants'
if (apiAccessData?.apiAccessType === 'access') {
if (apiAccessData.grantStatus === 'custom') return 'custom-grants'
@@ -52,16 +50,37 @@ export function getTableDataApiStatus({
* admonition (the "everything is fine" `secured` case and the orthogonal
* `schema-not-exposed` case which is rendered separately with a link).
*/
-export function getTableAdmonitionMessage(status: TableDataApiStatus): string | null {
+export function getTableAdmonitionMessage({
+ status,
+ ref = '_',
+}: {
+ status: TableDataApiStatus
+ ref?: string
+}): ReactNode | null {
switch (status) {
case 'custom-grants':
- return 'This table has custom Data API permissions — access may be restricted for some roles or operations.'
+ return (
+ <p>
+ This table has custom Data API permissions — access may be restricted for some roles or
+ operations.
+ </p>
+ )
case 'no-grants':
- return 'This table cannot be accessed via the Data API. Enable access in your project’s Data API settings.'
+ return (
+ <p>
+ This table cannot be accessed via the Data API. Enable access in your project’s{' '}
+ <InlineLink href={`/project/${ref}/integrations/data_api/settings`}>
+ Data API settings
+ </InlineLink>
+ .
+ </p>
+ )
case 'publicly-readable':
- return 'This table can be accessed by anyone via the Data API as RLS is disabled.'
+ return <p>This table can be accessed by anyone via the Data API as RLS is disabled.</p>
case 'locked-by-rls':
- return 'No data will be returned via the Data API as no RLS policies exist on this table.'
+ return (
+ <p>No data will be returned via the Data API as no RLS policies exist on this table.</p>
+ )
default:
return null
}
diff --git a/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/index.tsx b/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/index.tsx
index 2e60637e59b..9b04640fe63 100644
--- a/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/index.tsx
+++ b/apps/studio/components/interfaces/Database/Policies/PolicyTableRow/index.tsx
@@ -22,7 +22,6 @@ import type { Policy } from './PolicyTableRow.utils'
import { getTableAdmonitionMessage, getTableDataApiStatus } from './PolicyTableRow.utils'
import { PolicyTableRowHeader } from './PolicyTableRowHeader'
import { AlertError } from '@/components/ui/AlertError'
-import { InlineLink } from '@/components/ui/InlineLink'
import { useTableApiAccessQuery } from '@/data/privileges/table-api-access-query'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
@@ -45,7 +44,7 @@ const PolicyTableRowComponent = ({
}: PolicyTableRowProps) => {
const { ref } = useParams()
const { data: project } = useSelectedProjectQuery()
- const { getPoliciesForTable, isPoliciesLoading, isPoliciesError, policiesError, exposedSchemas } =
+ const { getPoliciesForTable, isPoliciesLoading, isPoliciesError, policiesError } =
usePoliciesData()
const policies = useMemo(
@@ -72,12 +71,11 @@ const PolicyTableRowComponent = ({
const status = useMemo(
() =>
getTableDataApiStatus({
- isSchemaExposed: exposedSchemas.has(table.schema),
apiAccessData: apiAccessMap?.[table.name],
isRLSEnabled: table.rls_enabled,
policiesCount: policies.length,
}),
- [exposedSchemas, apiAccessMap, table.schema, table.name, table.rls_enabled, policies.length]
+ [apiAccessMap, table.name, table.rls_enabled, policies.length]
)
const hasApiAccess =
@@ -90,7 +88,7 @@ const PolicyTableRowComponent = ({
const showPolicies = !isPoliciesLoading && !isPoliciesError && !isLoadingRolesAccess
- const admonitionMessage = useMemo(() => getTableAdmonitionMessage(status), [status])
+ const admonitionMessage = useMemo(() => getTableAdmonitionMessage({ status, ref }), [status, ref])
return (
<Card className={cn(isPubliclyReadable && 'border-warning-500')}>
@@ -107,30 +105,13 @@ const PolicyTableRowComponent = ({
/>
</CardHeader>
- {!isLoadingRolesAccess && !isRolesAccessError && status === 'schema-not-exposed' && (
- <Admonition
- showIcon={false}
- type="warning"
- className="border-0 border-y rounded-none min-h-12 flex items-center"
- >
- <p className="text-foreground-light">
- No data will be selectable via Supabase APIs as this schema is not exposed. You may
- configure this in your project’s{' '}
- <InlineLink href={`/project/${ref}/integrations/data_api/settings`}>
- API settings
- </InlineLink>
- .
- </p>
- </Admonition>
- )}
-
{!isLoadingRolesAccess && !isRolesAccessError && admonitionMessage !== null && (
<Admonition
showIcon={false}
type={isPubliclyReadable ? 'warning' : 'default'}
className="border-0 border-y rounded-none min-h-12 flex items-center"
>
- <p>{admonitionMessage}</p>
+ {admonitionMessage}
</Admonition>
)}
diff --git a/apps/studio/components/layouts/TableEditorLayout/TableEditorMenu.tsx b/apps/studio/components/layouts/TableEditorLayout/TableEditorMenu.tsx
index 43c120841e7..688fc9cea21 100644
--- a/apps/studio/components/layouts/TableEditorLayout/TableEditorMenu.tsx
+++ b/apps/studio/components/layouts/TableEditorLayout/TableEditorMenu.tsx
@@ -3,17 +3,7 @@ import { keepPreviousData } from '@tanstack/react-query'
import { useParams } from 'common'
import { Filter, Plus } from 'lucide-react'
import { useCallback, useEffect, useMemo, useState } from 'react'
-import {
- Button,
- Checkbox,
- Label,
- Popover,
- PopoverContent,
- PopoverTrigger,
- Tooltip,
- TooltipContent,
- TooltipTrigger,
-} from 'ui'
+import { Button, Checkbox, Label, Popover, PopoverContent, PopoverTrigger } from 'ui'
import {
InnerSideBarEmptyPanel,
InnerSideBarFilters,
@@ -250,21 +240,17 @@ export const TableEditorMenu = () => {
</InnerSideBarFilterSearchInput>
<Popover>
<PopoverTrigger asChild>
- <Tooltip>
- <TooltipTrigger asChild>
- <Button
- variant={visibleTypes.length !== 5 ? 'default' : 'dashed'}
- className="h-[32px] md:h-[28px] px-1.5"
- icon={<Filter />}
- aria-label="Filter"
- />
- </TooltipTrigger>
- <TooltipContent side="bottom">Filter</TooltipContent>
- </Tooltip>
+ <ButtonTooltip
+ variant={visibleTypes.length !== 5 ? 'default' : 'dashed'}
+ className="h-[32px] md:h-[28px] px-1.5"
+ icon={<Filter />}
+ aria-label="Filter"
+ tooltip={{ content: { side: 'bottom', text: 'Filter' } }}
+ />
</PopoverTrigger>
- <PopoverContent className="p-0 w-56" side="bottom" align="center">
+ <PopoverContent className="p-0 w-60" side="bottom" align="center">
<div className="px-3 pt-3 pb-2 flex flex-col gap-y-2">
- <p className="text-xs">Show entity types</p>
+ <p className="text-xs">Filter entity types</p>
<div className="flex flex-col">
{Object.entries(ENTITY_TYPE).map(([key, value]) => (
<div key={key} className="group flex items-center justify-between py-0.5">