react-native-onyx 1.0.75 → 1.0.77

package/API.md

@@ -319,7 +319,6 @@ Initialize the store with actions and listening for storage events
 | [options.captureMetrics] | <code>Boolean</code> |  | Enables Onyx benchmarking and exposes the get/print/reset functions |
 | [options.shouldSyncMultipleInstances] | <code>Boolean</code> |  | Auto synchronize storage events between multiple instances of Onyx running in different tabs/windows. Defaults to true for platforms that support local storage (web/desktop) |
 | [options.debugSetState] | <code>Boolean</code> |  | Enables debugging setState() calls to connected components. |
-| [options.enableDevTools] | <code>Boolean</code> |  | Enables debugging using Redux DevTools extension. |
 
 **Example**  
 ```js

package/README.md

@@ -321,18 +321,8 @@ Sample output of `Onyx.printMetrics()`
 
 # Debug mode
 
-## Using debugSetState
-
 It can be useful to log why Onyx is calling `setState()` on a particular React component so that we can understand which key changed, what changed about the value, and the connected component that ultimately rendered as a result. When used correctly this can help isolate problem areas and unnecessary renders in the code. To enable this feature, pass `debugSetState: true` to the config and grep JS console logs for `[Onyx-Debug]`.
 
-## Using Redux DevTools extension
-
-It can be useful to check the order of writes to the storage and it's state at a specific point in time.
-
-First, install Redux DevTools through your favorite browser ([Edge](https://microsoftedge.microsoft.com/addons/detail/redux-devtools/nnkgneoiohoecpdiaponcejilbhhikei), [Chrome](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd), [Firefox](https://addons.mozilla.org/en-US/firefox/addon/reduxdevtools/))
-
-Then, you can enable this type of debugging by passing `enableDevTools: true` to `Onyx.init({...})`.
-
 # Development
 
 `react-native` bundles source using the `metro` bundler. `metro` does not follow symlinks, so we can't use `npm link` to

package/dist/web.development.js

@@ -11,77 +11,6 @@
 return /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
-/***/ "./lib/DevTools.js":
-/*!*************************!*\
-  !*** ./lib/DevTools.js ***!
-  \*************************/
-/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
-
-"use strict";
-__webpack_require__.r(__webpack_exports__);
-/* harmony export */ __webpack_require__.d(__webpack_exports__, {
-/* harmony export */   "default": () => (__WEBPACK_DEFAULT_EXPORT__)
-/* harmony export */ });
-/* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! underscore */ "underscore");
-/* harmony import */ var underscore__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(underscore__WEBPACK_IMPORTED_MODULE_0__);
-
-
-const { connectViaExtension } =  false ? 0 : {
-  connectViaExtension: () => ({
-    init: () => {},
-    send: () => {}
-  })
-};
-
-class DevTools {
-  /**
-   * @callback onStateChange
-   * @param {object} state
-   */
-  /**
-   * Creates an instance of DevTools, with an internal state that mirrors the storage.
-   *
-   * @param {object} initialState - initial state of the storage
-   * @param {onStateChange} onStateChange - callback which is triggered when we timetravel to a different registered action
-   */
-  constructor() {let initialState = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    this.state = initialState;
-    this.remotedev = connectViaExtension();
-    this.remotedev.init(this.state);
-  }
-
-  /**
-   * Registers an action that updated the current state of the storage
-   *
-   * @param {string} type - name of the action
-   * @param {any} payload - data written to the storage
-   * @param {object} stateChanges - partial state that got updated after the changes
-   */
-  registerAction(type) {let payload = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : undefined;let stateChanges = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-    const newState = {
-      ...this.state,
-      ...stateChanges
-    };
-
-    this.remotedev.send({ type, payload }, newState);
-    this.state = newState;
-  }
-
-  /**
-   * This clears the internal state of the DevTools, preserving the keys not included in `keyToBeRemoved`
-   *
-   * @param {string[]} keysToBeRemoved
-   */
-  clearState() {let keysToBeRemoved = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-    const pairs = underscore__WEBPACK_IMPORTED_MODULE_0___default().map(keysToBeRemoved, (key) => [key, undefined]);
-    this.registerAction('CLEAR', undefined, underscore__WEBPACK_IMPORTED_MODULE_0___default().object(pairs));
-  }
-}
-
-/* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (DevTools);
-
-/***/ }),
-
 /***/ "./lib/Logger.js":
 /*!***********************!*\
   !*** ./lib/Logger.js ***!
@@ -151,7 +80,6 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _fastMerge__WEBPACK_IMPORTED_MODULE_8__ = __webpack_require__(/*! ./fastMerge */ "./lib/fastMerge.js");
 /* harmony import */ var _metrics_PerformanceUtils__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(/*! ./metrics/PerformanceUtils */ "./lib/metrics/PerformanceUtils.js");
 /* harmony import */ var _storage__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./storage */ "./lib/storage/index.web.js");
-/* harmony import */ var _DevTools__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(/*! ./DevTools */ "./lib/DevTools.js");
 /* eslint-disable no-continue */
 
 
@@ -163,7 +91,6 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
-
 // Method constants
 const METHOD = {
   SET: 'set',
@@ -192,11 +119,6 @@ let recentlyAccessedKeys = [];
 // whatever appears in this list it will NEVER be a candidate for eviction.
 let evictionAllowList = [];
 
-let devTools = {
-  registerAction: () => {},
-  clearState: () => {}
-};
-
 // Holds a map of keys and connectionID arrays whose keys will never be automatically evicted as
 // long as we have at least one subscriber that returns false for the canEvict property.
 const evictionBlocklist = {};
@@ -1002,10 +924,7 @@ function notifyCollectionSubscribersOnNextTick(key, value) {
 function remove(key) {
   _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].drop(key);
   notifySubscribersOnNextTick(key, null);
-  return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].removeItem(key).then((result) => {
-    devTools.registerAction(`REMOVE/${key.toUpperCase()}`, undefined, { [key]: undefined });
-    return result;
-  });
+  return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].removeItem(key);
 }
 
 /**
@@ -1129,7 +1048,6 @@ function set(key, value) {
   const hasChanged = _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].hasValueChanged(key, valueWithNullRemoved);
 
   // This approach prioritizes fast UI changes without waiting for data to be stored in device storage.
-  broadcastUpdate(key, value, 'set');
   broadcastUpdate(key, valueWithNullRemoved, hasChanged, 'set');
 
   // If the value has not changed, calling Storage.setItem() would be redundant and a waste of performance, so return early instead.
@@ -1138,10 +1056,6 @@ function set(key, value) {
   }
 
   return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].setItem(key, valueWithNullRemoved).
-  then((result) => {
-    devTools.registerAction(`SET/${key.toUpperCase()}`, valueWithNullRemoved, { [key]: valueWithNullRemoved });
-    return result;
-  }).
   catch((error) => evictStorageAndRetry(error, set, key, valueWithNullRemoved));
 }
 
@@ -1172,11 +1086,6 @@ function multiSet(data) {
     // Update cache and optimistically inform subscribers on the next tick
     _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].set(key, val);
     notifySubscribersOnNextTick(key, val);
-    if (underscore__WEBPACK_IMPORTED_MODULE_1___default().isNull(val)) {
-      devTools.registerAction(`REMOVE/${key.toUpperCase()}`, val, { [key]: undefined });
-    } else {
-      devTools.registerAction(`SET/${key.toUpperCase()}`, val, { [key]: val });
-    }
   });
 
   return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].multiSet(keyValuePairs).
@@ -1271,10 +1180,7 @@ function merge(key, changes) {
         return Promise.resolve();
       }
 
-      return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].mergeItem(key, batchedChanges, modifiedData).then((results) => {
-        devTools.registerAction(`MERGE/${key.toUpperCase()}`, modifiedData, { [key]: modifiedData });
-        return results;
-      });
+      return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].mergeItem(key, batchedChanges, modifiedData);
     } catch (error) {
       _Logger__WEBPACK_IMPORTED_MODULE_5__.logAlert(`An error occurred while applying merge for key: ${key}, Error: ${error}`);
     }
@@ -1286,10 +1192,9 @@ function merge(key, changes) {
 /**
  * Merge user provided default key value pairs.
  * @private
- * @param {boolean} enableDevTools
  * @returns {Promise}
  */
-function initializeWithDefaultKeyStates() {let enableDevTools = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+function initializeWithDefaultKeyStates() {
   return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].multiGet(underscore__WEBPACK_IMPORTED_MODULE_1___default().keys(defaultKeyStates)).
   then((pairs) => {
     const asObject = underscore__WEBPACK_IMPORTED_MODULE_1___default().object(pairs);
@@ -1297,9 +1202,6 @@ function initializeWithDefaultKeyStates() {let enableDevTools = arguments.length
     const merged = (0,_fastMerge__WEBPACK_IMPORTED_MODULE_8__["default"])(asObject, defaultKeyStates);
     _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].merge(merged);
     underscore__WEBPACK_IMPORTED_MODULE_1___default().each(merged, (val, key) => keyChanged(key, val));
-    if (enableDevTools) {
-      devTools = new _DevTools__WEBPACK_IMPORTED_MODULE_9__["default"](merged);
-    }
   });
 }
 
@@ -1347,7 +1249,7 @@ function clear() {let keysToPreserve = arguments.length > 0 && arguments[0] !==
       //      since collection key subscribers need to be updated differently
       if (!isKeyToPreserve) {
         const oldValue = _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].getValue(key);
-        const newValue = underscore__WEBPACK_IMPORTED_MODULE_1___default().get(defaultKeyStates, key, undefined);
+        const newValue = underscore__WEBPACK_IMPORTED_MODULE_1___default().get(defaultKeyStates, key, null);
         if (newValue !== oldValue) {
           _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].set(key, newValue);
           const collectionKey = key.substring(0, key.indexOf('_') + 1);
@@ -1378,15 +1280,11 @@ function clear() {let keysToPreserve = arguments.length > 0 && arguments[0] !==
       notifyCollectionSubscribersOnNextTick(key, value);
     });
 
-    const defaultKeyValueState = underscore__WEBPACK_IMPORTED_MODULE_1___default().omit(defaultKeyStates, keysToPreserve);
-    const defaultKeyValuePairs = underscore__WEBPACK_IMPORTED_MODULE_1___default().pairs(defaultKeyValueState);
+    const defaultKeyValuePairs = underscore__WEBPACK_IMPORTED_MODULE_1___default().pairs(underscore__WEBPACK_IMPORTED_MODULE_1___default().omit(defaultKeyStates, keysToPreserve));
 
     // Remove only the items that we want cleared from storage, and reset others to default
     underscore__WEBPACK_IMPORTED_MODULE_1___default().each(keysToBeClearedFromStorage, (key) => _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].drop(key));
-    return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].removeItems(keysToBeClearedFromStorage).then(() => {
-      devTools.clearState(keysToBeClearedFromStorage);
-      return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].multiSet(defaultKeyValuePairs);
-    });
+    return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].removeItems(keysToBeClearedFromStorage).then(() => _storage__WEBPACK_IMPORTED_MODULE_4__["default"].multiSet(defaultKeyValuePairs));
   });
 }
 
@@ -1460,11 +1358,6 @@ function mergeCollection(collectionKey, collection) {
     Promise.all(underscore__WEBPACK_IMPORTED_MODULE_1___default().map(existingKeys, get)).then(() => {
       _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].merge(collection);
       keysChanged(collectionKey, collection);
-      if (underscore__WEBPACK_IMPORTED_MODULE_1___default().isNull(collection)) {
-        devTools.registerAction(`REMOVE/${collectionKey.toUpperCase()}`, collection, { [collectionKey]: undefined });
-      } else {
-        devTools.registerAction(`SET/${collectionKey.toUpperCase()}`, collection, { [collectionKey]: collection });
-      }
     });
 
     return Promise.all(promises).
@@ -1566,8 +1459,7 @@ function init()
 
 
 
-
-{let { keys = {}, initialKeyStates = {}, safeEvictionKeys = [], maxCachedKeysCount = 1000, captureMetrics = false, shouldSyncMultipleInstances = Boolean(__webpack_require__.g.localStorage), debugSetState = false, enableDevTools = false } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+{let { keys = {}, initialKeyStates = {}, safeEvictionKeys = [], maxCachedKeysCount = 1000, captureMetrics = false, shouldSyncMultipleInstances = Boolean(__webpack_require__.g.localStorage), debugSetState = false } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   if (captureMetrics) {
     // The code here is only bundled and applied when the captureMetrics is set
     // eslint-disable-next-line no-use-before-define
@@ -1599,7 +1491,7 @@ function init()
   // Initialize all of our keys with data provided then give green light to any pending connections
   Promise.all([
   addAllSafeEvictionKeysToRecentlyAccessedList(),
-  initializeWithDefaultKeyStates(enableDevTools)]).
+  initializeWithDefaultKeyStates()]).
 
   then(deferredInitTask.resolve);
 
@@ -1607,11 +1499,6 @@ function init()
     _storage__WEBPACK_IMPORTED_MODULE_4__["default"].keepInstancesSync((key, value) => {
       _OnyxCache__WEBPACK_IMPORTED_MODULE_3__["default"].set(key, value);
       keyChanged(key, value);
-      if (underscore__WEBPACK_IMPORTED_MODULE_1___default().isNull(value)) {
-        devTools.registerAction(`REMOVE/${key.toUpperCase()}`, value, { [key]: undefined });
-      } else {
-        devTools.registerAction(`SET/${key.toUpperCase()}`, value, { [key]: value });
-      }
     });
   }
 }