feat: client identification headers (#690)

Unleash · Jan 8, 2025 · 4f7b767 · 4f7b767
1 parent dcbb847
commit 4f7b767
Show file tree

Hide file tree

Showing 9 changed files with 158 additions and 26 deletions.
diff --git a/src/metrics.ts b/src/metrics.ts
@@ -11,6 +11,7 @@ import { SUPPORTED_SPEC_VERSION } from './repository';
 export interface MetricsOptions {
   appName: string;
   instanceId: string;
+  connectionId: string;
   strategies: string[];
   metricsInterval: number;
   metricsJitter?: number;
@@ -80,6 +81,8 @@ export default class Metrics extends EventEmitter {
 
   private instanceId: string;
 
+  private connectionId: string;
+
   private sdkVersion: string;
 
   private strategies: string[];
@@ -111,6 +114,7 @@ export default class Metrics extends EventEmitter {
   constructor({
     appName,
     instanceId,
+    connectionId,
     strategies,
     metricsInterval = 0,
     metricsJitter = 0,
@@ -127,6 +131,7 @@ export default class Metrics extends EventEmitter {
     this.metricsJitter = metricsJitter;
     this.appName = appName;
     this.instanceId = instanceId;
+    this.connectionId = connectionId;
     this.sdkVersion = sdkVersion;
     this.strategies = strategies;
     this.url = url;
@@ -198,6 +203,7 @@ export default class Metrics extends EventEmitter {
         json: payload,
         appName: this.appName,
         instanceId: this.instanceId,
+        connectionId: this.connectionId,
         headers,
         timeout: this.timeout,
         httpOptions: this.httpOptions,
@@ -250,6 +256,7 @@ export default class Metrics extends EventEmitter {
         json: payload,
         appName: this.appName,
         instanceId: this.instanceId,
+        connectionId: this.connectionId,
         headers,
         timeout: this.timeout,
         httpOptions: this.httpOptions,

diff --git a/src/repository/bootstrap-provider.ts b/src/repository/bootstrap-provider.ts
@@ -48,7 +48,13 @@ export class DefaultBootstrapProvider implements BootstrapProvider {
     const response = await fetch(bootstrapUrl, {
       method: 'GET',
       timeout: 10_000,
-      headers: buildHeaders(this.appName, this.instanceId, undefined, undefined, this.urlHeaders),
+      headers: buildHeaders({
+        appName: this.appName,
+        instanceId: this.instanceId,
+        etag: undefined,
+        contentType: undefined,
+        custom: this.urlHeaders,
+      }),
       retry: {
         retries: 2,
         maxTimeout: 10_000,

diff --git a/src/repository/index.ts b/src/repository/index.ts
@@ -30,6 +30,7 @@ export interface RepositoryOptions {
   url: string;
   appName: string;
   instanceId: string;
+  connectionId: string;
   projectName?: string;
   refreshInterval: number;
   timeout?: number;
@@ -59,6 +60,8 @@ export default class Repository extends EventEmitter implements EventEmitter {
 
   private instanceId: string;
 
+  private connectionId: string;
+
   private refreshInterval: number;
 
   private headers?: CustomHeaders;
@@ -101,6 +104,7 @@ export default class Repository extends EventEmitter implements EventEmitter {
     url,
     appName,
     instanceId,
+    connectionId,
     projectName,
     refreshInterval = 15_000,
     timeout,
@@ -118,6 +122,7 @@ export default class Repository extends EventEmitter implements EventEmitter {
     this.url = url;
     this.refreshInterval = refreshInterval;
     this.instanceId = instanceId;
+    this.connectionId = connectionId;
     this.appName = appName;
     this.projectName = projectName;
     this.headers = headers;
@@ -386,6 +391,7 @@ Message: ${err.message}`,
         appName: this.appName,
         timeout: this.timeout,
         instanceId: this.instanceId,
+        connectionId: this.connectionId,
         headers,
         httpOptions: this.httpOptions,
         supportedSpecVersion: SUPPORTED_SPEC_VERSION,

diff --git a/src/request.ts b/src/request.ts
@@ -7,6 +7,7 @@ import { URL } from 'url';
 import { getProxyForUrl } from 'proxy-from-env';
 import { CustomHeaders } from './headers';
 import { HttpOptions } from './http-options';
+const details = require('./details.json');
 
 export interface RequestOptions {
   url: string;
@@ -18,6 +19,7 @@ export interface GetRequestOptions extends RequestOptions {
   etag?: string;
   appName?: string;
   instanceId?: string;
+  connectionId: string;
   supportedSpecVersion?: string;
   httpOptions?: HttpOptions;
 }
@@ -30,6 +32,7 @@ export interface PostRequestOptions extends RequestOptions {
   json: Data;
   appName?: string;
   instanceId?: string;
+  connectionId?: string;
   httpOptions?: HttpOptions;
 }
 
@@ -55,18 +58,35 @@ export const getDefaultAgent = (url: URL) => {
     : new HttpProxyAgent(proxy, httpAgentOptions);
 };
 
-export const buildHeaders = (
-  appName?: string,
-  instanceId?: string,
-  etag?: string,
-  contentType?: string,
-  custom?: CustomHeaders,
-  specVersionSupported?: string,
-): Record<string, string> => {
+type HeaderOptions = {
+  appName?: string;
+  instanceId?: string;
+  etag?: string;
+  contentType?: string;
+  custom?: CustomHeaders;
+  specVersionSupported?: string;
+  connectionId?: string;
+};
+
+export const buildHeaders = ({
+  appName,
+  instanceId,
+  etag,
+  contentType,
+  custom,
+  specVersionSupported,
+  connectionId,
+}: HeaderOptions): Record<string, string> => {
   const head: Record<string, string> = {};
   if (appName) {
+    // TODO: delete
     head['UNLEASH-APPNAME'] = appName;
+    // TODO: delete
     head['User-Agent'] = appName;
+    head['x-unleash-appname'] = appName;
+  }
+  if (connectionId) {
+    head['x-unleash-connection-id'] = connectionId;
   }
   if (instanceId) {
     head['UNLEASH-INSTANCEID'] = instanceId;
@@ -80,6 +100,8 @@ export const buildHeaders = (
   if (specVersionSupported) {
     head['Unleash-Client-Spec'] = specVersionSupported;
   }
+  const version = details.version;
+  head['x-unleash-sdk'] = `unleash-node@${version}`;
   if (custom) {
     Object.assign(head, custom);
   }
@@ -91,6 +113,7 @@ export const post = ({
   appName,
   timeout,
   instanceId,
+  connectionId,
   headers,
   json,
   httpOptions,
@@ -99,7 +122,14 @@ export const post = ({
     timeout: timeout || 10000,
     method: 'POST',
     agent: httpOptions?.agent || getDefaultAgent,
-    headers: buildHeaders(appName, instanceId, undefined, 'application/json', headers),
+    headers: buildHeaders({
+      appName,
+      instanceId,
+      connectionId,
+      etag: undefined,
+      contentType: 'application/json',
+      custom: headers,
+    }),
     body: JSON.stringify(json),
     strictSSL: httpOptions?.rejectUnauthorized,
   });
@@ -110,6 +140,7 @@ export const get = ({
   appName,
   timeout,
   instanceId,
+  connectionId,
   headers,
   httpOptions,
   supportedSpecVersion,
@@ -118,7 +149,15 @@ export const get = ({
     method: 'GET',
     timeout: timeout || 10_000,
     agent: httpOptions?.agent || getDefaultAgent,
-    headers: buildHeaders(appName, instanceId, etag, undefined, headers, supportedSpecVersion),
+    headers: buildHeaders({
+      appName,
+      instanceId,
+      etag,
+      contentType: undefined,
+      custom: headers,
+      specVersionSupported: supportedSpecVersion,
+      connectionId,
+    }),
     retry: {
       retries: 2,
       maxTimeout: timeout || 10_000,

diff --git a/src/test/metrics.test.ts b/src/test/metrics.test.ts
@@ -122,17 +122,27 @@ test('should sendMetrics', async (t) => {
   t.true(metricsEP.isDone());
 });
 
-test('should send custom headers', (t) =>
+test('should send correct custom and x-unleash headers', (t) =>
   new Promise((resolve) => {
     const url = getUrl();
     t.plan(2);
     const randomKey = `value-${Math.random()}`;
-    const metricsEP = nockMetrics(url).matchHeader('randomKey', randomKey);
-    const regEP = nockRegister(url).matchHeader('randomKey', randomKey);
+    const metricsEP = nockMetrics(url)
+      .matchHeader('randomKey', randomKey)
+      .matchHeader('x-unleash-appname', 'appName')
+      .matchHeader('x-unleash-sdk', /^unleash-node@(\d+\.\d+\.\d+)$/)
+      .matchHeader('x-unleash-connection-id', 'connectionId');
+    const regEP = nockRegister(url)
+      .matchHeader('randomKey', randomKey)
+      .matchHeader('x-unleash-appname', 'appName')
+      .matchHeader('x-unleash-sdk', /^unleash-node@(\d+\.\d+\.\d+)$/)
+      .matchHeader('x-unleash-connection-id', 'connectionId');
 
     // @ts-expect-error
     const metrics = new Metrics({
       url,
+      appName: 'appName',
+      connectionId: 'connectionId',
       metricsInterval: 50,
       headers: {
         randomKey,
@@ -259,6 +269,7 @@ test('sendMetrics should backoff on 404', async (t) => {
   const metrics = new Metrics({
     appName: '404-tester',
     instanceId: '404-instance',
+    connectionId: '404-connection',
     metricsInterval: 10,
     strategies: [],
     url,
@@ -449,6 +460,7 @@ test('sendMetrics should stop on 401', async (t) => {
   const metrics = new Metrics({
     appName: '401-tester',
     instanceId: '401-instance',
+    connectionId: '401-connection',
     metricsInterval: 0,
     strategies: [],
     url,
@@ -465,6 +477,7 @@ test('sendMetrics should stop on 403', async (t) => {
   const metrics = new Metrics({
     appName: '401-tester',
     instanceId: '401-instance',
+    connectionId: '401-connection',
     metricsInterval: 0,
     strategies: [],
     url,
@@ -481,6 +494,7 @@ test('sendMetrics should backoff on 429', async (t) => {
   const metrics = new Metrics({
     appName: '429-tester',
     instanceId: '429-instance',
+    connectionId: '429-connection',
     metricsInterval: 10,
     strategies: [],
     url,
@@ -504,6 +518,7 @@ test('sendMetrics should backoff on 500', async (t) => {
   const metrics = new Metrics({
     appName: '500-tester',
     instanceId: '500-instance',
+    connectionId: '500-connetion',
     metricsInterval: 10,
     strategies: [],
     url,
@@ -528,6 +543,7 @@ test('sendMetrics should backoff on 429 and gradually reduce interval', async (t
   const metrics = new Metrics({
     appName: '429-tester',
     instanceId: '429-instance',
+    connectionId: '429-connection',
     metricsInterval,
     strategies: [],
     url,