react-native-onyx 1.0.98 → 1.0.100

package/lib/Onyx.js

@@ -1024,6 +1024,25 @@ function hasPendingMergeForKey(key) {
     return Boolean(mergeQueue[key]);
 }
 
+/**
+ * Removes a key from storage if the value is null.
+ * Otherwise removes all nested null values in objects and returns the object
+ * @param {String} key
+ * @param {Mixed} value
+ * @returns {Mixed} `null` if the key got removed completely, otherwise the value without null values
+ */
+function removeNullValues(key, value) {
+    if (_.isNull(value)) {
+        remove(key);
+        return null;
+    }
+
+    // We can remove all null values in an object by merging it with itself
+    // utils.fastMerge recursively goes through the object and removes all null values
+    // Passing two identical objects as source and target to fastMerge will not change it, but only remove the null values
+    return utils.removeNestedNullValues(value);
+}
+
 /**
  * Write a value to our store with the given key
  *
@@ -1033,28 +1052,28 @@ function hasPendingMergeForKey(key) {
  * @returns {Promise}
  */
 function set(key, value) {
-    if (_.isNull(value)) {
-        return remove(key);
+    const valueWithoutNull = removeNullValues(key, value);
+
+    if (valueWithoutNull === null) {
+        return Promise.resolve();
     }
 
     if (hasPendingMergeForKey(key)) {
         Logger.logAlert(`Onyx.set() called after Onyx.merge() for key: ${key}. It is recommended to use set() or merge() not both.`);
     }
 
-    const valueWithNullRemoved = utils.removeNullObjectValues(value);
-
-    const hasChanged = cache.hasValueChanged(key, valueWithNullRemoved);
+    const hasChanged = cache.hasValueChanged(key, valueWithoutNull);
 
     // This approach prioritizes fast UI changes without waiting for data to be stored in device storage.
-    const updatePromise = broadcastUpdate(key, valueWithNullRemoved, hasChanged, 'set');
+    const updatePromise = broadcastUpdate(key, valueWithoutNull, hasChanged, 'set');
 
     // If the value has not changed, calling Storage.setItem() would be redundant and a waste of performance, so return early instead.
     if (!hasChanged) {
         return updatePromise;
     }
 
-    return Storage.setItem(key, valueWithNullRemoved)
-        .catch(error => evictStorageAndRetry(error, set, key, valueWithNullRemoved))
+    return Storage.setItem(key, valueWithoutNull)
+        .catch(error => evictStorageAndRetry(error, set, key, valueWithoutNull))
         .then(() => updatePromise);
 }
 
@@ -1087,7 +1106,16 @@ function multiSet(data) {
         return scheduleSubscriberUpdate(key, val);
     });
 
-    return Storage.multiSet(keyValuePairs)
+    const keyValuePairsWithoutNull = _.filter(_.map(keyValuePairs, ([key, value]) => {
+        const valueWithoutNull = removeNullValues(key, value);
+
+        if (valueWithoutNull === null) {
+            return;
+        }
+        return [key, valueWithoutNull];
+    }), Boolean);
+
+    return Storage.multiSet(keyValuePairsWithoutNull)
         .catch(error => evictStorageAndRetry(error, multiSet, data))
         .then(() => Promise.all(updatePromises));
 }
@@ -1098,9 +1126,10 @@ function multiSet(data) {
  * @private
  * @param {*} existingValue
  * @param {Array<*>} changes Array of changes that should be applied to the existing value
+ * @param {Boolean} shouldRemoveNullObjectValues
  * @returns {*}
  */
-function applyMerge(existingValue, changes) {
+function applyMerge(existingValue, changes, shouldRemoveNullObjectValues) {
     const lastChange = _.last(changes);
 
     if (_.isArray(lastChange)) {
@@ -1109,7 +1138,7 @@ function applyMerge(existingValue, changes) {
 
     if (_.some(changes, _.isObject)) {
         // Object values are then merged one after the other
-        return _.reduce(changes, (modifiedData, change) => utils.fastMerge(modifiedData, change),
+        return _.reduce(changes, (modifiedData, change) => utils.fastMerge(modifiedData, change, shouldRemoveNullObjectValues),
             existingValue || {});
     }
 
@@ -1157,10 +1186,12 @@ function merge(key, changes) {
         .then((existingValue) => {
             try {
                 // We first only merge the changes, so we can provide these to the native implementation (SQLite uses only delta changes in "JSON_PATCH" to merge)
-                let batchedChanges = applyMerge(undefined, mergeQueue[key]);
+                // We don't want to remove null values from the "batchedChanges", because SQLite uses them to remove keys from storage natively.
+                let batchedChanges = applyMerge(undefined, mergeQueue[key], false);
 
                 if (_.isNull(batchedChanges)) {
-                    return remove(key);
+                    remove(key);
+                    return;
                 }
 
                 // The presence of a `null` in the merge queue instructs us to drop the existing value.
@@ -1172,15 +1203,16 @@ function merge(key, changes) {
                 delete mergeQueuePromise[key];
 
                 // After that we merge the batched changes with the existing value
-                const updatedValue = shouldOverwriteExistingValue ? batchedChanges : applyMerge(existingValue, [batchedChanges]);
-                const modifiedData = utils.removeNullObjectValues(updatedValue);
+                // We can remove null values from the "modifiedData", because "null" implicates that the user wants to remove a value from storage.
+                // The "modifiedData" will be directly "set" in storage instead of being merged
+                const modifiedData = shouldOverwriteExistingValue ? batchedChanges : applyMerge(existingValue, [batchedChanges], true);
 
                 // On native platforms we use SQLite which utilises JSON_PATCH to merge changes.
-                // JSON_PATCH generally removes top-level nullish values from the stored object.
-                // When there is no existing value though, SQLite will just insert the changes as a new value and thus the top-level nullish values won't be removed.
-                // Therefore we need to remove nullish values from the `batchedChanges` which are sent to the SQLite, if no existing value is present.
+                // JSON_PATCH generally removes null values from the stored object.
+                // When there is no existing value though, SQLite will just insert the changes as a new value and thus the null values won't be removed.
+                // Therefore we need to remove null values from the `batchedChanges` which are sent to the SQLite, if no existing value is present.
                 if (!existingValue) {
-                    batchedChanges = utils.removeNullObjectValues(batchedChanges);
+                    batchedChanges = applyMerge(undefined, [batchedChanges], true);
                 }
 
                 const hasChanged = cache.hasValueChanged(key, modifiedData);
@@ -1349,6 +1381,13 @@ function mergeCollection(collectionKey, collection) {
         .then((persistedKeys) => {
             // Split to keys that exist in storage and keys that don't
             const [existingKeys, newKeys] = _.chain(collection)
+                .pick((value, key) => {
+                    if (_.isNull(value)) {
+                        remove(key);
+                        return false;
+                    }
+                    return true;
+                })
                 .keys()
                 .partition(key => persistedKeys.includes(key))
                 .value();

package/lib/storage/__mocks__/index.js

@@ -26,8 +26,7 @@ const idbKeyvalMock = {
     multiMerge(pairs) {
         _.forEach(pairs, ([key, value]) => {
             const existingValue = storageMapInternal[key];
-            const newValue = _.isObject(existingValue)
-                ? utils.fastMerge(existingValue, value) : value;
+            const newValue = utils.fastMerge(existingValue, value);
 
             set(key, newValue);
         });

package/lib/storage/providers/IDBKeyVal.js

@@ -44,6 +44,7 @@ const provider = {
     /**
      * Multiple merging of existing and new values in a batch
      * @param {Array<[key, value]>} pairs
+     * This function also removes all nested null values from an object.
      * @return {Promise<void>}
      */
     multiMerge: pairs => getCustomStore()('readwrite', (store) => {
@@ -55,8 +56,8 @@ const provider = {
         return getValues.then((values) => {
             const upsertMany = _.map(pairs, ([key, value], index) => {
                 const prev = values[index];
-                const newValue = _.isObject(prev) ? utils.fastMerge(prev, value) : value;
-                return promisifyRequest(store.put(utils.removeNullObjectValues(newValue), key));
+                const newValue = utils.fastMerge(prev, value);
+                return promisifyRequest(store.put(newValue, key));
             });
             return Promise.all(upsertMany);
         });

package/lib/utils.js

@@ -1,4 +1,4 @@
-import * as _ from 'underscore';
+import _ from 'underscore';
 
 function areObjectsEmpty(a, b) {
     return (
@@ -18,16 +18,19 @@ function areObjectsEmpty(a, b) {
 function isMergeableObject(val) {
     const nonNullObject = val != null ? typeof val === 'object' : false;
     return (nonNullObject
-  && Object.prototype.toString.call(val) !== '[object RegExp]'
-  && Object.prototype.toString.call(val) !== '[object Date]');
+        && Object.prototype.toString.call(val) !== '[object RegExp]'
+        && Object.prototype.toString.call(val) !== '[object Date]')
+        // eslint-disable-next-line rulesdir/prefer-underscore-method
+        && !Array.isArray(val);
 }
 
 /**
 * @param {Object} target
 * @param {Object} source
+* @param {Boolean} shouldRemoveNullObjectValues
 * @returns {Object}
 */
-function mergeObject(target, source) {
+function mergeObject(target, source, shouldRemoveNullObjectValues = true) {
     const destination = {};
     if (isMergeableObject(target)) {
         // lodash adds a small overhead so we don't use it here
@@ -35,7 +38,14 @@ function mergeObject(target, source) {
         const targetKeys = Object.keys(target);
         for (let i = 0; i < targetKeys.length; ++i) {
             const key = targetKeys[i];
-            destination[key] = target[key];
+
+            // If shouldRemoveNullObjectValues is true, we want to remove null values from the merged object
+            const isSourceOrTargetNull = target[key] === null || source[key] === null;
+            const shouldOmitSourceKey = shouldRemoveNullObjectValues && isSourceOrTargetNull;
+
+            if (!shouldOmitSourceKey) {
+                destination[key] = target[key];
+            }
         }
     }
 
@@ -44,15 +54,24 @@ function mergeObject(target, source) {
     const sourceKeys = Object.keys(source);
     for (let i = 0; i < sourceKeys.length; ++i) {
         const key = sourceKeys[i];
-        if (source[key] === undefined) {
-            // eslint-disable-next-line no-continue
-            continue;
-        }
-        if (!isMergeableObject(source[key]) || !target[key]) {
-            destination[key] = source[key];
-        } else {
-            // eslint-disable-next-line no-use-before-define
-            destination[key] = fastMerge(target[key], source[key]);
+
+        // If shouldRemoveNullObjectValues is true, we want to remove null values from the merged object
+        const shouldOmitSourceKey = shouldRemoveNullObjectValues && source[key] === null;
+
+        // If we pass undefined as the updated value for a key, we want to generally ignore it
+        const isSourceKeyUndefined = source[key] === undefined;
+
+        if (!isSourceKeyUndefined && !shouldOmitSourceKey) {
+            const isSourceKeyMergable = isMergeableObject(source[key]);
+
+            if (isSourceKeyMergable && target[key]) {
+                if ((!shouldRemoveNullObjectValues || isSourceKeyMergable)) {
+                    // eslint-disable-next-line no-use-before-define
+                    destination[key] = fastMerge(target[key], source[key], shouldRemoveNullObjectValues);
+                }
+            } else if (!shouldRemoveNullObjectValues || source[key] !== null) {
+                destination[key] = source[key];
+            }
         }
     }
 
@@ -60,39 +79,33 @@ function mergeObject(target, source) {
 }
 
 /**
+ * Merges two objects and removes null values if "shouldRemoveNullObjectValues" is set to true
+ *
+ * We generally want to remove null values from objects written to disk and cache, because it decreases the amount of data stored in memory and on disk.
+ * On native, when merging an existing value with new changes, SQLite will use JSON_PATCH, which removes top-level nullish values.
+ * To be consistent with the behaviour for merge, we'll also want to remove null values for "set" operations.
+ *
 * @param {Object|Array} target
 * @param {Object|Array} source
+* @param {Boolean} shouldRemoveNullObjectValues
 * @returns {Object|Array}
 */
-function fastMerge(target, source) {
+function fastMerge(target, source, shouldRemoveNullObjectValues = true) {
     // We have to ignore arrays and nullish values here,
     // otherwise "mergeObject" will throw an error,
     // because it expects an object as "source"
-    if (_.isArray(source) || _.isNull(source) || _.isUndefined(source)) {
+    if (_.isArray(source) || source === null || source === undefined) {
         return source;
     }
-    return mergeObject(target, source);
+    return mergeObject(target, source, shouldRemoveNullObjectValues);
 }
 
-/**
- * We generally want to remove top-level nullish values from objects written to disk and cache, because it decreases the amount of data stored in memory and on disk.
- * On native, when merging an existing value with new changes, SQLite will use  JSON_PATCH, which removes top-level nullish values.
- * To be consistent with the behaviour for merge, we'll also want to remove nullish values for "set" operations.
- * On web, IndexedDB will keep the top-level keys along with a null value and this uses up storage and memory.
- * This method will ensure that keys for null values are removed before an object is written to disk and cache so that all platforms are storing the data in the same efficient way.
- * @private
- * @param {*} value
- * @returns {*}
- */
-function removeNullObjectValues(value) {
-    if (_.isArray(value) || !_.isObject(value)) {
-        return value;
+function removeNestedNullValues(value) {
+    if (typeof value === 'object' && !_.isArray(value)) {
+        return fastMerge(value, value);
     }
 
-    const objectWithoutNullObjectValues = _.omit(value, objectValue => _.isNull(objectValue));
-
-    return objectWithoutNullObjectValues;
+    return value;
 }
 
-export default {removeNullObjectValues, areObjectsEmpty, fastMerge};
-
+export default {areObjectsEmpty, fastMerge, removeNestedNullValues};

package/package.json

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