Files
supabase/apps/studio/data/privileges/update-exposed-entities-mutation.ts
Charis 2d4e87f579 studio: SafeSql for reports, query performance, privileges (4/7) (#45998)
## Summary

Part 4 of the SafeSql migration stack
([#45897](https://github.com/supabase/supabase/pull/45897),
[#45903](https://github.com/supabase/supabase/pull/45903),
[#45990](https://github.com/supabase/supabase/pull/45990), this PR, …).

Converts the remaining reports, query performance, observability, index
advisor, and privileges call sites of `executeSql` to produce
`SafeSqlFragment` values. The `ReportQuery.sql` field flips from
`string` to `SafeSqlFragment`, which cascades into every consumer —
landed here atomically so each branch typechecks cleanly.

Touched areas:

- `interfaces/Reports/*` — `ReportQuery.sql: SafeSqlFragment`, plus all
report definitions/utilities updated
- `interfaces/QueryPerformance/useQueryPerformanceQuery.ts`
- `interfaces/Database/IndexAdvisor/*` and
`data/database/{table-index-advisor,retrieve-index-advisor-result}-query.ts`
-
`data/privileges/{table-api-access,update-exposed-entities}-mutation.ts`
- `interfaces/Storage/StoragePolicies/StoragePolicies.tsx`
- `hooks/analytics/useDbQuery.tsx`
- `Observability/useSlowQueriesCount.ts` +
`useQueryInsightsIssues.utils.test.ts`

## Test plan

- [x] `pnpm typecheck` passes
- [x] `useQueryInsightsIssues.utils.test.ts` passes
- [x] Dev-server smoke test: reports pages, query performance, index
advisor, storage policies

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

* **Refactor**
* Reworked SQL construction and typings across reporting, query
performance, index advisor, and privilege features to use safer SQL
fragments, improving reliability and preventing query composition
issues.
* **Types**
* Reporting query types were split to distinguish database vs. logs
queries, enabling correct handling and validation.
* **Docs/Utils**
  * Added a helper to consistently generate logs SQL for report hooks.
* **Tests**
  * Updated tests to exercise the new SQL-building API.

<!-- review_stack_entry_start -->

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/45998)

<!-- review_stack_entry_end -->
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-15 14:50:38 -04:00

73 lines
2.2 KiB
TypeScript

import { buildFunctionPrivilegesSql, buildTablePrivilegesSql } from '@supabase/pg-meta'
import { joinSqlFragments, type SafeSqlFragment } from '@supabase/pg-meta/src/pg-format'
import { useMutation } from '@tanstack/react-query'
import { toast } from 'sonner'
import type { ConnectionVars } from '@/data/common.types'
import { executeSql } from '@/data/sql/execute-sql-query'
import type { UseCustomMutationOptions } from '@/types'
export type UpdateExposedEntitiesVariables = ConnectionVars & {
tableIdsToAdd: number[]
tableIdsToRemove: number[]
functionNamesToAdd: string[]
functionNamesToRemove: string[]
}
export async function updateExposedEntities({
projectRef,
connectionString,
tableIdsToAdd,
tableIdsToRemove,
functionNamesToAdd,
functionNamesToRemove,
}: UpdateExposedEntitiesVariables): Promise<void> {
if (!projectRef) throw new Error('projectRef is required')
const sqlParts: Array<SafeSqlFragment> = []
if (tableIdsToAdd.length > 0) {
sqlParts.push(buildTablePrivilegesSql(tableIdsToAdd, 'grant'))
}
if (tableIdsToRemove.length > 0) {
sqlParts.push(buildTablePrivilegesSql(tableIdsToRemove, 'revoke'))
}
if (functionNamesToAdd.length > 0) {
sqlParts.push(buildFunctionPrivilegesSql(functionNamesToAdd, 'grant'))
}
if (functionNamesToRemove.length > 0) {
sqlParts.push(buildFunctionPrivilegesSql(functionNamesToRemove, 'revoke'))
}
if (sqlParts.length === 0) return
await executeSql({
projectRef,
connectionString,
sql: joinSqlFragments(sqlParts, '\n'),
queryKey: ['update-exposed-entities'],
})
}
type UpdateExposedEntitiesData = Awaited<ReturnType<typeof updateExposedEntities>>
export const useUpdateExposedEntitiesMutation = ({
onError,
...options
}: Omit<
UseCustomMutationOptions<UpdateExposedEntitiesData, Error, UpdateExposedEntitiesVariables>,
'mutationFn'
> = {}) => {
return useMutation<UpdateExposedEntitiesData, Error, UpdateExposedEntitiesVariables>({
mutationFn: (vars: UpdateExposedEntitiesVariables) => updateExposedEntities(vars),
onError(error: Error) {
toast.error(`Failed to update entity access: ${error.message}`)
},
...(onError ? { onError } : {}),
...options,
})
}