react-native-onyx 1.0.63 → 1.0.65

package/dist/web.development.js

@@ -96,6 +96,7 @@ const METHOD = {
   SET: 'set',
   MERGE: 'merge',
   MERGE_COLLECTION: 'mergecollection',
+  MULTI_SET: 'multiset',
   CLEAR: 'clear'
 };
 
@@ -926,6 +927,20 @@ function remove(key) {
   return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].removeItem(key);
 }
 
+/**
+ * @private
+ * @returns {Promise<void>}
+ */
+function reportStorageQuota() {
+  return _storage__WEBPACK_IMPORTED_MODULE_4__["default"].getDatabaseSize().
+  then((_ref) => {let { bytesUsed, bytesRemaining } = _ref;
+    _Logger__WEBPACK_IMPORTED_MODULE_5__.logInfo(`Storage Quota Check -- bytesUsed: ${bytesUsed} bytesRemaining: ${bytesRemaining}`);
+  }).
+  catch((dbSizeError) => {
+    _Logger__WEBPACK_IMPORTED_MODULE_5__.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
@@ -938,7 +953,7 @@ function remove(key) {
  * @return {Promise}
  */
 function evictStorageAndRetry(error, onyxMethod) {for (var _len = arguments.length, args = new Array(_len > 2 ? _len - 2 : 0), _key = 2; _key < _len; _key++) {args[_key - 2] = arguments[_key];}
-  _Logger__WEBPACK_IMPORTED_MODULE_5__.logInfo(`Handled error: ${error}`);
+  _Logger__WEBPACK_IMPORTED_MODULE_5__.logInfo(`Failed to save to storage. Error: ${error}. onyxMethod: ${onyxMethod.name}`);
 
   if (error && _Str__WEBPACK_IMPORTED_MODULE_6__.startsWith(error.message, 'Failed to execute \'put\' on \'IDBObjectStore\'')) {
     _Logger__WEBPACK_IMPORTED_MODULE_5__.logAlert('Attempted to set invalid data set in Onyx. Please ensure all data is serializable.');
@@ -947,14 +962,17 @@ function evictStorageAndRetry(error, onyxMethod) {for (var _len = arguments.leng
 
   // Find the first key that we can remove that has no subscribers in our blocklist
   const keyForRemoval = underscore__WEBPACK_IMPORTED_MODULE_1___default().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__WEBPACK_IMPORTED_MODULE_5__.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__WEBPACK_IMPORTED_MODULE_5__.logInfo(`Out of storage. Evicting least recently accessed key (${keyForRemoval}) and retrying.`);
+  reportStorageQuota();
   return remove(keyForRemoval).
   then(() => onyxMethod(...args));
 }
@@ -1350,16 +1368,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
-  underscore__WEBPACK_IMPORTED_MODULE_1___default().each(data, (_ref) => {let { onyxMethod, key } = _ref;
-    if (!underscore__WEBPACK_IMPORTED_MODULE_1___default().contains([METHOD.CLEAR, METHOD.SET, METHOD.MERGE, METHOD.MERGE_COLLECTION], onyxMethod)) {
+  underscore__WEBPACK_IMPORTED_MODULE_1___default().each(data, (_ref2) => {let { onyxMethod, key, value } = _ref2;
+    if (!underscore__WEBPACK_IMPORTED_MODULE_1___default().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 && !underscore__WEBPACK_IMPORTED_MODULE_1___default().isString(key)) {
+    if (onyxMethod === METHOD.MULTI_SET) {
+      // For multiset, we just expect the value to be an object
+      if (!underscore__WEBPACK_IMPORTED_MODULE_1___default().isObject(value) || underscore__WEBPACK_IMPORTED_MODULE_1___default().isArray(value) || underscore__WEBPACK_IMPORTED_MODULE_1___default().isFunction(value)) {
+        throw new Error('Invalid value provided in Onyx multiSet. Onyx multiSet value must be of type object.');
+      }
+    } else if (onyxMethod !== METHOD.CLEAR && !underscore__WEBPACK_IMPORTED_MODULE_1___default().isString(key)) {
       throw new Error(`Invalid ${typeof key} key provided in Onyx update. Onyx key must be of type string.`);
     }
   });
@@ -1367,7 +1390,7 @@ function update(data) {
   const promises = [];
   let clearPromise = Promise.resolve();
 
-  underscore__WEBPACK_IMPORTED_MODULE_1___default().each(data, (_ref2) => {let { onyxMethod, key, value } = _ref2;
+  underscore__WEBPACK_IMPORTED_MODULE_1___default().each(data, (_ref3) => {let { onyxMethod, key, value } = _ref3;
     switch (onyxMethod) {
       case METHOD.SET:
         promises.push(() => set(key, value));
@@ -1378,6 +1401,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;
@@ -2263,7 +2289,26 @@ const provider = {
    * @param {Array} keysParam
    * @returns {Promise}
    */
-  removeItems: (keysParam) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.delMany)(keysParam, getCustomStore())
+  removeItems: (keysParam) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.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}`);
+    });
+  }
 };
 
 /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (provider);