Skip to content

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

convert advisor and auth queries in pgmeta to safesql (#44998)

Charis62d59d596b55
diff --git a/packages/pg-meta/src/sql/studio/advisor/lints.ts b/packages/pg-meta/src/sql/studio/advisor/lints.ts
index e7609f6452f..1e7a4d2d050 100644
--- a/packages/pg-meta/src/sql/studio/advisor/lints.ts
+++ b/packages/pg-meta/src/sql/studio/advisor/lints.ts
@@ -1,5 +1,7 @@
-export const enrichLintsQuery = (query: string, exposedSchemas?: string) => {
- return `
+import { literal, safeSql, type SafeSqlFragment } from '../../../pg-format'
+
+export const enrichLintsQuery = (query: SafeSqlFragment, exposedSchemas?: string) => {
+ return safeSql`
do $$
begin
set pg_stat_statements.track = none;
@@ -7,10 +9,10 @@ exception when others then
-- not a superuser or extension not installed, skip silently
end
$$;
-${!!exposedSchemas ? `set local pgrst.db_schemas = '${exposedSchemas}';` : ''}
+${!!exposedSchemas ? safeSql`set local pgrst.db_schemas = ${literal(exposedSchemas)};` : safeSql``}
-- source: dashboard
--- user: ${'self host'}
--- date: ${new Date().toISOString()}
+-- user: self host
+-- date: ${new Date().toISOString() as SafeSqlFragment}
${query}
`
@@ -22,8 +24,8 @@ ${query}
* - Replace all "\`%s\`" with backquotes to escape the tick character ("\`%s\`")
* - Replace docs url with docsUrl (${docsUrl})
*/
-export const getLintsSQL = ({ docsUrl }: { docsUrl: string }) =>
- /* SQL */ `set local search_path = '';
+export const getLintsSQL = ({ docsUrl }: { docsUrl: string }): SafeSqlFragment =>
+ safeSql`set local search_path = '';
(
with foreign_keys as (
@@ -70,7 +72,7 @@ select
fk.table_name,
fk.fkey_name
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0001_unindexed_foreign_keys' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0001_unindexed_foreign_keys`)} as remediation,
jsonb_build_object(
'schema', fk.schema_name,
'name', fk.table_name,
@@ -110,7 +112,7 @@ select
'View/Materialized View "%s" in the public schema may expose \`auth.users\` data to anon or authenticated roles.',
c.relname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0002_auth_users_exposed' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0002_auth_users_exposed`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -224,12 +226,12 @@ select
array['PERFORMANCE'] as categories,
'Detects if calls to \`current_setting()\` and \`auth.<function>()\` in RLS policies are being unnecessarily re-evaluated for each row' as description,
format(
- 'Table \`%s.%s\` has a row level security policy \`%s\` that re-evaluates current_setting() or auth.<function>() for each row. This produces suboptimal query performance at scale. Resolve the issue by replacing \`auth.<function>()\` with \`(select auth.<function>())\`. See [docs](${docsUrl}/guides/database/postgres/row-level-security#call-functions-with-select) for more info.',
+ ${literal(`Table \`%s.%s\` has a row level security policy \`%s\` that re-evaluates current_setting() or auth.<function>() for each row. This produces suboptimal query performance at scale. Resolve the issue by replacing \`auth.<function>()\` with \`(select auth.<function>())\`. See [docs](${docsUrl}/guides/database/postgres/row-level-security#call-functions-with-select) for more info.`)},
schema_name,
table_name,
policy_name
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0003_auth_rls_initplan' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0003_auth_rls_initplan`)} as remediation,
jsonb_build_object(
'schema', schema_name,
'name', table_name,
@@ -301,7 +303,7 @@ select
pgns.nspname,
pgc.relname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0004_no_primary_key' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0004_no_primary_key`)} as remediation,
jsonb_build_object(
'schema', pgns.nspname,
'name', pgc.relname,
@@ -348,7 +350,7 @@ select
psui.schemaname,
psui.relname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0005_unused_index' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0005_unused_index`)} as remediation,
jsonb_build_object(
'schema', psui.schemaname,
'name', psui.relname,
@@ -393,7 +395,7 @@ select
act.cmd,
array_agg(p.polname order by p.polname)
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0006_multiple_permissive_policies' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0006_multiple_permissive_policies`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -464,7 +466,7 @@ select
c.relname,
array_agg(p.polname order by p.polname)
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0007_policy_exists_rls_disabled' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0007_policy_exists_rls_disabled`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -509,7 +511,7 @@ select
n.nspname,
c.relname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0008_rls_enabled_no_policy' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0008_rls_enabled_no_policy`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -556,7 +558,7 @@ select
c.relname,
array_agg(pi.indexname order by pi.indexname)
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0009_duplicate_index' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0009_duplicate_index`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -610,7 +612,7 @@ select
n.nspname,
c.relname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0010_security_definer_view' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0010_security_definer_view`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -663,7 +665,7 @@ select
n.nspname,
p.proname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0011_function_search_path_mutable' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0011_function_search_path_mutable`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', p.proname,
@@ -707,7 +709,7 @@ select
n.nspname,
c.relname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0013_rls_disabled_in_public' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0013_rls_disabled_in_public`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -747,7 +749,7 @@ select
'Extension \`%s\` is installed in the public schema. Move it to another schema.',
pe.extname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0014_extension_in_public' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0014_extension_in_public`)} as remediation,
jsonb_build_object(
'schema', pe.extnamespace::regnamespace,
'name', pe.extname,
@@ -801,7 +803,7 @@ select
table_name,
policy_name
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0015_rls_references_user_metadata' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0015_rls_references_user_metadata`)} as remediation,
jsonb_build_object(
'schema', schema_name,
'name', table_name,
@@ -837,7 +839,7 @@ select
n.nspname,
c.relname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0016_materialized_view_in_api' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0016_materialized_view_in_api`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -880,7 +882,7 @@ select
n.nspname,
c.relname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0017_foreign_table_in_api' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0017_foreign_table_in_api`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -925,7 +927,7 @@ select
a.attname,
t.typname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=unsupported_reg_types' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=unsupported_reg_types`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -966,7 +968,7 @@ select
n.nspname,
c.relname
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0019_insecure_queue_exposed_in_api' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0019_insecure_queue_exposed_in_api`)} as remediation,
jsonb_build_object(
'schema', n.nspname,
'name', c.relname,
@@ -1149,7 +1151,7 @@ select
ext.installed_version,
ext.default_version
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0022_extension_versions_outdated' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0022_extension_versions_outdated`)} as remediation,
jsonb_build_object(
'extension_name', ext.name,
'installed_version', ext.installed_version,
@@ -1260,7 +1262,7 @@ select
table_name,
string_agg(distinct column_name, ', ' order by column_name)
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0023_sensitive_columns_exposed' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0023_sensitive_columns_exposed`)} as remediation,
jsonb_build_object(
'schema', schema_name,
'name', table_name,
@@ -1382,7 +1384,7 @@ select
end,
array_to_string(roles, ', ')
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0024_permissive_rls_policy' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0024_permissive_rls_policy`)} as remediation,
jsonb_build_object(
'schema', schema_name,
'name', table_name,
@@ -1491,7 +1493,7 @@ select
end,
array_to_string(policy_names, ', ')
) as detail,
- '${docsUrl}/guides/database/database-linter?lint=0025_public_bucket_allows_listing' as remediation,
+ ${literal(`${docsUrl}/guides/database/database-linter?lint=0025_public_bucket_allows_listing`)} as remediation,
jsonb_build_object(
'schema', 'storage',
'name', bucket_name,
@@ -1505,4 +1507,4 @@ select
from
affected_buckets
order by
- bucket_id)`.trim()
+ bucket_id)`
diff --git a/packages/pg-meta/src/sql/studio/auth/get-users-count.ts b/packages/pg-meta/src/sql/studio/auth/get-users-count.ts
index 864dd2807c9..16dc51236f9 100644
--- a/packages/pg-meta/src/sql/studio/auth/get-users-count.ts
+++ b/packages/pg-meta/src/sql/studio/auth/get-users-count.ts
@@ -1,9 +1,9 @@
-import { literal } from '../../../pg-format'
+import { joinSqlFragments, literal, safeSql, type SafeSqlFragment } from '../../../pg-format'
import { COUNT_ESTIMATE_SQL, THRESHOLD_COUNT } from '../database/get-count-estimate'
import { prefixToUUID, stringRange } from './get-users-common'
import type { OptimizedSearchColumns } from './get-users-types'
-export const USERS_COUNT_ESTIMATE_SQL = `select reltuples as estimate from pg_class where oid = 'auth.users'::regclass`
+export const USERS_COUNT_ESTIMATE_SQL = safeSql`select reltuples as estimate from pg_class where oid = 'auth.users'::regclass`
export const getUsersCountSQL = ({
filter,
@@ -18,12 +18,12 @@ export const getUsersCountSQL = ({
forceExactCount?: boolean
/** If set, uses optimized prefix search for the specified column */
column?: OptimizedSearchColumns
-}) => {
+}): SafeSqlFragment => {
const hasValidKeywords = keywords && keywords !== ''
- const conditions: string[] = []
- const baseQueryCount = `select count(*) from auth.users`
- const baseQuerySelect = `select * from auth.users`
+ const conditions: SafeSqlFragment[] = []
+ const baseQueryCount = safeSql`select count(*) from auth.users`
+ const baseQuerySelect = safeSql`select * from auth.users`
const optimizedSearchMode = column && hasValidKeywords
if (optimizedSearchMode) {
@@ -32,21 +32,23 @@ export const getUsersCountSQL = ({
const lowerBound = literal(range[0])
const upperBound = range[1] ? literal(range[1]) : null
conditions.push(
- `lower(email) >= ${lowerBound}${upperBound ? ` and lower(email) < ${upperBound}` : ''} and instance_id = '00000000-0000-0000-0000-000000000000'::uuid`
+ safeSql`lower(email) >= ${lowerBound}${upperBound ? safeSql` and lower(email) < ${upperBound}` : safeSql``} and instance_id = '00000000-0000-0000-0000-000000000000'::uuid`
)
} else if (column === 'phone') {
const range = stringRange(keywords)
const lowerBound = literal(range[0])
const upperBound = range[1] ? literal(range[1]) : null
- conditions.push(`phone >= ${lowerBound}${upperBound ? ` and phone < ${upperBound}` : ''}`)
+ conditions.push(
+ safeSql`phone >= ${lowerBound}${upperBound ? safeSql` and phone < ${upperBound}` : safeSql``}`
+ )
} else if (column === 'id') {
const lowerUUID = prefixToUUID(keywords, false)
const isMatchingUUIDValue = lowerUUID === keywords
if (isMatchingUUIDValue) {
- conditions.push(`id = ${literal(keywords)}`)
+ conditions.push(safeSql`id = ${literal(keywords)}`)
} else {
const upperUUID = prefixToUUID(keywords, true)
- conditions.push(`id >= ${literal(lowerUUID)} and id < ${literal(upperUUID)}`)
+ conditions.push(safeSql`id >= ${literal(lowerUUID)} and id < ${literal(upperUUID)}`)
}
}
} else {
@@ -54,16 +56,16 @@ export const getUsersCountSQL = ({
if (hasValidKeywords) {
const escapedFilterKeywords = literal(`%${keywords}%`)
conditions.push(
- `id::text ilike ${escapedFilterKeywords} or email ilike ${escapedFilterKeywords} or phone ilike ${escapedFilterKeywords}`
+ safeSql`id::text ilike ${escapedFilterKeywords} or email ilike ${escapedFilterKeywords} or phone ilike ${escapedFilterKeywords}`
)
}
if (filter === 'verified') {
- conditions.push(`email_confirmed_at IS NOT NULL or phone_confirmed_at IS NOT NULL`)
+ conditions.push(safeSql`email_confirmed_at IS NOT NULL or phone_confirmed_at IS NOT NULL`)
} else if (filter === 'anonymous') {
- conditions.push(`is_anonymous is true`)
+ conditions.push(safeSql`is_anonymous is true`)
} else if (filter === 'unverified') {
- conditions.push(`email_confirmed_at IS NULL AND phone_confirmed_at IS NULL`)
+ conditions.push(safeSql`email_confirmed_at IS NULL AND phone_confirmed_at IS NULL`)
}
if (providers && providers.length > 0) {
@@ -72,38 +74,41 @@ export const getUsersCountSQL = ({
if (providers.includes('saml 2.0')) {
const mappedProviders = providers.map((p) => (p === 'saml 2.0' ? 'sso' : p))
conditions.push(
- `(select jsonb_agg(case when value ~ '^sso' then 'sso' else value end) from jsonb_array_elements_text((raw_app_meta_data ->> 'providers')::jsonb)) ?| array[${literal(mappedProviders)}]`.trim()
+ safeSql`(select jsonb_agg(case when value ~ '^sso' then 'sso' else value end) from jsonb_array_elements_text((raw_app_meta_data ->> 'providers')::jsonb)) ?| array[${literal(mappedProviders)}]`
)
} else {
- conditions.push(`(raw_app_meta_data->>'providers')::jsonb ?| array[${literal(providers)}]`)
+ conditions.push(
+ safeSql`(raw_app_meta_data->>'providers')::jsonb ?| array[${literal(providers)}]`
+ )
}
}
}
- const combinedConditions = conditions.map((x) => `(${x})`).join(' and ')
- const whereClause = conditions.length > 0 ? ` where ${combinedConditions}` : ''
+ const combinedConditions = joinSqlFragments(
+ conditions.map((x) => safeSql`(${x})`),
+ ' and '
+ )
+ const whereClause = conditions.length > 0 ? safeSql` where ${combinedConditions}` : safeSql``
if (forceExactCount) {
- return `select (${baseQueryCount}${whereClause}), false as is_estimate;`
+ return safeSql`select (${baseQueryCount}${whereClause}), false as is_estimate;`
} else {
- const selectBaseSql = `${baseQuerySelect}${whereClause}`
- const countBaseSql = `${baseQueryCount}${whereClause}`
+ const selectBaseSql = safeSql`${baseQuerySelect}${whereClause}`
+ const countBaseSql = safeSql`${baseQueryCount}${whereClause}`
const escapedSelectSql = literal(selectBaseSql)
- const sql = `
-${COUNT_ESTIMATE_SQL}
+ const sql = safeSql`${COUNT_ESTIMATE_SQL}
with approximation as (${USERS_COUNT_ESTIMATE_SQL})
select
case
when estimate = -1 then (select pg_temp.count_estimate(${escapedSelectSql}))::int
- when estimate > ${THRESHOLD_COUNT} then ${conditions.length > 0 ? `(select pg_temp.count_estimate(${escapedSelectSql}))::int` : 'estimate::int'}
+ when estimate > ${literal(THRESHOLD_COUNT)} then ${conditions.length > 0 ? safeSql`(select pg_temp.count_estimate(${escapedSelectSql}))::int` : safeSql`estimate::int`}
else (${countBaseSql})
end as count,
- estimate = -1 or estimate > ${THRESHOLD_COUNT} as is_estimate
-from approximation;
-`.trim()
+ estimate = -1 or estimate > ${literal(THRESHOLD_COUNT)} as is_estimate
+from approximation`
return sql
}
diff --git a/packages/pg-meta/src/sql/studio/auth/get-users-paginated.ts b/packages/pg-meta/src/sql/studio/auth/get-users-paginated.ts
index ab4fd4427b0..56b0eb9b0e4 100644
--- a/packages/pg-meta/src/sql/studio/auth/get-users-paginated.ts
+++ b/packages/pg-meta/src/sql/studio/auth/get-users-paginated.ts
@@ -1,4 +1,11 @@
-import { ident, literal } from '../../../pg-format'
+import {
+ ident,
+ joinSqlFragments,
+ keyword,
+ literal,
+ safeSql,
+ type SafeSqlFragment,
+} from '../../../pg-format'
import { prefixToUUID, stringRange } from './get-users-common'
import { OptimizedSearchColumns } from './get-users-types'
@@ -41,7 +48,7 @@ export const getPaginatedUsersSQL = ({
cursor,
improvedSearchEnabled = false,
-}: getPaginatedUsersSQLProps) => {
+}: getPaginatedUsersSQLProps): SafeSqlFragment => {
if (improvedSearchEnabled) {
return getImprovedPaginatedUsersSQL({
column: column ?? 'email',
@@ -59,21 +66,21 @@ export const getPaginatedUsersSQL = ({
const offset = page * limit
const hasValidKeywords = keywords && keywords !== ''
- const conditions: string[] = []
+ const conditions: SafeSqlFragment[] = []
if (hasValidKeywords) {
const pattern = `%${keywords}%`
conditions.push(
- `id::text like ${literal(pattern)} or email like ${literal(pattern)} or phone like ${literal(pattern)} or raw_user_meta_data->>'full_name' ilike ${literal(pattern)} or raw_user_meta_data->>'first_name' ilike ${literal(pattern)} or raw_user_meta_data->>'last_name' ilike ${literal(pattern)} or raw_user_meta_data->>'display_name' ilike ${literal(pattern)}`
+ safeSql`id::text like ${literal(pattern)} or email like ${literal(pattern)} or phone like ${literal(pattern)} or raw_user_meta_data->>'full_name' ilike ${literal(pattern)} or raw_user_meta_data->>'first_name' ilike ${literal(pattern)} or raw_user_meta_data->>'last_name' ilike ${literal(pattern)} or raw_user_meta_data->>'display_name' ilike ${literal(pattern)}`
)
}
if (verified === 'verified') {
- conditions.push(`email_confirmed_at IS NOT NULL or phone_confirmed_at IS NOT NULL`)
+ conditions.push(safeSql`email_confirmed_at IS NOT NULL or phone_confirmed_at IS NOT NULL`)
} else if (verified === 'anonymous') {
- conditions.push(`is_anonymous is true`)
+ conditions.push(safeSql`is_anonymous is true`)
} else if (verified === 'unverified') {
- conditions.push(`email_confirmed_at IS NULL AND phone_confirmed_at IS NULL`)
+ conditions.push(safeSql`email_confirmed_at IS NULL AND phone_confirmed_at IS NULL`)
}
if (providers && providers.length > 0) {
@@ -81,48 +88,57 @@ export const getPaginatedUsersSQL = ({
// JFYI in case we do eventually run into performance issues here when filtering for SAML provider
if (providers.includes('saml 2.0')) {
conditions.push(
- `(select jsonb_agg(case when value ~ '^sso' then 'sso' else value end) from jsonb_array_elements_text((raw_app_meta_data ->> 'providers')::jsonb)) ?| array[${providers.map((p) => literal(p === 'saml 2.0' ? 'sso' : p)).join(', ')}]`.trim()
+ safeSql`(select jsonb_agg(case when value ~ '^sso' then 'sso' else value end) from jsonb_array_elements_text((raw_app_meta_data ->> 'providers')::jsonb)) ?| array[${joinSqlFragments(
+ providers.map((p) => literal(p === 'saml 2.0' ? 'sso' : p)),
+ ', '
+ )}]`
)
} else {
conditions.push(
- `(raw_app_meta_data->>'providers')::jsonb ?| array[${providers.map((p) => literal(p)).join(', ')}]`
+ safeSql`(raw_app_meta_data->>'providers')::jsonb ?| array[${joinSqlFragments(
+ providers.map((p) => literal(p)),
+ ', '
+ )}]`
)
}
}
- const combinedConditions = conditions.map((x) => `(${x})`).join(' and ')
- const sortOn = sort ?? 'created_at'
- const sortOrder = order ?? 'desc'
+ const combinedConditions = joinSqlFragments(
+ conditions.map((x) => safeSql`(${x})`),
+ ' and '
+ )
+ const sortOn = keyword(sort) ?? safeSql`created_at`
+ const sortOrder = keyword(order) ?? safeSql`desc`
- let whereStatement = `${conditions.length > 0 ? ` where ${combinedConditions}` : ''}
+ let whereStatement = safeSql`${conditions.length > 0 ? safeSql` where ${combinedConditions}` : safeSql``}
order by
${ident(sortOn)} ${sortOrder} nulls last
limit
- ${limit}
+ ${literal(limit)}
offset
- ${offset}
+ ${literal(offset)}
`
// DON'T TOUCH THESE QUERIES. ONE CHARACTER OFF AND DISASTER.
- const firstOperator = startAt ? '>' : '>='
+ const firstOperator = startAt ? safeSql`>` : safeSql`>=`
if (column === 'email') {
const range = stringRange(keywords ?? '')
- whereStatement = `where lower(email) ${firstOperator} ${literal(startAt ? startAt : range[0])} ${range[1] ? `and lower(email) < ${literal(range[1])}` : ''} and instance_id = '00000000-0000-0000-0000-000000000000'::uuid order by instance_id, lower(email) asc limit ${limit}`
+ whereStatement = safeSql`where lower(email) ${firstOperator} ${literal(startAt ? startAt : range[0])} ${range[1] ? safeSql`and lower(email) < ${literal(range[1])}` : safeSql``} and instance_id = '00000000-0000-0000-0000-000000000000'::uuid order by instance_id, lower(email) asc limit ${literal(limit)}`
} else if (column === 'phone') {
const range = stringRange(keywords ?? '')
- whereStatement = `where phone ${firstOperator} ${literal(startAt ? startAt : range[0])} ${range[1] ? `and phone < ${literal(range[1])}` : ''} order by phone asc limit ${limit}`
+ whereStatement = safeSql`where phone ${firstOperator} ${literal(startAt ? startAt : range[0])} ${range[1] ? safeSql`and phone < ${literal(range[1])}` : safeSql``} order by phone asc limit ${literal(limit)}`
} else if (column === 'id') {
const isMatchingUUIDValue = prefixToUUID(keywords ?? '', false) === keywords
if (isMatchingUUIDValue) {
- whereStatement = `where id = ${literal(keywords)} order by id asc limit ${limit}`
+ whereStatement = safeSql`where id = ${literal(keywords)} order by id asc limit ${literal(limit)}`
} else {
- whereStatement = `where id ${firstOperator} ${literal(startAt ? startAt : prefixToUUID(keywords ?? '', false))} and id < ${literal(prefixToUUID(keywords ?? '', true))} order by id asc limit ${limit}`
+ whereStatement = safeSql`where id ${firstOperator} ${literal(startAt ? startAt : prefixToUUID(keywords ?? '', false))} and id < ${literal(prefixToUUID(keywords ?? '', true))} order by id asc limit ${literal(limit)}`
}
}
- let usersData = `
+ let usersData = safeSql`
select
auth.users.id,
auth.users.email,
@@ -142,8 +158,7 @@ export const getPaginatedUsersSQL = ({
auth.users
${whereStatement}`
- let usersQuery = `
-with
+ let usersQuery = safeSql`with
users_data as (${usersData})
select
*,
@@ -159,8 +174,7 @@ select
'{}'::text[]
) as providers
from
- users_data;
- `.trim()
+ users_data;`
return usersQuery
}
@@ -185,10 +199,10 @@ export const getImprovedPaginatedUsersSQL = ({
order,
cursor,
limit = DEFAULT_LIMIT,
-}: getPaginatedUsersSQLProps) => {
+}: getPaginatedUsersSQLProps): SafeSqlFragment => {
const hasValidKeywords = keywords && keywords !== ''
- const conditions: string[] = []
+ const conditions: SafeSqlFragment[] = []
// Column-specific search condition
if (hasValidKeywords) {
@@ -196,82 +210,91 @@ export const getImprovedPaginatedUsersSQL = ({
// Use btree index with prefix matching
const range = stringRange(keywords)
if (range[1]) {
- conditions.push(`email >= ${literal(range[0])} AND email < ${literal(range[1])}`)
+ conditions.push(safeSql`email >= ${literal(range[0])} AND email < ${literal(range[1])}`)
} else {
- conditions.push(`email >= ${literal(range[0])}`)
+ conditions.push(safeSql`email >= ${literal(range[0])}`)
}
} else if (column === 'phone') {
// Use btree index with prefix matching
const range = stringRange(keywords)
if (range[1]) {
- conditions.push(`phone >= ${literal(range[0])} AND phone < ${literal(range[1])}`)
+ conditions.push(safeSql`phone >= ${literal(range[0])} AND phone < ${literal(range[1])}`)
} else {
- conditions.push(`phone >= ${literal(range[0])}`)
+ conditions.push(safeSql`phone >= ${literal(range[0])}`)
}
} else if (column === 'id') {
// Exact match on UUID
- conditions.push(`id = ${literal(keywords)}`)
+ conditions.push(safeSql`id = ${literal(keywords)}`)
} else if (column === 'name') {
// Use btree index with prefix matching on raw_user_meta_data->>'name'
const range = stringRange(keywords)
if (range[1]) {
conditions.push(
- `raw_user_meta_data->>'name' >= ${literal(range[0])} AND raw_user_meta_data->>'name' < ${literal(range[1])}`
+ safeSql`raw_user_meta_data->>'name' >= ${literal(range[0])} AND raw_user_meta_data->>'name' < ${literal(range[1])}`
)
} else {
- conditions.push(`raw_user_meta_data->>'name' >= ${literal(range[0])}`)
+ conditions.push(safeSql`raw_user_meta_data->>'name' >= ${literal(range[0])}`)
}
}
}
// Verified filter
if (verified === 'verified') {
- conditions.push(`(email_confirmed_at IS NOT NULL OR phone_confirmed_at IS NOT NULL)`)
+ conditions.push(safeSql`(email_confirmed_at IS NOT NULL OR phone_confirmed_at IS NOT NULL)`)
} else if (verified === 'anonymous') {
- conditions.push(`is_anonymous IS TRUE`)
+ conditions.push(safeSql`is_anonymous IS TRUE`)
} else if (verified === 'unverified') {
- conditions.push(`(email_confirmed_at IS NULL AND phone_confirmed_at IS NULL)`)
+ conditions.push(safeSql`(email_confirmed_at IS NULL AND phone_confirmed_at IS NULL)`)
}
// Providers filter
if (providers && providers.length > 0) {
if (providers.includes('saml 2.0')) {
conditions.push(
- `(SELECT jsonb_agg(CASE WHEN value ~ '^sso' THEN 'sso' ELSE value END) FROM jsonb_array_elements_text((raw_app_meta_data ->> 'providers')::jsonb)) ?| array[${providers.map((p) => literal(p === 'saml 2.0' ? 'sso' : p)).join(', ')}]`
+ safeSql`(SELECT jsonb_agg(CASE WHEN value ~ '^sso' THEN 'sso' ELSE value END) FROM jsonb_array_elements_text((raw_app_meta_data ->> 'providers')::jsonb)) ?| array[${joinSqlFragments(
+ providers.map((p) => literal(p === 'saml 2.0' ? 'sso' : p)),
+ ', '
+ )}]`
)
} else {
conditions.push(
- `(raw_app_meta_data->>'providers')::jsonb ?| array[${providers.map((p) => literal(p)).join(', ')}]`
+ safeSql`(raw_app_meta_data->>'providers')::jsonb ?| array[${joinSqlFragments(
+ providers.map((p) => literal(p)),
+ ', '
+ )}]`
)
}
}
- const sortOn = sort ?? 'created_at'
- const sortOrder = order ?? 'desc'
+ const sortOn = keyword(sort) ?? safeSql`created_at`
+ const sortOrder = keyword(order) ?? safeSql`desc`
// Cursor-based pagination: fetch rows after the cursor position
if (cursor) {
- const operator = sortOrder === 'desc' ? '<' : '>'
+ const operator = sortOrder === 'desc' ? safeSql`<` : safeSql`>`
// When sorting by id, no need for a composite cursor since id is already unique
if (sortOn === 'id') {
- conditions.push(`id ${operator} ${literal(cursor.id)}::uuid`)
+ conditions.push(safeSql`id ${operator} ${literal(cursor.id)}::uuid`)
} else {
conditions.push(
- `(${ident(sortOn)}, id) ${operator} (${literal(cursor.sort)}, ${literal(cursor.id)}::uuid)`
+ safeSql`(${ident(sortOn)}, id) ${operator} (${literal(cursor.sort)}, ${literal(cursor.id)}::uuid)`
)
}
}
- const combinedConditions = conditions.map((x) => `(${x})`).join(' AND ')
- const whereClause = conditions.length > 0 ? `WHERE ${combinedConditions}` : ''
+ const combinedConditions = joinSqlFragments(
+ conditions.map((x) => safeSql`(${x})`),
+ ' AND '
+ )
+ const whereClause = conditions.length > 0 ? safeSql`WHERE ${combinedConditions}` : safeSql``
// Order by sort column, with id as tie breaker (unless already sorting by id)
const orderByClause =
sortOn === 'id'
- ? `${ident(sortOn)} ${sortOrder}`
- : `${ident(sortOn)} ${sortOrder}, id ${sortOrder}`
+ ? safeSql`${ident(sortOn)} ${sortOrder}`
+ : safeSql`${ident(sortOn)} ${sortOrder}, id ${sortOrder}`
- const usersData = `
+ const usersData = safeSql`
SELECT
auth.users.id,
auth.users.email,
@@ -292,10 +315,9 @@ export const getImprovedPaginatedUsersSQL = ({
ORDER BY
${orderByClause}
LIMIT
- ${limit}`
+ ${literal(limit)}`
- const usersQuery = `
-WITH
+ const usersQuery = safeSql`WITH
users_data AS (${usersData})
SELECT
*,
@@ -311,7 +333,7 @@ SELECT
'{}'::text[]
) AS providers
FROM
- users_data;`.trim()
+ users_data;`
return usersQuery
}
diff --git a/packages/pg-meta/test/sql/studio/lints.test.ts b/packages/pg-meta/test/sql/studio/lints.test.ts
index 39a2dbf6625..d5eee906fa4 100644
--- a/packages/pg-meta/test/sql/studio/lints.test.ts
+++ b/packages/pg-meta/test/sql/studio/lints.test.ts
@@ -1,9 +1,9 @@
import { describe, expect, it } from 'vitest'
-import { enrichLintsQuery } from '../../../src'
+import { enrichLintsQuery, safeSql } from '../../../src'
describe('enrichLintsQuery', () => {
- const dummyQuery = 'SELECT 1'
+ const dummyQuery = safeSql`SELECT 1`
it('should include SET LOCAL pgrst.db_schemas when exposedSchemas is provided', () => {
const result = enrichLintsQuery(dummyQuery, 'public, storage')