Merge pull request finos#1197 from andypols/add-proxy-healthcheck

chore: add /healthcheck endpoint to the proxy

Author: jescalada

src/proxy/routes/index.ts

@@ -233,7 +233,15 @@ const getRouter = async () => {
 
   console.log('proxy keys registered: ', JSON.stringify(proxyKeys));
 
-  router.use('/', (req, res, next) => {
+  router.use('/', ((req, res, next) => {
+    if (req.path === '/healthcheck') {
+      res.set('Cache-Control', 'no-cache, no-store, must-revalidate, proxy-revalidate');
+      res.set('Pragma', 'no-cache');
+      res.set('Expires', '0');
+      res.set('Surrogate-Control', 'no-store');
+      return res.status(200).send('OK');
+    }
+
     console.log(
       `processing request URL: '${req.url}' against registered proxy keys: ${JSON.stringify(proxyKeys)}`,
     );
@@ -247,7 +255,7 @@ const getRouter = async () => {
     // fallback
     console.log(`\tusing fallback`);
     return fallbackProxy(req, res, next);
-  });
+  }) as RequestHandler);
   return router;
 };
 

test/testProxyRoute.test.js

@@ -200,6 +200,31 @@ describe('proxy route helpers', () => {
   });
 });
 
+describe('healthcheck route', () => {
+  let app;
+
+  beforeEach(async () => {
+    app = express();
+    app.use('/', await getRouter());
+  });
+
+  it('returns 200 OK with no-cache headers', async () => {
+    const res = await chai.request(app).get('/healthcheck');
+
+    expect(res).to.have.status(200);
+    expect(res.text).to.equal('OK');
+
+    // Basic header checks (values defined in route)
+    expect(res).to.have.header(
+      'cache-control',
+      'no-cache, no-store, must-revalidate, proxy-revalidate',
+    );
+    expect(res).to.have.header('pragma', 'no-cache');
+    expect(res).to.have.header('expires', '0');
+    expect(res).to.have.header('surrogate-control', 'no-store');
+  });
+});
+
 describe('proxyFilter function', async () => {
   let proxyRoutes;
   let req;