Merge pull request #75 from Expensify/marcaaron-reinitValuesOnClear

Make sure Onyx re-sets with default values when logging out and back in

Author: MariaHCD

lib/Onyx.js

@@ -24,6 +24,9 @@ let evictionAllowList = [];
 // long as we have at least one subscriber that returns false for the canEvict property.
 const evictionBlocklist = {};
 
+// Optional user-provided key value states set when Onyx initializes or clears
+let defaultKeyStates = {};
+
 /**
  * When a key change happens, search for any callbacks matching the regex pattern and trigger those callbacks
  * Get some data from the store
@@ -432,23 +435,6 @@ function multiSet(data) {
         .catch(error => evictStorageAndRetry(error, multiSet, data));
 }
 
-/**
- * Clear out all the data in the store
- *
- * @returns {Promise<void>}
- */
-function clear() {
-    let allKeys;
-    return AsyncStorage.getAllKeys()
-        .then(keys => allKeys = keys)
-        .then(() => AsyncStorage.clear())
-        .then(() => {
-            _.each(allKeys, (key) => {
-                keyChanged(key, null);
-            });
-        });
-}
-
 // Key/value store of Onyx key and arrays of values to merge
 const mergeQueue = {};
 
@@ -515,6 +501,32 @@ function merge(key, val) {
         });
 }
 
+/**
+ * Merge user provided default key value pairs.
+ */
+function initializeWithDefaultKeyStates() {
+    _.each(defaultKeyStates, (state, key) => merge(key, state));
+}
+
+/**
+ * Clear out all the data in the store
+ *
+ * @returns {Promise<void>}
+ */
+function clear() {
+    let allKeys;
+    return AsyncStorage.getAllKeys()
+        .then(keys => allKeys = keys)
+        .then(() => AsyncStorage.clear())
+        .then(() => {
+            _.each(allKeys, (key) => {
+                keyChanged(key, null);
+            });
+
+            initializeWithDefaultKeyStates();
+        });
+}
+
 /**
  * Merges a collection based on their keys
  *
@@ -584,12 +596,15 @@ function init({
     // Let Onyx know about all of our keys
     onyxKeys = keys;
 
+    // Set our default key states to use when initializing and clearing Onyx data
+    defaultKeyStates = initialKeyStates;
+
     // Let Onyx know about which keys are safe to evict
     evictionAllowList = safeEvictionKeys;
     addAllSafeEvictionKeysToRecentlyAccessedList();
 
     // Initialize all of our keys with data provided
-    _.each(initialKeyStates, (state, key) => merge(key, state));
+    initializeWithDefaultKeyStates();
 
     // Update any key whose value changes in storage
     registerStorageEventListener((key, newValue) => keyChanged(key, newValue));

tests/unit/onyxTest.js

@@ -3,6 +3,7 @@ import waitForPromisesToResolve from '../utils/waitForPromisesToResolve';
 
 const ONYX_KEYS = {
     TEST_KEY: 'test',
+    ANOTHER_TEST: 'anotherTest',
     COLLECTION: {
         TEST_KEY: 'test_',
     }
@@ -11,6 +12,9 @@ const ONYX_KEYS = {
 Onyx.init({
     keys: ONYX_KEYS,
     registerStorageEventListener: () => {},
+    initialKeyStates: {
+        [ONYX_KEYS.ANOTHER_TEST]: 42,
+    },
 });
 
 describe('Onyx', () => {
@@ -68,16 +72,28 @@ describe('Onyx', () => {
             initWithStoredValues: false,
             callback: (value) => {
                 testKeyValue = value;
-            }
+            },
         });
 
-        return Onyx.set(ONYX_KEYS.TEST_KEY, 'test')
+        let anotherTestValue;
+        const anotherTestConnectionID = Onyx.connect({
+            key: ONYX_KEYS.ANOTHER_TEST,
+            callback: (value) => {
+                anotherTestValue = value;
+            },
+        });
+
+        return waitForPromisesToResolve()
+            .then(() => Onyx.set(ONYX_KEYS.TEST_KEY, 'test'))
             .then(() => {
                 expect(testKeyValue).toBe('test');
-                return Onyx.clear();
+                expect(anotherTestValue).toBe(42);
+                return Onyx.clear().then(waitForPromisesToResolve);
             })
             .then(() => {
                 expect(testKeyValue).toBeNull();
+                expect(anotherTestValue).toBe(42);
+                return Onyx.disconnect(anotherTestConnectionID);
             });
     });