The minimalistic document archiving platform.
refactor(api): migrate ping/health routes to new system (#1557)
Corentin Thomassete125ef7176a2
diff --git a/apps/papra-server/src/modules/api/api.contracts.registry.ts b/apps/papra-server/src/modules/api/api.contracts.registry.tsindex 0cc04334..7a3ec772 100644--- a/apps/papra-server/src/modules/api/api.contracts.registry.ts+++ b/apps/papra-server/src/modules/api/api.contracts.registry.ts@@ -1,8 +1,11 @@+import { healthCheckContract, pingContract } from '../app/health-check/health-check.api.contracts';import { getCurrentUserContract, updateCurrentUserContract } from '../users/users.api.contracts';export type { ApiContract } from './api.contracts';export const apiContracts = {+ ping: pingContract,+ healthCheck: healthCheckContract,getCurrentUser: getCurrentUserContract,updateCurrentUser: updateCurrentUserContract,};diff --git a/apps/papra-server/src/modules/app/health-check/e2e/health-check.e2e.test.ts b/apps/papra-server/src/modules/app/health-check/e2e/health-check.e2e.test.tsindex 8cd6caf2..4c10bdee 100644--- a/apps/papra-server/src/modules/app/health-check/e2e/health-check.e2e.test.ts+++ b/apps/papra-server/src/modules/app/health-check/e2e/health-check.e2e.test.ts@@ -16,8 +16,11 @@ describe('health check routes e2e', () => {const response = await app.request('/api/health');- expect(response.status).to.eql(200);- expect(await response.json()).to.eql({+ const body = await response.json();++ expect(response.status).toEqual(200);+ expect(response.headers.get('Content-Type')).toEqual('application/json');+ expect(body).toEqual({isDatabaseHealthy: true,isEverythingOk: true,status: 'ok',@@ -37,8 +40,11 @@ describe('health check routes e2e', () => {const response = await app.request('/api/health');- expect(response.status).to.eql(500);- expect(await response.json()).to.eql({+ const body = await response.json();++ expect(response.status).toEqual(500);+ expect(response.headers.get('Content-Type')).toEqual('application/json');+ expect(body).toEqual({isDatabaseHealthy: false,isEverythingOk: false,status: 'error',diff --git a/apps/papra-server/src/modules/app/health-check/e2e/ping.e2e.test.ts b/apps/papra-server/src/modules/app/health-check/e2e/ping.e2e.test.tsindex b98f5acd..cb6785e1 100644--- a/apps/papra-server/src/modules/app/health-check/e2e/ping.e2e.test.ts+++ b/apps/papra-server/src/modules/app/health-check/e2e/ping.e2e.test.ts@@ -11,9 +11,21 @@ describe('ping routes e2e', () => {const response = await app.request('/api/ping');- expect(response.status).to.eql(200);- expect(await response.json()).to.eql({- status: 'ok',- });+ const body = await response.json();++ expect(response.status).toEqual(200);+ expect(response.headers.get('Content-Type')).toEqual('application/json');+ expect(body).toEqual({ status: 'ok' });+ });++ test('HEAD requests to /api/ping are public and return no body', async () => {+ const { db } = await createInMemoryDatabase();+ const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig() }));++ const response = await app.request('/api/ping', { method: 'HEAD' });++ expect(response.status).toEqual(200);+ expect(response.headers.get('Content-Type')).toEqual('application/json');+ expect(response.body).toEqual(null);});});diff --git a/apps/papra-server/src/modules/app/health-check/health-check.api.contracts.ts b/apps/papra-server/src/modules/app/health-check/health-check.api.contracts.tsnew file mode 100644index 00000000..49e6e4d7--- /dev/null+++ b/apps/papra-server/src/modules/app/health-check/health-check.api.contracts.ts@@ -0,0 +1,46 @@+import * as v from 'valibot';+import { defineApiContract } from '../../api/api.contracts';++export const pingContract = defineApiContract({+ path: '/api/ping',+ method: 'GET',+ responses: {+ 200: {+ description: 'Returns an ok status when the server is reachable.',+ content: {+ 'application/json': {+ schema: v.object({ status: v.literal('ok') }),+ },+ },+ },+ },+});++const healthCheckResponseSchema = v.object({+ isDatabaseHealthy: v.boolean(),+ isEverythingOk: v.boolean(),+ status: v.picklist(['ok', 'error']),+});++export const healthCheckContract = defineApiContract({+ path: '/api/health',+ method: 'GET',+ responses: {+ 200: {+ description: 'Returns health information when the server is healthy.',+ content: {+ 'application/json': {+ schema: healthCheckResponseSchema,+ },+ },+ },+ 500: {+ description: 'Returns health information when the server is unhealthy.',+ content: {+ 'application/json': {+ schema: healthCheckResponseSchema,+ },+ },+ },+ },+});diff --git a/apps/papra-server/src/modules/app/health-check/health-check.api.routes.ts b/apps/papra-server/src/modules/app/health-check/health-check.api.routes.tsnew file mode 100644index 00000000..08d9f7cc--- /dev/null+++ b/apps/papra-server/src/modules/app/health-check/health-check.api.routes.ts@@ -0,0 +1,42 @@+import type { ApiDependencies } from '../server.types';+import { defineApiRoute } from '../../api/api.routes';+import { healthCheckContract, pingContract } from './health-check.api.contracts';+import { isDatabaseHealthy } from './health-check.repository';++export function buildHealthCheckApiRoutes(deps: ApiDependencies) {+ return [setupPingRoute(), setupHealthCheckRoute(deps)];+}++function setupPingRoute() {+ return defineApiRoute({+ contract: pingContract,+ handler: async () => ({+ status: 200,+ contentType: 'application/json',+ body: { status: 'ok' as const },+ }),+ });+}++function setupHealthCheckRoute({ db }: ApiDependencies) {+ return defineApiRoute({+ contract: healthCheckContract,+ handler: async () => {+ const isHealthy = await isDatabaseHealthy({ db });++ const isEverythingOk = isHealthy;+ const status = isEverythingOk ? 'ok' : 'error';+ const statusCode = isEverythingOk ? 200 : 500;++ return {+ status: statusCode,+ contentType: 'application/json',+ body: {+ isDatabaseHealthy: isHealthy,+ isEverythingOk,+ status,+ } as const,+ };+ },+ });+}diff --git a/apps/papra-server/src/modules/app/health-check/health-check.routes.ts b/apps/papra-server/src/modules/app/health-check/health-check.routes.tsdeleted file mode 100644index 0ce9814a..00000000--- a/apps/papra-server/src/modules/app/health-check/health-check.routes.ts+++ /dev/null@@ -1,30 +0,0 @@-import type { RouteDefinitionContext } from '../server.types';-import { isDatabaseHealthy } from './health-check.repository';--export function registerHealthCheckRoutes(context: RouteDefinitionContext) {- setupPingRoute(context);- setupHealthCheckRoute(context);-}--function setupPingRoute({ app }: RouteDefinitionContext) {- app.get('/api/ping', (context) => context.json({ status: 'ok' }));-}--function setupHealthCheckRoute({ app, db }: RouteDefinitionContext) {- app.get('/api/health', async (context) => {- const isHealthy = await isDatabaseHealthy({ db });-- const isEverythingOk = isHealthy;- const status = isEverythingOk ? 'ok' : 'error';- const statusCode = isEverythingOk ? 200 : 500;-- return context.json(- {- isDatabaseHealthy: isHealthy,- isEverythingOk,- status,- },- statusCode,- );- });-}diff --git a/apps/papra-server/src/modules/app/server.api.routes.test.ts b/apps/papra-server/src/modules/app/server.api.routes.test.tsindex 531cc834..15858041 100644--- a/apps/papra-server/src/modules/app/server.api.routes.test.ts+++ b/apps/papra-server/src/modules/app/server.api.routes.test.ts@@ -89,7 +89,7 @@ describe('contract API wiring', () => {const { db } = await createInMemoryDatabase();const { app } = createServer(createTestServerDependencies({ db }));- const response = await app.request('/api/ping', { method: 'HEAD' });+ const response = await app.request('/api/config', { method: 'HEAD' });expect(response.status).toEqual(200);expect(response.headers.get('Content-Type')).toEqual('application/json');diff --git a/apps/papra-server/src/modules/app/server.api.routes.ts b/apps/papra-server/src/modules/app/server.api.routes.tsindex 8c8e76a7..a9634fa6 100644--- a/apps/papra-server/src/modules/app/server.api.routes.ts+++ b/apps/papra-server/src/modules/app/server.api.routes.ts@@ -2,6 +2,7 @@ import type { ApiDependencies, RouteDefinitionContext } from './server.types';import { buildApiRequestHandler } from '../api/api.request-handler';import { buildUserApiRoutes } from '../users/users.api.routes';+import { buildHealthCheckApiRoutes } from './health-check/health-check.api.routes';import {buildGetApiKey,buildGetSession,@@ -9,7 +10,7 @@ import {} from '../api/api.authentication';function buildApiRoutes(deps: ApiDependencies) {- return [...buildUserApiRoutes(deps)];+ return [...buildHealthCheckApiRoutes(deps), ...buildUserApiRoutes(deps)];}export function registerApiRoutes({ app, ...deps }: RouteDefinitionContext) {diff --git a/apps/papra-server/src/modules/app/server.routes.test.ts b/apps/papra-server/src/modules/app/server.routes.test.tsindex 2f196bb7..db3807be 100644--- a/apps/papra-server/src/modules/app/server.routes.test.ts+++ b/apps/papra-server/src/modules/app/server.routes.test.ts@@ -40,8 +40,6 @@ describe('server routes', () => {const { app } = createServer(createTestServerDependencies({ db, config: overrideConfig() }));const publicRoutes = [- 'GET /api/ping',- 'GET /api/health','GET /api/config',// Authentication is handled by payload signature verificationdiff --git a/apps/papra-server/src/modules/app/server.routes.ts b/apps/papra-server/src/modules/app/server.routes.tsindex c71bb9cf..e8e75d7b 100644--- a/apps/papra-server/src/modules/app/server.routes.ts+++ b/apps/papra-server/src/modules/app/server.routes.ts@@ -17,13 +17,11 @@ import { registerTaggingRulesRoutes } from '../tagging-rules/tagging-rules.routeimport { registerTagsRoutes } from '../tags/tags.routes';import { registerWebhooksRoutes } from '../webhooks/webhooks.routes';import { registerAuthRoutes } from './auth/auth.routes';-import { registerHealthCheckRoutes } from './health-check/health-check.routes';import { registerOrganizationSettingsRoutes } from '../organizations/organization-settings/organization-settings.routes';export function registerRoutes(context: RouteDefinitionContext) {registerAuthRoutes(context);registerConfigRoutes(context);- registerHealthCheckRoutes(context);registerIntakeEmailsRoutes(context);registerSubscriptionsRoutes(context);registerOrganizationsRoutes(context);