react-native-onyx 1.0.21 → 1.0.23

package/API.md

@@ -13,7 +13,7 @@
 <dt><a href="#disconnect">disconnect(connectionID, [keyToRemoveFromEvictionBlocklist])</a></dt>
 <dd><p>Remove the listener for a react component</p>
 </dd>
-<dt><a href="#notifySubscribersOnNextTick">notifySubscribersOnNextTick(key, value)</a></dt>
+<dt><a href="#notifySubscribersOnNextTick">notifySubscribersOnNextTick(key, value, [canUpdateSubscriber])</a></dt>
 <dd><p>This method mostly exists for historical reasons as this library was initially designed without a memory cache and one was added later.
 For this reason, Onyx works more similar to what you might expect from a native AsyncStorage with reads, writes, etc all becoming
 available async. Since we have code in our main applications that might expect things to work this way it&#39;s not safe to change this
@@ -115,7 +115,7 @@ Onyx.disconnect(connectionID);
 ```
 <a name="notifySubscribersOnNextTick"></a>
 
-## notifySubscribersOnNextTick(key, value)
+## notifySubscribersOnNextTick(key, value, [canUpdateSubscriber])
 This method mostly exists for historical reasons as this library was initially designed without a memory cache and one was added later.
 For this reason, Onyx works more similar to what you might expect from a native AsyncStorage with reads, writes, etc all becoming
 available async. Since we have code in our main applications that might expect things to work this way it's not safe to change this
@@ -123,11 +123,16 @@ behavior just yet.
 
 **Kind**: global function
 
-| Param | Type |
-| --- | --- |
-| key | <code>String</code> |
-| value | <code>\*</code> |
+| Param | Type | Description |
+| --- | --- | --- |
+| key | <code>String</code> |  |
+| value | <code>\*</code> |  |
+| [canUpdateSubscriber] | <code>function</code> | only subscribers that pass this truth test will be updated |
 
+**Example**
+```js
+notifySubscribersOnNextTick(key, value, subscriber => subscriber.initWithStoredValues === false)
+```
 <a name="set"></a>
 
 ## set(key, value) ⇒ <code>Promise</code>
@@ -251,7 +256,7 @@ Initialize the store with actions and listening for storage events
 | [options.maxCachedKeysCount] | <code>Number</code> | <code>55</code> | Sets how many recent keys should we try to keep in cache Setting this to 0 would practically mean no cache We try to free cache when we connect to a safe eviction key |
 | [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) |
-| [option.keysToDisableSyncEvents] | <code>Array.&lt;String&gt;</code> | <code>[]</code> | Contains keys for which we want to disable sync event across tabs. |
+| [options.debugSetState] | <code>Boolean</code> |  | Enables debugging setState() calls to connected components. |
 
 **Example**
 ```js

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("lodash/get"), require("localforage"), require("lodash/transform"), require("react"));
+		module.exports = factory(require("underscore"), require("expensify-common/lib/str"), require("lodash/get"), require("localforage"), require("fast-equals"), require("lodash/transform"), require("react"));
 	else if(typeof define === 'function' && define.amd)
-		define(["underscore", "expensify-common/lib/str", "lodash/get", "localforage", "lodash/transform", "react"], factory);
+		define(["underscore", "expensify-common/lib/str", "lodash/get", "localforage", "fast-equals", "lodash/transform", "react"], factory);
 	else if(typeof exports === 'object')
-		exports["react-native-onyx/web"] = factory(require("underscore"), require("expensify-common/lib/str"), require("lodash/get"), require("localforage"), require("lodash/transform"), require("react"));
+		exports["react-native-onyx/web"] = factory(require("underscore"), require("expensify-common/lib/str"), require("lodash/get"), require("localforage"), require("fast-equals"), require("lodash/transform"), require("react"));
 	else
-		root["react-native-onyx/web"] = factory(root["underscore"], root["expensify-common/lib/str"], 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_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["lodash/get"], root["localforage"], root["fast-equals"], root["lodash/transform"], root["react"]);
+})(self, (__WEBPACK_EXTERNAL_MODULE_underscore__, __WEBPACK_EXTERNAL_MODULE_expensify_common_lib_str__, __WEBPACK_EXTERNAL_MODULE_lodash_get__, __WEBPACK_EXTERNAL_MODULE_localforage__, __WEBPACK_EXTERNAL_MODULE_fast_equals__, __WEBPACK_EXTERNAL_MODULE_lodash_transform__, __WEBPACK_EXTERNAL_MODULE_react__) => {
 return /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
@@ -858,11 +858,15 @@ function keysChanged(collectionKey, partialCollection) {
 /**
  * When a key change happens, search for any callbacks matching the key or collection key and trigger those callbacks
  *
+ * @example
+ * keyChanged(key, value, subscriber => subscriber.initWithStoredValues === false)
+ *
  * @private
  * @param {String} key
  * @param {*} data
+ * @param {Function} [canUpdateSubscriber] only subscribers that pass this truth test will be updated
  */
-function keyChanged(key, data) {
+function keyChanged(key, data, canUpdateSubscriber) {
   // Add or remove this key from the recentlyAccessedKeys lists
   if (!_underscore.default.isNull(data)) {
     addLastAccessedKey(key);
@@ -876,7 +880,7 @@ function keyChanged(key, data) {
   var stateMappingKeys = _underscore.default.keys(callbackToStateMapping);var _loop2 = function _loop2(
   i) {
     var subscriber = callbackToStateMapping[stateMappingKeys[i]];
-    if (!subscriber || !isKeyMatch(subscriber.key, key)) {
+    if (!subscriber || !isKeyMatch(subscriber.key, key) || _underscore.default.isFunction(canUpdateSubscriber) && !canUpdateSubscriber(subscriber)) {
       return "continue";
     }
 
@@ -1122,12 +1126,16 @@ function disconnect(connectionID, keyToRemoveFromEvictionBlocklist) {
  * available async. Since we have code in our main applications that might expect things to work this way it's not safe to change this
  * behavior just yet.
  *
+ * @example
+ * notifySubscribersOnNextTick(key, value, subscriber => subscriber.initWithStoredValues === false)
+ *
  * @param {String} key
  * @param {*} value
+ * @param {Function} [canUpdateSubscriber] only subscribers that pass this truth test will be updated
  */
 // eslint-disable-next-line rulesdir/no-negated-variables
-function notifySubscribersOnNextTick(key, value) {
-  Promise.resolve().then(function () {return keyChanged(key, value);});
+function notifySubscribersOnNextTick(key, value, canUpdateSubscriber) {
+  Promise.resolve().then(function () {return keyChanged(key, value, canUpdateSubscriber);});
 }
 
 /**
@@ -1194,6 +1202,14 @@ function set(key, value) {
     Logger.logAlert("Onyx.set() called after Onyx.merge() for key: " + key + ". It is recommended to use set() or merge() not both.");
   }
 
+  // If the value in the cache is the same as what we have then do not update subscribers unless they
+  // have initWithStoredValues: false then they MUST get all updates even if nothing has changed.
+  if (!_OnyxCache.default.hasValueChanged(key, value)) {
+    _OnyxCache.default.addToAccessedKeys(key);
+    notifySubscribersOnNextTick(key, value, function (subscriber) {return subscriber.initWithStoredValues === false;});
+    return Promise.resolve();
+  }
+
   // Adds the key to cache when it's not available
   _OnyxCache.default.set(key, value);
   notifySubscribersOnNextTick(key, value);
@@ -1499,8 +1515,6 @@ function update(data) {
  * @param {Boolean} [options.captureMetrics] Enables Onyx benchmarking and exposes the get/print/reset functions
  * @param {Boolean} [options.shouldSyncMultipleInstances] 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)
- * @param {String[]} [option.keysToDisableSyncEvents=[]] Contains keys for which
- * we want to disable sync event across tabs.
  * @param {Boolean} [options.debugSetState] Enables debugging setState() calls to connected components.
  * @example
  * Onyx.init({
@@ -1518,8 +1532,7 @@ function init()
 
 
 
-
-{var _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},_ref7$keys = _ref7.keys,keys = _ref7$keys === void 0 ? {} : _ref7$keys,_ref7$initialKeyState = _ref7.initialKeyStates,initialKeyStates = _ref7$initialKeyState === void 0 ? {} : _ref7$initialKeyState,_ref7$safeEvictionKey = _ref7.safeEvictionKeys,safeEvictionKeys = _ref7$safeEvictionKey === void 0 ? [] : _ref7$safeEvictionKey,_ref7$maxCachedKeysCo = _ref7.maxCachedKeysCount,maxCachedKeysCount = _ref7$maxCachedKeysCo === void 0 ? 1000 : _ref7$maxCachedKeysCo,_ref7$captureMetrics = _ref7.captureMetrics,captureMetrics = _ref7$captureMetrics === void 0 ? false : _ref7$captureMetrics,_ref7$shouldSyncMulti = _ref7.shouldSyncMultipleInstances,shouldSyncMultipleInstances = _ref7$shouldSyncMulti === void 0 ? Boolean(__webpack_require__.g.localStorage) : _ref7$shouldSyncMulti,_ref7$keysToDisableSy = _ref7.keysToDisableSyncEvents,keysToDisableSyncEvents = _ref7$keysToDisableSy === void 0 ? [] : _ref7$keysToDisableSy,_ref7$debugSetState = _ref7.debugSetState,debugSetState = _ref7$debugSetState === void 0 ? false : _ref7$debugSetState;
+{var _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},_ref7$keys = _ref7.keys,keys = _ref7$keys === void 0 ? {} : _ref7$keys,_ref7$initialKeyState = _ref7.initialKeyStates,initialKeyStates = _ref7$initialKeyState === void 0 ? {} : _ref7$initialKeyState,_ref7$safeEvictionKey = _ref7.safeEvictionKeys,safeEvictionKeys = _ref7$safeEvictionKey === void 0 ? [] : _ref7$safeEvictionKey,_ref7$maxCachedKeysCo = _ref7.maxCachedKeysCount,maxCachedKeysCount = _ref7$maxCachedKeysCo === void 0 ? 1000 : _ref7$maxCachedKeysCo,_ref7$captureMetrics = _ref7.captureMetrics,captureMetrics = _ref7$captureMetrics === void 0 ? false : _ref7$captureMetrics,_ref7$shouldSyncMulti = _ref7.shouldSyncMultipleInstances,shouldSyncMultipleInstances = _ref7$shouldSyncMulti === void 0 ? Boolean(__webpack_require__.g.localStorage) : _ref7$shouldSyncMulti,_ref7$debugSetState = _ref7.debugSetState,debugSetState = _ref7$debugSetState === void 0 ? false : _ref7$debugSetState;
   if (captureMetrics) {
     // The code here is only bundled and applied when the captureMetrics is set
     // eslint-disable-next-line no-use-before-define
@@ -1551,7 +1564,7 @@ function init()
   then(deferredInitTask.resolve);
 
   if (shouldSyncMultipleInstances && _underscore.default.isFunction(_storage.default.keepInstancesSync)) {
-    _storage.default.keepInstancesSync(keysToDisableSyncEvents, function (key, value) {
+    _storage.default.keepInstancesSync(function (key, value) {
       _OnyxCache.default.set(key, value);
       keyChanged(key, value);
     });
@@ -1623,6 +1636,7 @@ Onyx;exports["default"] = _default;
 /***/ ((__unused_webpack_module, exports, __webpack_require__) => {
 
 var _interopRequireDefault = __webpack_require__(/*! @babel/runtime/helpers/interopRequireDefault */ "./node_modules/@babel/runtime/helpers/interopRequireDefault.js");Object.defineProperty(exports, "__esModule", ({ value: true }));exports["default"] = void 0;var _toConsumableArray2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/toConsumableArray */ "./node_modules/@babel/runtime/helpers/toConsumableArray.js"));var _extends2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/extends */ "./node_modules/@babel/runtime/helpers/extends.js"));var _classCallCheck2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/classCallCheck */ "./node_modules/@babel/runtime/helpers/classCallCheck.js"));var _createClass2 = _interopRequireDefault(__webpack_require__(/*! @babel/runtime/helpers/createClass */ "./node_modules/@babel/runtime/helpers/createClass.js"));var _underscore = _interopRequireDefault(__webpack_require__(/*! underscore */ "underscore"));
+var _fastEquals = __webpack_require__(/*! fast-equals */ "fast-equals");
 var _fastMerge = _interopRequireDefault(__webpack_require__(/*! ./fastMerge */ "./lib/fastMerge.js"));
 
 var isDefined = _underscore.default.negate(_underscore.default.isUndefined);
@@ -1814,6 +1828,15 @@ OnyxCache = /*#__PURE__*/function () {
      */ }, { key: "setRecentKeysLimit", value: function setRecentKeysLimit(
     limit) {
       this.maxRecentKeysSize = limit;
+    }
+
+    /**
+     * @param {String} key
+     * @param {*} value
+     * @returns {Boolean}
+     */ }, { key: "hasValueChanged", value: function hasValueChanged(
+    key, value) {
+      return !(0, _fastEquals.deepEqual)(this.storageMap[key], value);
     } }]);return OnyxCache;}();
 
 
@@ -2093,12 +2116,9 @@ var webStorage = (0, _extends2.default)({},
 _LocalForage.default, {
 
   /**
-   * Contains keys for which we want to disable sync event across tabs.
-   * @param {String[]} keysToDisableSyncEvents
-   * Storage synchronization mechanism keeping all opened tabs in sync
-   * @param {function(key: String, data: *)} onStorageKeyChanged
+   * @param {Function} onStorageKeyChanged Storage synchronization mechanism keeping all opened tabs in sync
    */
-  keepInstancesSync: function keepInstancesSync(keysToDisableSyncEvents, onStorageKeyChanged) {var _this = this;
+  keepInstancesSync: function keepInstancesSync(onStorageKeyChanged) {var _this = this;
     // Override set, remove and clear to raise storage events that we intercept in other tabs
     this.setItem = function (key, value) {return _LocalForage.default.setItem(key, value).
       then(function () {return raiseStorageSyncEvent(key);});};
@@ -2120,10 +2140,6 @@ _LocalForage.default, {
       }
 
       var onyxKey = event.newValue;
-      if (_underscore.default.contains(keysToDisableSyncEvents, onyxKey)) {
-        return;
-      }
-
       _LocalForage.default.getItem(onyxKey).
       then(function (value) {return onStorageKeyChanged(onyxKey, value);});
     });
@@ -3562,6 +3578,17 @@ module.exports = __WEBPACK_EXTERNAL_MODULE_expensify_common_lib_str__;
 
 /***/ }),
 
+/***/ "fast-equals":
+/*!******************************!*\
+  !*** external "fast-equals" ***!
+  \******************************/
+/***/ ((module) => {
+
+"use strict";
+module.exports = __WEBPACK_EXTERNAL_MODULE_fast_equals__;
+
+/***/ }),
+
 /***/ "localforage":
 /*!******************************!*\
   !*** external "localforage" ***!