react-native-onyx 1.0.28 → 1.0.30

package/lib/Onyx.js

@@ -661,7 +661,10 @@ function getCollectionDataAndSendAsObject(matchingKeys, mapping) {
  * @param {Boolean} [mapping.initWithStoredValues] If set to false, then no data will be prefilled into the
  *  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).
+ * @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).
  * @returns {Number} an ID to use when calling disconnect
  */
 function connect(mapping) {
@@ -1025,17 +1028,37 @@ function initializeWithDefaultKeyStates() {
  * Storage.setItem() from Onyx.clear() will have already finished and the merged
  * value will be saved to storage after the default value.
  *
+ * @param {Array} keysToPreserve is a list of ONYXKEYS that should not be cleared with the rest of the data
  * @returns {Promise<void>}
  */
-function clear() {
+function clear(keysToPreserve = []) {
     return getAllKeys()
         .then((keys) => {
-            _.each(keys, (key) => {
-                const resetValue = lodashGet(defaultKeyStates, key, null);
-                cache.set(key, resetValue);
-                notifySubscribersOnNextTick(key, resetValue);
+            const keyValuesToReset = [];
+            const defaultKeys = _.keys(defaultKeyStates);
+
+            // The only keys that should not be cleared are:
+            // 1. Anything specifically passed in keysToPreserve (because some keys like language preferences, offline status, or activeClients need to remain in Onyx even when signed out)
+            // 2. Any keys with a default state (because they need to remain in Onyx as their default, and setting them to null would cause unknown behavior)
+            const keysToClear = _.difference(keys, keysToPreserve, defaultKeys);
+            keyValuesToReset.push(..._.map(keysToClear, key => [key, null]));
+
+            // Remove any keysToPreserve from the defaultKeyStates because if they are passed in it has been explicitly called out to preserve those values instead of resetting them back
+            // to the default.
+            const defaultKeyValuePairs = _.pairs(_.omit(defaultKeyStates, ...keysToPreserve));
+
+            // Add the default key value pairs to the keyValuesToReset so that they get set back to their default values when we clear Onyx
+            keyValuesToReset.push(...defaultKeyValuePairs);
+
+            // Make sure that we also reset the cache values before clearing the values from storage.
+            // We do this before clearing Storage so that any call to clear() followed by merge() on a key with a default state results in the merged value getting saved, since the update
+            // from the merge() call would happen on the tick after the update from this clear()
+            _.each(keyValuesToReset, (keyValue) => {
+                cache.set(keyValue[0], keyValue[1]);
+                notifySubscribersOnNextTick(keyValue[0], keyValue[1]);
             });
-            return Storage.clear();
+
+            return Storage.multiSet(keyValuesToReset);
         });
 }
 

package/lib/metrics/index.web.js

@@ -1,6 +1,6 @@
 // For web-only implementations of Onyx, this module will just be a no-op
 
-function decorateWithMetrics() {}
+function decorateWithMetrics(func) { return func; }
 function getMetrics() {}
 function printMetrics() {}
 function resetMetrics() {}

package/package.json

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