added healthcheck service and endpoint, updated e2e with healthcheck test

Author: LCcodder

source/api/v1/handlers/CommonHandler.ts

@@ -0,0 +1,37 @@
+import { FastifyInstance } from "fastify";
+import Healthcheck, { SystemReport } from "../shared/utils/common/Healthcheck";
+import { Handler } from "./Handler";
+import { isException } from "../shared/utils/guards/ExceptionGuard";
+
+export class CommonHandler extends Handler<Healthcheck> {
+    constructor(server: FastifyInstance, healthcheck: Healthcheck) {
+        super(server, undefined, healthcheck)
+    }
+
+    public override handleRoutes(): void {
+
+        this.server.get("/ping", async (_, reply) => {
+            reply.code(200).send("pong")
+        })
+
+        this.server.head("/", async (_, reply) => {
+            reply.code(200).send()
+        })
+
+        this.server.get<{
+            Reply: {
+                200: SystemReport
+            }
+        }>("/healthcheck", async (_, reply) => {
+
+            const result = await this.service.getFullSystemReport()
+            if (isException(result)) {
+                // @ts-ignore
+                reply.code(result.statusCode).send(result)
+                return
+            }
+    
+            reply.code(200).send(result)
+        })
+    }
+}

source/api/v1/shared/utils/common/Healthcheck.ts

@@ -0,0 +1,58 @@
+import { RedisClientType } from "redis";
+import { DataSource } from "typeorm";
+import { withExceptionCatch } from "../../decorators/WithExceptionCatch";
+
+export type SystemReport = {
+    databaseAccess: boolean;
+    cacheAccess: boolean;
+    serverUptimeInSec: number;
+    databaseUptimeInSec: number;
+}
+
+export default class Healthcheck {
+    constructor(
+        private redis: RedisClientType, 
+        private dataSource: DataSource
+    ) {}
+
+    private async isRedisAccesible(): Promise<boolean> {
+        try {
+            await this.redis.PING()
+            return true
+        } catch {
+            return false
+        }
+    }
+
+    private async isPostgreSQLAccesible(): Promise<boolean> {
+        try {
+            await this.dataSource.query("SELECT user;")
+            return true
+        } catch {
+            return false
+        }
+    }
+
+    private async getPostgreSQLUptime(): Promise<number> {
+        try {
+            const result = await this.dataSource.query("SELECT FLOOR(EXTRACT('epoch' from current_timestamp - pg_postmaster_start_time()));")
+            return parseInt(result[0]["floor"])
+        } catch {
+            return 0
+        }
+    }
+
+    private getProccessUptime(): number {
+        return Math.floor(process.uptime())
+    }
+
+    @withExceptionCatch
+    public async getFullSystemReport(): Promise<SystemReport> {
+        return {
+            databaseAccess: await this.isPostgreSQLAccesible(),
+            cacheAccess: await this.isRedisAccesible(),
+            serverUptimeInSec: this.getProccessUptime(),
+            databaseUptimeInSec: await this.getPostgreSQLUptime(),
+        }
+    }
+}

source/main.ts

@@ -15,6 +15,8 @@ import { initAndGetDataSource } from './api/v1/database/InitDataSource'
 import { NoteEntity } from './api/v1/database/entities/Note'
 import { initSwaggerViewer } from './api/v1/openapi/swagger/InitSwagger'
 import { connectAndGetRedisInstance } from './api/v1/cache/InitRedisInstance'
+import Healthcheck from './api/v1/shared/utils/common/Healthcheck'
+import { CommonHandler } from './api/v1/handlers/CommonHandler'
 
 const main = async () => {
     CONFIG.log()
@@ -26,8 +28,6 @@ const main = async () => {
         }
     })
 
-    
-    
     await initSwaggerViewer(server)
 
     server.addHook('onRequest', logRequestMetadata)
@@ -40,29 +40,31 @@ const main = async () => {
         CONFIG.databasePassword,
         CONFIG.databaseName
     )
-
+    appDataSource.isInitialized
     const redis = await connectAndGetRedisInstance(
         CONFIG.redisConnectionString
     )
-    
+    redis.PING()
     // services DI
     const usersService = new UsersService(
         appDataSource.getRepository(UserEntity.User)
     )
     const authService = new AuthService(usersService, redis)
     const authentication = authenticationFactory(authService)
     const notesService = new NotesService(appDataSource.getRepository(NoteEntity.Note), usersService)
-    
+    const healthcheck = new Healthcheck(redis, appDataSource)
 
     // registering handlers with version prefix
     server.register((server, _, done) => {
         const usersHandler = new UsersHandler(server, authentication, usersService)
         const notesHandler = new NotesHandler(server, authentication, notesService)
         const authHandler = new AuthHandler(server, authentication, authService)
+        const commonHandler = new CommonHandler(server, healthcheck)
 
         usersHandler.handleRoutes()
         notesHandler.handleRoutes()
         authHandler.handleRoutes()
+        commonHandler.handleRoutes()
         done()
     }, { prefix: "/api/v1" })
 

tests/e2e/api_v1.postman_collection.json

@@ -1,12 +1,68 @@
 {
 	"info": {
-		"_postman_id": "2ab9da82-cedd-4f0f-a26c-6e98eb3f0f8f",
+		"_postman_id": "b7daecf2-89c3-4203-a003-2b69d9b68cab",
 		"name": "NodeNotes v1",
 		"description": "**NodeNotes E2E tests coverage snippets.**\n\n_Linear testing scenario, negatives and positives._\n\n_All endpoints coverage_",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
-		"_exporter_id": "27933519"
+		"_exporter_id": "27933519",
+		"_collection_link": "https://blue-trinity-780436.postman.co/workspace/My-Workspace~ad9419b7-fa53-4d0c-8bc5-91d56b7dcbdc/collection/27933519-b7daecf2-89c3-4203-a003-2b69d9b68cab?action=share&source=collection_link&creator=27933519"
 	},
 	"item": [
+		{
+			"name": "Healthcheck",
+			"item": [
+				{
+					"name": "Healthcheck",
+					"event": [
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"pm.test(\"Status code is 200\", function () {\r",
+									"    pm.response.to.have.status(200);\r",
+									"});\r",
+									"\r",
+									"const result = pm.response.json()\r",
+									"pm.test(\"Database is accesible\", function () {\r",
+									"    pm.expect(result.databaseAccess).to.equal(true)\r",
+									"});\r",
+									"\r",
+									"pm.test(\"Cache is accesible\", function () {\r",
+									"    pm.expect(result.cacheAccess).to.equal(true)\r",
+									"});\r",
+									"\r",
+									"pm.test(\"Uptimes are greater than 0\", function () {\r",
+									"    pm.expect(result.serverUptimeInSec).to.be.greaterThan(-1)\r",
+									"    pm.expect(result.databaseUptimeInSec).to.be.greaterThan(-1)\r",
+									"});\r",
+									""
+								],
+								"type": "text/javascript",
+								"packages": {}
+							}
+						}
+					],
+					"request": {
+						"method": "GET",
+						"header": [],
+						"url": {
+							"raw": "{{protocol}}://{{host}}:{{port}}/api/v1/healthcheck",
+							"protocol": "{{protocol}}",
+							"host": [
+								"{{host}}"
+							],
+							"port": "{{port}}",
+							"path": [
+								"api",
+								"v1",
+								"healthcheck"
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		},
 		{
 			"name": "Registration",
 			"item": [
@@ -3864,7 +3920,7 @@
 		},
 		{
 			"key": "port",
-			"value": "8080",
+			"value": "8000",
 			"type": "string"
 		},
 		{