fix(core): add deprecation message enableLogging config option

Author: prescottprue

docs/api/constants.md

@@ -7,37 +7,33 @@ import { applyMiddleware, compose, createStore } from 'redux'
 import { browserHistory } from 'react-router'
 import makeRootReducer from './reducers'
 import createSagaMiddleware from 'redux-saga'
-import firebase from 'firebase/app';
-import 'firebase/database';
+import firebase from 'firebase/app'
+import 'firebase/database'
 
 const firebaseConfig = {} // firebase configuration including databaseURL
 const reduxFirebase = {
-  userProfile: 'users',
-  enableLogging: 'false'
+  userProfile: 'users'
 }
 
-firebase.initializeApp(firebaseConfig);
+firebase.initializeApp(firebaseConfig)
 
 function* helloSaga() {
   try {
     yield firebase.ref('/some/path').push({ nice: 'work!' })
-  } catch(err) {
+  } catch (err) {
     console.log('Error in saga!:', err)
   }
 }
 
 export default (initialState = {}, history) => {
-
   const sagaMiddleware = createSagaMiddleware() // create middleware
 
-  const middleware = [ sagaMiddleware ]
+  const middleware = [sagaMiddleware]
 
   const store = createStore(
     makeRootReducer(),
     {}, // initial state
-    compose(
-      applyMiddleware(...middleware)
-    )
+    compose(applyMiddleware(...middleware))
   )
 
   return store

docs/integrations/redux-saga.md

@@ -9,8 +9,7 @@ export const firebase = {
 
 export const rrfConfig = {
   userProfile: 'users',
-  useFirestoreForProfile: true, // Store in Firestore instead of Real Time DB
-  enableLogging: false
+  useFirestoreForProfile: true // Store in Firestore instead of Real Time DB
 }
 
 export default { firebase, rrfConfig }

examples/complete/firestore/src/config.js

@@ -9,8 +9,7 @@ export const firebase = {
 
 export const rrfConfig = {
   userProfile: 'users',
-  useFirestoreForProfile: true, // Store in Firestore instead of Real Time DB
-  enableLogging: false
+  useFirestoreForProfile: true // Store in Firestore instead of Real Time DB
 }
 
 export default { firebase, rrfConfig }

examples/complete/react-native/config.js

@@ -15,7 +15,6 @@ export default function configureStore(initialState, history) {
     reactReduxFirebase(firebase, {
       userProfile: 'users',
       useFirestoreForProfile: true, // Store in Firestore instead of Real Time DB
-      enableLogging: false
     })
   )(createStore)
 

examples/complete/react-native/store.js

@@ -9,8 +9,7 @@ export const firebase = {
 
 export const reduxFirebase = {
   userProfile: 'users',
-  useFirestoreForProfile: true,
-  enableLogging: false
+  useFirestoreForProfile: true
 }
 
 export default { firebase, reduxFirebase }

examples/complete/simple/src/config.js

@@ -9,8 +9,7 @@ export const firebase = {
 
 export const reduxFirebase = {
   userProfile: 'users',
-  useFirestoreForProfile: true,
-  enableLogging: false
+  useFirestoreForProfile: true
 }
 
 export default { firebase, reduxFirebase }

examples/complete/typescript/src/config.ts

@@ -8,7 +8,6 @@ export default function configureStore (initialState, history) {
     reactReduxFirebase(fbConfig,
       {
         userProfile: 'users',
-        enableLogging: false
       }
     ),
     typeof window === 'object' && typeof window.devToolsExtension !== 'undefined' ? window.devToolsExtension() : f => f

examples/snippets/webpack2/src/store.js

@@ -1087,6 +1087,9 @@ interface ReactReduxFirebaseConfig {
   dispatchOnUnsetListener: boolean
   dispatchRemoveAction: boolean
   enableEmptyAuthChanges: boolean
+  /**
+   * @deprecated
+   */ 
   enableLogging: boolean
   enableRedirectHandling: boolean
   firebaseStateName: string
@@ -1128,6 +1131,9 @@ interface ReactReduxFirebaseConfig {
  * @see https://github.com/prescottprue/redux-firestore#config-options
  */
 export interface ReduxFirestoreConfig {
+  /**
+   * @deprecated
+   */
   enableLogging: boolean
 
   helpersNamespace: string | null

index.d.ts

@@ -115,7 +115,7 @@ export const actionTypes = {
  * @property {string|Function} sessions - `sessions` Location on Firebase where user
  * sessions are stored (only if presense is set). Often set to `'sessions'` or
  * `'userSessions'`. If a function is passed, the arguments are: `(currentUser, firebase)`.
- * @property {boolean} enableLogging - `false` Whether or not firebase
+ * @property {boolean} enableLogging - `false` (*deprecated*) Whether or not firebase
  * database logging is enabled. Providing `true` turns on error logging
  * (enabled by itself through `logErrors`).
  * @property {boolean} logErrors - `true` Whether or not to log internal

src/constants.js

@@ -19,11 +19,18 @@ let firebaseInstance
 export default function createFirebaseInstance(firebase, configs, dispatch) {
   /* istanbul ignore next: Logging is external */
   // Enable Logging based on config (handling instances without i.e RNFirebase)
+  // NOTE: This will be removed in a future version
   if (
+    configs &&
     configs.enableLogging &&
     firebase.database &&
     typeof firebase.database.enableLogging === 'function'
   ) {
+    /* eslint-disable no-console */
+    console.warn(
+      'The enableLogging config option is disabled and will be removed in a future version of react-redux-firebase. Enable logging as part of instance initialization.'
+    )
+    /* eslint-enable no-console */
     firebase.database.enableLogging(configs.enableLogging)
   }