react-native-onyx 1.0.25 → 1.0.27

package/lib/Onyx.js

@@ -10,6 +10,14 @@ import createDeferredTask from './createDeferredTask';
 import fastMerge from './fastMerge';
 import * as PerformanceUtils from './metrics/PerformanceUtils';
 
+// Method constants
+const METHOD = {
+    SET: 'set',
+    MERGE: 'merge',
+    MERGE_COLLECTION: 'mergecollection',
+    CLEAR: 'clear',
+};
+
 // Keeps track of the last connectionID that was used so we can keep incrementing it
 let lastConnectionID = 0;
 
@@ -1046,6 +1054,11 @@ function clear() {
  * @returns {Promise}
  */
 function mergeCollection(collectionKey, collection) {
+    if (!_.isObject(collection) || _.isArray(collection) || _.isEmpty(collection)) {
+        Logger.logInfo('mergeCollection() called with invalid or empty value. Skipping this update.');
+        return Promise.resolve();
+    }
+
     // Confirm all the collection keys belong to the same parent
     _.each(collection, (_data, dataKey) => {
         if (isKeyMatch(collectionKey, dataKey)) {
@@ -1096,36 +1109,41 @@ function mergeCollection(collectionKey, collection) {
  * Insert API responses and lifecycle data into Onyx
  *
  * @param {Array} data An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection'), key: string, value: *}
+ * @returns {Promise} resolves when all operations are complete
  */
 function update(data) {
     // First, validate the Onyx object is in the format we expect
     _.each(data, ({onyxMethod, key}) => {
-        if (!_.contains(['clear', 'set', 'merge', 'mergecollection'], onyxMethod)) {
+        if (!_.contains([METHOD.CLEAR, METHOD.SET, METHOD.MERGE, METHOD.MERGE_COLLECTION], onyxMethod)) {
             throw new Error(`Invalid onyxMethod ${onyxMethod} in Onyx update.`);
         }
-        if (onyxMethod !== 'clear' && !_.isString(key)) {
+        if (onyxMethod !== METHOD.CLEAR && !_.isString(key)) {
             throw new Error(`Invalid ${typeof key} key provided in Onyx update. Onyx key must be of type string.`);
         }
     });
 
+    const promises = [];
+
     _.each(data, ({onyxMethod, key, value}) => {
         switch (onyxMethod) {
-            case 'set':
-                set(key, value);
+            case METHOD.SET:
+                promises.push(set(key, value));
                 break;
-            case 'merge':
-                merge(key, value);
+            case METHOD.MERGE:
+                promises.push(merge(key, value));
                 break;
-            case 'mergecollection':
-                mergeCollection(key, value);
+            case METHOD.MERGE_COLLECTION:
+                promises.push(mergeCollection(key, value));
                 break;
-            case 'clear':
-                clear();
+            case METHOD.CLEAR:
+                promises.push(clear());
                 break;
             default:
                 break;
         }
     });
+
+    return Promise.all(promises);
 }
 
 /**
@@ -1214,6 +1232,7 @@ const Onyx = {
     addToEvictionBlockList,
     removeFromEvictionBlockList,
     isSafeEvictionKey,
+    METHOD,
 };
 
 /**

package/lib/OnyxCache.js

@@ -111,6 +111,10 @@ class OnyxCache {
      * @param {Record<string, *>} data - a map of (cache) key - values
      */
     merge(data) {
+        if (!_.isObject(data) || _.isArray(data)) {
+            throw new Error('data passed to cache.merge() must be an Object of onyx key/value pairs');
+        }
+
         // lodash adds a small overhead so we don't use it here
         // eslint-disable-next-line prefer-object-spread, rulesdir/prefer-underscore-method
         this.storageMap = Object.assign({}, fastMerge(this.storageMap, data));

package/package.json

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