[templates/nextjs] Add healthz check

packages/create-sitecore-jss/src/templates/nextjs/next.config.js

@@ -50,6 +50,11 @@ const nextConfig = {
         source: '/layouts/system/:path*',
         destination: `${jssConfig.sitecoreApiHost}/layouts/system/:path*`,
       },
+      // healthz check
+      {
+        source: '/healthz',
+        destination: '/api/healthz',
+      }
     ];
   },
 };

packages/create-sitecore-jss/src/templates/nextjs/src/pages/api/healthz.ts

@@ -0,0 +1,12 @@
+import { HealthcheckMiddleware } from '@sitecore-jss/sitecore-jss-nextjs/monitoring';
+
+/**
+ * This Next.js API route is used to handle healthz check request.
+ * By default this is used only by Sitecore XM Cloud (when running as editing host),
+ * but could be used in other deployment scenarios.
+*/
+
+// Wire up the HealthcheckMiddleware handler
+const handler = new HealthcheckMiddleware().getHandler();
+
+export default handler;

packages/sitecore-jss-nextjs/monitoring.d.ts

@@ -0,0 +1 @@
+export * from './types/monitoring/index';

packages/sitecore-jss-nextjs/monitoring.js

@@ -0,0 +1 @@
+module.exports = require('./dist/cjs/monitoring/index');

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

@@ -0,0 +1,39 @@
+import { expect, use } from 'chai';
+import { NextApiRequest, NextApiResponse } from 'next';
+import { spy } from 'sinon';
+import sinonChai from 'sinon-chai';
+import { HealthcheckMiddleware } from './healthcheck-middleware';
+
+use(sinonChai);
+
+const mockRequest = () => {
+  return {
+    method: 'GET',
+  } as NextApiRequest;
+};
+
+const mockResponse = () => {
+  const res = {} as NextApiResponse;
+  res.status = spy(() => {
+    return res;
+  });
+  res.send = spy(() => {
+    return res;
+  });
+  return res;
+};
+
+describe('HealthcheckMiddleware', () => {
+  it('should handle request', async () => {
+    const req = mockRequest();
+    const res = mockResponse();
+
+    const middleware = new HealthcheckMiddleware();
+    const handler = middleware.getHandler();
+
+    await handler(req, res);
+
+    expect(res.status).to.have.been.calledOnceWith(200);
+    expect(res.send).to.have.been.calledOnceWith('Healthy');
+  });
+});

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

@@ -0,0 +1,18 @@
+import { NextApiResponse, NextApiRequest } from 'next';
+
+/**
+ * Middleware / handler for use in healthcheck Next.js API route (e.g. '/api/healthz').
+ */
+export class HealthcheckMiddleware {
+  /**
+   * Gets the Next.js API route handler
+   * @returns route handler
+   */
+  public getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void> {
+    return this.handler;
+  }
+
+  private handler = async (_req: NextApiRequest, res: NextApiResponse): Promise<void> => {
+    res.status(200).send('Healthy');
+  };
+}

packages/sitecore-jss-nextjs/src/monitoring/index.ts

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

packages/sitecore-jss-nextjs/tsconfig.json

@@ -16,6 +16,7 @@
     "dist",
     "middleware.d.ts",
     "editing.d.ts",
+    "monitoring.d.ts",
     "src/tests/*",
     "src/test-data/*",
     "**/*.test.ts",