Version v1.1.1

* errors now dispatched for all query `.catch` methods
* includes authProvider bug fix in #11
* Provider name validity checking (only Google, Twitter, Facebook, and Github)
* Tests + Coverage improved with spies using `sinon` and `sinon-chai`

Author: prescottprue

README.md

@@ -26,8 +26,8 @@ View deployed version of Material Example [here](https://redux-firebasev3.fireba
 - queries support ( `orderByChild`, `orderByKey`, `orderByValue`, `orderByPriority`, `limitToLast`, `limitToFirst`, `startAt`, `endAt`, `equalTo` right now )
 - Automatic binding/unbinding
 - Declarative decorator syntax for React components
-- [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [redux-observable](https://redux-observable.js.org/) integrations
-- Action Types and other Constants exported for external use (such as in redux-observable)
+- [`redux-thunk`](https://github.com/gaearon/redux-thunk) and [`redux-observable`](https://redux-observable.js.org/) integrations
+- Action Types and other Constants exported for external use (such as in `redux-observable`)
 - Firebase v3+ support
 
 ## Install

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-redux-firebase",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Redux integration for Firebase. Comes with a Higher Order Component for use with React.",
   "main": "dist/index.js",
   "module": "src/index.js",
@@ -61,6 +61,7 @@
     "babel-preset-react": "^6.16.0",
     "babel-preset-stage-1": "^6.16.0",
     "chai": "^3.5.0",
+    "chai-as-promised": "^6.0.0",
     "codecov": "^1.0.1",
     "eslint": "^3.10.2",
     "eslint-config-standard": "^6.2.1",
@@ -74,7 +75,9 @@
     "mocha": "^3.1.2",
     "react-addons-test-utils": "^15.4.0",
     "react-dom": "^15.4.0",
-    "rimraf": "^2.5.4"
+    "rimraf": "^2.5.4",
+    "sinon": "^1.17.6",
+    "sinon-chai": "^2.8.0"
   },
   "license": "MIT",
   "repository": {

src/actions/query.js

@@ -1,67 +1,13 @@
 import { actionTypes } from '../constants'
 import { promisesForPopulate } from '../utils/populate'
-import { getQueryIdFromPath, applyParamsToQuery } from '../utils/query'
+import {
+  applyParamsToQuery,
+  getWatcherCount,
+  setWatcher,
+  unsetWatcher
+} from '../utils/query'
 
-const { SET, NO_VALUE } = actionTypes
-
-const getWatchPath = (event, path) =>
-  `${event}:${((path.substring(0, 1) === '/') ? '' : '/')}${path}`
-
-/**
- * @description Set a new watcher
- * @param {Object} firebase - Internal firebase object
- * @param {String} event - Type of event to watch for
- * @param {String} path - Path to watch with watcher
- * @param {String} queryId - Id of query
- */
-const setWatcher = (firebase, event, path, queryId = undefined) => {
-  const id = queryId ? `${event}:/${queryId}` : getWatchPath(event, path)
-
-  if (firebase._.watchers[id]) {
-    firebase._.watchers[id]++
-  } else {
-    firebase._.watchers[id] = 1
-  }
-
-  return firebase._.watchers[id]
-}
-
-/**
- * @description Get count of currently attached watchers
- * @param {Object} firebase - Internal firebase object
- * @param {String} event - Type of event to watch for
- * @param {String} path - Path to watch with watcher
- * @param {String} queryId - Id of query
- */
-const getWatcherCount = (firebase, event, path, queryId = undefined) => {
-  const id = queryId ? `${event}:/${queryId}` : getWatchPath(event, path)
-  return firebase._.watchers[id]
-}
-
-/**
- * @description Remove/Unset a watcher
- * @param {Object} firebase - Internal firebase object
- * @param {String} event - Type of event to watch for
- * @param {String} path - Path to watch with watcher
- * @param {String} queryId - Id of query
- */
-const unsetWatcher = (firebase, event, path, queryId = undefined) => {
-  let id = queryId || getQueryIdFromPath(path)
-  path = path.split('#')[0]
-
-  if (!id) {
-    id = getWatchPath(event, path)
-  }
-
-  if (firebase._.watchers[id] <= 1) {
-    delete firebase._.watchers[id]
-    if (event !== 'first_child') {
-      firebase.database().ref().child(path).off(event)
-    }
-  } else if (firebase._.watchers[id]) {
-    firebase._.watchers[id]--
-  }
-}
+const { SET, NO_VALUE, ERROR } = actionTypes
 
 /**
  * @description Watch a specific event type
@@ -102,6 +48,12 @@ export const watchEvent = (firebase, dispatch, { type, path, populates, queryPar
             path
           })
         }
+        return snapshot
+      }, (err) => {
+        dispatch({
+          type: ERROR,
+          payload: err
+        })
       })
   }
 
@@ -115,16 +67,25 @@ export const watchEvent = (firebase, dispatch, { type, path, populates, queryPar
     // Handle once queries
     if (e === 'once') {
       return q.once('value')
-        .then(snapshot =>
+        .then(snapshot => {
+          if (snapshot.val() !== null) {
+            dispatch({
+              type: SET,
+              path,
+              data: snapshot.val()
+            })
+          }
+          return snapshot
+        }, (err) => {
           dispatch({
-            type: SET,
-            path,
-            data: snapshot.val()
+            type: ERROR,
+            payload: err
           })
-        )
+        })
     }
     // Handle all other queries
-    // TODO: Handle onError of query (i.e. security errors)
+
+    /* istanbul ignore next: is run by tests but doesn't show in coverage */
     q.on(e, snapshot => {
       let data = (e === 'child_removed') ? undefined : snapshot.val()
       const resultPath = dest || (e === 'value') ? p : `${p}/${snapshot.key}`
@@ -156,10 +117,15 @@ export const watchEvent = (firebase, dispatch, { type, path, populates, queryPar
             data: list
           })
         })
+    }, (err) => {
+      dispatch({
+        type: ERROR,
+        payload: err
+      })
     })
   }
 
-  runQuery(query, type, path, queryParams)
+  return runQuery(query, type, path, queryParams)
 }
 
 /**

src/constants.js

@@ -20,17 +20,28 @@ export const actionTypes = {
   LOGIN_ERROR: `${prefix}LOGIN_ERROR`,
   NO_VALUE: `${prefix}NO_VALUE`,
   UNAUTHORIZED_ERROR: `${prefix}UNAUTHORIZED_ERROR`,
+  ERROR: `${prefix}ERROR`,
   INIT_BY_PATH: `${prefix}INIT_BY_PATH`,
   AUTHENTICATION_INIT_STARTED: `${prefix}AUTHENTICATION_INIT_STARTED`,
   AUTHENTICATION_INIT_FINISHED: `${prefix}AUTHENTICATION_INIT_FINISHED`
 }
 
+// List of all external auth providers that are supported (firebase's email/anonymous included by default)
+export const supportedAuthProviders = [
+  'google',
+  'github',
+  'twitter',
+  'facebook'
+]
+
 export default {
   defaultJWTKeys,
-  actionTypes
+  actionTypes,
+  supportedAuthProviders
 }
 
 module.exports = {
   defaultJWTKeys,
-  actionTypes
+  actionTypes,
+  supportedAuthProviders
 }

src/utils/auth.js

@@ -1,8 +1,17 @@
 import { capitalize, isArray, isString } from 'lodash'
-
+import { supportedAuthProviders } from '../constants'
+/**
+ * @description Get correct login method and params order based on provided credentials
+ * @param {Object} firebase - Internal firebase object
+ * @param {String} providerName - Name of Auth Provider (i.e. google, github, facebook, twitter)
+ * @param {Array|String} scopes - List of scopes to add to auth provider
+ */
 export const createAuthProvider = (firebase, providerName, scopes) => {
-  // TODO: Verify provider
   // TODO: Verify scopes are valid before adding
+  // Verify providerName is valid
+  if (supportedAuthProviders.indexOf(providerName.toLowerCase()) === -1) {
+    throw new Error(`${providerName} is not a valid Auth Provider`)
+  }
   const provider = new firebase.auth[`${capitalize(providerName)}AuthProvider`]()
   provider.addScope('email')
   if (scopes) {
@@ -20,12 +29,14 @@ export const createAuthProvider = (firebase, providerName, scopes) => {
 
 /**
  * @description Get correct login method and params order based on provided credentials
+ * @param {Object} firebase - Internal firebase object
  * @param {Object} credentials - Login credentials
  * @param {String} credentials.email - Email to login with (only needed for email login)
  * @param {String} credentials.password - Password to login with (only needed for email login)
  * @param {String} credentials.provider - Provider name such as google, twitter (only needed for 3rd party provider login)
  * @param {String} credentials.type - Popup or redirect (only needed for 3rd party provider login)
  * @param {String} credentials.token - Custom or provider token
+ * @param {String} credentials.scopes - Scopes to add to provider (i.e. email)
  */
 export const getLoginMethodAndParams = (firebase, {email, password, provider, type, token, scopes}) => {
   if (provider) {

src/utils/index.js

@@ -1,5 +1,4 @@
 import { isFunction } from 'lodash'
-import { promisesForPopulate } from './populate'
 import { getEventsFromInput } from './events'
 
 /**
@@ -9,12 +8,10 @@ import { getEventsFromInput } from './events'
 export const createCallable = f => isFunction(f) ? f : () => f
 
 export {
-  promisesForPopulate,
   getEventsFromInput
 }
 
 export default {
   createCallable,
-  promisesForPopulate,
   getEventsFromInput
 }

src/utils/populate.js

@@ -57,49 +57,49 @@ export const getPopulateChild = (firebase, populate, id) =>
  * @param {Object} populateString - String containg population data
  */
 export const promisesForPopulate = (firebase, originalData, populates) => {
-  // TODO: Handle multiple populates
-  // TODO: Handle single object based populates
   // TODO: Handle selecting of parameter to populate with (i.e. displayName of users/user)
-  const firstPopulate = populates[0]
-  // Loop over each object in list
   let promisesArray = []
-  forEach(originalData, (d, key) => {
-    // TODO: Handle input of [] within child (notating parameter for whole list)
-    // Get value of parameter to be populated (key or list of keys)
-    const idOrList = get(d, `${firstPopulate.child}`)
+  // Loop over all populates
+  forEach(populates, (p) =>
+    // Loop over each object in list
+    forEach(originalData, (d, key) => {
+      // TODO: Handle input of [] within child (notating parameter for whole list)
+      // Get value of parameter to be populated (key or list of keys)
+      const idOrList = get(d, `${p.child}`)
 
-    // Parameter/child to be populated does not exist
-    if (!idOrList) {
-      return
-    }
+      // Parameter/child to be populated does not exist
+      if (!idOrList) {
+        return
+      }
 
-    // Parameter is single ID
-    if (isString(idOrList)) {
-      return promisesArray.push(
-        getPopulateChild(firebase, firstPopulate, idOrList)
-        .then((v) =>
-          // replace parameter with loaded object
-          set(originalData, `${key}.${firstPopulate.child}`, v)
+      // Parameter is single ID
+      if (isString(idOrList)) {
+        return promisesArray.push(
+          getPopulateChild(firebase, p, idOrList)
+          .then((v) =>
+            // replace parameter with loaded object
+            set(originalData, `${key}.${p.child}`, v)
+          )
         )
-      )
-    }
+      }
 
-    // Parameter is a list of ids
-    if (isArray(idOrList)) {
-      // Create single promise that includes a promise for each child
-      return promisesArray.push(
-        Promise.all(
-          map(idOrList, (id) =>
-            getPopulateChild(firebase, firstPopulate, id)
+      // Parameter is a list of ids
+      if (isArray(idOrList)) {
+        // Create single promise that includes a promise for each child
+        return promisesArray.push(
+          Promise.all(
+            map(idOrList, (id) =>
+              getPopulateChild(firebase, p, id)
+            )
+          )
+          // replace parameter with populated list
+          .then((v) =>
+            set(originalData, `${key}.${p.child}`, v)
           )
         )
-        // replace parameter with populated list
-        .then((v) =>
-          set(originalData, `${key}.${firstPopulate.child}`, v)
-        )
-      )
-    }
-  })
+      }
+    })
+  )
 
   // Return original data after population promises run
   return Promise.all(promisesArray).then(d => originalData)