feat: health check

healthcheck/Dockerfile

@@ -12,7 +12,7 @@ RUN npm ci
 FROM base AS production-deps
 WORKDIR /app
 ADD package.json package-lock.json ./
-RUN npm ci --omit=dev
+RUN npm ci
 
 # Build stage
 FROM base AS build

healthcheck/adonisrc.ts

@@ -30,7 +30,7 @@ export default defineConfig({
     },
     () => import('@adonisjs/core/providers/vinejs_provider'),
     () => import('@adonisjs/cors/cors_provider'),
-    () => import('@adonisjs/lucid/database_provider')
+    () => import('@adonisjs/lucid/database_provider'),
   ],
 
   /*

healthcheck/app/controllers/health_checks_controller.ts

@@ -0,0 +1,14 @@
+import { healthChecks } from '#start/health'
+import type { HttpContext } from '@adonisjs/core/http'
+
+export default class HealthChecksController {
+  async handle({ response }: HttpContext) {
+    const report = await healthChecks.run()
+
+    if (report.isHealthy) {
+      return response.ok(report)
+    }
+
+    return response.serviceUnavailable(report)
+  }
+}

healthcheck/app/controllers/healthchecks_controller.ts

@@ -1,9 +1,11 @@
+import { healthChecks } from '#start/health'
 import type { HttpContext } from '@adonisjs/core/http'
 
 export default class HealthchecksController {
-  index({ response }: HttpContext) {
-    return response.status(200).json({
-      status: 'ok',
-    })
+  async index({ response }: HttpContext) {
+    const health = await healthChecks.run()
+    const check = health.checks[0]
+    check.status
+    return response.send(health.checks)
   }
 }

healthcheck/start/env.ts

@@ -27,5 +27,5 @@ export default await Env.create(new URL('../', import.meta.url), {
   DB_PORT: Env.schema.number(),
   DB_USER: Env.schema.string(),
   DB_PASSWORD: Env.schema.string.optional(),
-  DB_DATABASE: Env.schema.string()
+  DB_DATABASE: Env.schema.string(),
 })

healthcheck/start/health.ts

@@ -0,0 +1,5 @@
+import { HealthChecks } from '@adonisjs/core/health'
+import { DbCheck } from '@adonisjs/lucid/database'
+import db from '@adonisjs/lucid/services/db'
+
+export const healthChecks = new HealthChecks().register([new DbCheck(db.connection())])

healthcheck/start/routes.ts

@@ -16,4 +16,4 @@ router.get('/', async () => {
   }
 })
 
-router.get('/healthcheck', [HealthchecksController, 'index'])
+router.get('/health', [HealthchecksController, 'index'])