feat: unprotected unversioned health route

src/plugins/remote-cache/index.ts

@@ -1,6 +1,13 @@
 import { FastifyInstance } from 'fastify'
 import { badRequest, unauthorized } from '@hapi/boom'
-import { getArtifact, putArtifact, artifactsEvents, headArtifact, getStatus } from './routes'
+import {
+  getArtifact,
+  putArtifact,
+  artifactsEvents,
+  headArtifact,
+  getStatus,
+  getHealth,
+} from './routes'
 import { createLocation } from './storage'
 import { STORAGE_PROVIDERS } from '../../env'
 
@@ -33,6 +40,10 @@ async function turboRemoteCache(
     let authHeader = request.headers['authorization']
     authHeader = Array.isArray(authHeader) ? authHeader.join() : authHeader
 
+    if (request.url.includes('health')) {
+      return
+    }
+
     if (!authHeader) {
       throw badRequest(`Missing Authorization header`)
     }
@@ -58,6 +69,10 @@ async function turboRemoteCache(
     }),
   )
 
+  await instance.register(async i => {
+    i.route(getHealth)
+  })
+
   await instance.register(
     async function (i) {
       i.route(getArtifact)

src/plugins/remote-cache/routes/get-health.ts

@@ -0,0 +1,14 @@
+import type { Server } from 'http'
+import type { RouteOptions, RawReplyDefaultExpression, RawRequestDefaultExpression } from 'fastify'
+
+export const getHealth: RouteOptions<
+  Server,
+  RawRequestDefaultExpression,
+  RawReplyDefaultExpression
+> = {
+  method: 'GET',
+  url: '/health',
+  async handler(req, reply) {
+    reply.send('Server is running 🙌')
+  },
+}

src/plugins/remote-cache/routes/index.ts

@@ -3,3 +3,4 @@ export { headArtifact } from './head-artifact'
 export { putArtifact } from './put-artifact'
 export { artifactsEvents } from './artifacts-events'
 export { getStatus } from './get-status'
+export { getHealth } from './get-health'

test/local.ts

@@ -165,4 +165,12 @@ test(`local'`, async t => {
     t2.equal(response.statusCode, 200)
     t2.same(response.json(), { status: 'enabled' })
   })
+  t.test('should return 200 when GET health is called', async t2 => {
+    t2.plan(1)
+    const response = await app.inject({
+      method: 'GET',
+      url: `/health`,
+    })
+    t2.equal(response.statusCode, 200)
+  })
 })