feat(healthcheck): Add Healthcheck Endpoint (#466)

hf-krechan · hf-kklein · web-flow · commit 06c1c71454c2 · 2025-02-19T07:40:40.000Z
* add healthcheck

* add launch.json to start express backend

* add healthcheck request

* fix url and add header

* add oh dear health check secret

* add oh dear health check secret for prod

* set env var OH_DEAR_HEALTH_CHECK_SECRET

* add OH_DEAR_HEALTH_CHECK_SECRET to example env

* add envs in bruno

* update requests in bruno

* change to require_secret

* Use 401

Co-authored-by: konstantin &lt;konstantin.klein@hochfrequenz.de&gt;

* verify that the expected tables are present

---------

Co-authored-by: konstantin &lt;konstantin.klein@hochfrequenz.de&gt;
diff --git a/.example.env b/.example.env
@@ -2,4 +2,6 @@ ENABLE_CORS=true
 
 AHB_CONTAINER_NAME='uploaded-files'
 AZURE_BLOB_STORAGE_CONNECTION_STRING=DefaultEndpointsProtocol='http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;'
-FORMAT_VERSION_CONTAINER_NAME=format-versions
+FORMAT_VERSION_CONTAINER_NAME=format-versions
+
+OH_DEAR_HEALTH_CHECK_SECRET=my-secret-oh-dear-health-check-secret
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -2,6 +2,23 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
+    {
+      "name": "Debug Express Server",
+      "type": "node",
+      "request": "launch",
+      "runtimeExecutable": "/Users/kevin/.nvm/versions/node/v20.13.1/bin/node",
+      "program": "${workspaceFolder}/node_modules/.bin/tsx",
+      "args": ["${workspaceFolder}/src/server.ts"],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "restart": true,
+      "envFile": "${workspaceFolder}/.env",
+      "env": {
+        "NODE_ENV": "development"
+      },
+      "skipFiles": ["<node_internals>/**", "${workspaceFolder}/node_modules/**"]
+    },
     {
       "name": "ng serve",
       "type": "chrome",
diff --git a/bruno/Get FormatVersions.bru b/bruno/Get FormatVersions.bru
@@ -5,7 +5,7 @@ meta {
 }
 
 get {
-  url: http://localhost:3000/formatversions
+  url: {{host}}/api/format-versions
   body: none
   auth: none
 }
diff --git a/bruno/Get all pruefis of formatversion.bru b/bruno/Get all pruefis of formatversion.bru
@@ -5,7 +5,7 @@ meta {
 }
 
 get {
-  url: localhost:4200/api/format-versions/FV2504/pruefis
+  url: {{host}}/api/format-versions/FV2504/pruefis
   body: none
   auth: none
 }
diff --git a/bruno/environments/local.bru b/bruno/environments/local.bru
@@ -0,0 +1,3 @@
+vars {
+  host: http://localhost:3000
+}
diff --git a/bruno/environments/prod.bru b/bruno/environments/prod.bru
@@ -0,0 +1,3 @@
+vars {
+  host: https://ahb-tabellen.hochfrequenz.de
+}
diff --git a/bruno/environments/stage.bru b/bruno/environments/stage.bru
@@ -0,0 +1,3 @@
+vars {
+  host: https://ahb-tabellen.stage.hochfrequenz.de
+}
diff --git a/bruno/health.bru b/bruno/health.bru
@@ -0,0 +1,15 @@
+meta {
+  name: health
+  type: http
+  seq: 4
+}
+
+get {
+  url: {{host}}/api/health
+  body: none
+  auth: none
+}
+
+headers {
+  oh-dear-health-check-secret: my-secret-oh-dear-health-check-secret
+}
diff --git a/pulumi/Pulumi.dev.yaml b/pulumi/Pulumi.dev.yaml
@@ -15,3 +15,5 @@ config:
   ahb-tabellen:websitesContainerStartTimeLimit: "300"
   azure-native:location: germanywestcentral
   pulumi:template: container-azure-python
+  ahb-tabellen:ohDearHealthCheckSecret:
+    secure: AAABAMlO2g+61udj5KO4b16Pg2ESsCmCAdj2LIvT77mrZdHkCZeANgSQz+0aBbkW
diff --git a/pulumi/Pulumi.prod.yaml b/pulumi/Pulumi.prod.yaml
@@ -16,3 +16,5 @@ config:
   ahb-tabellen:websitesContainerStartTimeLimit: "300"
   azure-native:location: germanywestcentral
   pulumi:template: container-azure-python
+  ahb-tabellen:ohDearHealthCheckSecret:
+    secure: AAABAHVhi8bu62ZujXIZQcHtU5USavOgn5rciI24E5ahGg3CPqt3mnRktu1uovTS
diff --git a/pulumi/__main__.py b/pulumi/__main__.py
@@ -38,6 +38,9 @@
 websites_container_start_time_limit = config.get("websitesContainerStartTimeLimit")
 assert websites_container_start_time_limit, "websitesContainerStartTimeLimit must be set"
 
+oh_dear_health_check_secret = config.require_secret("ohDearHealthCheckSecret")
+assert oh_dear_health_check_secret, "ohDearHealthCheckSecret must be set"
+
 cpu = config.get_int("cpu", 1)
 memory = config.get_int("memory", 2)
 
@@ -126,6 +129,7 @@
             ),
             azure_native.web.NameValuePairArgs(name="ENVIRONMENT", value=environment),
             azure_native.web.NameValuePairArgs(name="WEBSITES_CONTAINER_START_TIME_LIMIT", value=websites_container_start_time_limit),
+            azure_native.web.NameValuePairArgs(name="OH_DEAR_HEALTH_CHECK_SECRET", value=oh_dear_health_check_secret),
         ],
         linux_fx_version=f"DOCKER|{image_name_with_tag}",
     ),
diff --git a/src/server/controller/health.ts b/src/server/controller/health.ts
@@ -0,0 +1,114 @@
+import { Request, Response } from 'express';
+import { AppDataSource } from '../infrastructure/database';
+import { createNewBlobStorageClient } from '../infrastructure/azure-blob-storage-client';
+import { ExternalServiceError } from '../infrastructure/errors';
+
+interface HealthCheckResult {
+  name: string;
+  label: string;
+  notificationMessage: string | null;
+  shortSummary: string;
+  status: 'ok' | 'warning' | 'failed' | 'crashed';
+  meta?: Record<string, unknown>;
+}
+
+interface HealthCheckResponse {
+  finishedAt: string;
+  checkResults: HealthCheckResult[];
+}
+
+export default class HealthController {
+  public async check(req: Request, res: Response): Promise<void> {
+    // Validate Oh Dear health check secret
+    const providedSecret = req.header('oh-dear-health-check-secret');
+    const expectedSecret = process.env['OH_DEAR_HEALTH_CHECK_SECRET'];
+
+    if (!expectedSecret) {
+      throw new ExternalServiceError('OH_DEAR_HEALTH_CHECK_SECRET environment variable is not set');
+    }
+
+    if (providedSecret !== expectedSecret) {
+      res.status(401).json({ error: 'Invalid health check secret' });
+      return;
+    }
+
+    const checkResults: HealthCheckResult[] = [];
+
+    // Check SQLite connection
+    try {
+      if (!AppDataSource.isInitialized) {
+        await AppDataSource.initialize();
+      }
+      await AppDataSource.query('SELECT 1');
+
+      // Check if tables exist and have data
+      const [ahbMetaCount] = await AppDataSource.query(
+        'SELECT COUNT(*) as count FROM ahbmetainformation'
+      );
+      const [ahbLineCount] = await AppDataSource.query('SELECT COUNT(*) as count FROM ahbline');
+
+      checkResults.push({
+        name: 'SQLiteConnection',
+        label: 'SQLite Database Connection',
+        notificationMessage: null,
+        shortSummary: `Connected - Tables verified`,
+        status: 'ok',
+        meta: {
+          ahbMetaCount: ahbMetaCount.count,
+          ahbLineCount: ahbLineCount.count,
+        },
+      });
+    } catch (error) {
+      checkResults.push({
+        name: 'SQLiteConnection',
+        label: 'SQLite Database Connection',
+        notificationMessage: `Database connection failed: ${(error as Error).message}`,
+        shortSummary: 'Failed',
+        status: 'failed',
+        meta: { error: (error as Error).message },
+      });
+    }
+
+    // Check Azure Blob Storage connection
+    try {
+      const blobClient = createNewBlobStorageClient();
+      const containerName = process.env['AHB_CONTAINER_NAME'];
+
+      if (!containerName) {
+        throw new Error('AHB_CONTAINER_NAME environment variable is not set');
+      }
+
+      const containerClient = blobClient.getContainerClient(containerName);
+      await containerClient.getProperties();
+
+      checkResults.push({
+        name: 'AzureBlobStorage',
+        label: 'Azure Blob Storage Connection',
+        notificationMessage: null,
+        shortSummary: 'Connected',
+        status: 'ok',
+      });
+    } catch (error) {
+      checkResults.push({
+        name: 'AzureBlobStorage',
+        label: 'Azure Blob Storage Connection',
+        notificationMessage: `Blob storage connection failed: ${(error as Error).message}`,
+        shortSummary: 'Failed',
+        status: 'failed',
+        meta: { error: (error as Error).message },
+      });
+    }
+
+    const response: HealthCheckResponse = {
+      finishedAt: new Date().toISOString(),
+      checkResults,
+    };
+
+    // If any check failed, return 500 status
+    const hasFailedChecks = checkResults.some(
+      check => check.status === 'failed' || check.status === 'crashed'
+    );
+
+    res.status(hasFailedChecks ? 500 : 200).json(response);
+  }
+}
diff --git a/src/server/infrastructure/api.routes.ts b/src/server/infrastructure/api.routes.ts
@@ -1,11 +1,17 @@
 import { Router, IRouter } from 'express';
 import AHBController from '../controller/ahb';
 import FormatVersionController from '../controller/formatVersion';
+import HealthController from '../controller/health';
 
 const router: IRouter = Router();
 
 const ahbController = new AHBController();
 const formatVersionController = new FormatVersionController();
+const healthController = new HealthController();
+
+router.get('/health', async (req, res, next) => {
+  await healthController.check(req, res).catch((err: Error) => next(err));
+});
 
 router.get('/ahb/:formatVersion/:pruefi', (req, res, next) => {
   ahbController.get(req, res, next);

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ meta {`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`get {`
`8`		`- url: http://localhost:3000/formatversions`
	`8`	`+ url: {{host}}/api/format-versions`
`9`	`9`	`body: none`
`10`	`10`	`auth: none`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ meta {`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`get {`
`8`		`- url: localhost:4200/api/format-versions/FV2504/pruefis`
	`8`	`+ url: {{host}}/api/format-versions/FV2504/pruefis`
`9`	`9`	`body: none`
`10`	`10`	`auth: none`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+vars {`
	`2`	`+ host: http://localhost:3000`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+vars {`
	`2`	`+ host: https://ahb-tabellen.hochfrequenz.de`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+vars {`
	`2`	`+ host: https://ahb-tabellen.stage.hochfrequenz.de`
	`3`	`+}`