v2.0.0 beta.7 (#252)

* fix(reducer): allow setting paths ending in numbers - #248
* feat(auth): make signInWithCredential not dependent on provider - #247
* `signInWithCustomToken` no longer decodes token internally for profile data (`profileFactory` should be used) - #244
* Removed `jwt-decode` as a dependency (not needed since auth token no longer decoded internally)
* Support lazy/module loading - #249, #250 
* Updated SSR docs to include notes about `enableRedirectHanlding: false` - #251
* Updated Roadmap with detection of non-http environments

Author: prescottprue

README.md

@@ -80,11 +80,11 @@ const config = {
 const rrfConfig = { userProfile: 'users' } // react-redux-firebase config
 
 // initialize firebase instance
-firebase.initializeApp(config) // <- new to v2.*.*
+const firebaseApp = firebase.initializeApp(config) // <- new to v2.*.*
 
 // Add reduxReduxFirebase to compose
 const createStoreWithFirebase = compose(
-  reactReduxFirebase(firebase, rrfConfig), // firebase instance as first argument
+  reactReduxFirebase(firebaseApp, rrfConfig), // firebase instance as first argument
 )(createStore)
 
 // Create store with reducers and initial state
@@ -207,7 +207,6 @@ In order to enable this functionality, you will most likely need to install a pl
 }
 ```
 
-
 ## [Docs](http://react-redux-firebase.com)
 See full documentation at [react-redux-firebase.com](http://react-redux-firebase.com)
 

docs/api/compose.md

@@ -11,7 +11,7 @@ Middleware that handles configuration (placed in redux's
 
 **Parameters**
 
--   `fbConfig`  
+-   `fbApp`  
 -   `otherConfig`  
 
 **Properties**

docs/recipes/populate.md

@@ -27,15 +27,28 @@ const populates = [
 
 ### Populate Profile Parameters
 
-To Populate parameters within profile/user object, include the `profileParamsToPopulate` parameter when [calling `reactReduxFirebase` in your compose function](/api/compose).
+To Populate parameters within profile/user object, include the `profileParamsToPopulate` parameter when [calling `reactReduxFirebase` in your compose function](/api/compose) as well as using `populate`.
+
+**NOTE** Using `profileParamsToPopulate` no longer automatically populates profile, you must use `populate`. Un-populated profile lives within state under `state.firebase.profile`.
 
 #### Examples
 
-##### Populate List of Items
+##### Populate Role
+
+Populating a user's role parameter from a list of roles (under `roles` collection).
 
 ```javascript
+export const profilePopulates = [{ child: 'role', root: 'roles' }]
 const config = {
   userProfile: 'users',
-  profileParamsToPopulate: [ 'todos:todos' ] // populate list of todos from todos ref
+  profileParamsToPopulate: profilePopulates // populate list of todos from todos ref
 }
+
+// In component
+@connect(
+  ({ firebase }) => ({
+    profile: firebase.profile,
+    populatedProfile: populate(firebase, 'profile', profilePopulates),
+  })
+)
 ```

docs/recipes/ssr.md

@@ -1,15 +1,21 @@
 # Server Side Rendering
 
-## Implement with webpack
+### Disable Redirect Handling
+
+Support automatically detecting non-HTTP environments has been added as of [`v2.0.0-beta.7`](https://github.com/prescottprue/react-redux-firebase/releases/tag/v2.0.0-beta.7), which means you can skip the rest of this section.
+
+If using earlier than `v2.0.0-beta.7`:
+
+By default a redirect handling listener is set up, which will not work in environments without HTTP. Currently, for SSR, you must disable this redirect handling listener to keep an error from appearing (see [#251](https://github.com/prescottprue/react-redux-firebase/issues/251) for more info).
 
-### Make Sure Loaders are setup appropriately
-Note, make sure that you have excluded `node_modules` in your webpack loaders
 
 ```js
-// webpack 1
-exclude: /node_modules/,
-// or webpack 2
-options: { presets: [ [ 'es2015', { modules: false } ] ] }
+// disable redirect listener setup (happens by default)
+const config = {
+  enableRedirectHandling: false
+}
+
+reactReduxFirebase(firebaseInstance, config)
 ```
 
 
@@ -21,3 +27,17 @@ global.XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest
 ```
 
 If you find adding this extra code to be an annoyance or you would like to discuss a different way to do it, please feel free to open an issue/pull request or reach out on [gitter](https://gitter.im/redux-firebase/Lobby).
+
+
+
+## Implement with Webpack
+
+### Make Sure Loaders are setup appropriately
+Note, make sure that you have excluded `node_modules` in your webpack loaders
+
+```js
+// webpack 1
+exclude: /node_modules/,
+// or webpack 2
+options: { presets: [ [ 'es2015', { modules: false } ] ] }
+```

docs/roadmap.md

@@ -89,6 +89,7 @@
 #### Breaking Changes
 * Remove usage of `Immutable.js` and Immutable Maps (no more need for `pathToJS()` & `dataToJS()` to load data from redux)
 * Firebase is now initialized outside of `react-redux-firebase` - [#173](https://github.com/prescottprue/react-redux-firebase/issues), [#131](https://github.com/prescottprue/react-redux-firebase/issues), [#107](https://github.com/prescottprue/react-redux-firebase/issues)
+* `login` with custom token no longer internally decodes JWT (use `profileFactory` instead to include token data on profile)
 * reducer split into multiple nested reducers for a few reasons:
   * follows [standard for nesting of reducers using combine reducers](http://redux.js.org/docs/recipes/reducers/UpdatingNormalizedData.html)).
   * allows for separately importable reducers (for placing in other parts of redux other than `state.firebase`)
@@ -100,12 +101,12 @@
 * `AuthRequired` decorator (or decorator factory) that forces auth to exist before rendering component
 * Support native modules through [`react-native-firebase`](https://github.com/invertase/react-native-firebase) - [#131](https://github.com/prescottprue/react-redux-firebase/issues/131)
 * Track online users and sessions by passing `presence` config option
-
-#### Enhancements/Fixes
+* Detect Non-HTTP environments (such as with SSR) so that `enableRedirectHandling: false` is not required in config
+* Allowing `presence` setting to accept a function for dynamically building presence path based on auth
+* Firebase app can now be passed instead of full firebase lib (pass around a smaller object) - [#249](https://github.com/prescottprue/react-redux-firebase/issues/250), [#250](https://github.com/prescottprue/react-redux-firebase/issues/250)
 * Implement [`firebase-server`](https://github.com/urish/firebase-server) for tests instead of using demo firebase instance
 
 #### Under Consideration
-* Allowing `presence` setting to accept a function for dynamically building presence path based on auth
 * Possibility of delayed initialization - [#70](https://github.com/prescottprue/react-redux-firebase/issues/70) (more research needed)
 
 ### Long Term Goals

examples/complete/material/config/webpack.config.js

@@ -1,4 +1,5 @@
 const webpack = require('webpack')
+const path = require('path')
 const cssnano = require('cssnano')
 const HtmlWebpackPlugin = require('html-webpack-plugin')
 const ExtractTextPlugin = require('extract-text-webpack-plugin')
@@ -19,6 +20,10 @@ const webpackConfig = {
     root: project.paths.client(),
     extensions: ['', '.js', '.jsx', '.json']
   },
+  alias: {
+    // fix issue of loading multiple versions of react
+    react: path.resolve('./node_modules/react'),
+  },
   module: {}
 }
 // ------------------------------------
@@ -113,10 +118,11 @@ if (!__TEST__) {
 // JavaScript / JSON
 webpackConfig.module.loaders = [{
   test: /\.(js|jsx)$/,
-  exclude: [ /node_modules/, /react-redux-firebase\/dist/ /* exclude any npm-linked modules here */ ],
+  exclude: [ /node_modules/, /react-redux-firebase\/lib\// /* exclude any npm-linked modules here */ ],
   loader: 'babel',
   query: project.compiler_babel
 }, {
+  exclude: [ /node_modules/, /react-redux-firebase\/lib\// /* exclude any npm-linked modules here */ ],
   test: /\.json$/,
   loader: 'json'
 }]

examples/complete/material/src/store/createStore.js

@@ -3,7 +3,9 @@ import thunk from 'redux-thunk'
 import { browserHistory } from 'react-router'
 import { reactReduxFirebase, getFirebase } from 'react-redux-firebase'
 import logger from 'redux-logger'
-import firebase from 'firebase'
+import firebase from 'firebase/app'
+import 'firebase/auth'
+import 'firebase/database'
 import { firebase as fbConfig, reduxFirebase as reduxConfig } from '../config'
 import makeRootReducer from './reducers'
 import { updateLocation } from './location'
@@ -29,7 +31,7 @@ export default (initialState = {}, history) => {
     }
   }
 
-  firebase.initializeApp(fbConfig)
+  const firebaseApp = firebase.initializeApp(fbConfig)
 
   // ======================================================
   // Store Instantiation and HMR Setup
@@ -38,7 +40,7 @@ export default (initialState = {}, history) => {
     makeRootReducer(),
     initialState,
     compose(
-      reactReduxFirebase(firebase, reduxConfig),
+      reactReduxFirebase(firebaseApp, reduxConfig),
       applyMiddleware(...middleware),
       ...enhancers
     )

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-redux-firebase",
-  "version": "2.0.0-beta.6",
+  "version": "2.0.0-beta.7",
   "description": "Redux integration for Firebase. Comes with a Higher Order Component for use with React.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -58,7 +58,6 @@
   ],
   "dependencies": {
     "hoist-non-react-statics": "^2.2.2",
-    "jwt-decode": "^2.2.0",
     "lodash": "^4.17.4",
     "prop-types": "^15.5.10"
   },

src/actions/auth.js

@@ -1,12 +1,10 @@
-import jwtDecode from 'jwt-decode'
 import {
-  omit,
   isArray,
   isString,
   isFunction,
   forEach
 } from 'lodash'
-import { actionTypes, defaultJWTProps } from '../constants'
+import { actionTypes } from '../constants'
 import { getLoginMethodAndParams } from '../utils/auth'
 import { promisesForPopulate } from '../utils/populate'
 
@@ -46,11 +44,10 @@ export const unWatchUserProfile = (firebase) => {
  * @private
  */
 export const watchUserProfile = (dispatch, firebase) => {
-  const authUid = firebase._.authUid
-  const userProfile = firebase._.config.userProfile
+  const { authUid, config: { userProfile } } = firebase._
   unWatchUserProfile(firebase)
 
-  if (firebase._.config.userProfile) {
+  if (userProfile && firebase.database) {
     firebase._.profileWatch = firebase.database()
       .ref()
       .child(`${userProfile}/${authUid}`)
@@ -100,20 +97,24 @@ export const watchUserProfile = (dispatch, firebase) => {
  * @private
  */
 export const createUserProfile = (dispatch, firebase, userData, profile) => {
-  const { database, _: { config } } = firebase
-  if (!config.userProfile) {
+  const { _: { config } } = firebase
+  if (!config.userProfile || !firebase.database) {
     return Promise.resolve(userData)
   }
-  try {
-    if (isFunction(config.profileFactory)) {
+
+  // use profileFactory if it exists in config
+  if (isFunction(config.profileFactory)) {
+    // catch errors in user provided profileFactory function
+    try {
       profile = config.profileFactory(userData, profile)
+    } catch (err) {
+      console.error('Error occured within profileFactory function:', err.message || err) // eslint-disable-line no-console
+      return Promise.reject(err)
     }
-  } catch (err) {
-    console.error('Error occured within profileFactory function:', err.toString ? err.toString() : err) // eslint-disable-line no-console
-    return Promise.reject(err)
   }
+
   // Check for user's profile at userProfile path if provided
-  return database()
+  return firebase.database()
     .ref()
     .child(`${config.userProfile}/${userData.uid}`)
     .once('value')
@@ -141,7 +142,10 @@ export const createUserProfile = (dispatch, firebase, userData, profile) => {
  * @private
  */
 const setupPresence = (dispatch, firebase) => {
-  // TODO: Enable more settings here (enable/disable sessions, store past sessions)
+  // exit if database does not exist on firebase instance
+  if (!firebase.database) {
+    return
+  }
   const ref = firebase.database().ref()
   const { config: { presence, sessions }, authUid } = firebase._
   let amOnline = ref.child('.info/connected')
@@ -183,8 +187,11 @@ const setupPresence = (dispatch, firebase) => {
  * @private
  */
 export const init = (dispatch, firebase) => {
+  // exit if auth does not exist
+  if (!firebase.auth) {
+    return
+  }
   dispatch({ type: actionTypes.AUTHENTICATION_INIT_STARTED })
-
   firebase.auth().onAuthStateChanged(authData => {
     if (!authData) {
       // Run onAuthStateChanged if it exists in config and enableEmptyAuthChanges is set to true
@@ -195,9 +202,12 @@ export const init = (dispatch, firebase) => {
     }
 
     firebase._.authUid = authData.uid
+
+    // setup presence if settings exist
     if (firebase._.config.presence) {
       setupPresence(dispatch, firebase)
     }
+
     watchUserProfile(dispatch, firebase)
 
     dispatch({ type: actionTypes.LOGIN, auth: authData })
@@ -209,11 +219,16 @@ export const init = (dispatch, firebase) => {
   })
 
   // set redirect result callback if enableRedirectHandling set to true
-  if (firebase._.config.enableRedirectHandling) {
+  if (firebase._.config.enableRedirectHandling && (
+    typeof window !== 'undefined' &&
+    window.location &&
+    window.location.protocol &&
+    window.location.protocol.indexOf('http') !== -1
+  )) {
     firebase.auth().getRedirectResult()
       .then((authData) => {
         // Run onRedirectResult if it exists in config
-        if (firebase._.config.onRedirectResult) {
+        if (typeof firebase._.config.onRedirectResult === 'function') {
           firebase._.config.onRedirectResult(authData, firebase, dispatch)
         }
         if (authData && authData.user) {
@@ -236,7 +251,8 @@ export const init = (dispatch, firebase) => {
             }
           )
         }
-      }).catch((error) => {
+      })
+      .catch((error) => {
         dispatchLoginError(dispatch, error)
         return Promise.reject(error)
       })
@@ -276,15 +292,13 @@ export const login = (dispatch, firebase, credentials) => {
 
       // For token auth, the user key doesn't exist. Instead, return the JWT.
       if (method === 'signInWithCustomToken') {
-        // Extract the extra data in the JWT token for user object
-        const { stsTokenManager: { accessToken }, uid } = userData.toJSON()
-        const extraJWTData = omit(jwtDecode(accessToken), defaultJWTProps)
-
+        if (!firebase._.config.updateProfileOnLogin) {
+          return { user: userData }
+        }
         return createUserProfile(
           dispatch,
           firebase,
-          { uid },
-          { ...extraJWTData, uid }
+          userData
         )
       }
 

src/actions/query.js

@@ -47,15 +47,17 @@ export const watchEvent = (firebase, dispatch, { type, path, populates, queryPar
       .child(path)
       .orderByKey()
       .limitToFirst(1)
-      .once('value', snapshot => {
+      .once('value')
+      .then(snapshot => {
         if (snapshot.val() === null) {
           dispatch({
             type: NO_VALUE,
             path: storeAs || path
           })
         }
         return snapshot
-      }, (err) => {
+      })
+      .catch(err => {
         // TODO: Handle catching unauthorized error
         // dispatch({
         //   type: UNAUTHORIZED_ERROR,
@@ -95,7 +97,8 @@ export const watchEvent = (firebase, dispatch, { type, path, populates, queryPar
             })
           }
           return snapshot
-        }, (err) => {
+        })
+        .catch(err => {
           dispatch({
             type: UNAUTHORIZED_ERROR,
             payload: err