feat: Move healthcheck to misc module

theopensystemslab · Sep 19, 2023 · db5506b · db5506b
1 parent 7a49fb4
commit db5506b
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 36 deletions.
diff --git a/api.planx.uk/modules/misc/controller.ts b/api.planx.uk/modules/misc/controller.ts
@@ -17,4 +17,6 @@ export const getLoggedInUserDetails: RequestHandler = async (_req, res, next) =>
   } catch (error) {
     next(error)
   }
-};
+};
+
+export const healthCheck: RequestHandler = (_req, res) => res.json({ hello: "world" });
diff --git a/api.planx.uk/modules/misc/docs.yaml b/api.planx.uk/modules/misc/docs.yaml
@@ -6,6 +6,24 @@ tags:
   - name: misc
     description: Miscellaneous
 paths:
+  /:
+    get:
+      summary: Health check
+      description: Confirms the API is healthy
+      tags:
+        - misc
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  hello:
+                    type: string
+                example:
+                  hello: world
   /me:
     get:
       summary: Get information about currently logged in user

diff --git a/api.planx.uk/modules/misc/routes.test.ts b/api.planx.uk/modules/misc/routes.test.ts
@@ -101,3 +101,12 @@ describe("/me endpoint", () => {
       });
   });
 });
+
+describe("healthcheck endpoint", () => {
+  it("always returns a 200", async () => {
+    await supertest(app)
+      .get("/")
+      .expect(200)
+      .then(res => expect(res.body).toHaveProperty("hello", "world"))
+  });
+});
diff --git a/api.planx.uk/modules/misc/routes.ts b/api.planx.uk/modules/misc/routes.ts
@@ -1,9 +1,10 @@
 import { Router } from "express";
 import { useLoginAuth } from "../auth/middleware";
-import { getLoggedInUserDetails } from "./controller";
+import { getLoggedInUserDetails, healthCheck } from "./controller";
 
 const router = Router();
 
+router.get("/", healthCheck);
 router.get("/me", useLoginAuth, getLoggedInUserDetails);
 
 export default router;
diff --git a/api.planx.uk/server.test.js b/api.planx.uk/server.test.js
@@ -3,15 +3,6 @@ import supertest from "supertest";
 import { queryMock } from "./tests/graphqlQueryMock";
 import app from "./server";
 
-it("works", async () => {
-  await supertest(app)
-    .get("/")
-    .expect(200)
-    .then((response) => {
-      expect(response.body).toEqual({ hello: "world" });
-    });
-});
-
 it("mocks hasura", async () => {
   queryMock.mockQuery({
     name: "GetTeams",

diff --git a/api.planx.uk/server.ts b/api.planx.uk/server.ts
@@ -224,31 +224,6 @@ app.get("/gis/:localAuthority", locationSearch);
 
 app.get("/roads", classifiedRoadsSearch);
 
-/**
- * @swagger
- * /:
- *  get:
- *    summary: Health check
- *    description: Confirms the API is healthy
- *    tags:
- *      - misc
- *    responses:
- *      '200':
- *        description: OK
- *        content:
- *          application/json:
- *            schema:
- *              type: object
- *              properties:
- *                hello:
- *                  type: string
- *              example:
- *                hello: world
- */
-app.get("/", (_req, res) => {
-  res.json({ hello: "world" });
-});
-
 app.use("/admin", usePlatformAdminAuth);
 app.get("/admin/feedback", downloadFeedbackCSV);
 app.get("/admin/session/:sessionId/xml", getOneAppXML);