v3.0.0-alpha.3 (#595)

* fix(firestoreConnect): remove remaining usage of old context pattern - #594 * fix(HOCs): add displayName to `firebaseConnect` and `firestoreConnect`
prescottprue · Dec 18, 2018 · 71dee92 · 71dee92
1 parent 1e96425
commit 71dee92
Show file tree

Hide file tree

Showing 12 changed files with 137 additions and 105 deletions.
diff --git a/.babelrc b/.babelrc
@@ -1,6 +1,6 @@
 {
   "presets": [
-    "minify",
+    ["minify", { "keepFnName": true }],
     "@babel/preset-react",
     ["@babel/env", {
       "targets": {

diff --git a/examples/complete/simple/src/Home.js b/examples/complete/simple/src/Home.js
@@ -12,42 +12,50 @@ import TodoItem from './TodoItem'
 import './App.css'
 import NewTodo from './NewTodo';
 
-const Home = ({ firebase, todos }) => (
-  <div className='App'>
-    <div className='App-header'>
-      <h2>react-redux-firebase demo</h2>
-      <img src={logo} className='App-logo' alt='logo' />
+function Home({ firebase, todos }) {
+  return (
+    <div className='App'>
+      <div className='App-header'>
+        <h2>react-redux-firebase demo</h2>
+        <img src={logo} className='App-logo' alt='logo' />
+      </div>
+      <div className='App-todos'>
+        <h4>
+          Loaded From
+          <span className='App-Url'>
+            <a href='https://redux-firebasev3.firebaseio.com/'>
+              redux-firebasev3.firebaseio.com
+            </a>
+          </span>
+        </h4>
+        <h4>Todos List</h4>
+        {
+          !isLoaded(todos)
+            ? 'Loading'
+            : isEmpty(todos)
+              ? 'Todo list is empty'
+              : todos.reverse().map(({ value: todo, key }, ind) => (
+                <TodoItem
+                  key={`${key}-${ind}`}
+                  id={key}
+                  {...todo}
+                />
+              ))
+        }
+        <NewTodo />
+      </div>
     </div>
-    <div className='App-todos'>
-      <h4>
-        Loaded From
-        <span className='App-Url'>
-          <a href='https://redux-firebasev3.firebaseio.com/'>
-            redux-firebasev3.firebaseio.com
-          </a>
-        </span>
-      </h4>
-      <h4>Todos List</h4>
-      {
-        !isLoaded(todos)
-          ? 'Loading'
-          : isEmpty(todos)
-            ? 'Todo list is empty'
-            : todos.reverse().map(({ value: todo, key }, ind) => (
-              <TodoItem
-                key={`${key}-${ind}`}
-                id={key}
-                {...todo}
-              />
-            ))
-      }
-      <NewTodo />
-    </div>
-  </div>
-)
+  )
+}
 
 Home.propTypes = {
-  // firebase: PropTypes.object.isRequired
+  firebase: PropTypes.object.isRequired
+}
+
+function mapStateToProps(state) {
+  return {
+    todos: state.firebase.ordered.todos
+  }
 }
 
 const enhance = compose(
@@ -57,11 +65,7 @@ const enhance = compose(
       queryParams: ['limitToLast=10']
     }
   ]),
-  connect(
-    ({ firebase }) => ({
-      todos: firebase.ordered.todos,
-    })
-  )
+  connect(mapStateToProps)
 )
 
 export default enhance(Home)
diff --git a/examples/complete/simple/src/TodoItem.js b/examples/complete/simple/src/TodoItem.js
@@ -21,9 +21,8 @@ const enhance = compose(
   })
 )
 
-const TodoItem = (props) => {
+function TodoItem(props) {
   const { deleteTodo, toggleDone, text, name, done } = props
-  console.log('props', props)
   return (
     <li className="Todo">
       <input

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-redux-firebase",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0-alpha.3",
   "description": "Redux integration for Firebase. Comes with a Higher Order Components for use with React.",
   "main": "lib/index.js",
   "module": "es/index.js",

diff --git a/src/ReactReduxFirebaseProvider.js b/src/ReactReduxFirebaseProvider.js
@@ -4,7 +4,7 @@ import createFirebaseInstance from './createFirebaseInstance'
 import ReactReduxFirebaseContext from './ReactReduxFirebaseContext'
 import ReduxFirestoreProvider from './ReduxFirestoreProvider'
 
-const ReactReduxFirebaseProvider = (props = {}) => {
+function ReactReduxFirebaseProvider(props = {}) {
   const {
     children,
     config,

diff --git a/src/ReduxFirestoreProvider.js b/src/ReduxFirestoreProvider.js
@@ -2,7 +2,7 @@ import React from 'react'
 import PropTypes from 'prop-types'
 import ReduxFirestoreContext from './ReduxFirestoreContext'
 
-const ReduxFirestoreProvider = (props = {}) => {
+function ReduxFirestoreProvider(props = {}) {
   const {
     children,
     config,

diff --git a/src/firebaseConnect.js b/src/firebaseConnect.js
@@ -3,7 +3,7 @@ import PropTypes from 'prop-types'
 import { isEqual, differenceWith } from 'lodash'
 import hoistStatics from 'hoist-non-react-statics'
 import { watchEvents, unWatchEvents } from './actions/query'
-import { getEventsFromInput, createCallable, getDisplayName } from './utils'
+import { getEventsFromInput, createCallable, wrapDisplayName } from './utils'
 import ReactReduxFirebaseContext from './ReactReduxFirebaseContext'
 
 /**
@@ -28,14 +28,17 @@ export const createFirebaseConnect = (storeKey = 'store') => (
   dataOrFn = []
 ) => WrappedComponent => {
   class FirebaseConnectWrapped extends Component {
-    static displayName = `FirebaseConnect(${getDisplayName(WrappedComponent)})`
+    static displayName = wrapDisplayName(
+      WrappedComponent,
+      'FirebaseConnectWrapped'
+    )
     static wrappedComponent = WrappedComponent
 
     firebaseEvents = []
     firebase = null
     prevData = null
 
-    componentWillMount() {
+    componentDidMount() {
       const { firebase, dispatch } = this.props
 
       // Allow function to be passed
@@ -87,7 +90,7 @@ export const createFirebaseConnect = (storeKey = 'store') => (
 
   FirebaseConnectWrapped.propTypes = {
     dispatch: PropTypes.func.isRequired,
-    firebase: PropTypes.object
+    firebase: PropTypes.object.isRequired
   }
 
   const HoistedComp = hoistStatics(FirebaseConnectWrapped, WrappedComponent)
@@ -104,9 +107,10 @@ export const createFirebaseConnect = (storeKey = 'store') => (
     </ReactReduxFirebaseContext.Consumer>
   )
 
-  FirebaseConnect.propTypes = {
-    dispatch: PropTypes.func.isRequired
-  }
+  FirebaseConnect.displayName = wrapDisplayName(
+    WrappedComponent,
+    'FirebaseConnect'
+  )
 
   return FirebaseConnect
 }

diff --git a/src/firestoreConnect.js b/src/firestoreConnect.js
@@ -16,7 +16,7 @@ import ReduxFirestoreContext from './ReduxFirestoreContext'
  * Firebase state (state.firebase)
  * @return {Function} - HOC that accepts a watchArray and wraps a component
  * @example <caption>Basic</caption>
- * // this.props.firebase set on App component as firebase object with helpers
+ * // props.firebase set on App component as firebase object with helpers
  * import { createFirestoreConnect } from 'react-redux-firebase'
  * // create firebase connect that uses another redux store
  * const firestoreConnect = createFirestoreConnect('anotherStore')
@@ -28,7 +28,10 @@ export const createFirestoreConnect = (storeKey = 'store') => (
 ) => WrappedComponent => {
   class FirestoreConnectWrapped extends Component {
     static wrappedComponent = WrappedComponent
-    static displayName = wrapDisplayName(WrappedComponent, 'FirestoreConnect')
+    static displayName = wrapDisplayName(
+      WrappedComponent,
+      'FirestoreConnectWrapped'
+    )
 
     prevData = null
 
@@ -37,20 +40,18 @@ export const createFirestoreConnect = (storeKey = 'store') => (
     }
 
     componentDidMount() {
-      const { firestore } = this.store
       if (this.firestoreIsEnabled) {
-        // Allow function to be passed
+        // Listener configs as object (handling function being passed)
         const inputAsFunc = createCallable(dataOrFn)
         this.prevData = inputAsFunc(this.props, this.props)
-
-        firestore.setListeners(this.prevData)
+        // Attach listeners based on listener config
+        this.props.firestore.setListeners(this.prevData)
       }
     }
 
-    componentDidUnmount() {
-      const { firestore } = this.store
+    componentWillUnmount() {
       if (this.firestoreIsEnabled && this.prevData) {
-        firestore.unsetListeners(this.prevData)
+        this.props.firestore.unsetListeners(this.prevData)
       }
     }
 
@@ -59,7 +60,7 @@ export const createFirestoreConnect = (storeKey = 'store') => (
       const inputAsFunc = createCallable(dataOrFn)
       const data = inputAsFunc(np, this.props)
 
-      // Handle changes to data
+      // Check for changes in the listener configs
       if (this.firestoreIsEnabled && !isEqual(data, this.prevData)) {
         const changes = this.getChanges(data, this.prevData)
 
@@ -86,7 +87,7 @@ export const createFirestoreConnect = (storeKey = 'store') => (
   }
 
   FirestoreConnectWrapped.propTypes = {
-    dispatch: PropTypes.func.isRequired,
+    dispatch: PropTypes.func,
     firebase: PropTypes.object,
     firestore: PropTypes.object
   }
@@ -98,6 +99,10 @@ export const createFirestoreConnect = (storeKey = 'store') => (
       {firestore => <HoistedComp firestore={firestore} {...props} />}
     </ReduxFirestoreContext.Consumer>
   )
+  FirestoreConnect.displayName = wrapDisplayName(
+    WrappedComponent,
+    'FirestoreConnect'
+  )
 
   FirestoreConnect.propTypes = {
     dispatch: PropTypes.func.isRequired
@@ -118,20 +123,18 @@ export const createFirestoreConnect = (storeKey = 'store') => (
  * is passed the current props and the firebase object.
  * @return {Function} - that accepts a component to wrap and returns the wrapped component
  * @example <caption>Basic</caption>
- * // this.props.firebase set on App component as firebase object with helpers
+ * // props.firebase set on App component as firebase object with helpers
  * import { firestoreConnect } from 'react-redux-firebase'
  * export default firestoreConnect()(SomeComponent)
  * @example <caption>Basic</caption>
  * import { connect } from 'react-redux'
  * import { firestoreConnect } from 'react-redux-firebase'
  *
- * // pass todos list from redux as this.props.todosList
+ * // pass todos list from redux as props.todosList
  * export default compose(
- *   firestoreConnect(['todos']), // sync todos collection from Firestore into redux
+ *   firestoreConnect(() => ['todos']), // sync todos collection from Firestore into redux
  *   connect((state) => ({
- *     todosList: state.firestore.data.todos,
- *     profile: state.firestore.profile, // pass profile data as this.props.profile
- *     auth: state.firestore.auth // pass auth data as this.props.auth
+ *     todosList: state.firestore.data.todos
  *   })
  * )(SomeComponent)
  */

diff --git a/src/utils/index.js b/src/utils/index.js
@@ -10,7 +10,7 @@ export function createCallable(f) {
   return isFunction(f) ? f : () => f
 }
 
-export function getDisplayName(Component) {
+function getDisplayName(Component) {
   if (typeof Component === 'string') {
     return Component
   }
@@ -22,6 +22,11 @@ export function getDisplayName(Component) {
   return Component.displayName || Component.name || 'Component'
 }
 
+/**
+ * Get provided react component's display name and wrap with with a passed name.
+ * @param {React.Component} BaseComponent - Component from which to get name to wrap
+ * @param {String} hocName - Name of wrapping hoc
+ */
 export function wrapDisplayName(BaseComponent, hocName) {
   return `${hocName}(${getDisplayName(BaseComponent)})`
 }

diff --git a/src/withFirebase.js b/src/withFirebase.js
@@ -15,7 +15,7 @@ import ReactReduxFirebaseContext from './ReactReduxFirebaseContext'
  * @return {Function} - Higher Order Component which accepts an array of
  * watchers config and wraps a React Component
  * @example <caption>Basic</caption>
- * // this.props.firebase set on App component as firebase object with helpers
+ * // props.firebase set on App component as firebase object with helpers
  * import { createWithFirebase } from 'react-redux-firebase'
  *
  * // create withFirebase that uses another redux store
@@ -68,28 +68,34 @@ export const createWithFirebase = (storeKey = 'store') => WrappedComponent => {
  * @example <caption>Basic</caption>
  * import { withFirebase } from 'react-redux-firebase'
  *
- * const AddData = ({ firebase: { push } }) =>
- *   <div>
- *     <button onClick={() => push('todos', { done: false, text: 'Sample' })}>
- *       Add Sample Todo
- *     </button>
- *   </div>
+ * function AddData({ firebase: { push } }) {
+ *   return (
+ *     <div>
+ *       <button onClick={() => push('todos', { done: false, text: 'Sample' })}>
+ *         Add Sample Todo
+ *       </button>
+ *     </div>
+ *   )
+ * }
  *
  * export default withFirebase(AddData)
  * @example <caption>Within HOC Composition</caption>
  * import { compose } from 'redux' // can also come from recompose
  * import { withHandlers } from 'recompose'
  * import { withFirebase } from 'react-redux-firebase'
  *
- * const AddTodo = ({ addTodo }) =>
- *   <div>
- *     <button onClick={addTodo}>
- *       Add Sample Todo
- *     </button>
- *   </div>
+ * function AddTodo({ addTodo }) {
+ *   return (
+ *     <div>
+ *       <button onClick={addTodo}>
+ *         Add Sample Todo
+ *       </button>
+ *     </div>
+ *   )
+ * }
  *
- * export default compose(
- *   withFirebase(AddTodo),
+ * const enhance = compose(
+ *   withFirebase,
  *   withHandlers({
  *     addTodo: props => () =>
  *        props.firestore.add(
@@ -98,5 +104,7 @@ export const createWithFirebase = (storeKey = 'store') => WrappedComponent => {
  *        )
  *   })
  * )
+ *
+ * export default enhance(AddTodo)
  */
 export default createWithFirebase()