react-native-onyx 1.0.32 → 1.0.34

package/lib/Onyx.js

@@ -799,8 +799,7 @@ function notifyCollectionSubscribersOnNextTick(key, value) {
  * @return {Promise}
  */
 function remove(key) {
-    // Cache the fact that the value was removed
-    cache.set(key, null);
+    cache.drop(key);
     notifySubscribersOnNextTick(key, null);
     return Storage.removeItem(key);
 }
@@ -847,8 +846,9 @@ function evictStorageAndRetry(error, onyxMethod, ...args) {
  * @returns {Promise}
  */
 function set(key, value) {
-    // Logging properties only since values could be sensitive things we don't want to log
-    Logger.logInfo(`set() called for key: ${key}${_.isObject(value) ? ` properties: ${_.keys(value).join(',')}` : ''}`);
+    if (_.isNull(value)) {
+        return remove(key);
+    }
 
     // eslint-disable-next-line no-use-before-define
     if (hasPendingMergeForKey(key)) {
@@ -1050,6 +1050,10 @@ function clear(keysToPreserve = []) {
             const keyValuesToReset = [];
             const defaultKeys = _.keys(defaultKeyStates);
 
+            // Get all the values for the keys that need to be preserved. These key/value pairs will be set
+            // in Onyx after the database is cleared().
+            const keyValuesToPreserve = _.map(keysToPreserve, key => [key, cache.getValue(key)]);
+
             // 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)
@@ -1102,7 +1106,11 @@ function clear(keysToPreserve = []) {
                 notifyCollectionSubscribersOnNextTick(key, value);
             });
 
-            return Storage.multiSet(keyValuesToReset);
+            // Call clear() and make sure that the default key/values and the key/values from the parameter
+            // are preserved in storage. This makes sure to always leave storage in a state that contains
+            // all the default values and any additional values that we want to remain after the database is cleared.
+            return Storage.clear()
+                .then(() => Storage.multiSet([...defaultKeyValuePairs, ...keyValuesToPreserve]));
         });
 }
 
@@ -1294,6 +1302,7 @@ const Onyx = {
     mergeCollection,
     update,
     clear,
+    getAllKeys,
     init,
     registerLogger: Logger.registerLogger,
     addToEvictionBlockList,

package/lib/OnyxCache.js

@@ -104,6 +104,8 @@ class OnyxCache {
      */
     drop(key) {
         delete this.storageMap[key];
+        this.storageKeys.delete(key);
+        this.recentKeys.delete(key);
     }
 
     /**

package/lib/SyncQueue.js

@@ -21,6 +21,14 @@ export default class SyncQueue {
         this.run = run;
     }
 
+    /**
+     * Stop the queue from being processed and clear out any existing tasks
+     */
+    abort() {
+        this.queue = [];
+        this.isProcessing = false;
+    }
+
     process() {
         if (this.isProcessing || this.queue.length === 0) {
             return;

package/lib/storage/WebStorage.js

@@ -1,3 +1,8 @@
+/**
+ * This file is here to wrap LocalForage with a layer that provides data-changed events like the ones that exist
+ * when using LocalStorage APIs in the browser. These events are great because multiple tabs can listen for when
+ * data changes and then stay up-to-date with everything happening in Onyx.
+ */
 import _ from 'underscore';
 import Storage from './providers/LocalForage';
 
@@ -27,10 +32,23 @@ const webStorage = {
             .then(() => raiseStorageSyncEvent(key));
 
         // If we just call Storage.clear other tabs will have no idea which keys were available previously
-        // so that they can call keysChanged for them. That's why we iterate and remove keys one by one
-        this.clear = () => Storage.getAllKeys()
-            .then(keys => _.map(keys, key => this.removeItem(key)))
-            .then(tasks => Promise.all(tasks));
+        // so that they can call keysChanged for them. That's why we iterate over every key and raise a storage sync
+        // event for each one
+        this.clear = () => {
+            let allKeys;
+
+            // They keys must be retreived before storage is cleared or else the list of keys would be empty
+            return Storage.getAllKeys()
+                .then((keys) => {
+                    allKeys = keys;
+                })
+                .then(() => Storage.clear())
+                .then(() => {
+                    // Now that storage is cleared, the storage sync event can happen which is a more atomic action
+                    // for other browser tabs
+                    _.each(allKeys, raiseStorageSyncEvent);
+                });
+        };
 
         // This listener will only be triggered by events coming from other tabs
         global.addEventListener('storage', (event) => {

package/lib/storage/providers/AsyncStorage.js

@@ -74,7 +74,7 @@ const provider = {
     removeItem: AsyncStorage.removeItem,
 
     /**
-     * Clear absolutely everything from storage
+     * Clear everything from storage
      * @returns {Promise<void>}
      */
     clear: AsyncStorage.clear,

package/lib/storage/providers/LocalForage.js

@@ -75,10 +75,13 @@ const provider = {
     },
 
     /**
-     * Clear absolutely everything from storage
+     * Clear everything from storage and also stops the SyncQueue from adding anything more to storage
      * @returns {Promise<void>}
      */
-    clear: localforage.clear,
+    clear() {
+        this.setItemQueue.abort();
+        return localforage.clear();
+    },
 
     /**
      * Returns all keys available in storage

package/package.json

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