feat: add status endpoint

src/plugins/remote-cache/index.ts

@@ -1,6 +1,6 @@
 import { FastifyInstance } from 'fastify'
 import { badRequest, unauthorized } from '@hapi/boom'
-import { getArtifact, putArtifact, artifactsEvents, headArtifact } from './routes'
+import { getArtifact, putArtifact, artifactsEvents, headArtifact, getStatus } from './routes'
 import { createLocation } from './storage'
 import { STORAGE_PROVIDERS } from '../../env'
 
@@ -63,6 +63,7 @@ async function turboRemoteCache(
       i.route(headArtifact)
       i.route(putArtifact)
       i.route(artifactsEvents)
+      i.route(getStatus)
     },
     { prefix: `/${apiVersion}` },
   )

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

@@ -0,0 +1,21 @@
+import type { Server } from 'http'
+import type { RawReplyDefaultExpression, RawRequestDefaultExpression, RouteOptions } from 'fastify'
+import { type Params, type Querystring } from './schema'
+import { statusRouteSchema } from './status-schema'
+
+export const getStatus: RouteOptions<
+  Server,
+  RawRequestDefaultExpression,
+  RawReplyDefaultExpression,
+  {
+    Querystring: Querystring
+    Params: Params
+  }
+> = {
+  method: 'GET',
+  url: '/artifacts/status',
+  schema: statusRouteSchema,
+  async handler(req, reply) {
+    reply.send({ status: 'enabled' })
+  },
+}

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

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

src/plugins/remote-cache/routes/status-schema.ts

@@ -0,0 +1,12 @@
+import { Static, Type } from '@sinclair/typebox'
+
+const querystring = Type.Object({}, { additionalParameters: false })
+export type Querystring = Static<typeof querystring>
+
+const params = Type.Object({}, { additionalParameters: false })
+export type Params = Static<typeof params>
+
+export const statusRouteSchema = {
+  querystring,
+  params,
+}

test/local.ts

@@ -153,4 +153,16 @@ test(`local'`, async t => {
     t2.equal(response.statusCode, 200)
     t2.same(response.json(), {})
   })
+  t.test('should return 200 when GET artifacts/status is called', async t2 => {
+    t2.plan(2)
+    const response = await app.inject({
+      method: 'GET',
+      url: `/v8/artifacts/status`,
+      headers: {
+        authorization: 'Bearer changeme',
+      },
+    })
+    t2.equal(response.statusCode, 200)
+    t2.same(response.json(), { status: 'enabled' })
+  })
 })