prepare 2.2.0 release (#98)

Author: eli-darkly

CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to the LaunchDarkly client-side JavaScript SDK will be documented in this file. 
 This project adheres to [Semantic Versioning](http://semver.org).
 
+## [2.2.0] - 2018-06-22
+### Added:
+- New event `goalsReady` (and new method `waitUntilGoalsReady`, which returns a Promise based on that event) indicates when the client has loaded goals-- i.e. when it is possible for pageview events and click events to be triggered.
+
+### Fixed:
+- Fixed a bug where calling `variation` would throw an error if the client was bootstrapped from local storage and there were no flags in local storage yet, and the initial HTTP request for flags from LaunchDarkly had not yet completed. (thanks, [mpcowan](https://github.com/launchdarkly/js-client/pull/97)!)
+
 ## [2.1.2] - 2018-06-08
 ### Fixed:
 - Fix the TypeScript definitions to properly support the ES default export.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ldclient-js",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "LaunchDarkly SDK for JavaScript",
   "author": "LaunchDarkly <[email protected]>",
   "license": "Apache-2.0",

src/__tests__/LDClient-test.js

@@ -100,6 +100,24 @@ describe('LDClient', () => {
       });
     });
 
+    it('should resolve waitUntilGoalsReady when goals are loaded', done => {
+      const handleGoalsReady = jest.fn();
+      const client = LDClient.initialize(envName, user, {
+        bootstrap: {},
+      });
+
+      client.waitUntilGoalsReady().then(handleGoalsReady);
+
+      client.on('goalsReady', () => {
+        setTimeout(() => {
+          expect(handleGoalsReady).toHaveBeenCalled();
+          done();
+        }, 0);
+      });
+
+      getLastRequest().respond(200);
+    });
+
     it('should emit an error when an invalid samplingInterval is specified', done => {
       const client = LDClient.initialize(envName, user, {
         bootstrap: {},
@@ -187,6 +205,24 @@ describe('LDClient', () => {
       });
     });
 
+    it('should start with empty flags if we tried to use cached settings and there are none', done => {
+      window.localStorage.removeItem(lsKey);
+
+      const client = LDClient.initialize(envName, user, {
+        bootstrap: 'localstorage',
+      });
+
+      // don't wait for ready event - verifying that variation() doesn't throw an error if called before ready
+      expect(client.variation('flag-key', 0)).toEqual(0);
+
+      // verify that the flags get requested from LD
+      client.on('ready', () => {
+        expect(client.variation('flag-key')).toEqual(1);
+        done();
+      });
+      requests[0].respond(200, { 'Content-Type': 'application/json' }, '{"flag-key":{"value":1,"version":1}}');
+    });
+
     it('should handle localStorage getItem throwing an exception', done => {
       // sandbox.restore(window.localStorage.__proto__, 'getItem');
       // sandbox.stub(window.localStorage.__proto__, 'getItem').throws();

src/index.js

@@ -11,6 +11,7 @@ import * as errors from './errors';
 
 const readyEvent = 'ready';
 const changeEvent = 'change';
+const goalsEvent = 'goalsReady';
 const locationWatcherInterval = 300;
 
 function initialize(env, user, options = {}) {
@@ -405,7 +406,7 @@ function initialize(env, user, options = {}) {
     flags = store.loadFlags();
 
     if (flags === null) {
-      flags = {}
+      flags = {};
       requestor.fetchFlagSettings(ident.getUser(), hash, (err, settings) => {
         if (err) {
           emitter.maybeReportError(new errors.LDFlagFetchError(messages.errorFetchingFlags(err)));
@@ -494,6 +495,7 @@ function initialize(env, user, options = {}) {
       goalTracker = GoalTracker(goals, sendGoalEvent);
       watchLocation(locationWatcherInterval, refreshGoalTracker);
     }
+    emitter.emit(goalsEvent);
   });
 
   function start() {
@@ -524,8 +526,16 @@ function initialize(env, user, options = {}) {
     });
   });
 
+  const goalsPromise = new Promise(resolve => {
+    const onGoals = emitter.on(goalsEvent, () => {
+      emitter.off(goalsEvent, onGoals);
+      resolve();
+    });
+  });
+
   const client = {
     waitUntilReady: () => readyPromise,
+    waitUntilGoalsReady: () => goalsPromise,
     identify: identify,
     variation: variation,
     track: track,