feat(config): add server.skipHealthz option for health check bypass

Author: cyber-hari

src/config.ts

@@ -76,6 +76,21 @@ export let config = {
      * Default TTL (time to live) for cache entries in seconds
      */
     defaultTtl: Env.getNumber('CACHE_DEFAULT_TTL_SECONDS', 3600) * 1000
+  },
+
+  server: {
+    /**
+     * Skip healthz endpoint even if health checks are configured
+     * Default: false
+     * Set to true to return 200 OK for /healthz without checks
+     * Useful in environments where a simple liveness probe is needed
+     * without performing actual health checks
+     * Example: Kubernetes liveness probe
+     * Note: This does not disable the health check functionality itself
+     *       Health checks can still be performed programmatically
+     *       or via other endpoints if needed
+     */
+    skipHealthz: Env.getBoolean('SERVER_SKIP_HEALTHZ', false)
   }
 };
 

src/servers/server.ts

@@ -33,7 +33,7 @@ import { getLogger } from '../utils/logger.utils';
 import { InternalServerErrorException, ServiceUnavailableException } from '../utils/exception.utils';
 import { NotFoundException } from '../utils/exception.utils';
 import fs from 'fs';
-import { defaultServerConfig } from '../config';
+import { config, defaultServerConfig } from '../config';
 import { deepObjMerge } from '../utils/obj.utils';
 import { fileExists } from '../utils/fs.utils';
 import { Socket } from 'net';
@@ -575,7 +575,7 @@ export class ExpressServer {
 
     this.app.get(healthCheckPath, async (_req: Request, res: Response) => {
       try {
-        if (!this.healthChecks.length) {
+        if (!this.healthChecks.length || config.server.skipHealthz) {
           return res.status(HttpStatusCodes.OK).json(new SuccessResponse('OK'));
         }
 

tests/config.test.ts

@@ -105,6 +105,9 @@ describe('config', () => {
       },
       cache: {
         defaultTtl: 3600000
+      },
+      server: {
+        skipHealthz: false
       }
     });
   });