fix: health check should not require auth (#392)

Author: arcoraven

src/server/middleware/auth.ts

@@ -171,7 +171,7 @@ export const withAuth = async (server: FastifyInstance) => {
     if (
       req.url === "/favicon.ico" ||
       req.url === "/" ||
-      req.url === "/health" ||
+      req.url === "/system/health" ||
       req.url === "/static" ||
       req.url === "/json" ||
       req.url.startsWith("/auth/payload") ||

src/server/routes/home.ts

@@ -13,6 +13,7 @@ export async function home(fastify: FastifyInstance) {
     method: "GET",
     url: "/",
     schema: {
+      hide: true,
       summary: "/",
       description: "Instructions to manage your Engine",
       tags: ["System"],

src/server/routes/index.ts

@@ -221,6 +221,7 @@ export const withRoutes = async (fastify: FastifyInstance) => {
   await fastify.register(marketplaceV3Routes);
 
   // System
+  // These should be hidden by default
   await fastify.register(home);
   await fastify.register(healthCheck);
   await fastify.register(queueStatus);

src/server/routes/system/health.ts

@@ -21,6 +21,7 @@ export async function healthCheck(fastify: FastifyInstance) {
     method: "GET",
     url: "/system/health",
     schema: {
+      hide: true,
       summary: "Check health",
       description: "Check the system health of Engine",
       tags: ["System"],
@@ -40,7 +41,7 @@ export async function healthCheck(fastify: FastifyInstance) {
 
       res.status(StatusCodes.OK).send({
         status: "OK",
-        engineVersion: process.env.ENGINE_VERSION || undefined,
+        engineVersion: process.env.ENGINE_VERSION,
       });
     },
   });

src/server/routes/system/queue.ts

@@ -23,6 +23,7 @@ export async function queueStatus(fastify: FastifyInstance) {
     method: "GET",
     url: "/system/queue",
     schema: {
+      hide: true,
       summary: "Check queue status",
       description: "Check the status of the queue",
       tags: ["System"],