Skip to content

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

Joshen/fe 3610 projectneedssecuring to avoid fetching all table privileges (#46929)

Joshen Lim4691372093ed
diff --git a/apps/studio/components/interfaces/Integrations/Queues/SingleQueue/QueueSettings.tsx b/apps/studio/components/interfaces/Integrations/Queues/SingleQueue/QueueSettings.tsx
index 3d08b838b4f..6f098227cfb 100644
--- a/apps/studio/components/interfaces/Integrations/Queues/SingleQueue/QueueSettings.tsx
+++ b/apps/studio/components/interfaces/Integrations/Queues/SingleQueue/QueueSettings.tsx
@@ -45,6 +45,7 @@ import {
} from '@/data/privileges/table-privileges-revoke-mutation'
import { useTablesQuery } from '@/data/tables/tables-query'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
+import { getErrorMessage } from '@/lib/get-error-message'
const ACTIONS = ['select', 'insert', 'update', 'delete']
const ROLES = ['anon', 'authenticated', 'postgres', 'service_role']
@@ -92,10 +93,9 @@ export const QueueSettings = ({}: QueueSettingsProps) => {
const { data: allTablePrivileges, isSuccess: isSuccessPrivileges } = useTablePrivilegesQuery({
projectRef: project?.ref,
connectionString: project?.connectionString,
+ includedSchemas: ['pgmq'],
})
- const queuePrivileges = allTablePrivileges?.find(
- (x) => x.schema === 'pgmq' && x.name === queueRelname
- )
+ const queuePrivileges = allTablePrivileges?.find((x) => x.name === queueRelname)
const { mutateAsync: grantPrivilege } = useTablePrivilegesGrantMutation()
const { mutateAsync: revokePrivilege } = useTablePrivilegesRevokeMutation()
@@ -213,8 +213,8 @@ export const QueueSettings = ({}: QueueSettingsProps) => {
])
toast.success('Successfully updated permissions')
setOpen(false)
- } catch (error: any) {
- toast.error(`Failed to update permissions: ${error.message}`)
+ } catch (error: unknown) {
+ toast.error(`Failed to update permissions: ${getErrorMessage(error)}`)
} finally {
setIsSaving(false)
}
@@ -222,12 +222,15 @@ export const QueueSettings = ({}: QueueSettingsProps) => {
useEffect(() => {
if (open && isSuccessPrivileges && queuePrivileges) {
- const initialState = queuePrivileges.privileges.reduce((a, b) => {
- return {
- ...a,
- [b.grantee]: { ...(a as any)[b.grantee], [b.privilege_type.toLowerCase()]: true },
- }
- }, {})
+ const initialState = queuePrivileges.privileges.reduce<{ [key: string]: Privileges }>(
+ (a, b) => {
+ return {
+ ...a,
+ [b.grantee]: { ...a[b.grantee], [b.privilege_type.toLowerCase()]: true },
+ }
+ },
+ {}
+ )
setPrivileges(initialState)
}
}, [open, isSuccessPrivileges])
diff --git a/apps/studio/components/layouts/ProjectNeedsSecuring/ProjectNeedsSecuring.tsx b/apps/studio/components/layouts/ProjectNeedsSecuring/ProjectNeedsSecuring.tsx
index 35259c472b2..7392403e73b 100644
--- a/apps/studio/components/layouts/ProjectNeedsSecuring/ProjectNeedsSecuring.tsx
+++ b/apps/studio/components/layouts/ProjectNeedsSecuring/ProjectNeedsSecuring.tsx
@@ -91,6 +91,7 @@ const ProjectNeedsSecuringGate = ({ children }: PropsWithChildren) => {
data: dbSchema,
error: postgrestConfigError,
isPending: isLoadingPostgrestConfig,
+ isSuccess: isSuccessPostgrestConfig,
} = useProjectPostgrestConfigQuery(
{ projectRef },
{
@@ -99,19 +100,20 @@ const ProjectNeedsSecuringGate = ({ children }: PropsWithChildren) => {
}
)
+ const exposedSchemas = getExposedSchemas(dbSchema)
+
const {
data: tablePrivileges,
error: tablePrivilegesError,
isPending: isLoadingTablePrivileges,
} = useTablePrivilegesQuery(
- { projectRef, connectionString: project?.connectionString },
- { enabled: shouldRenderGate }
+ { projectRef, connectionString: project?.connectionString, includedSchemas: exposedSchemas },
+ { enabled: shouldRenderGate && isSuccessPostgrestConfig }
)
const tableRows = useMemo(() => {
if (!tables) return []
- const exposedSchemas = getExposedSchemas(dbSchema)
const dataApiAccessByTable = new Map<string, boolean>()
for (const entry of tablePrivileges ?? []) {
@@ -128,7 +130,6 @@ const ProjectNeedsSecuringGate = ({ children }: PropsWithChildren) => {
return sortTables(
tables
- .filter((table) => exposedSchemas.includes(table.schema))
.filter((table) => !table.rls_enabled && rlsIssueKeys.has(getTableKey(table)))
.map((table) => {
const key = getTableKey(table)
@@ -143,7 +144,7 @@ const ProjectNeedsSecuringGate = ({ children }: PropsWithChildren) => {
}
})
)
- }, [dbSchema, rlsIssueKeys, tablePrivileges, tables])
+ }, [rlsIssueKeys, tablePrivileges, tables])
if (!isProjectHomeRoute || !projectRef || isLoadingLints || !hasRlsIssues) {
return <>{children}</>
diff --git a/apps/studio/data/privileges/column-privileges-query.ts b/apps/studio/data/privileges/column-privileges-query.ts
index 7b829c21a1a..42c71cdc073 100644
--- a/apps/studio/data/privileges/column-privileges-query.ts
+++ b/apps/studio/data/privileges/column-privileges-query.ts
@@ -1,57 +1,56 @@
-import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
+import pgMeta from '@supabase/pg-meta'
import { useQuery } from '@tanstack/react-query'
+import { z } from 'zod'
+import { executeSql } from '../sql/execute-sql-query'
import { privilegeKeys } from './keys'
import type { components } from '@/data/api'
-import { get, handleError } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type ColumnPrivilegesVariables = {
projectRef?: string
connectionString?: string | null
+ /**
+ * [Joshen] Specifically requiring schema to prevent a heavy query on the DB
+ * The only UI using this is the column privileges UI atm, so opting to be strict here
+ * Ideally we'd be able to also filter based on table to be even more prudent, but
+ * leaving out for now as it needs update to pg-meta + might not be worth the over-optimization
+ * given this UI isn't a primary tool
+ */
+ schema: string
}
export type ColumnPrivilege = components['schemas']['PostgresColumnPrivileges']
+const pgMetaColumnPrivilegesList = pgMeta.columnPrivileges.list()
+type ColumnPrivilegesData = z.infer<typeof pgMetaColumnPrivilegesList.zod>
+
export async function getColumnPrivileges(
- { projectRef, connectionString }: ColumnPrivilegesVariables,
+ { projectRef, connectionString, schema }: ColumnPrivilegesVariables,
signal?: AbortSignal
) {
if (!projectRef) throw new Error('projectRef is required')
- const headers = new Headers()
- if (connectionString) headers.set('x-connection-encrypted', connectionString)
-
- const { data, error } = await get('/platform/pg-meta/{ref}/column-privileges', {
- params: {
- path: { ref: projectRef },
- // this is needed to satisfy the typescript, but it doesn't pass the actual header
- header: {
- 'x-connection-encrypted': connectionString!,
- 'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
- },
- },
- signal,
- headers,
- })
-
- if (error) handleError(error)
- return data
+ const sql = pgMeta.columnPrivileges.list({ includedSchemas: [schema] }).sql
+ const queryKey = ['column-privileges', schema]
+ const { result } = await executeSql({ projectRef, connectionString, sql, queryKey }, signal)
+ return result as ColumnPrivilegesData
}
-export type ColumnPrivilegesData = Awaited<ReturnType<typeof getColumnPrivileges>>
export type ColumnPrivilegesError = ResponseError
export const useColumnPrivilegesQuery = <TData = ColumnPrivilegesData>(
- { projectRef, connectionString }: ColumnPrivilegesVariables,
+ vars: ColumnPrivilegesVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<ColumnPrivilegesData, ColumnPrivilegesError, TData> = {}
-) =>
- useQuery<ColumnPrivilegesData, ColumnPrivilegesError, TData>({
- queryKey: privilegeKeys.columnPrivilegesList(projectRef),
- queryFn: ({ signal }) => getColumnPrivileges({ projectRef, connectionString }, signal),
- enabled: enabled && typeof projectRef !== 'undefined',
+) => {
+ const { projectRef, schema } = vars
+ return useQuery<ColumnPrivilegesData, ColumnPrivilegesError, TData>({
+ queryKey: privilegeKeys.columnPrivilegesList(projectRef, schema),
+ queryFn: ({ signal }) => getColumnPrivileges(vars, signal),
+ enabled: enabled && typeof projectRef !== 'undefined' && typeof schema !== 'undefined',
...options,
})
+}
diff --git a/apps/studio/data/privileges/keys.ts b/apps/studio/data/privileges/keys.ts
index da4f5f43084..006f7a3e7a4 100644
--- a/apps/studio/data/privileges/keys.ts
+++ b/apps/studio/data/privileges/keys.ts
@@ -1,8 +1,8 @@
export const privilegeKeys = {
- tablePrivilegesList: (projectRef: string | undefined) =>
- ['projects', projectRef, 'database', 'table-privileges'] as const,
- columnPrivilegesList: (projectRef: string | undefined) =>
- ['projects', projectRef, 'database', 'column-privileges'] as const,
+ tablePrivilegesList: (projectRef: string | undefined, includedSchemas?: string[]) =>
+ ['projects', projectRef, 'database', 'table-privileges', includedSchemas].filter(Boolean),
+ columnPrivilegesList: (projectRef: string | undefined, schema?: string | undefined) =>
+ ['projects', projectRef, 'database', 'column-privileges', schema].filter(Boolean),
exposedTablesInfinite: (projectRef: string | undefined, search?: string) =>
[
'projects',
diff --git a/apps/studio/data/privileges/table-privileges-query.ts b/apps/studio/data/privileges/table-privileges-query.ts
index 2266b8cdafd..e331a30668d 100644
--- a/apps/studio/data/privileges/table-privileges-query.ts
+++ b/apps/studio/data/privileges/table-privileges-query.ts
@@ -9,45 +9,42 @@ import { UseCustomQueryOptions } from '@/types'
export type TablePrivilegesVariables = {
projectRef?: string
connectionString?: string | null
+ includedSchemas?: string[]
}
export type PgTablePrivileges = z.infer<typeof pgMeta.tablePrivileges.zod>
const pgMetaTablePrivilegesList = pgMeta.tablePrivileges.list()
-
export type TablePrivilegesData = z.infer<typeof pgMetaTablePrivilegesList.zod>
export type TablePrivilegesError = ExecuteSqlError
async function getTablePrivileges(
- { projectRef, connectionString }: TablePrivilegesVariables,
+ { projectRef, connectionString, includedSchemas }: TablePrivilegesVariables,
signal?: AbortSignal
) {
- const { result } = await executeSql(
- {
- projectRef,
- connectionString,
- sql: pgMetaTablePrivilegesList.sql,
- queryKey: ['table-privileges'],
- },
- signal
- )
+ const sql = pgMeta.tablePrivileges.list({ includedSchemas }).sql
+ const queryKey = ['table-privileges', includedSchemas?.join(',')]
+
+ const { result } = await executeSql({ projectRef, connectionString, sql, queryKey }, signal)
return result as TablePrivilegesData
}
export const useTablePrivilegesQuery = <TData = TablePrivilegesData>(
- { projectRef, connectionString }: TablePrivilegesVariables,
+ vars: TablePrivilegesVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<TablePrivilegesData, TablePrivilegesError, TData> = {}
-) =>
- useQuery<TablePrivilegesData, TablePrivilegesError, TData>({
- queryKey: privilegeKeys.tablePrivilegesList(projectRef),
- queryFn: ({ signal }) => getTablePrivileges({ projectRef, connectionString }, signal),
+) => {
+ const { projectRef, includedSchemas } = vars
+ return useQuery<TablePrivilegesData, TablePrivilegesError, TData>({
+ queryKey: privilegeKeys.tablePrivilegesList(projectRef, includedSchemas),
+ queryFn: ({ signal }) => getTablePrivileges(vars, signal),
enabled: enabled && typeof projectRef !== 'undefined',
...options,
})
+}
export function invalidateTablePrivilegesQuery(
client: QueryClient,
diff --git a/apps/studio/pages/project/[ref]/database/column-privileges.tsx b/apps/studio/pages/project/[ref]/database/column-privileges.tsx
index 46b58de7045..9bca371826b 100644
--- a/apps/studio/pages/project/[ref]/database/column-privileges.tsx
+++ b/apps/studio/pages/project/[ref]/database/column-privileges.tsx
@@ -84,12 +84,12 @@ const PrivilegesPage: NextPageWithLayout = () => {
} = useTablePrivilegesQuery({
projectRef: project?.ref,
connectionString: project?.connectionString,
+ includedSchemas: [selectedSchema],
})
const tablePrivilege = useMemo(() => {
const tablePrivilege = allTablePrivileges?.find(
- (tablePrivilege) =>
- tablePrivilege.schema === selectedSchema && tablePrivilege.name === selectedTable
+ (tablePrivilege) => tablePrivilege.name === selectedTable
)
if (tablePrivilege) {
@@ -100,7 +100,7 @@ const PrivilegesPage: NextPageWithLayout = () => {
),
}
}
- }, [allTablePrivileges, selectedRole, selectedSchema, selectedTable])
+ }, [allTablePrivileges, selectedRole, selectedTable])
const {
data: allColumnPrivileges,
@@ -110,6 +110,7 @@ const PrivilegesPage: NextPageWithLayout = () => {
} = useColumnPrivilegesQuery({
projectRef: project?.ref,
connectionString: project?.connectionString,
+ schema: selectedSchema,
})
const columnPrivileges = useMemo(