react-native-onyx 1.0.63 → 1.0.65

package/lib/Onyx.js

@@ -14,6 +14,7 @@ const METHOD = {
     SET: 'set',
     MERGE: 'merge',
     MERGE_COLLECTION: 'mergecollection',
+    MULTI_SET: 'multiset',
     CLEAR: 'clear',
 };
 
@@ -844,6 +845,20 @@ function remove(key) {
     return Storage.removeItem(key);
 }
 
+/**
+ * @private
+ * @returns {Promise<void>}
+ */
+function reportStorageQuota() {
+    return Storage.getDatabaseSize()
+        .then(({bytesUsed, bytesRemaining}) => {
+            Logger.logInfo(`Storage Quota Check -- bytesUsed: ${bytesUsed} bytesRemaining: ${bytesRemaining}`);
+        })
+        .catch((dbSizeError) => {
+            Logger.logAlert(`Unable to get database size. Error: ${dbSizeError}`);
+        });
+}
+
 /**
  * If we fail to set or merge we must handle this by
  * evicting some data from Onyx and then retrying to do
@@ -856,7 +871,7 @@ function remove(key) {
  * @return {Promise}
  */
 function evictStorageAndRetry(error, onyxMethod, ...args) {
-    Logger.logInfo(`Handled error: ${error}`);
+    Logger.logInfo(`Failed to save to storage. Error: ${error}. onyxMethod: ${onyxMethod.name}`);
 
     if (error && Str.startsWith(error.message, 'Failed to execute \'put\' on \'IDBObjectStore\'')) {
         Logger.logAlert('Attempted to set invalid data set in Onyx. Please ensure all data is serializable.');
@@ -865,14 +880,17 @@ function evictStorageAndRetry(error, onyxMethod, ...args) {
 
     // Find the first key that we can remove that has no subscribers in our blocklist
     const keyForRemoval = _.find(recentlyAccessedKeys, key => !evictionBlocklist[key]);
-
     if (!keyForRemoval) {
+        // If we have no acceptable keys to remove then we are possibly trying to save mission critical data. If this is the case,
+        // then we should stop retrying as there is not much the user can do to fix this. Instead of getting them stuck in an infinite loop we
+        // will allow this write to be skipped.
         Logger.logAlert('Out of storage. But found no acceptable keys to remove.');
-        throw error;
+        return reportStorageQuota();
     }
 
     // Remove the least recently viewed key that is not currently being accessed and retry.
     Logger.logInfo(`Out of storage. Evicting least recently accessed key (${keyForRemoval}) and retrying.`);
+    reportStorageQuota();
     return remove(keyForRemoval)
         .then(() => onyxMethod(...args));
 }
@@ -1268,16 +1286,21 @@ function mergeCollection(collectionKey, collection) {
 /**
  * Insert API responses and lifecycle data into Onyx
  *
- * @param {Array} data An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection'), key: string, value: *}
+ * @param {Array} data An array of objects with shape {onyxMethod: oneOf('set', 'merge', 'mergeCollection', 'multiSet', 'clear'), key: string, value: *}
  * @returns {Promise} resolves when all operations are complete
  */
 function update(data) {
     // First, validate the Onyx object is in the format we expect
-    _.each(data, ({onyxMethod, key}) => {
-        if (!_.contains([METHOD.CLEAR, METHOD.SET, METHOD.MERGE, METHOD.MERGE_COLLECTION], onyxMethod)) {
+    _.each(data, ({onyxMethod, key, value}) => {
+        if (!_.contains([METHOD.CLEAR, METHOD.SET, METHOD.MERGE, METHOD.MERGE_COLLECTION, METHOD.MULTI_SET], onyxMethod)) {
             throw new Error(`Invalid onyxMethod ${onyxMethod} in Onyx update.`);
         }
-        if (onyxMethod !== METHOD.CLEAR && !_.isString(key)) {
+        if (onyxMethod === METHOD.MULTI_SET) {
+            // For multiset, we just expect the value to be an object
+            if (!_.isObject(value) || _.isArray(value) || _.isFunction(value)) {
+                throw new Error('Invalid value provided in Onyx multiSet. Onyx multiSet value must be of type object.');
+            }
+        } else if (onyxMethod !== METHOD.CLEAR && !_.isString(key)) {
             throw new Error(`Invalid ${typeof key} key provided in Onyx update. Onyx key must be of type string.`);
         }
     });
@@ -1296,6 +1319,9 @@ function update(data) {
             case METHOD.MERGE_COLLECTION:
                 promises.push(() => mergeCollection(key, value));
                 break;
+            case METHOD.MULTI_SET:
+                promises.push(() => multiSet(value));
+                break;
             case METHOD.CLEAR:
                 clearPromise = clear();
                 break;

package/lib/storage/__mocks__/index.js

@@ -55,6 +55,9 @@ const idbKeyvalMock = {
         return Promise.resolve(_.keys(storageMapInternal));
     },
     config() {},
+    getDatabaseSize() {
+        return Promise.resolve({bytesRemaining: 0, bytesUsed: 99999});
+    },
 };
 
 const idbKeyvalMockSpy = {
@@ -74,6 +77,7 @@ const idbKeyvalMockSpy = {
     setInitialMockData: jest.fn((data) => {
         storageMapInternal = data;
     }),
+    getDatabaseSize: jest.fn(idbKeyvalMock.getDatabaseSize),
 };
 
 export default idbKeyvalMockSpy;

package/lib/storage/providers/IDBKeyVal.js

@@ -113,6 +113,25 @@ const provider = {
      * @returns {Promise}
      */
     removeItems: keysParam => delMany(keysParam, getCustomStore()),
+
+    /**
+     * Gets the total bytes of the database file
+     * @returns {Promise<number>}
+     */
+    getDatabaseSize() {
+        if (!window.navigator || !window.navigator.storage) {
+            throw new Error('StorageManager browser API unavailable');
+        }
+
+        return window.navigator.storage.estimate()
+            .then(value => ({
+                bytesUsed: value.usage,
+                bytesRemaining: value.quota - value.usage,
+            }))
+            .catch((error) => {
+                throw new Error(`Unable to estimate web storage quota. Original error: ${error}`);
+            });
+    },
 };
 
 export default provider;

package/lib/storage/providers/SQLiteStorage.js

@@ -3,6 +3,7 @@
  * converting the value to a JSON string
  */
 import {open} from 'react-native-quick-sqlite';
+import {getFreeDiskStorage} from 'react-native-device-info';
 import _ from 'underscore';
 
 const DB_NAME = 'OnyxDB';
@@ -143,6 +144,22 @@ const provider = {
      * Noop on mobile for now.
      */
     setMemoryOnlyKeys: () => {},
+
+    /**
+     * Gets the total bytes of the database file
+     * @returns {Promise}
+     */
+    getDatabaseSize() {
+        return Promise.all([db.executeAsync('PRAGMA page_size;'), db.executeAsync('PRAGMA page_count;'), getFreeDiskStorage()])
+            .then(([pageSizeResult, pageCountResult, bytesRemaining]) => {
+                const pageSize = pageSizeResult.rows.item(0).page_size;
+                const pageCount = pageCountResult.rows.item(0).page_count;
+                return {
+                    bytesUsed: pageSize * pageCount,
+                    bytesRemaining,
+                };
+            });
+    },
 };
 
 export default provider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "1.0.63",
+  "version": "1.0.65",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",
@@ -67,6 +67,7 @@
     "prop-types": "^15.7.2",
     "react": "18.2.0",
     "react-native": "0.71.2",
+    "react-native-device-info": "^10.3.0",
     "react-native-performance": "^2.0.0",
     "react-native-quick-sqlite": "^8.0.0-beta.2",
     "react-test-renderer": "18.1.0",
@@ -79,7 +80,8 @@
     "idb-keyval": "^6.2.1",
     "react": ">=18.1.0",
     "react-native-performance": "^4.0.0",
-    "react-native-quick-sqlite": "^8.0.0-beta.2"
+    "react-native-quick-sqlite": "^8.0.0-beta.2",
+    "react-native-device-info": "^10.3.0"
   },
   "peerDependenciesMeta": {
     "idb-keyval": {
@@ -90,6 +92,9 @@
     },
     "react-native-quick-sqlite": {
       "optional": true
+    },
+    "react-native-device-info": {
+      "optional": true
     }
   },
   "engines": {