Added subscribe option

Author: yusinto

.eslintrc

@@ -1,10 +1,12 @@
 {
   "parser": "babel-eslint",
-  "extends": "airbnb",
+  "extends": ["prettier"],
   "plugins": [
+    "prettier",
     "babel"
   ],
   "rules": {
+    "prettier/prettier": ["error"],
     "import/first": 0,
     "eol-last": 0,
     "arrow-body-style": 0,

.gitignore

@@ -38,4 +38,4 @@ jspm_packages
 
 .eslintcache
 
-.idea
+.idea

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 120
+}

README.md

@@ -94,7 +94,7 @@ yarn add ld-redux
     ```
 
 ## API
-### init({clientSideId, dispatch, flags, user, options})
+### init({clientSideId, dispatch, flags, user, subscribe, options})
 The init method accepts an object with the above properties. `clientSideId`, `dispatch` are mandatory.
 
 The `flags` property is optional. This is an object containing all the flags you want to use and subscribe to in your app.
@@ -113,6 +113,10 @@ ldRedux.init({
 });
 ```
 
+The `subscribe` property is optional. This defaults to true which means by default you'll get automatic live updates
+of flag changes from the server. You can turn this off and manually subscribe to flag changes through the ldClient
+object if for some reason you don't want to get live updates.
+
 The `user` property is optional. You can initialise the sdk with a custom user by specifying one. This must be an object containing
 at least a "key" property. If you don't specify a user object, ldRedux will create a default one that looks like this:
 

example/src/client/index.js

@@ -1,8 +1,8 @@
 import React from 'react';
-import {hydrate} from 'react-dom';
-import {Router, browserHistory} from 'react-router';
+import { hydrate } from 'react-dom';
+import { Router, browserHistory } from 'react-router';
 import routes from '../universal/routes';
-import {Provider} from 'react-redux';
+import { Provider } from 'react-redux';
 import createStore from '../universal/redux/store';
 import ldRedux from 'ld-redux';
 import flags from '../../flags.json';
@@ -11,14 +11,14 @@ const reduxState = window.__INITIAL_STATE__ || undefined;
 const store = createStore(reduxState);
 
 ldRedux.init({
-  clientSideId: '57df4354dd79c70721bcb507',
+  clientSideId: '59b2b2596d1a250b1c78baa4',
   dispatch: store.dispatch,
   flags,
 });
 
 hydrate(
   <Provider store={store}>
-    <Router routes={routes} history={browserHistory}/>
+    <Router routes={routes} history={browserHistory} />
   </Provider>,
-  document.getElementById('reactDiv')
+  document.getElementById('reactDiv'),
 );

example/yarn.lock

@@ -2,10 +2,6 @@
 # yarn lockfile v1
 
 
-[email protected]:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/Base64/-/Base64-1.0.1.tgz#def45cc50c961bcc9bf2321d0f52bcbfec1f1bb1"
-
 abbrev@1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/abbrev/-/abbrev-1.1.1.tgz#f8f2c887ad10bf67f634f005b6987fed3179aac8"
@@ -1332,7 +1328,7 @@ escape-html@~1.0.3:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988"
 
-escape-string-regexp@1.0.5, escape-string-regexp@^1.0.2:
+escape-string-regexp@^1.0.2:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"
 
@@ -1774,10 +1770,6 @@ invert-kv@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/invert-kv/-/invert-kv-1.0.0.tgz#104a8e4aaca6d3d8cd157a8ef8bfab2d7a3ffdb6"
 
-ip@^1.1.5:
-  version "1.1.5"
-  resolved "https://registry.yarnpkg.com/ip/-/ip-1.1.5.tgz#bdded70114290828c0a039e72ef25f5aaec4354a"
-
 [email protected]:
   version "1.8.0"
   resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.8.0.tgz#eaa33d6ddd7ace8f7f6fe0c9ca0440e706738b1e"
@@ -1972,22 +1964,8 @@ lcid@^1.0.0:
   dependencies:
     invert-kv "^1.0.0"
 
-ld-redux@^3.1.0:
-  version "3.2.0"
-  resolved "https://registry.yarnpkg.com/ld-redux/-/ld-redux-3.2.0.tgz#6631b2ca5ea4288924fb34254ec4902f232b645c"
-  dependencies:
-    ip "^1.1.5"
-    ldclient-js "^2.6.0"
-    lodash.camelcase "^4.3.0"
-    ua-parser-js "^0.7.18"
-    uuid "^3.3.2"
-
-ldclient-js@^2.6.0:
-  version "2.6.0"
-  resolved "https://registry.yarnpkg.com/ldclient-js/-/ldclient-js-2.6.0.tgz#39875ae1b05fda2b4ffee4d53c103cabc2602bba"
-  dependencies:
-    Base64 "1.0.1"
-    escape-string-regexp "1.0.5"
+"ld-redux@file:../lib":
+  version "0.0.0"
 
 load-json-file@^1.0.0:
   version "1.1.0"
@@ -2016,10 +1994,6 @@ lodash-es@^4.17.5:
   version "4.17.11"
   resolved "https://registry.yarnpkg.com/lodash-es/-/lodash-es-4.17.11.tgz#145ab4a7ac5c5e52a3531fb4f310255a152b4be0"
 
-lodash.camelcase@^4.3.0:
-  version "4.3.0"
-  resolved "https://registry.yarnpkg.com/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz#b28aa6288a2b9fc651035c7711f65ab6190331a6"
-
 lodash@^4.14.0, lodash@^4.6.1:
   version "4.17.4"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.4.tgz#78203a4d1c328ae1d86dca6460e369b57f4055ae"
@@ -3105,10 +3079,6 @@ uuid@^3.0.0:
   version "3.2.1"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.2.1.tgz#12c528bb9d58d0b9265d9a2f6f0fe8be17ff1f14"
 
-uuid@^3.3.2:
-  version "3.3.2"
-  resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.3.2.tgz#1b4af4955eb3077c501c23872fc6513811587131"
-
 validate-npm-package-license@^3.0.1:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/validate-npm-package-license/-/validate-npm-package-license-3.0.1.tgz#2804babe712ad3379459acfbe24746ab2c303fbc"

lib/init.js

@@ -91,10 +91,14 @@ exports.default = function (_ref) {
       dispatch = _ref.dispatch,
       flags = _ref.flags,
       user = _ref.user,
+      subscribe = _ref.subscribe,
       options = _ref.options;
 
   initFlags(flags, dispatch);
 
+  // default subscribe to true
+  var sanitisedSubscribe = typeof subscribe === 'undefined' ? true : subscribe;
+
   if (!user) {
     user = initUser();
   }
@@ -103,6 +107,9 @@ exports.default = function (_ref) {
   window.ldClient.on('ready', function () {
     var flagsSanitised = flags || ldClient.allFlags();
     setFlags(flagsSanitised, dispatch);
-    subscribeToChanges(flagsSanitised, dispatch);
+
+    if (sanitisedSubscribe) {
+      subscribeToChanges(flagsSanitised, dispatch);
+    }
   });
 };

package.json

@@ -38,12 +38,15 @@
     "babel-preset-stage-0": "^6.24.1",
     "eslint": "^5.5.0",
     "eslint-config-airbnb": "^17.1.0",
+    "eslint-config-prettier": "4.3.0",
     "eslint-friendly-formatter": "^4.0.1",
     "eslint-plugin-babel": "^5.2.0",
     "eslint-plugin-import": "^2.14.0",
     "eslint-plugin-jsx-a11y": "^6.1.1",
+    "eslint-plugin-prettier": "3.1.0",
     "eslint-plugin-react": "^7.11.1",
-    "jest": "^23.5.0",
+    "jest": "23.6.0",
+    "prettier": "1.17.1",
     "rimraf": "^2.6.2",
     "testdouble": "^3.8.1"
   },

src/actions.js

@@ -1,6 +1,6 @@
-export const setFlags = (flags) => {
+export const setFlags = flags => {
   return {
     type: 'SET_FLAGS',
     data: flags,
   };
-};
+};

src/index.js

@@ -4,4 +4,4 @@ import reducer from './reducer';
 export default {
   init,
   reducer: () => reducer,
-};
+};

src/init.js

@@ -1,17 +1,17 @@
-import {initialize as ldClientInitialize} from 'ldclient-js';
+import { initialize as ldClientInitialize } from 'ldclient-js';
 import camelCase from 'lodash.camelcase';
 import uuid from 'uuid';
 import ip from 'ip';
 import UAParser from 'ua-parser-js';
-import {setFlags as setFlagsAction} from './actions';
+import { setFlags as setFlagsAction } from './actions';
 
 const userAgentParser = new UAParser();
 const isMobileDevice = typeof window !== 'undefined' && userAgentParser.getDevice().type === 'mobile';
 const isTabletDevice = typeof window !== 'undefined' && userAgentParser.getDevice().type === 'tablet';
 
 // initialise flags with default values in ld redux store
 const initFlags = (flags, dispatch) => {
-  const flagValues = {isLDReady: false};
+  const flagValues = { isLDReady: false };
   for (const flag in flags) {
     const camelCasedKey = camelCase(flag);
     flagValues[camelCasedKey] = flags[flag];
@@ -21,7 +21,7 @@ const initFlags = (flags, dispatch) => {
 
 // set flags with real values from ld server
 const setFlags = (flags, dispatch) => {
-  const flagValues = {isLDReady: true};
+  const flagValues = { isLDReady: true };
   for (const flag in flags) {
     const camelCasedKey = camelCase(flag);
     flagValues[camelCasedKey] = ldClient.variation(flag, flags[flag]);
@@ -32,7 +32,7 @@ const setFlags = (flags, dispatch) => {
 const subscribeToChanges = (flags, dispatch) => {
   for (const flag in flags) {
     const camelCasedKey = camelCase(flag);
-    ldClient.on(`change:${flag}`, (current) => {
+    ldClient.on(`change:${flag}`, current => {
       const newFlagValue = {};
       newFlagValue[camelCasedKey] = current;
       dispatch(setFlagsAction(newFlagValue));
@@ -61,9 +61,12 @@ const initUser = () => {
   };
 };
 
-export default ({clientSideId, dispatch, flags, user, options}) => {
+export default ({ clientSideId, dispatch, flags, user, subscribe, options }) => {
   initFlags(flags, dispatch);
 
+  // default subscribe to true
+  const sanitisedSubscribe = typeof subscribe === 'undefined' ? true : subscribe;
+
   if (!user) {
     user = initUser();
   }
@@ -72,6 +75,9 @@ export default ({clientSideId, dispatch, flags, user, options}) => {
   window.ldClient.on('ready', () => {
     const flagsSanitised = flags || ldClient.allFlags();
     setFlags(flagsSanitised, dispatch);
-    subscribeToChanges(flagsSanitised, dispatch);
+
+    if (sanitisedSubscribe) {
+      subscribeToChanges(flagsSanitised, dispatch);
+    }
   });
 };