The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
feat(logs): brand Reports logs presets with SafeLogSqlFragment (#46403)
Charis0ab0106758af
diff --git a/apps/studio/components/interfaces/Reports/Reports.constants.ts b/apps/studio/components/interfaces/Reports/Reports.constants.tsindex 6a48c807fa9..11b0dd34cbf 100644--- a/apps/studio/components/interfaces/Reports/Reports.constants.ts+++ b/apps/studio/components/interfaces/Reports/Reports.constants.ts@@ -3,6 +3,13 @@ import dayjs from 'dayjs'import type { DatetimeHelper } from '../Settings/Logs/Logs.types'import { PresetConfig, Presets, ReportFilterItem } from './Reports.types'+import {+ analyticsLiteral,+ joinSqlFragments,+ quotedIdent,+ safeSql as safeLogSql,+ type SafeLogSqlFragment,+} from '@/data/logs/safe-analytics-sql'import { PlanId } from '@/data/subscriptions/types'export const LAYOUT_COLUMN_COUNT = 2@@ -133,13 +140,67 @@ export const generateRegexpWhere = (filters: ReportFilterItem[], prepend = true)}}+// Unlike the legacy `generateRegexpWhere`, this function requires filter values+// to be raw (unquoted) strings or numbers. `analyticsLiteral` handles all+// quoting and escaping — callers must NOT pre-wrap values in single quotes.+export function generateRegexpWhereSafe(+ filters: ReportFilterItem[],+ prepend = true+): SafeLogSqlFragment {+ if (filters.length === 0) return safeLogSql``++ const conditions = filters+ .map((filter) => {+ const splitKey = filter.key.split('.')+ const normalizedKey = [splitKey[splitKey.length - 2], splitKey[splitKey.length - 1]].join('.')+ const keyToQuote = filter.key.includes('.') ? normalizedKey : filter.key++ let col: SafeLogSqlFragment+ try {+ col = quotedIdent(keyToQuote)+ } catch {+ return null+ }++ const valueIsNumber = !isNaN(Number(filter.value))+ const lit = valueIsNumber+ ? analyticsLiteral(Number(filter.value))+ : analyticsLiteral(String(filter.value).toLowerCase())++ switch (filter.compare) {+ case 'matches':+ return safeLogSql`REGEXP_CONTAINS(${col}, ${lit})`+ case 'is':+ return safeLogSql`${col} = ${lit}`+ case '!=':+ return safeLogSql`${col} != ${lit}`+ case '>=':+ return safeLogSql`${col} >= ${lit}`+ case '<=':+ return safeLogSql`${col} <= ${lit}`+ case '>':+ return safeLogSql`${col} > ${lit}`+ case '<':+ return safeLogSql`${col} < ${lit}`+ default:+ return safeLogSql`${col} = ${lit}`+ }+ })+ .filter((c) => c !== null)++ if (conditions.length === 0) return safeLogSql``++ const joined = joinSqlFragments(conditions, ' AND ')+ return prepend ? safeLogSql`WHERE ${joined}` : safeLogSql`AND ${joined}`+}+export const PRESET_CONFIG: Record<Presets, PresetConfig> = {[Presets.API]: {title: 'API',queries: {totalRequests: {queryType: 'logs',- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-api-total-requestsselectcast(timestamp_trunc(t.timestamp, hour) as datetime) as timestamp,@@ -149,7 +210,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {cross join unnest(m.response) as responsecross join unnest(m.request) as requestcross join unnest(request.headers) as headers- ${generateRegexpWhere(filters)}+ ${generateRegexpWhereSafe(filters)}GROUP BYtimestampORDER BY@@ -157,7 +218,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {},topRoutes: {queryType: 'logs',- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-api-top-routesselectrequest.path as path,@@ -170,7 +231,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {cross join unnest(m.response) as responsecross join unnest(m.request) as requestcross join unnest(request.headers) as headers- ${generateRegexpWhere(filters)}+ ${generateRegexpWhereSafe(filters)}group byrequest.path, request.method, request.search, response.status_codeorder by@@ -180,7 +241,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {},errorCounts: {queryType: 'logs',- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-api-error-countsselectcast(timestamp_trunc(t.timestamp, hour) as datetime) as timestamp,@@ -192,7 +253,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {cross join unnest(request.headers) as headersWHEREresponse.status_code >= 400- ${generateRegexpWhere(filters, false)}+ ${generateRegexpWhereSafe(filters, false)}GROUP BYtimestampORDER BY@@ -201,7 +262,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {},topErrorRoutes: {queryType: 'logs',- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-api-top-error-routesselectrequest.path as path,@@ -216,7 +277,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {cross join unnest(request.headers) as headerswhereresponse.status_code >= 400- ${generateRegexpWhere(filters, false)}+ ${generateRegexpWhereSafe(filters, false)}group byrequest.path, request.method, request.search, response.status_codeorder by@@ -226,7 +287,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {},responseSpeed: {queryType: 'logs',- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-api-response-speedselectcast(timestamp_trunc(t.timestamp, hour) as datetime) as timestamp,@@ -237,7 +298,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {cross join unnest(m.response) as responsecross join unnest(m.request) as requestcross join unnest(request.headers) as headers- ${generateRegexpWhere(filters)}+ ${generateRegexpWhereSafe(filters)}GROUP BYtimestampORDER BY@@ -246,7 +307,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {},topSlowRoutes: {queryType: 'logs',- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-api-top-slow-routesselectrequest.path as path,@@ -260,7 +321,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {cross join unnest(m.response) as responsecross join unnest(m.request) as requestcross join unnest(request.headers) as headers- ${generateRegexpWhere(filters)}+ ${generateRegexpWhereSafe(filters)}group byrequest.path, request.method, request.search, response.status_codeorder by@@ -270,7 +331,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {},networkTraffic: {queryType: 'logs',- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-api-network-trafficselectcast(timestamp_trunc(t.timestamp, hour) as datetime) as timestamp,@@ -299,7 +360,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {cross join unnest(m.request) as requestcross join unnest(request.headers) as headerscross join unnest(response.headers) as resp_headers- ${generateRegexpWhere(filters)}+ ${generateRegexpWhereSafe(filters)}GROUP BYtimestampORDER BY@@ -308,7 +369,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {},requestsByCountry: {queryType: 'logs',- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-api-requests-by-countryselectcf.country as country,@@ -321,7 +382,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {cross join unnest(request.cf) as cfwherecf.country is not null- ${generateRegexpWhere(filters, false)}+ ${generateRegexpWhereSafe(filters, false)}group bycf.country`,@@ -338,7 +399,7 @@ export const PRESET_CONFIG: Record<Presets, PresetConfig> = {cacheHitRate: {queryType: 'logs',// storage report does not perform any filtering- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-storage-cache-hit-rateSELECTtimestamp_trunc(timestamp, hour) as timestamp,@@ -350,7 +411,7 @@ from edge_logs fcross join unnest(m.response) as rescross join unnest(res.headers) as hwhere starts_with(r.path, '/storage/v1/object') and r.method = 'GET'- ${generateRegexpWhere(filters, false)}+ ${generateRegexpWhereSafe(filters, false)}group by timestamporder by timestamp desc`,@@ -358,7 +419,7 @@ order by timestamp desctopCacheMisses: {queryType: 'logs',// storage report does not perform any filtering- sql: (filters) => `+ sql: (filters) => safeLogSql`-- reports-storage-top-cache-missesSELECTr.path as path,@@ -372,7 +433,7 @@ from edge_logs fwhere starts_with(r.path, '/storage/v1/object')and r.method = 'GET'and h.cf_cache_status in ('MISS', 'NONE/UNKNOWN', 'EXPIRED', 'BYPASS', 'DYNAMIC')- ${generateRegexpWhere(filters, false)}+ ${generateRegexpWhereSafe(filters, false)}group by path, searchorder by count desclimit 12diff --git a/apps/studio/components/interfaces/Reports/Reports.types.ts b/apps/studio/components/interfaces/Reports/Reports.types.tsindex 6eb68e2aab4..33fb035fcfa 100644--- a/apps/studio/components/interfaces/Reports/Reports.types.ts+++ b/apps/studio/components/interfaces/Reports/Reports.types.ts@@ -1,5 +1,6 @@import type { SafeSqlFragment } from '@supabase/pg-meta'+import type { SafeLogSqlFragment } from '@/data/logs/safe-analytics-sql'import type { ResponseError } from '@/types'export enum Presets {@@ -31,7 +32,7 @@ export interface ReportQueryLogs {filterIndexAdvisor?: boolean,page?: number,pageSize?: number- ) => string+ ) => SafeLogSqlFragment}export interface ReportQueryDb {diff --git a/apps/studio/components/interfaces/Reports/Reports.utils.tsx b/apps/studio/components/interfaces/Reports/Reports.utils.tsxindex fa37349f582..064c3ee9ec9 100644--- a/apps/studio/components/interfaces/Reports/Reports.utils.tsx+++ b/apps/studio/components/interfaces/Reports/Reports.utils.tsx@@ -10,6 +10,7 @@ import {isUnixMicro,unixMicroToIsoTimestamp,} from '@/components/interfaces/Settings/Logs/Logs.utils'+import type { SafeLogSqlFragment } from '@/data/logs/safe-analytics-sql'import { REPORT_STATUS_CODE_COLORS } from '@/data/reports/report.utils'import useDbQuery, { DbQueryHook } from '@/hooks/analytics/useDbQuery'import useLogsQuery, { LogsQueryHook } from '@/hooks/analytics/useLogsQuery'@@ -49,7 +50,7 @@ export const queriesFactory = <T extends string>(return hooks}-export function getLogsSql(query: ReportQuery, filters: ReportFilterItem[]): string {+export function getLogsSql(query: ReportQuery, filters: ReportFilterItem[]): SafeLogSqlFragment {if (query.queryType !== 'logs') {throw new Error(`Expected logs query, got ${query.queryType}`)}diff --git a/apps/studio/data/reports/api-report-query.ts b/apps/studio/data/reports/api-report-query.tsindex 4745aa5fca4..56e8c018590 100644--- a/apps/studio/data/reports/api-report-query.ts+++ b/apps/studio/data/reports/api-report-query.ts@@ -66,7 +66,7 @@ export const useApiReport = () => {const formattedFilters: ReportFilterItem[] = [...filters,...(identifier !== undefined- ? [{ key: 'identifier', value: `'${identifier}'`, compare: 'is' } as ReportFilterItem]+ ? [{ key: 'identifier', value: identifier, compare: 'is' } as ReportFilterItem]: []),]diff --git a/apps/studio/data/reports/storage-report-query.ts b/apps/studio/data/reports/storage-report-query.tsindex cd6d2433462..56f2432bb34 100644--- a/apps/studio/data/reports/storage-report-query.ts+++ b/apps/studio/data/reports/storage-report-query.ts@@ -80,7 +80,7 @@ export const useStorageReport = () => {const formattedFilters: ReportFilterItem[] = [...filters,...(identifier !== undefined- ? [{ key: 'identifier', value: `'${identifier}'`, compare: 'is' } as ReportFilterItem]+ ? [{ key: 'identifier', value: identifier, compare: 'is' } as ReportFilterItem]: []),]