prepare 2.9.0 release

packages/ldclient-electron/src/__tests__/LDClient-test.js

@@ -34,7 +34,7 @@ describe('LDClient', () => {
   describe('initialization', () => {
     it('should trigger the ready event', done => {
       const handleReady = jest.fn();
-      const client = LDClient.initializeInMain(envName, user, { bootstrap: {}, sendEvents: false });
+      const client = LDClient.initializeInMain(envName, user, { bootstrap: {}, mockHttp: true, sendEvents: false });
 
       client.on('ready', handleReady);
 
@@ -43,12 +43,23 @@ describe('LDClient', () => {
         done();
       }, 0);
     });
+
+    it('sends correct User-Agent in request', done => {
+      LDClient.initializeInMain(envName, user, { mockHttp: true });
+
+      setTimeout(() => {
+        expect(requests.length).toEqual(1);
+        expect(requests[0].requestHeaders['X-LaunchDarkly-User-Agent']).toMatch(/^ElectronClient\//);
+        done();
+      }, 0);
+    });
   });
 
   describe('track()', () => {
     it('should not warn when tracking an arbitrary custom event', done => {
       const client = LDClient.initializeInMain(envName, user, {
         bootstrap: {},
+        mockHttp: true,
         sendEvents: false,
         logger: LDClient.createConsoleLogger('warn'),
       });

packages/ldclient-electron/src/electronPlatform.js

@@ -25,5 +25,7 @@ export default function makeElectronPlatform(options) {
   ret.eventSourceIsActive = es => es.readyState === EventSource.OPEN || es.readyState === EventSource.CONNECTING;
   ret.eventSourceAllowsReport = true;
 
+  ret.userAgent = 'ElectronClient';
+
   return ret;
 }

packages/ldclient-js-common/src/EventSender.js

@@ -35,7 +35,7 @@ export default function EventSender(platform, eventsUrl, environmentId, imageCre
       function createRequest(canRetry) {
         const xhr = platform.newHttpRequest();
         xhr.open('POST', postUrl, !sync);
-        utils.addLDHeaders(xhr);
+        utils.addLDHeaders(xhr, platform);
         xhr.setRequestHeader('Content-Type', 'application/json');
         xhr.setRequestHeader('X-LaunchDarkly-Event-Schema', '3');
         if (!sync) {

packages/ldclient-js-common/src/Requestor.js

@@ -59,7 +59,7 @@ export default function Requestor(platform, options, environment) {
     }
 
     if (sendLDHeaders) {
-      utils.addLDHeaders(xhr);
+      utils.addLDHeaders(xhr, platform);
     }
 
     xhr.send(data);

packages/ldclient-js-common/src/__tests__/EventSender-test.js

@@ -141,7 +141,7 @@ describe('EventSender', () => {
       const event = { kind: 'identify', key: 'userKey' };
       sender.sendEvents([event], false);
       lastRequest().respond();
-      expect(lastRequest().requestHeaders['X-LaunchDarkly-User-Agent']).toEqual(utils.getLDUserAgentString());
+      expect(lastRequest().requestHeaders['X-LaunchDarkly-User-Agent']).toEqual(utils.getLDUserAgentString(platform));
     });
 
     const retryableStatuses = [400, 408, 429, 500, 503];

packages/ldclient-js-common/src/__tests__/LDClient-test.js

@@ -217,7 +217,7 @@ describe('LDClient', () => {
       platform.testing.makeClient(envName, user, { sendLDHeaders: sendLDHeaders });
       const request = requests[0];
       expect(request.requestHeaders['X-LaunchDarkly-User-Agent']).toEqual(
-        shouldGetHeaders ? utils.getLDUserAgentString() : undefined
+        shouldGetHeaders ? utils.getLDUserAgentString(platform) : undefined
       );
     }
 

packages/ldclient-js-common/src/__tests__/Requestor-test.js

@@ -178,7 +178,9 @@ describe('Requestor', () => {
     requestor.fetchFlagSettings(user, 'hash1', sinon.spy());
 
     expect(server.requests.length).toEqual(1);
-    expect(server.requests[0].requestHeaders['X-LaunchDarkly-User-Agent']).toEqual(utils.getLDUserAgentString());
+    expect(server.requests[0].requestHeaders['X-LaunchDarkly-User-Agent']).toEqual(
+      utils.getLDUserAgentString(platform)
+    );
   });
 
   it('should send custom user-agent header in REPORT mode when sendLDHeaders is true', () => {
@@ -187,7 +189,9 @@ describe('Requestor', () => {
     requestor.fetchFlagSettings(user, 'hash1', sinon.spy());
 
     expect(server.requests.length).toEqual(1);
-    expect(server.requests[0].requestHeaders['X-LaunchDarkly-User-Agent']).toEqual(utils.getLDUserAgentString());
+    expect(server.requests[0].requestHeaders['X-LaunchDarkly-User-Agent']).toEqual(
+      utils.getLDUserAgentString(platform)
+    );
   });
 
   it('should NOT send custom user-agent header when sendLDHeaders is false', () => {

packages/ldclient-js-common/src/__tests__/stubPlatform.js

@@ -37,6 +37,7 @@ export function defaults() {
         setTimeout(() => callback(null), 0);
       },
     },
+    userAgent: 'stubClient',
 
     // extra methods used for testing
     testing: {

packages/ldclient-js-common/src/utils.js

@@ -143,12 +143,12 @@ export function chunkUserEventsForUrl(maxLength, events) {
   return allChunks;
 }
 
-export function getLDUserAgentString() {
-  return 'JSClient/' + VERSION;
+export function getLDUserAgentString(platform) {
+  return platform.userAgent + '/' + VERSION;
 }
 
-export function addLDHeaders(xhr) {
-  xhr.setRequestHeader('X-LaunchDarkly-User-Agent', getLDUserAgentString());
+export function addLDHeaders(xhr, platform) {
+  xhr.setRequestHeader('X-LaunchDarkly-User-Agent', getLDUserAgentString(platform));
 }
 
 export function extend(...objects) {

packages/ldclient-js/src/__tests__/LDClient-test.js

@@ -52,6 +52,16 @@ describe('LDClient', () => {
       expect(requests.length).toEqual(1);
       expect(/sdk\/eval/.test(requests[0].url)).toEqual(false); // it's the goals request
     });
+
+    it('sends correct User-Agent in request', done => {
+      LDClient.initialize(envName, user, { fetchGoals: false });
+
+      setTimeout(() => {
+        expect(requests.length).toEqual(1);
+        expect(requests[0].requestHeaders['X-LaunchDarkly-User-Agent']).toMatch(/^JSClient\//);
+        done();
+      }, 0);
+    });
   });
 
   describe('goals', () => {

packages/ldclient-js/src/browserPlatform.js

@@ -80,5 +80,7 @@ export default function makeBrowserPlatform() {
 
   ret.eventSourceAllowsReport = false;
 
+  ret.userAgent = 'JSClient';
+
   return ret;
 }