-
-
Notifications
You must be signed in to change notification settings - Fork 553
Adds various features to populates #132
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Hmm, the test suite passes for me locally, will have a look later this afternoon. |
Codecov Report
@@ Coverage Diff @@
## v1.5.0 #132 +/- ##
=========================================
Coverage ? 89.03%
=========================================
Files ? 17
Lines ? 1413
Branches ? 229
=========================================
Hits ? 1258
Misses ? 155
Partials ? 0 |
|
These are awesome additions to populate! Going to test it out today, and look into when this should be merged. |
|
These features have been added to the roadmap for Going to mere into |
| requested: true | ||
| }) | ||
| }) | ||
| dispatch({ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This got moved to the dispatch after the populate children dispatches (keeps isLoaded from being true before all children are set to redux)
### Description * Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * Adds multiple features to populate - #132 * Uses `prop-types` instead of importing from react - #122 * `distpatchOnUnsetListener` fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * Do not include `dbPath` in response from `deleteFile` method if it is undefined (test added to check this case) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * Unnessesary global eslint comments removed from tests (no longer needed due to globals being moved to `.eslintrc`) * `enableEmptyAuthChanges` config option added - #137 ### Check List - [X] All tests passing - [X] Docs updated with any changes or examples - [X] Added tests to ensure feature(s) work properly ### Relevant Issues * [#122](https://github.com/prescottprue/react-redux-firebase/issues/#122) * [#132](https://github.com/prescottprue/react-redux-firebase/issues/#132) * [#137](https://github.com/prescottprue/react-redux-firebase/issues/#137)
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 ### Breaking Changes * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 ### Core * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 ### Build * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance ### Docs * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
Description
Adds various features supporting
populatesthat we found to be missing for our use-case. I've ensured the tests pass and functionally everything appears to work. We could consider splitting this PR up if some features are deemed undesired for merge.populates.child, e.g.this.is.a.nested.prop. This was added to support populating on ids that may be nested arbitrarily in the top level object and primarily required changing direct JS prop accessorsfoo[bar], foo.barto_.get(foo, bar)rootpath, or to only populate items passing a test when querying for a list.storeAswhenpopulatesis configured to continue working around bug(populates): populates clears all data at root #130 - is there a reason why this shouldn't work?Check List