react-native-onyx 1.0.38 → 1.0.40

package/dist/web.development.js

@@ -1,13 +1,13 @@
 (function webpackUniversalModuleDefinition(root, factory) {
 	if(typeof exports === 'object' && typeof module === 'object')
-		module.exports = factory(require("underscore"), require("expensify-common/lib/str"), require("fast-equals"), require("lodash/get"), require("localforage"), require("lodash/transform"), require("react"));
+		module.exports = factory(require("underscore"), require("expensify-common/lib/str"), require("fast-equals"), require("lodash/get"), require("localforage"), require("localforage-removeitems"), require("lodash/transform"), require("react"));
 	else if(typeof define === 'function' && define.amd)
-		define(["underscore", "expensify-common/lib/str", "fast-equals", "lodash/get", "localforage", "lodash/transform", "react"], factory);
+		define(["underscore", "expensify-common/lib/str", "fast-equals", "lodash/get", "localforage", "localforage-removeitems", "lodash/transform", "react"], factory);
 	else if(typeof exports === 'object')
-		exports["react-native-onyx/web"] = factory(require("underscore"), require("expensify-common/lib/str"), require("fast-equals"), require("lodash/get"), require("localforage"), require("lodash/transform"), require("react"));
+		exports["react-native-onyx/web"] = factory(require("underscore"), require("expensify-common/lib/str"), require("fast-equals"), require("lodash/get"), require("localforage"), require("localforage-removeitems"), require("lodash/transform"), require("react"));
 	else
-		root["react-native-onyx/web"] = factory(root["underscore"], root["expensify-common/lib/str"], root["fast-equals"], root["lodash/get"], root["localforage"], root["lodash/transform"], root["react"]);
-})(self, (__WEBPACK_EXTERNAL_MODULE_underscore__, __WEBPACK_EXTERNAL_MODULE_expensify_common_lib_str__, __WEBPACK_EXTERNAL_MODULE_fast_equals__, __WEBPACK_EXTERNAL_MODULE_lodash_get__, __WEBPACK_EXTERNAL_MODULE_localforage__, __WEBPACK_EXTERNAL_MODULE_lodash_transform__, __WEBPACK_EXTERNAL_MODULE_react__) => {
+		root["react-native-onyx/web"] = factory(root["underscore"], root["expensify-common/lib/str"], root["fast-equals"], root["lodash/get"], root["localforage"], root["localforage-removeitems"], root["lodash/transform"], root["react"]);
+})(self, (__WEBPACK_EXTERNAL_MODULE_underscore__, __WEBPACK_EXTERNAL_MODULE_expensify_common_lib_str__, __WEBPACK_EXTERNAL_MODULE_fast_equals__, __WEBPACK_EXTERNAL_MODULE_lodash_get__, __WEBPACK_EXTERNAL_MODULE_localforage__, __WEBPACK_EXTERNAL_MODULE_localforage_removeitems__, __WEBPACK_EXTERNAL_MODULE_lodash_transform__, __WEBPACK_EXTERNAL_MODULE_react__) => {
 return /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
@@ -1132,55 +1132,46 @@ function initializeWithDefaultKeyStates() {
 function clear() {let keysToPreserve = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
   return getAllKeys().
   then((keys) => {
-    const keyValuesToReset = [];
-    const defaultKeys = underscore__WEBPACK_IMPORTED_MODULE_0___default().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 = underscore__WEBPACK_IMPORTED_MODULE_0___default().map(keysToPreserve, (key) => [key, _OnyxCache__WEBPACK_IMPORTED_MODULE_5__["default"].getValue(key)]);
+    const keysToBeClearedFromStorage = [];
+    const keyValuesToResetAsCollection = {};
+    const keyValuesToResetIndividually = {};
 
     // 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 = underscore__WEBPACK_IMPORTED_MODULE_0___default().difference(keys, keysToPreserve, defaultKeys);
-    keyValuesToReset.push(...underscore__WEBPACK_IMPORTED_MODULE_0___default().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 = underscore__WEBPACK_IMPORTED_MODULE_0___default().pairs(underscore__WEBPACK_IMPORTED_MODULE_0___default().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);
-
-    // We now have all the key/values that need to be reset, but we're not done yet!
-    // There will be two groups of key/values and they each need to be updated a little bit differently.
-    // Collection keys need to be notified differently than non collection keys
-    const keyValuesToResetAsCollection = {};
-    const keyValuesToResetIndividually = {};
-
-    // 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()
-    underscore__WEBPACK_IMPORTED_MODULE_0___default().each(keyValuesToReset, (keyValue) => {
-      const key = keyValue[0];
-      const value = keyValue[1];
-      _OnyxCache__WEBPACK_IMPORTED_MODULE_5__["default"].set(key, value);
-
-      const collectionKey = key.substring(0, key.indexOf('_') + 1);
-      if (collectionKey) {
-        if (!keyValuesToResetAsCollection[collectionKey]) {
-          keyValuesToResetAsCollection[collectionKey] = {};
+    underscore__WEBPACK_IMPORTED_MODULE_0___default().each(keys, (key) => {
+      const isKeyToPreserve = underscore__WEBPACK_IMPORTED_MODULE_0___default().contains(keysToPreserve, key);
+      const isDefaultKey = underscore__WEBPACK_IMPORTED_MODULE_0___default().has(defaultKeyStates, key);
+
+      // If the key is being removed or reset to default:
+      // 1. Update it in the cache
+      // 2. Figure out whether it is a collection key or not,
+      //      since collection key subscribers need to be updated differently
+      if (!isKeyToPreserve) {
+        const oldValue = _OnyxCache__WEBPACK_IMPORTED_MODULE_5__["default"].getValue(key);
+        const newValue = underscore__WEBPACK_IMPORTED_MODULE_0___default().get(defaultKeyStates, key, null);
+        if (newValue !== oldValue) {
+          _OnyxCache__WEBPACK_IMPORTED_MODULE_5__["default"].set(key, newValue);
+          const collectionKey = key.substring(0, key.indexOf('_') + 1);
+          if (collectionKey) {
+            if (!keyValuesToResetAsCollection[collectionKey]) {
+              keyValuesToResetAsCollection[collectionKey] = {};
+            }
+            keyValuesToResetAsCollection[collectionKey][key] = newValue;
+          } else {
+            keyValuesToResetIndividually[key] = newValue;
+          }
         }
-        keyValuesToResetAsCollection[collectionKey][key] = value;
+      }
+
+      if (isKeyToPreserve || isDefaultKey) {
         return;
       }
 
-      keyValuesToResetIndividually[key] = value;
+      // If it isn't preserved and doesn't have a default, we'll remove it
+      keysToBeClearedFromStorage.push(key);
     });
 
     // Notify the subscribers for each key/value group so they can receive the new values
@@ -1191,11 +1182,10 @@ function clear() {let keysToPreserve = arguments.length > 0 && arguments[0] !==
       notifyCollectionSubscribersOnNextTick(key, value);
     });
 
-    // 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__WEBPACK_IMPORTED_MODULE_6__["default"].clear().
-    then(() => _storage__WEBPACK_IMPORTED_MODULE_6__["default"].multiSet([...defaultKeyValuePairs, ...keyValuesToPreserve]));
+    const defaultKeyValuePairs = underscore__WEBPACK_IMPORTED_MODULE_0___default().pairs(underscore__WEBPACK_IMPORTED_MODULE_0___default().omit(defaultKeyStates, keysToPreserve));
+
+    // Remove only the items that we want cleared from storage, and reset others to default
+    return _storage__WEBPACK_IMPORTED_MODULE_6__["default"].removeItems(keysToBeClearedFromStorage).then(() => _storage__WEBPACK_IMPORTED_MODULE_6__["default"].multiSet(defaultKeyValuePairs));
   });
 }
 
@@ -1996,6 +1986,12 @@ function raiseStorageSyncEvent(onyxKey) {
   __webpack_require__.g.localStorage.removeItem(SYNC_ONYX, onyxKey);
 }
 
+function raiseStorageSyncManyKeysEvent(onyxKeys) {
+  underscore__WEBPACK_IMPORTED_MODULE_0___default().each(onyxKeys, (onyxKey) => {
+    raiseStorageSyncEvent(onyxKey);
+  });
+}
+
 const webStorage = {
   ..._providers_LocalForage__WEBPACK_IMPORTED_MODULE_1__["default"],
 
@@ -2010,6 +2006,9 @@ const webStorage = {
     this.removeItem = (key) => _providers_LocalForage__WEBPACK_IMPORTED_MODULE_1__["default"].removeItem(key).
     then(() => raiseStorageSyncEvent(key));
 
+    this.removeItems = (keys) => _providers_LocalForage__WEBPACK_IMPORTED_MODULE_1__["default"].removeItems(keys).
+    then(() => raiseStorageSyncManyKeysEvent(keys));
+
     // 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 over every key and raise a storage sync
     // event for each one
@@ -2080,8 +2079,10 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var localforage__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(localforage__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! underscore */ "underscore");
 /* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(underscore__WEBPACK_IMPORTED_MODULE_1__);
-/* harmony import */ var _SyncQueue__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ../../SyncQueue */ "./lib/SyncQueue.js");
-/* harmony import */ var _fastMerge__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ../../fastMerge */ "./lib/fastMerge.js");
+/* harmony import */ var localforage_removeitems__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! localforage-removeitems */ "localforage-removeitems");
+/* harmony import */ var localforage_removeitems__WEBPACK_IMPORTED_MODULE_2___default = /*#__PURE__*/__webpack_require__.n(localforage_removeitems__WEBPACK_IMPORTED_MODULE_2__);
+/* harmony import */ var _SyncQueue__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ../../SyncQueue */ "./lib/SyncQueue.js");
+/* harmony import */ var _fastMerge__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ../../fastMerge */ "./lib/fastMerge.js");
 /**
  * @file
  * The storage provider based on localforage allows us to store most anything in its
@@ -2093,6 +2094,9 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
+
+(0,localforage_removeitems__WEBPACK_IMPORTED_MODULE_2__.extendPrototype)((localforage__WEBPACK_IMPORTED_MODULE_0___default()));
+
 localforage__WEBPACK_IMPORTED_MODULE_0___default().config({
   name: 'OnyxDB'
 });
@@ -2103,7 +2107,7 @@ const provider = {
    * So, we are slowing this process down by waiting until one write is complete before moving on
    * to the next.
    */
-  setItemQueue: new _SyncQueue__WEBPACK_IMPORTED_MODULE_2__["default"]((_ref) => {let { key, value, shouldMerge } = _ref;
+  setItemQueue: new _SyncQueue__WEBPACK_IMPORTED_MODULE_3__["default"]((_ref) => {let { key, value, shouldMerge } = _ref;
     if (shouldMerge) {
       return localforage__WEBPACK_IMPORTED_MODULE_0___default().getItem(key).
       then((existingValue) => {
@@ -2111,7 +2115,7 @@ const provider = {
 
         // lodash adds a small overhead so we don't use it here
         // eslint-disable-next-line prefer-object-spread, rulesdir/prefer-underscore-method
-        ? Object.assign({}, (0,_fastMerge__WEBPACK_IMPORTED_MODULE_3__["default"])(existingValue, value)) :
+        ? Object.assign({}, (0,_fastMerge__WEBPACK_IMPORTED_MODULE_4__["default"])(existingValue, value)) :
         value;
         return localforage__WEBPACK_IMPORTED_MODULE_0___default().setItem(key, newValue);
       });
@@ -2187,6 +2191,16 @@ const provider = {
    */
   removeItem: (localforage__WEBPACK_IMPORTED_MODULE_0___default().removeItem),
 
+  /**
+   * Remove given keys and their values from storage
+   *
+   * @param {Array} keys
+   * @returns {Promise}
+   */
+  removeItems(keys) {
+    return localforage__WEBPACK_IMPORTED_MODULE_0___default().removeItems(keys);
+  },
+
   /**
    * Sets the value for a given key. The only requirement is that the value should be serializable to JSON string
    * @param {String} key
@@ -3531,6 +3545,17 @@ module.exports = __WEBPACK_EXTERNAL_MODULE_localforage__;
 
 /***/ }),
 
+/***/ "localforage-removeitems":
+/*!******************************************!*\
+  !*** external "localforage-removeitems" ***!
+  \******************************************/
+/***/ ((module) => {
+
+"use strict";
+module.exports = __WEBPACK_EXTERNAL_MODULE_localforage_removeitems__;
+
+/***/ }),
+
 /***/ "lodash/get":
 /*!*****************************!*\
   !*** external "lodash/get" ***!