Merge pull request #18 from nickpresta/add-ie-edge-support

Add guard around EventSource for browsers without support

Author: apucacao

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 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).
 
+## [1.0.6] - 2016-08-23
+### Changed
+- Added check for EventSource before trying to connect Stream.
+
 ## [1.0.5] - 2016-08-22
 ### Changed
 - Fixed an error that occurred on `hashchage`/`popstate` if the account had no goals.

README.md

@@ -7,6 +7,19 @@ This is the official LaunchDarkly client-side JavaScript SDK. This SDK does two
 * Makes feature flags available to your client-side (front-end) JavaScript code.
 * Sends click, pageview, and custom events from your front-end for A/B tests and analytics.
 
+## Browser Support
+
+The LaunchDarkly client-side JavaScript SDK supports the following browsers:
+
+* Chrome (any recent)
+* Firefox (any recent)
+* Safari (any recent)*
+* Internet Explorer (IE10+)*
+* Edge (any recent)*
+* Opera (any recent)*
+
+\* These browsers do not support streaming new flags to connected clients, even when `client.on('change')` is called.
+
 ## Installation
 
 There are two ways to install the client-side SDK:
@@ -51,7 +64,7 @@ Out of the box, initializing the client will make a remote request to LaunchDark
 
 Bootstrapping refers to providing the LaunchDarkly client object with an initial, immediately available set of feature flag values so that on page load `variation` can be called with no delay.
 
-#### From the server-side SDK 
+#### From the server-side SDK
 
 The preferred approach to bootstrapping is to populate the bootstrap values (a map of feature flag keys to flag values) from your backend. LaunchDarkly's server-side SDKs have a function called `all_flags`-- this function provides the initial set of bootstrap values. You can then provide these values to your front-end as a template. Depending on your templating language, this might look something like this:
 
@@ -66,15 +79,15 @@ If you bootstrap from the server-side, feature flags will be ready immediately,
 
 #### From Local Storage
 
-Alternatively, you can bootstrap feature flags from local storage. 
+Alternatively, you can bootstrap feature flags from local storage.
 
         var client = LDClient.initialize('YOUR_ENVIRONMENT_ID', user, options = {
           bootstrap: 'localStorage'
         });
 
-When using local storage, the client will store the latest flag settings in local storage. On page load, the previous settings will be used and the 'ready' event will be emitted immediately. This means that on page load, the user may see cached flag values until the next page load. 
+When using local storage, the client will store the latest flag settings in local storage. On page load, the previous settings will be used and the 'ready' event will be emitted immediately. This means that on page load, the user may see cached flag values until the next page load.
 
-You can still subscribe to flag changes if you're using local storage. 
+You can still subscribe to flag changes if you're using local storage.
 
 
 ### Secure mode

package.json

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

src/Stream.js

@@ -2,20 +2,22 @@ function Stream(url, environment) {
   var stream = {};
   var url = url + '/ping/' + environment;
   var es = null;
-  
+
   stream.connect = function(onPing) {
-    es = new EventSource(url);
-    es.addEventListener('ping', onPing);
+    if (typeof EventSource !== 'undefined') {
+      es = new window.EventSource(url);
+      es.addEventListener('ping', onPing);
+    }
   }
 
   stream.disconnect = function() {
-    es.close();
+    es && es.close();
   }
-  
+
   stream.isConnected = function() {
     return es && (es.readyState === EventSource.OPEN || es.readyState === EventSource.CONNECTING);
   }
-  
+
   return stream;
 }
 

src/__tests__/Stream-test.js

@@ -0,0 +1,25 @@
+var Stream = require('../Stream');
+
+var noop = function() {};
+
+describe('Stream', function() {
+  it('should not throw on EventSource when it does not exist', function() {
+    window.EventSource = undefined;
+    var stream = new Stream('https://example.com', 'test');
+
+    var connect = function() {
+      stream.connect(noop);
+    }
+
+    expect(connect).to.not.throw(TypeError);
+  });
+  it('should not throw when calling disconnect without first calling connect', function() {
+    var stream = new Stream('https://example.com', 'test');
+
+    var disconnect = function() {
+      stream.disconnect(noop);
+    }
+
+    expect(disconnect).to.not.throw(TypeError);
+  })
+});