test.js

Go to the documentation of this file.

/**
 * @file Database Health Check API Endpoint
 * @description
 * Provides simple health check endpoint to verify database connectivity and API availability.
 * Returns current database timestamp to confirm both database connection and query execution
 * are functioning correctly. Useful for monitoring systems, load balancers, and uptime checks.
 *
 * Key features:
 * - **No authentication**: Public endpoint for health monitoring
 * - **Database connectivity test**: Executes simple SELECT NOW() query
 * - **Fast response**: Minimal processing for sub-100ms response time
 *
 * Use cases:
 * - Load balancer health checks (ALB, ELB, HAProxy)
 * - Kubernetes liveness/readiness probes
 * - Monitoring systems (Prometheus, Datadog, New Relic)
 * - CI/CD pipeline validation
 * - Manual diagnostic checks
 * @module routes/test
 * @requires express
 * @requires ../services/db - PostgreSQL database pool
 */
 
const express = require('express');
const router = express.Router();
const pool = require('../services/db');
 
/**
 * @api {get} /test Database Health Check
 * @apiName DatabaseHealthCheck
 * @apiGroup Health
 * @apiDescription
 * Verifies database connectivity by executing simple SELECT NOW() query and returning
 * current database timestamp. Used by monitoring systems and load balancers to determine
 * if API and database are healthy.
 * @apiPermission public
 * @apiNote No authentication required - designed for health check systems
 * @apiSuccess {string} time Current database timestamp (ISO 8601 format)
 * @apiError (500) {String} error "Database connection failed" (plaintext, not JSON)
 * @apiExample {curl} Example Request:
 *     curl https://api.ibghub.com/api/test
 * @apiExample {json} Example Response:
 *     {
 *       "time": "2025-01-15T14:22:35.123Z"
 *     }
 */
 
router.get('/', async (req, res) => {
  try {
    const result = await pool.query('SELECT NOW()');
    res.json({ time: result.rows[0].now });
  } catch (err) {
    console.error('DB connection error:', err);
    res.status(500).send('Database connection failed');
  }
});
 
module.exports = router;