fix(api): set x-pg-application-name for dashboard (supabase#37048)

avallete · web-flow · commit 4bd28eecb8b4 · 2025-07-21T10:39:46.000+02:00
chore(api): set x-pg-application-name for dashboard
diff --git a/apps/studio/data/database-extensions/database-extensions-query.ts b/apps/studio/data/database-extensions/database-extensions-query.ts
@@ -5,6 +5,7 @@ import { databaseExtensionsKeys } from './keys'
 import { components } from 'api-types'
 import { useSelectedProject } from 'hooks/misc/useSelectedProject'
 import { PROJECT_STATUS } from 'lib/constants'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type DatabaseExtension = components['schemas']['PostgresExtension']
 
@@ -27,6 +28,7 @@ export async function getDatabaseExtensions(
     params: {
       header: {
         'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
       },
       path: {
         ref: projectRef,
diff --git a/apps/studio/data/database-policies/database-policies-query.ts b/apps/studio/data/database-policies/database-policies-query.ts
@@ -5,6 +5,7 @@ import { useSelectedProject } from 'hooks/misc/useSelectedProject'
 import { PROJECT_STATUS } from 'lib/constants'
 import type { ResponseError } from 'types'
 import { databasePoliciesKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type DatabasePoliciesVariables = {
   projectRef?: string
@@ -24,7 +25,10 @@ export async function getDatabasePolicies(
 
   const { data, error } = await get('/platform/pg-meta/{ref}/policies', {
     params: {
-      header: { 'x-connection-encrypted': connectionString! },
+      header: {
+        'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
+      },
       path: { ref: projectRef },
       query: {
         included_schemas: schema || '',
diff --git a/apps/studio/data/database-publications/database-publications-query.ts b/apps/studio/data/database-publications/database-publications-query.ts
@@ -2,6 +2,7 @@ import { UseQueryOptions, useQuery } from '@tanstack/react-query'
 import { get, handleError } from 'data/fetchers'
 import type { ResponseError } from 'types'
 import { databasePublicationsKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type DatabasePublicationsVariables = {
   projectRef?: string
@@ -21,6 +22,7 @@ export async function getDatabasePublications(
     params: {
       header: {
         'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
       },
       path: {
         ref: projectRef,
diff --git a/apps/studio/data/database-triggers/database-triggers-query.ts b/apps/studio/data/database-triggers/database-triggers-query.ts
@@ -2,6 +2,7 @@ import { useQuery, UseQueryOptions } from '@tanstack/react-query'
 import { get, handleError } from 'data/fetchers'
 import type { ResponseError } from 'types'
 import { databaseTriggerKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type DatabaseTriggersVariables = {
   projectRef?: string
@@ -19,7 +20,10 @@ export async function getDatabaseTriggers(
 
   const { data, error } = await get('/platform/pg-meta/{ref}/triggers', {
     params: {
-      header: { 'x-connection-encrypted': connectionString! },
+      header: {
+        'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
+      },
       path: { ref: projectRef },
       query: undefined as any,
     },
diff --git a/apps/studio/data/enumerated-types/enumerated-types-query.ts b/apps/studio/data/enumerated-types/enumerated-types-query.ts
@@ -4,6 +4,7 @@ import type { components } from 'data/api'
 import { get, handleError } from 'data/fetchers'
 import type { ResponseError } from 'types'
 import { enumeratedTypesKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type EnumeratedTypesVariables = {
   projectRef?: string
@@ -23,7 +24,10 @@ export async function getEnumeratedTypes(
 
   const { data, error } = await get('/platform/pg-meta/{ref}/types', {
     params: {
-      header: { 'x-connection-encrypted': connectionString! },
+      header: {
+        'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
+      },
       path: { ref: projectRef },
     },
     headers: Object.fromEntries(headers),
diff --git a/apps/studio/data/fetchers.ts b/apps/studio/data/fetchers.ts
@@ -6,8 +6,8 @@ import { API_URL } from 'lib/constants'
 import { getAccessToken } from 'lib/gotrue'
 import { uuidv4 } from 'lib/helpers'
 import { ResponseError } from 'types'
-// generated from openapi-typescript
-import type { paths } from './api'
+import type { paths } from './api' // generated from openapi-typescript
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 const DEFAULT_HEADERS = { Accept: 'application/json' }
 
@@ -73,6 +73,9 @@ function pgMetaGuard(request: Request) {
         retryAfterHeader ? parseInt(retryAfterHeader) : undefined
       )
     }
+    if (!request.headers.get('x-pg-application-name')) {
+      request.headers.set('x-pg-application-name', DEFAULT_PLATFORM_APPLICATION_NAME)
+    }
   }
   return request
 }
diff --git a/apps/studio/data/foreign-tables/foreign-tables-query.ts b/apps/studio/data/foreign-tables/foreign-tables-query.ts
@@ -4,6 +4,7 @@ import { PostgresView } from '@supabase/postgres-meta'
 import { get, handleError } from 'data/fetchers'
 import type { ResponseError } from 'types'
 import { foreignTableKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type ForeignTablesVariables = {
   projectRef?: string
@@ -22,7 +23,10 @@ export async function getForeignTables(
 
   const { data, error } = await get('/platform/pg-meta/{ref}/foreign-tables', {
     params: {
-      header: { 'x-connection-encrypted': connectionString! },
+      header: {
+        'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
+      },
       path: { ref: projectRef },
       query: {
         included_schemas: schema || '',
diff --git a/apps/studio/data/materialized-views/materialized-views-query.ts b/apps/studio/data/materialized-views/materialized-views-query.ts
@@ -4,6 +4,7 @@ import { PostgresMaterializedView } from '@supabase/postgres-meta'
 import { get, handleError } from 'data/fetchers'
 import type { ResponseError } from 'types'
 import { materializedViewKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type MaterializedViewsVariables = {
   projectRef?: string
@@ -22,7 +23,10 @@ export async function getMaterializedViews(
 
   const { data, error } = await get('/platform/pg-meta/{ref}/materialized-views', {
     params: {
-      header: { 'x-connection-encrypted': connectionString! },
+      header: {
+        'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
+      },
       path: { ref: projectRef },
       query: {
         included_schemas: schema || '',
diff --git a/apps/studio/data/privileges/column-privileges-query.ts b/apps/studio/data/privileges/column-privileges-query.ts
@@ -4,6 +4,7 @@ import type { components } from 'data/api'
 import { get, handleError } from 'data/fetchers'
 import type { ResponseError } from 'types'
 import { privilegeKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type ColumnPrivilegesVariables = {
   projectRef?: string
@@ -25,7 +26,10 @@ export async function getColumnPrivileges(
     params: {
       path: { ref: projectRef },
       // this is needed to satisfy the typescript, but it doesn't pass the actual header
-      header: { 'x-connection-encrypted': connectionString! },
+      header: {
+        'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
+      },
     },
     signal,
     headers,
diff --git a/apps/studio/data/sql/execute-sql-query.ts b/apps/studio/data/sql/execute-sql-query.ts
@@ -9,6 +9,7 @@ import {
 } from 'lib/role-impersonation'
 import type { ResponseError } from 'types'
 import { sqlKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type ExecuteSqlVariables = {
   projectRef?: string
@@ -73,7 +74,12 @@ export async function executeSql<T = any>(
     const result = await post('/platform/pg-meta/{ref}/query', {
       signal,
       params: {
-        header: { 'x-connection-encrypted': connectionString ?? '' },
+        header: {
+          'x-connection-encrypted': connectionString ?? '',
+          'x-pg-application-name': isStatementTimeoutDisabled
+            ? 'supabase/dashboard-query-editor'
+            : DEFAULT_PLATFORM_APPLICATION_NAME,
+        },
         path: { ref: projectRef },
         // @ts-expect-error: This is just a client side thing to identify queries better
         query: {
diff --git a/apps/studio/data/tables/tables-query.ts b/apps/studio/data/tables/tables-query.ts
@@ -6,6 +6,7 @@ import { useCallback } from 'react'
 import { get, handleError } from 'data/fetchers'
 import type { ResponseError } from 'types'
 import { tableKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type TablesVariables = {
   projectRef?: string
@@ -45,7 +46,10 @@ export async function getTables(
 
   const { data, error } = await get('/platform/pg-meta/{ref}/tables', {
     params: {
-      header: { 'x-connection-encrypted': connectionString! },
+      header: {
+        'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
+      },
       path: { ref: projectRef },
       query: queryParams as any,
     },
diff --git a/apps/studio/data/views/views-query.ts b/apps/studio/data/views/views-query.ts
@@ -4,6 +4,7 @@ import { PostgresView } from '@supabase/postgres-meta'
 import { get, handleError } from 'data/fetchers'
 import type { ResponseError } from 'types'
 import { viewKeys } from './keys'
+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'
 
 export type ViewsVariables = {
   projectRef?: string
@@ -22,7 +23,10 @@ export async function getViews(
 
   const { data, error } = await get('/platform/pg-meta/{ref}/views', {
     params: {
-      header: { 'x-connection-encrypted': connectionString! },
+      header: {
+        'x-connection-encrypted': connectionString!,
+        'x-pg-application-name': DEFAULT_PLATFORM_APPLICATION_NAME,
+      },
       path: { ref: projectRef },
       query: {
         included_schemas: schema || '',
diff --git a/packages/api-types/types/platform.d.ts b/packages/api-types/types/platform.d.ts
diff --git a/packages/pg-meta/src/constants.ts b/packages/pg-meta/src/constants.ts

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@ import { API_URL } from 'lib/constants'`
`6`	`6`	`import { getAccessToken } from 'lib/gotrue'`
`7`	`7`	`import { uuidv4 } from 'lib/helpers'`
`8`	`8`	`import { ResponseError } from 'types'`
`9`		`-// generated from openapi-typescript`
`10`		`-import type { paths } from './api'`
	`9`	`+import type { paths } from './api' // generated from openapi-typescript`
	`10`	`+import { DEFAULT_PLATFORM_APPLICATION_NAME } from '@supabase/pg-meta/src/constants'`
`11`	`11`
`12`	`12`	`const DEFAULT_HEADERS = { Accept: 'application/json' }`
`13`	`13`
`@@ -73,6 +73,9 @@ function pgMetaGuard(request: Request) {`
`73`	`73`	`retryAfterHeader ? parseInt(retryAfterHeader) : undefined`
`74`	`74`	`)`
`75`	`75`	`}`
	`76`	`+ if (!request.headers.get('x-pg-application-name')) {`
	`77`	`+ request.headers.set('x-pg-application-name', DEFAULT_PLATFORM_APPLICATION_NAME)`
	`78`	`+ }`
`76`	`79`	`}`
`77`	`80`	`return request`
`78`	`81`	`}`