react-native-onyx 1.0.41 → 1.0.43

package/lib/Onyx.js

@@ -48,12 +48,13 @@ const deferredInitTask = createDeferredTask();
  * Uses a selector string or function to return a simplified version of sourceData
  * @param {Mixed} sourceData
  * @param {String|Function} selector
+ * @param {Object} [withOnyxInstanceState]
  *      If it's a string, the selector is passed to lodashGet on the sourceData
  *      If it's a function, it is passed the sourceData and it should return the simplified data
  * @returns {Mixed}
  */
-const getSubsetOfData = (sourceData, selector) => (_.isFunction(selector)
-    ? selector(sourceData)
+const getSubsetOfData = (sourceData, selector, withOnyxInstanceState) => (_.isFunction(selector)
+    ? selector(sourceData, withOnyxInstanceState)
     : lodashGet(sourceData, selector));
 
 /**
@@ -62,11 +63,12 @@ const getSubsetOfData = (sourceData, selector) => (_.isFunction(selector)
  * The resulting collection will only contain items that are returned by the selector.
  * @param {Object} collection
  * @param {String|Function} selector (see method docs for getSubsetOfData() for full details)
+ * @param {Object} [withOnyxInstanceState]
  * @returns {Object}
  */
-const reduceCollectionWithSelector = (collection, selector) => _.reduce(collection, (finalCollection, item, key) => {
+const reduceCollectionWithSelector = (collection, selector, withOnyxInstanceState) => _.reduce(collection, (finalCollection, item, key) => {
     // eslint-disable-next-line no-param-reassign
-    finalCollection[key] = getSubsetOfData(item, selector);
+    finalCollection[key] = getSubsetOfData(item, selector, withOnyxInstanceState);
 
     return finalCollection;
 }, {});
@@ -362,8 +364,8 @@ function keysChanged(collectionKey, partialCollection) {
                 // returned by the selector.
                 if (subscriber.selector) {
                     subscriber.withOnyxInstance.setState((prevState) => {
-                        const previousData = reduceCollectionWithSelector(prevState[subscriber.statePropertyName], subscriber.selector);
-                        const newData = reduceCollectionWithSelector(cachedCollection, subscriber.selector);
+                        const previousData = reduceCollectionWithSelector(prevState[subscriber.statePropertyName], subscriber.selector, subscriber.withOnyxInstance.state);
+                        const newData = reduceCollectionWithSelector(cachedCollection, subscriber.selector, subscriber.withOnyxInstance.state);
 
                         if (!deepEqual(previousData, newData)) {
                             return {
@@ -406,7 +408,7 @@ function keysChanged(collectionKey, partialCollection) {
                 if (subscriber.selector) {
                     subscriber.withOnyxInstance.setState((prevState) => {
                         const prevData = prevState[subscriber.statePropertyName];
-                        const newData = getSubsetOfData(cachedCollection[subscriber.key], subscriber.selector);
+                        const newData = getSubsetOfData(cachedCollection[subscriber.key], subscriber.selector, subscriber.withOnyxInstance.state);
                         if (!deepEqual(prevData, newData)) {
                             PerformanceUtils.logSetStateCall(subscriber, prevData, newData, 'keysChanged', collectionKey);
                             return {
@@ -488,11 +490,11 @@ function keyChanged(key, data, canUpdateSubscriber) {
                     subscriber.withOnyxInstance.setState((prevState) => {
                         const prevData = prevState[subscriber.statePropertyName];
                         const newData = {
-                            [key]: getSubsetOfData(data, subscriber.selector),
+                            [key]: getSubsetOfData(data, subscriber.selector, subscriber.withOnyxInstance.state),
                         };
                         const prevDataWithNewData = {
                             ...prevData,
-                            [key]: getSubsetOfData(data, subscriber.selector),
+                            [key]: getSubsetOfData(data, subscriber.selector, subscriber.withOnyxInstance.state),
                         };
                         if (!deepEqual(prevData, prevDataWithNewData)) {
                             PerformanceUtils.logSetStateCall(subscriber, prevData, newData, 'keyChanged', key);
@@ -523,8 +525,8 @@ function keyChanged(key, data, canUpdateSubscriber) {
             // returned by the selector and only if the selected data has changed.
             if (subscriber.selector) {
                 subscriber.withOnyxInstance.setState((prevState) => {
-                    const previousValue = getSubsetOfData(prevState[subscriber.statePropertyName], subscriber.selector);
-                    const newValue = getSubsetOfData(data, subscriber.selector);
+                    const previousValue = getSubsetOfData(prevState[subscriber.statePropertyName], subscriber.selector, subscriber.withOnyxInstance.state);
+                    const newValue = getSubsetOfData(data, subscriber.selector, subscriber.withOnyxInstance.state);
                     if (!deepEqual(previousValue, newValue)) {
                         return {
                             [subscriber.statePropertyName]: newValue,
@@ -582,9 +584,9 @@ function sendDataToConnection(mapping, val, matchedKey) {
         // returned by the selector.
         if (mapping.selector) {
             if (isCollectionKey(mapping.key)) {
-                newData = reduceCollectionWithSelector(val, mapping.selector);
+                newData = reduceCollectionWithSelector(val, mapping.selector, mapping.withOnyxInstance.state);
             } else {
-                newData = getSubsetOfData(val, mapping.selector);
+                newData = getSubsetOfData(val, mapping.selector, mapping.withOnyxInstance.state);
             }
         }
 
@@ -662,9 +664,10 @@ function getCollectionDataAndSendAsObject(matchingKeys, mapping) {
  *  component
  * @param {Boolean} [mapping.waitForCollectionCallback] If set to true, it will return the entire collection to the callback as a single object
  * @param {String|Function} [mapping.selector] THIS PARAM IS ONLY USED WITH withOnyx(). If included, this will be used to subscribe to a subset of an Onyx key's data.
- *       If the selector is a string, the selector is passed to lodashGet on the sourceData. If the selector is a function, the sourceData is passed to the selector and should return the
- *       simplified data. Using this setting on `withOnyx` can have very positive performance benefits because the component will only re-render when the subset of data changes.
- *       Otherwise, any change of data on any property would normally cause the component to re-render (and that can be expensive from a performance standpoint).
+ *       If the selector is a string, the selector is passed to lodashGet on the sourceData. If the selector is a function, the sourceData and withOnyx state are
+ *       passed to the selector and should return the simplified data. Using this setting on `withOnyx` can have very positive performance benefits because the component
+ *       will only re-render when the subset of data changes. Otherwise, any change of data on any property would normally cause the component to re-render (and that can
+ *       be expensive from a performance standpoint).
  * @returns {Number} an ID to use when calling disconnect
  */
 function connect(mapping) {
@@ -1189,27 +1192,28 @@ function update(data) {
     });
 
     const promises = [];
+    let clearPromise = Promise.resolve();
 
     _.each(data, ({onyxMethod, key, value}) => {
         switch (onyxMethod) {
             case METHOD.SET:
-                promises.push(set(key, value));
+                promises.push(() => set(key, value));
                 break;
             case METHOD.MERGE:
-                promises.push(merge(key, value));
+                promises.push(() => merge(key, value));
                 break;
             case METHOD.MERGE_COLLECTION:
-                promises.push(mergeCollection(key, value));
+                promises.push(() => mergeCollection(key, value));
                 break;
             case METHOD.CLEAR:
-                promises.push(clear());
+                clearPromise = clear();
                 break;
             default:
                 break;
         }
     });
 
-    return Promise.all(promises);
+    return clearPromise.then(() => Promise.all(_.map(promises, p => p())));
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "1.0.41",
+  "version": "1.0.43",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",