react-native-onyx 1.0.55 → 1.0.56

package/dist/web.development.js

@@ -268,6 +268,46 @@ function isSafeEvictionKey(testKey) {
   return underscore__WEBPACK_IMPORTED_MODULE_2___default().some(evictionAllowList, (key) => isKeyMatch(key, testKey));
 }
 
+/**
+ * Tries to get a value from the cache. If the value is not present in cache it will return the default value or undefined.
+ * If the requested key is a collection, it will return an object with all the collection members.
+ *
+ * @param {String} key
+ * @param {Object} mapping
+ * @returns {Mixed}
+ */
+function tryGetCachedValue(key) {let mapping = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  let val = _OnyxCache__WEBPACK_IMPORTED_MODULE_4__["default"].getValue(key);
+
+  if (isCollectionKey(key)) {
+    const allKeys = _OnyxCache__WEBPACK_IMPORTED_MODULE_4__["default"].getAllKeys();
+    const matchingKeys = underscore__WEBPACK_IMPORTED_MODULE_2___default().filter(allKeys, (k) => k.startsWith(key));
+    const values = underscore__WEBPACK_IMPORTED_MODULE_2___default().reduce(matchingKeys, (finalObject, matchedKey) => {
+      const cachedValue = _OnyxCache__WEBPACK_IMPORTED_MODULE_4__["default"].getValue(matchedKey);
+      if (cachedValue) {
+        // This is permissible because we're in the process of constructing the final object in a reduce function.
+        // eslint-disable-next-line no-param-reassign
+        finalObject[matchedKey] = cachedValue;
+      }
+      return finalObject;
+    }, {});
+    if (underscore__WEBPACK_IMPORTED_MODULE_2___default().isEmpty(values)) {
+      return;
+    }
+    val = values;
+  }
+
+  if (mapping.selector) {
+    const state = mapping.withOnyxInstance ? mapping.withOnyxInstance.state : undefined;
+    if (isCollectionKey(key)) {
+      return reduceCollectionWithSelector(val, mapping.selector, state);
+    }
+    return getSubsetOfData(val, mapping.selector, state);
+  }
+
+  return val;
+}
+
 /**
  * Remove a key from the recently accessed key list.
  *
@@ -1436,7 +1476,8 @@ const Onyx = {
   removeFromEvictionBlockList,
   isSafeEvictionKey,
   METHOD,
-  setMemoryOnlyKeys
+  setMemoryOnlyKeys,
+  tryGetCachedValue
 };
 
 /**
@@ -2402,13 +2443,25 @@ function getDisplayName(component) {
         // disconnected. It is a key value store with the format {[mapping.key]: connectionID}.
         this.activeConnectionIDs = {};
 
+        const cachedState = underscore__WEBPACK_IMPORTED_MODULE_2___default().reduce(mapOnyxToState, (resultObj, mapping, propertyName) => {
+          const key = _Str__WEBPACK_IMPORTED_MODULE_3__.result(mapping.key, props);
+          const value = _Onyx__WEBPACK_IMPORTED_MODULE_4__["default"].tryGetCachedValue(key, mapping);
+
+          if (value !== undefined) {
+            // eslint-disable-next-line no-param-reassign
+            resultObj[propertyName] = value;
+          }
+
+          return resultObj;
+        }, {});
+
+        // If we have all the data we need, then we can render the component immediately
+        cachedState.loading = underscore__WEBPACK_IMPORTED_MODULE_2___default().size(cachedState) < requiredKeysForInit.length;
+
         // Object holding the temporary initial state for the component while we load the various Onyx keys
-        this.tempState = {};
+        this.tempState = cachedState;
 
-        this.state = {
-          // If there are no required keys for init then we can render the wrapped component immediately
-          loading: requiredKeysForInit.length > 0
-        };
+        this.state = cachedState;
       }
 
       componentDidMount() {
@@ -2425,7 +2478,6 @@ function getDisplayName(component) {
         underscore__WEBPACK_IMPORTED_MODULE_2___default().each(mapOnyxToState, (mapping, propertyName) => {
           const previousKey = _Str__WEBPACK_IMPORTED_MODULE_3__.result(mapping.key, prevProps);
           const newKey = _Str__WEBPACK_IMPORTED_MODULE_3__.result(mapping.key, this.props);
-
           if (previousKey !== newKey) {
             _Onyx__WEBPACK_IMPORTED_MODULE_4__["default"].disconnect(this.activeConnectionIDs[previousKey], previousKey);
             delete this.activeConnectionIDs[previousKey];
@@ -2453,6 +2505,16 @@ function getDisplayName(component) {
        * @param {*} val
        */
       setWithOnyxState(statePropertyName, val) {
+        // We might have loaded the values for the onyx keys/mappings already from the cache.
+        // In case we were able to load all the values upfront, the loading state will be false.
+        // However, Onyx.js will always call setWithOnyxState, as it doesn't know that this implementation
+        // already loaded the values from cache. Thus we have to check whether the value has changed
+        // before we set the state to prevent unnecessary renders.
+        const prevValue = this.state[statePropertyName];
+        if (!this.state.loading && prevValue === val) {
+          return;
+        }
+
         if (!this.state.loading) {
           this.setState({ [statePropertyName]: val });
           return;
@@ -2465,7 +2527,14 @@ function getDisplayName(component) {
           return;
         }
 
-        this.setState({ ...this.tempState, loading: false });
+        const stateUpdate = { ...this.tempState, loading: false };
+
+        // The state is set here manually, instead of using setState because setState is an async operation, meaning it might execute on the next tick,
+        // or at a later point in the microtask queue. That can lead to a race condition where
+        // setWithOnyxState is called before the state is actually set. This results in unreliable behavior when checking the loading state and has been mainly observed on fabric.
+        this.state = stateUpdate;
+
+        this.setState(stateUpdate); // Trigger a render
         delete this.tempState;
       }