Skip to content

feat(backend, auth): /healthz fails if a database is not connected #3717

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
njlie merged 7 commits into from
Dec 5, 2025
Merged

feat(backend, auth): /healthz fails if a database is not connected #3717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d68911f
feat(backend, auth): /healthz fails if a database is not connected
njlie Oct 23, 2025
fac692b
chore: remove comments
njlie Oct 24, 2025
1314802
chore: cleanup
njlie Oct 24, 2025
571a7c0
fix: remove missing logger instantiation
njlie Nov 25, 2025
6abf764
feat: add healthz to auth admin server
njlie Dec 2, 2025
d291b44
fix: remove extraneous middleware
njlie Dec 3, 2025
4e9e163
fix: return next properly
njlie Dec 3, 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
60 changes: 54 additions & 6 deletions packages/auth/src/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,30 @@ export class App {

koa.use(bodyParser())

const redis = await this.container.use('redis')
koa.use(
async (
ctx: {
path: string
status: number
},
next: Koa.Next
): Promise<void> => {
if (ctx.path === '/healthz') {
const knex = await this.container.use('knex')
try {
await redis.ping()
await knex.raw('SELECT 1')
ctx.status = 200
} catch (err) {
ctx.status = 500
}
} else {
return next()
}
}
)

koa.use(
async (
ctx: {
Expand Down Expand Up @@ -268,8 +292,16 @@ export class App {

const router = new Router<DefaultState, AppContext>()
router.use(bodyParser())
router.get('/healthz', (ctx: AppContext): void => {
ctx.status = 200
router.get('/healthz', async (ctx: AppContext): Promise<void> => {
Copy link
Copy Markdown
Contributor

@mkurapov mkurapov Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's add this route for the Admin API as well (like in backend)

const redis = await this.container.use('redis')
const knex = await this.container.use('knex')
try {
await redis.ping()
await knex.raw('SELECT 1')
ctx.status = 200
} catch (e) {
ctx.status = 500
}
})
router.use(gnapServerErrorMiddleware)

Expand Down Expand Up @@ -413,8 +445,16 @@ export class App {

const router = new Router<DefaultState, AppContext>()
router.use(bodyParser())
router.get('/healthz', (ctx: AppContext): void => {
ctx.status = 200
router.get('/healthz', async (ctx: AppContext): Promise<void> => {
const redis = await this.container.use('redis')
const knex = await this.container.use('knex')
try {
await redis.ping()
await knex.raw('SELECT 1')
ctx.status = 200
} catch (e) {
ctx.status = 500
}
})

const accessTokenRoutes = await this.container.use('accessTokenRoutes')
Expand Down Expand Up @@ -505,8 +545,16 @@ export class App {

koa.use(errorHandler)

router.get('/healthz', (ctx: AppContext): void => {
ctx.status = 200
router.get('/healthz', async (ctx: AppContext): Promise<void> => {
const redis = await this.container.use('redis')
const knex = await this.container.use('knex')
try {
await redis.ping()
await knex.raw('SELECT 1')
ctx.status = 200
} catch (e) {
ctx.status = 500
}
})

const tenantRoutes = await this.container.use('tenantRoutes')
Expand Down
21 changes: 18 additions & 3 deletions packages/backend/src/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,14 @@ export class App {
next: Koa.Next
): Promise<void> => {
if (ctx.path === '/healthz') {
ctx.status = 200
const knex = await this.container.use('knex')
try {
await redis.ping()
await knex.raw('SELECT 1')
ctx.status = 200
} catch (err) {
ctx.status = 500
}
} else if (ctx.path !== '/graphql') {
ctx.status = 404
} else {
Expand Down Expand Up @@ -479,8 +486,16 @@ export class App {

const router = new Router<DefaultState, AppContext>()
router.use(bodyParser())
router.get('/healthz', (ctx: AppContext): void => {
ctx.status = 200
router.get('/healthz', async (ctx: AppContext): Promise<void> => {
const redis = await ctx.container.use('redis')
const knex = await ctx.container.use('knex')
try {
await redis.ping()
await knex.raw('SELECT 1')
ctx.status = 200
} catch (e) {
ctx.status = 500
}
})
router.use(openPaymentsServerErrorMiddleware)

Expand Down
Loading