From e769ceab056a839a67deac0f8ade443081e96f13 Mon Sep 17 00:00:00 2001
From: Christopher Kolstad <chriswk@getunleash.ai>
Date: Fri, 5 Jan 2024 11:54:28 +0100
Subject: [PATCH] task: Add an X-Unleash-Version header to register response
 (#5774)

Related to our work for making Edge bulk metrics a 1st class citizen of
Unleash, this PR adds an X-Unleash-Version header to the response from
client registration.

Based on when we add the new `/api/client/metrics/bulk` endpoint, Edge
can use the response header from upstream to decide whether to post
metrics to `/edge/metrics` or `/api/client/metrics/bulk`.
---
 src/lib/routes/client-api/register.test.ts | 16 ++++++++++++++++
 src/lib/routes/client-api/register.ts      |  3 ++-
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/src/lib/routes/client-api/register.test.ts b/src/lib/routes/client-api/register.test.ts
index 70e0dd21a5..6ed4f66a78 100644
--- a/src/lib/routes/client-api/register.test.ts
+++ b/src/lib/routes/client-api/register.test.ts
@@ -102,3 +102,19 @@ test('should allow an empty instanceId field', () => {
         })
         .expect(202);
 });
+
+test('Includes an X-Unleash-Version header in the response', () => {
+    return request
+        .post('/api/client/register')
+        .send({
+            appName: 'demo',
+            instanceId: '',
+            strategies: ['default'],
+            started: Date.now(),
+            interval: 10,
+        })
+        .expect(202)
+        .expect((res) => {
+            expect(res.headers['x-unleash-version']).toBeTruthy();
+        });
+});
diff --git a/src/lib/routes/client-api/register.ts b/src/lib/routes/client-api/register.ts
index 87dd651d8d..dea657986d 100644
--- a/src/lib/routes/client-api/register.ts
+++ b/src/lib/routes/client-api/register.ts
@@ -15,6 +15,7 @@ import { createRequestSchema } from '../../openapi/util/create-request-schema';
 import { ClientApplicationSchema } from '../../openapi/spec/client-application-schema';
 import rateLimit from 'express-rate-limit';
 import { minutesToMilliseconds } from 'date-fns';
+import version from '../../util/version';
 
 export default class RegisterController extends Controller {
     logger: Logger;
@@ -93,6 +94,6 @@ export default class RegisterController extends Controller {
         data.environment = RegisterController.resolveEnvironment(user, data);
         data.project = RegisterController.extractProjectFromRequest(req);
         await this.clientInstanceService.registerClient(data, clientIp);
-        res.status(202).end();
+        res.header('X-Unleash-Version', version).status(202).end();
     }
 }