Skip to content

feat: allow setting application_name via header #941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 8, 2025
Merged

feat: allow setting application_name via header #941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9ee152
feat: allow setting application_name via header
soedirgo May 7, 2025
e8f7e41
test: setting custom application_name
soedirgo May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions src/server/routes/column-privileges.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
postgresColumnPrivilegesRevokeSchema,
postgresColumnPrivilegesSchema,
} from '../../lib/types.js'
import { DEFAULT_POOL_CONFIG } from '../constants.js'
import { createConnectionConfig } from '../utils.js'
import { extractRequestForLogging, translateErrorToResponseCode } from '../utils.js'

const route: FastifyPluginAsyncTypebox = async (fastify) => {
Expand All @@ -16,6 +16,7 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
schema: {
headers: Type.Object({
pg: Type.String(),
'x-pg-application-name': Type.Optional(Type.String()),
}),
querystring: Type.Object({
include_system_schemas: Type.Optional(Type.Boolean()),
Expand All @@ -34,14 +35,14 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
},
},
async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)
const includeSystemSchemas = request.query.include_system_schemas
const includedSchemas = request.query.included_schemas?.split(',')
const excludedSchemas = request.query.excluded_schemas?.split(',')
const limit = request.query.limit
const offset = request.query.offset

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.columnPrivileges.list({
includeSystemSchemas,
includedSchemas,
Expand All @@ -66,6 +67,7 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
schema: {
headers: Type.Object({
pg: Type.String(),
'x-pg-application-name': Type.Optional(Type.String()),
}),
body: Type.Array(postgresColumnPrivilegesGrantSchema),
response: {
Expand All @@ -77,9 +79,9 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
},
},
async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.columnPrivileges.grant(request.body)
await pgMeta.end()
if (error) {
Expand All @@ -98,6 +100,7 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
schema: {
headers: Type.Object({
pg: Type.String(),
'x-pg-application-name': Type.Optional(Type.String()),
}),
body: Type.Array(postgresColumnPrivilegesRevokeSchema),
response: {
Expand All @@ -112,9 +115,9 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
},
},
async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.columnPrivileges.revoke(request.body)
await pgMeta.end()
if (error) {
Expand Down
34 changes: 18 additions & 16 deletions src/server/routes/columns.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { PostgresMeta } from '../../lib/index.js'
import { DEFAULT_POOL_CONFIG } from '../constants.js'
import { extractRequestForLogging } from '../utils.js'
import { createConnectionConfig, extractRequestForLogging } from '../utils.js'
import { Type } from '@sinclair/typebox'
import {
postgresColumnCreateSchema,
Expand All @@ -16,6 +15,7 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
schema: {
headers: Type.Object({
pg: Type.String(),
'x-pg-application-name': Type.Optional(Type.String()),
}),
querystring: Type.Object({
include_system_schemas: Type.Optional(Type.Boolean()),
Expand All @@ -33,14 +33,14 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
},
},
async (request, reply) => {
const connectionString = request.headers.pg
const includeSystemSchemas = request.query.include_system_schemas
const includedSchemas = request.query.included_schemas?.split(',')
const excludedSchemas = request.query.excluded_schemas?.split(',')
const limit = request.query.limit
const offset = request.query.offset

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const config = createConnectionConfig(request)
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.columns.list({
includeSystemSchemas,
includedSchemas,
Expand All @@ -65,6 +65,7 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
schema: {
headers: Type.Object({
pg: Type.String(),
'x-pg-application-name': Type.Optional(Type.String()),
}),
params: Type.Object({
tableId: Type.String(),
Expand All @@ -86,13 +87,13 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
async (request, reply) => {
if (request.params.ordinalPosition === '') {
const {
headers: { pg: connectionString },
query: { limit, offset },
params: { tableId },
} = request
const includeSystemSchemas = request.query.include_system_schemas

const pgMeta: PostgresMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const config = createConnectionConfig(request)
const pgMeta: PostgresMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.columns.list({
tableId: Number(tableId),
includeSystemSchemas,
Expand All @@ -109,12 +110,12 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
return data[0]
} else if (/^\.\d+$/.test(request.params.ordinalPosition)) {
const {
headers: { pg: connectionString },
params: { tableId, ordinalPosition: ordinalPositionWithDot },
} = request
const ordinalPosition = ordinalPositionWithDot.slice(1)

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const config = createConnectionConfig(request)
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.columns.retrieve({
id: `${tableId}.${ordinalPosition}`,
})
Expand All @@ -139,6 +140,7 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
schema: {
headers: Type.Object({
pg: Type.String(),
'x-pg-application-name': Type.Optional(Type.String()),
}),
body: postgresColumnCreateSchema,
response: {
Expand All @@ -150,9 +152,8 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
},
},
async (request, reply) => {
const connectionString = request.headers.pg

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const config = createConnectionConfig(request)
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.columns.create(request.body)
await pgMeta.end()
if (error) {
Expand All @@ -172,6 +173,7 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
schema: {
headers: Type.Object({
pg: Type.String(),
'x-pg-application-name': Type.Optional(Type.String()),
}),
params: Type.Object({
id: Type.String(),
Expand All @@ -186,9 +188,8 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
},
},
async (request, reply) => {
const connectionString = request.headers.pg

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const config = createConnectionConfig(request)
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.columns.update(request.params.id, request.body)
await pgMeta.end()
if (error) {
Expand All @@ -208,6 +209,7 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
schema: {
headers: Type.Object({
pg: Type.String(),
'x-pg-application-name': Type.Optional(Type.String()),
}),
params: Type.Object({
id: Type.String(),
Expand All @@ -224,10 +226,10 @@ const route: FastifyPluginAsyncTypebox = async (fastify) => {
},
},
async (request, reply) => {
const connectionString = request.headers.pg
const cascade = request.query.cascade === 'true'

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const config = createConnectionConfig(request)
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.columns.remove(request.params.id, { cascade })
await pgMeta.end()
if (error) {
Expand Down
14 changes: 7 additions & 7 deletions src/server/routes/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
import { FastifyInstance } from 'fastify'
import { PostgresMeta } from '../../lib/index.js'
import { DEFAULT_POOL_CONFIG } from '../constants.js'
import { createConnectionConfig } from '../utils.js'
import { extractRequestForLogging } from '../utils.js'

export default async (fastify: FastifyInstance) => {
fastify.get<{
Headers: { pg: string }
Headers: { pg: string; 'x-pg-application-name'?: string }
Querystring: {
limit?: number
offset?: number
}
}>('/', async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)
const limit = request.query.limit
const offset = request.query.offset

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.config.list({ limit, offset })
await pgMeta.end()
if (error) {
Expand All @@ -28,11 +28,11 @@ export default async (fastify: FastifyInstance) => {
})

fastify.get<{
Headers: { pg: string }
Headers: { pg: string; 'x-pg-application-name'?: string }
}>('/version', async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.version.retrieve()
await pgMeta.end()
if (error) {
Expand Down
32 changes: 16 additions & 16 deletions src/server/routes/extensions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
import { FastifyInstance } from 'fastify'
import { PostgresMeta } from '../../lib/index.js'
import { DEFAULT_POOL_CONFIG } from '../constants.js'
import { createConnectionConfig } from '../utils.js'
import { extractRequestForLogging } from '../utils.js'

export default async (fastify: FastifyInstance) => {
fastify.get<{
Headers: { pg: string }
Headers: { pg: string; 'x-pg-application-name'?: string }
Querystring: {
limit?: number
offset?: number
}
}>('/', async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)
const limit = request.query.limit
const offset = request.query.offset

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.extensions.list({ limit, offset })
await pgMeta.end()
if (error) {
Expand All @@ -28,14 +28,14 @@ export default async (fastify: FastifyInstance) => {
})

fastify.get<{
Headers: { pg: string }
Headers: { pg: string; 'x-pg-application-name'?: string }
Params: {
name: string
}
}>('/:name', async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.extensions.retrieve({ name: request.params.name })
await pgMeta.end()
if (error) {
Expand All @@ -48,12 +48,12 @@ export default async (fastify: FastifyInstance) => {
})

fastify.post<{
Headers: { pg: string }
Headers: { pg: string; 'x-pg-application-name'?: string }
Body: any
}>('/', async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.extensions.create(request.body as any)
await pgMeta.end()
if (error) {
Expand All @@ -66,15 +66,15 @@ export default async (fastify: FastifyInstance) => {
})

fastify.patch<{
Headers: { pg: string }
Headers: { pg: string; 'x-pg-application-name'?: string }
Params: {
name: string
}
Body: any
}>('/:name', async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.extensions.update(request.params.name, request.body as any)
await pgMeta.end()
if (error) {
Expand All @@ -88,18 +88,18 @@ export default async (fastify: FastifyInstance) => {
})

fastify.delete<{
Headers: { pg: string }
Headers: { pg: string; 'x-pg-application-name'?: string }
Params: {
name: string
}
Querystring: {
cascade?: string
}
}>('/:name', async (request, reply) => {
const connectionString = request.headers.pg
const config = createConnectionConfig(request)
const cascade = request.query.cascade === 'true'

const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
const pgMeta = new PostgresMeta(config)
const { data, error } = await pgMeta.extensions.remove(request.params.name, { cascade })
await pgMeta.end()
if (error) {
Expand Down
Loading