feat: Allow specifying the user agent per-sdk implementation. (#226)

Author: kinyoklion

packages/sdk/cloudflare/src/createPlatformInfo.ts

@@ -13,6 +13,7 @@ class CloudflarePlatformInfo implements Info {
     return {
       name,
       version,
+      userAgentBase: 'CloudflareEdgeSDK',
     };
   }
 }

packages/sdk/server-node/src/platform/NodeInfo.ts

@@ -37,6 +37,7 @@ export default class NodeInfo implements platform.Info {
     return {
       name: packageJson.name,
       version: packageJson.version,
+      userAgentBase: 'NodeJSClient',
       // No wrapper name/version at the moment.
     };
   }

packages/sdk/vercel/src/createPlatformInfo.ts

@@ -11,6 +11,7 @@ class VercelPlatformInfo implements Info {
     return {
       name: '@launchdarkly/vercel-server-sdk',
       version: '__LD_VERSION__',
+      userAgentBase: 'VercelEdgeSDK',
     };
   }
 }

packages/shared/akamai-edgeworker-sdk/src/__tests__/platform/info/index.test.ts

@@ -20,6 +20,7 @@ describe('Akamai Platform Info', () => {
     expect(platformData.sdkData()).toEqual({
       name: packageJson.name,
       version: packageJson.version,
+      userAgentBase: 'AkamaiEdgeSDK',
     });
   });
 });

packages/shared/akamai-edgeworker-sdk/src/platform/info/index.ts

@@ -17,6 +17,7 @@ class AkamaiPlatformInfo implements Info {
     return {
       name: this.sdkName,
       version: this.sdkVersion,
+      userAgentBase: 'AkamaiEdgeSDK',
     };
   }
 }

packages/shared/common/src/api/platform/Info.ts

@@ -44,6 +44,12 @@ export interface SdkData {
    */
   version?: string;
 
+  /**
+   * If this is a top-level (not a wrapper) SDK this will be used to create the user agent string.
+   * It will take the form 'userAgentBase/version`.
+   */
+  userAgentBase?: string;
+
   /**
    * Name of the wrapper SDK if present.
    */

packages/shared/sdk-server/__tests__/data_sources/defaultHeaders.test.ts

@@ -3,13 +3,14 @@ import { Info, PlatformData, SdkData } from '@launchdarkly/js-sdk-common';
 import defaultHeaders from '../../src/data_sources/defaultHeaders';
 import Configuration from '../../src/options/Configuration';
 
-const makeInfo = (wrapperName?: string, wrapperVersion?: string): Info => ({
+const makeInfo = (wrapperName?: string, wrapperVersion?: string, userAgentBase?: string): Info => ({
   platformData(): PlatformData {
     return {};
   },
   sdkData(): SdkData {
     const sdkData: SdkData = {
       version: '2.2.2',
+      userAgentBase,
       wrapperName,
       wrapperVersion,
     };
@@ -23,12 +24,18 @@ it('sets SDK key', () => {
   expect(h).toMatchObject({ authorization: 'my-sdk-key' });
 });
 
-it('sets user agent', () => {
+it('sets the default user agent', () => {
   const config = new Configuration({});
   const h = defaultHeaders('my-sdk-key', config, makeInfo());
   expect(h).toMatchObject({ 'user-agent': 'NodeJSClient/2.2.2' });
 });
 
+it('sets the SDK specific user agent', () => {
+  const config = new Configuration({});
+  const h = defaultHeaders('my-sdk-key', config, makeInfo(undefined, undefined, 'CATS'));
+  expect(h).toMatchObject({ 'user-agent': 'CATS/2.2.2' });
+});
+
 it('does not include wrapper header by default', () => {
   const config = new Configuration({});
   const h = defaultHeaders('my-sdk-key', config, makeInfo());

packages/shared/sdk-server/src/data_sources/defaultHeaders.ts

@@ -12,7 +12,9 @@ export default function defaultHeaders(
   const sdkData = info.sdkData();
   const headers: { [key: string]: string } = {
     authorization: sdkKey,
-    'user-agent': `NodeJSClient/${sdkData.version}`,
+    'user-agent': `${sdkData.userAgentBase ? sdkData.userAgentBase : 'NodeJSClient'}/${
+      sdkData.version
+    }`,
   };
 
   if (sdkData.wrapperName) {