add a health endpoint

Author: VigneshVSV

backend/src/app.tsx

@@ -1,6 +1,7 @@
 import * as express from 'express';
 import * as dotenv from 'dotenv';
 import feedbackRoutes from './routes/feedback.routes';
+import healthRoutes from './routes/health.routes';
 import * as swaggerUi from 'swagger-ui-express';
 import * as YAML from 'yamljs';
 import * as path from 'path';
@@ -15,10 +16,9 @@ app.use(express.json());
 
 // Routes
 // @ts-ignore
-app.get('/', (req, res) => {
-    res.redirect('/api-docs');
-});
+app.get('/', (req, res) => res.redirect('/api-docs'));
 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
 app.use('/feedbacks', feedbackRoutes);
+app.use('/health', healthRoutes)
 
 export default app;

backend/src/controllers/feedback.controller.tsx

@@ -4,11 +4,17 @@ import { Feedback } from '../models/feedback.model'
 export const addNewFeedback = async (req, res) => {
     try {
         const { name, email, text } = req.body;
+        if (!name || !email || !text) {
+            return res.status(400).json({ message: 'Name, email, and text are required.' });
+        }
         const feedback = new Feedback({ name, email, text });
         console.debug('Adding new feedback:', { name, email, text });
         await feedback.save();
         res.status(201).json({ message: 'Feedback submitted successfully' });
     } catch (error: any) {
+        if (error.name === 'SequelizeValidationError') {
+            return res.status(422).json({ message: `Validation error: ${error.errors}` });
+        }
         console.error('Error submitting feedback:', error);
         res.status(500).json({ message: `Error submitting feedback: ${error.message}` });
     }
@@ -33,6 +39,6 @@ export const getFeedbackById = async (req, res) => {
         }
         res.status(200).json(feedback);
     } catch (error) {
-        res.status(500).json({ message: 'Error fetching feedback', error });
+        res.status(500).json({ message: `Error fetching feedback ${error}` });
     }
 };

backend/src/controllers/health.controller.tsx

@@ -0,0 +1,12 @@
+import { sequelize } from '../db';
+
+// @ts-ignore
+export const healthCheck = async (req, res) => {
+    try {
+        await sequelize.query('SELECT 1');
+        res.status(200).json({ status: 'OK', message: 'Service is healthy' });
+    } catch (error: any) {
+        console.error('Health check error:', error);
+        res.status(500).json({ status: 'ERROR', message: `DB not accessible yet: ${error.message}` });
+    }
+}

backend/src/docs/openapi.yaml

@@ -12,14 +12,38 @@ components:
   schemas:
     Feedback:
       type: object
+      description: Feedback submitted by users
       properties:
         name:
           type: string
+        type:
+          type: string
+          example: "bug" # or "feature"
         email:
           type: string
         text:
           type: string
 
+    ResponseMessage:
+      type: object
+      description: Plain response with a message field
+      properties:
+        message:
+          type: string
+          example: "Feedback submitted successfully"
+
+    HealthStatus:
+      type: object
+      description: Health status of the service
+      properties:
+        status:
+          type: string
+          example: "OK"
+        message:
+          type: string
+          example: "Service is healthy"
+
+
 paths: 
   /feedbacks:
     post:
@@ -37,21 +61,26 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  message:
-                    type: string
-                    example: "Feedback submitted successfully"
+                $ref: '#/components/schemas/ResponseMessage'
         '400':
           description: Bad request
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  error:
-                    type: string
-                    example: "Invalid input data"
+                $ref: '#/components/schemas/ResponseMessage'
+        '422':
+          description: Unprocessable payload or validation error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseMessage'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResponseMessage'
+                
     get:
       summary: Get all feedbacks
       operationId: getFeedbacks
@@ -69,11 +98,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  error:
-                    type: string
-                    example: "Internal server error"
+                $ref: '#/components/schemas/ResponseMessage'
 
   /feedbacks/{id}:
     get:
@@ -97,11 +122,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  error:
-                    type: string
-                    example: "Feedback not found"
+                $ref: '#/components/schemas/ResponseMessage'
 
 
   /health:
@@ -114,11 +135,13 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  status:
-                    type: string
-                    example: "OK"
+                $ref: '#/components/schemas/HealthStatus'
+        '500':
+          description: Service is unhealthy
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HealthStatus'
 
 
 

backend/src/routes/health.routes.tsx

@@ -0,0 +1,8 @@
+import * as express from 'express';
+import { healthCheck } from '../controllers/health.controller';
+
+const router = express.Router();
+
+router.get('/', healthCheck);
+
+export default router;