prepare 3.2.1 release (#14)

Author: LaunchDarklyCI

src/Stream.js

@@ -10,7 +10,7 @@ import { base64URLEncode, getLDHeaders } from './utils';
 //   it is in an active state (connected or connecting).
 // eventSourceAllowsReport: true if REPORT is supported.
 
-export default function Stream(platform, config, environment, diagnosticsAccumulator, hash) {
+export default function Stream(platform, config, environment, diagnosticsAccumulator) {
   const baseUrl = config.streamUrl;
   const logger = config.logger;
   const stream = {};
@@ -24,10 +24,12 @@ export default function Stream(platform, config, environment, diagnosticsAccumul
   let reconnectTimeoutReference = null;
   let connectionAttemptStartTime;
   let user = null;
+  let hash = null;
   let handlers = null;
 
-  stream.connect = function(newUser, newHandlers) {
+  stream.connect = function(newUser, newHash, newHandlers) {
     user = newUser;
+    hash = newHash;
     handlers = {};
     for (const key in newHandlers || {}) {
       handlers[key] = function(e) {

src/__tests__/LDClient-streaming-test.js

@@ -13,6 +13,7 @@ import { makeBootstrap } from './testUtils';
 // implementation, verifying that the SDK interacts properly with the stream abstraction.
 
 describe('LDClient streaming', () => {
+  const defaultStreamBaseUrl = 'https://clientstream.launchdarkly.com';
   const envName = 'UNKNOWN_ENVIRONMENT_ID';
   const lsKey = 'ld:UNKNOWN_ENVIRONMENT_ID:' + utils.btoa('{"key":"user"}');
   const user = { key: 'user' };
@@ -32,9 +33,20 @@ describe('LDClient streaming', () => {
     return await withCloseable(client, async () => await asyncCallback(client, server));
   }
 
+  function makeExpectedStreamUrl(base64User, userHash, withReasons) {
+    const baseUrl = defaultStreamBaseUrl + '/eval/' + envName + '/' + base64User;
+    const queryParams = [];
+    if (userHash) {
+      queryParams.push('h=' + userHash);
+    }
+    if (withReasons) {
+      queryParams.push('?withReasons=true');
+    }
+    return baseUrl + (queryParams.length ? '?' + queryParams.join('&') : '');
+  }
+
   describe('streaming/event listening', () => {
-    const streamUrl = 'https://clientstream.launchdarkly.com';
-    const fullStreamUrlWithUser = streamUrl + '/eval/' + envName + '/' + encodedUser;
+    const fullStreamUrlWithUser = makeExpectedStreamUrl(encodedUser);
 
     async function expectStreamConnecting(url) {
       const stream = await platform.testing.expectStream(url);
@@ -599,10 +611,26 @@ describe('LDClient streaming', () => {
         await client.waitForInitialization();
         client.setStreaming(true);
 
-        await expectStreamConnecting(streamUrl + '/eval/' + envName + '/' + encodedUser);
+        await expectStreamConnecting(makeExpectedStreamUrl(encodedUser));
 
         await client.identify(user2);
-        await expectStreamConnecting(streamUrl + '/eval/' + envName + '/' + encodedUser2);
+        await expectStreamConnecting(makeExpectedStreamUrl(encodedUser2));
+      });
+    });
+
+    it('reconnects to stream with new hash value in secure mode if the user changes', async () => {
+      const newUser = { key: 'user2' };
+      const newEncodedUser = 'eyJrZXkiOiJ1c2VyMiJ9';
+      const newHash = hash + 'xxx';
+
+      await withClientAndServer({ hash }, async client => {
+        await client.waitForInitialization();
+        client.setStreaming(true);
+
+        await expectStreamConnecting(makeExpectedStreamUrl(encodedUser, hash));
+
+        await client.identify(newUser, newHash);
+        await expectStreamConnecting(makeExpectedStreamUrl(newEncodedUser, newHash));
       });
     });
   });

src/__tests__/Stream-test.js

@@ -27,6 +27,18 @@ describe('Stream', () => {
     baseHeaders = getLDHeaders(platform, defaultConfig);
   });
 
+  function makeExpectedStreamUrl(base64User, userHash, withReasons) {
+    const url = baseUrl + '/eval/' + envName + '/' + base64User;
+    const queryParams = [];
+    if (userHash) {
+      queryParams.push('h=' + userHash);
+    }
+    if (withReasons) {
+      queryParams.push('?withReasons=true');
+    }
+    return url + (queryParams.length ? '?' + queryParams.join('&') : '');
+  }
+
   it('should not throw on EventSource when it does not exist', () => {
     const platform1 = { ...platform };
     delete platform1['eventSourceFactory'];
@@ -51,22 +63,22 @@ describe('Stream', () => {
 
   it('connects to EventSource with eval stream URL by default', async () => {
     const stream = new Stream(platform, defaultConfig, envName);
-    stream.connect(user, {});
+    stream.connect(user, null, {});
 
-    await platform.testing.expectStream(baseUrl + '/eval/' + envName + '/' + encodedUser);
+    await platform.testing.expectStream(makeExpectedStreamUrl(encodedUser));
   });
 
   it('adds secure mode hash to URL if provided', async () => {
-    const stream = new Stream(platform, defaultConfig, envName, null, hash);
-    stream.connect(user, {});
+    const stream = new Stream(platform, defaultConfig, envName);
+    stream.connect(user, hash, {});
 
-    await platform.testing.expectStream(baseUrl + '/eval/' + envName + '/' + encodedUser + '?h=' + hash);
+    await platform.testing.expectStream(makeExpectedStreamUrl(encodedUser, hash));
   });
 
   it('falls back to ping stream URL if useReport is true and REPORT is not supported', async () => {
     const config = { ...defaultConfig, useReport: true };
     const stream = new Stream(platform, config, envName);
-    stream.connect(user, {});
+    stream.connect(user, null, {});
 
     await platform.testing.expectStream(baseUrl + '/ping/' + envName);
   });
@@ -75,7 +87,7 @@ describe('Stream', () => {
     const platform1 = { ...platform, eventSourceAllowsReport: true };
     const config = { ...defaultConfig, useReport: true };
     const stream = new Stream(platform1, config, envName);
-    stream.connect(user, {});
+    stream.connect(user, null, {});
 
     const created = await platform.testing.expectStream(baseUrl + '/eval/' + envName);
     expect(created.options.method).toEqual('REPORT');
@@ -84,27 +96,27 @@ describe('Stream', () => {
 
   it('sends default SDK headers', async () => {
     const stream = new Stream(platform, defaultConfig, envName);
-    stream.connect(user, {});
+    stream.connect(user, null, {});
 
-    const created = await platform.testing.expectStream(baseUrl + '/eval/' + envName + '/' + encodedUser);
+    const created = await platform.testing.expectStream(makeExpectedStreamUrl(encodedUser));
     expect(created.options.headers).toEqual(baseHeaders);
   });
 
   it('sends SDK headers with wrapper info', async () => {
     const config = { ...defaultConfig, wrapperName: 'FakeSDK' };
     const stream = new Stream(platform, config, envName);
-    stream.connect(user, {});
+    stream.connect(user, null, {});
 
-    const created = await platform.testing.expectStream(baseUrl + '/eval/' + envName + '/' + encodedUser);
+    const created = await platform.testing.expectStream(makeExpectedStreamUrl(encodedUser));
     expect(created.options.headers).toEqual({ ...baseHeaders, 'X-LaunchDarkly-Wrapper': 'FakeSDK' });
   });
 
   it('does not send SDK headers when sendLDHeaders is false', async () => {
     const config = { ...defaultConfig, sendLDHeaders: false };
     const stream = new Stream(platform, config, envName);
-    stream.connect(user, {});
+    stream.connect(user, null, {});
 
-    const created = await platform.testing.expectStream(baseUrl + '/eval/' + envName + '/' + encodedUser);
+    const created = await platform.testing.expectStream(makeExpectedStreamUrl(encodedUser));
     expect(created.options.headers).toEqual({});
   });
 
@@ -113,7 +125,7 @@ describe('Stream', () => {
     const fn1 = jest.fn();
     const fn2 = jest.fn();
 
-    stream.connect(user, {
+    stream.connect(user, null, {
       birthday: fn1,
       anniversary: fn2,
     });
@@ -184,7 +196,7 @@ describe('Stream', () => {
     const config = { ...defaultConfig, streamReconnectDelay: 1 };
     const stream = new Stream(platform, config, envName);
     const fakePut = jest.fn();
-    stream.connect(user, {
+    stream.connect(user, null, {
       put: fakePut,
     });
 
@@ -227,7 +239,7 @@ describe('Stream', () => {
 
       expect(acc.getProps().streamInits.length).toEqual(0);
 
-      stream.connect(user, {
+      stream.connect(user, null, {
         put: jest.fn(),
       });
 
@@ -255,7 +267,7 @@ describe('Stream', () => {
 
       expect(acc.getProps().streamInits.length).toEqual(0);
 
-      stream.connect(user, {
+      stream.connect(user, null, {
         put: jest.fn(),
       });
 

src/index.js

@@ -32,9 +32,9 @@ export function initialize(env, user, specifiedOptions, platform, extraOptionDef
   const logger = createLogger();
   const emitter = EventEmitter(logger);
   const options = configuration.validate(specifiedOptions, emitter, extraOptionDefs, logger);
-  const hash = options.hash;
   const sendEvents = options.sendEvents;
   let environment = env;
+  let hash = options.hash;
 
   const eventSender = EventSender(platform, environment, options);
 
@@ -48,7 +48,7 @@ export function initialize(env, user, specifiedOptions, platform, extraOptionDef
     diagnosticsManager.start();
   }
 
-  const stream = Stream(platform, options, environment, diagnosticsAccumulator, hash);
+  const stream = Stream(platform, options, environment, diagnosticsAccumulator);
 
   const events =
     options.eventProcessor ||
@@ -198,7 +198,7 @@ export function initialize(env, user, specifiedOptions, platform, extraOptionDef
     enqueueEvent(event);
   }
 
-  function identify(user, hash, onDone) {
+  function identify(user, newHash, onDone) {
     if (closed) {
       return utils.wrapPromiseCallback(Promise.resolve({}), onDone);
     }
@@ -213,11 +213,12 @@ export function initialize(env, user, specifiedOptions, platform, extraOptionDef
         .then(() => userValidator.validateUser(user))
         .then(realUser =>
           requestor
-            .fetchFlagSettings(realUser, hash)
+            .fetchFlagSettings(realUser, newHash)
             // the following then() is nested within this one so we can use realUser from the previous closure
             .then(requestedFlags => {
               const flagValueMap = utils.transformVersionedValuesToValues(requestedFlags);
               ident.setUser(realUser);
+              hash = newHash;
               if (requestedFlags) {
                 return replaceAllFlags(requestedFlags).then(() => flagValueMap);
               } else {
@@ -334,7 +335,7 @@ export function initialize(env, user, specifiedOptions, platform, extraOptionDef
     if (!ident.getUser()) {
       return;
     }
-    stream.connect(ident.getUser(), {
+    stream.connect(ident.getUser(), hash, {
       ping: function() {
         logger.debug(messages.debugStreamPing());
         requestor

typings.d.ts

@@ -468,7 +468,7 @@ declare module 'launchdarkly-js-sdk-common' {
      * @param user
      *   The user properties. Must contain at least the `key` property.
      * @param hash
-     *   The signed user key for [Secure Mode](http://docs.launchdarkly.com/docs/js-sdk-reference#secure-mode).
+     *   The signed user key if you are using [Secure Mode](http://docs.launchdarkly.com/docs/js-sdk-reference#secure-mode).
      * @param onDone
      *   A function which will be called as soon as the flag values for the new user are available,
      *   with two parameters: an error value (if any), and an [[LDFlagSet]] containing the new values