the health check endpoint and middleware

packages/create-sitecore-jss/src/templates/node-xmcloud-proxy/src/index.ts

@@ -4,6 +4,7 @@ import compression from 'compression';
 import { createProxyMiddleware } from 'http-proxy-middleware';
 import { debug } from '@sitecore-jss/sitecore-jss';
 import { editingRouter } from '@sitecore-jss/sitecore-jss-proxy';
+import { healthCheckMiddleware } from '@sitecore-jss/sitecore-jss-proxy';
 import { config } from './config';
 
 const server = express();
@@ -127,6 +128,11 @@ server.use(
   })
 );
 
+/**
+ * The health check endpoint
+ */
+server.get('/api/healthz', healthCheckMiddleware());
+
 /**
  * Proxy editing requests through the editing router
  */

packages/sitecore-jss-proxy/src/middleware/index.ts

@@ -2,3 +2,4 @@
 // eslint-disable-next-line prettier/prettier
 export * as headlessProxy from './headless-ssr-proxy';
 export { editingRouter } from './editing';
+export { healthCheckMiddleware } from './monitoring';

packages/sitecore-jss-proxy/src/middleware/monitoring/healthcheck-middleware.test.ts

@@ -0,0 +1,15 @@
+import express from 'express';
+import request from 'supertest';
+import { healthCheckMiddleware } from './index';
+
+describe('editingRouter - /editing/render', () => {
+  const app = express();
+
+  it('should handle request', async () => {
+    app.get('/api/halthz', healthCheckMiddleware());
+
+    request(app)
+      .get('/api/halthz')
+      .expect(200, 'Healthy');
+  });
+});

packages/sitecore-jss-proxy/src/middleware/monitoring/healthcheck-middleware.ts

@@ -0,0 +1,8 @@
+import { Request, Response } from 'express';
+
+/**
+ * Middleware to handle health check requests
+ */
+export const healthCheckMiddleware = () => (_req: Request, res: Response): void => {
+  res.status(200).send('Healthy');
+};

packages/sitecore-jss-proxy/src/middleware/monitoring/index.ts

@@ -0,0 +1 @@
+export { healthCheckMiddleware } from './healthcheck-middleware';