react-native-onyx 1.0.62 → 1.0.64

package/dist/web.development.js

@@ -926,6 +926,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 +952,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 +961,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));
 }
@@ -1355,7 +1372,7 @@ function mergeCollection(collectionKey, collection) {
  */
 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;
+  underscore__WEBPACK_IMPORTED_MODULE_1___default().each(data, (_ref2) => {let { onyxMethod, key } = _ref2;
     if (!underscore__WEBPACK_IMPORTED_MODULE_1___default().contains([METHOD.CLEAR, METHOD.SET, METHOD.MERGE, METHOD.MERGE_COLLECTION], onyxMethod)) {
       throw new Error(`Invalid onyxMethod ${onyxMethod} in Onyx update.`);
     }
@@ -1367,7 +1384,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));
@@ -2164,7 +2181,15 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
-const customStore = (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.createStore)('OnyxDB', 'keyvaluepairs');
+// We don't want to initialize the store while the JS bundle loads as idb-keyval will try to use global.indexedDB
+// which might not be available in certain environments that load the bundle (e.g. electron main process).
+let customStoreInstance;
+const getCustomStore = () => {
+  if (!customStoreInstance) {
+    customStoreInstance = (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.createStore)('OnyxDB', 'keyvaluepairs');
+  }
+  return customStoreInstance;
+};
 
 const provider = {
   /**
@@ -2173,7 +2198,7 @@ const provider = {
    * @param {*} value
    * @return {Promise<void>}
    */
-  setItem: (key, value) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.set)(key, value, customStore),
+  setItem: (key, value) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.set)(key, value, getCustomStore()),
 
   /**
    * Get multiple key-value pairs for the give array of keys in a batch.
@@ -2181,7 +2206,7 @@ const provider = {
    * @param {String[]} keysParam
    * @return {Promise<Array<[key, value]>>}
    */
-  multiGet: (keysParam) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.getMany)(keysParam, customStore).
+  multiGet: (keysParam) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.getMany)(keysParam, getCustomStore()).
   then((values) => underscore__WEBPACK_IMPORTED_MODULE_1___default().map(values, (value, index) => [keysParam[index], value])),
 
   /**
@@ -2189,7 +2214,7 @@ const provider = {
    * @param {Array<[key, value]>} pairs
    * @return {Promise<void>}
    */
-  multiMerge: (pairs) => customStore('readwrite', (store) => {
+  multiMerge: (pairs) => getCustomStore()('readwrite', (store) => {
     // Note: we are using the manual store transaction here, to fit the read and update
     // of the items in one transaction to achieve best performance.
 
@@ -2221,33 +2246,33 @@ const provider = {
    * @param {Array<[key, value]>} pairs
    * @return {Promise<void>}
    */
-  multiSet: (pairs) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.setMany)(pairs, customStore),
+  multiSet: (pairs) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.setMany)(pairs, getCustomStore()),
 
   /**
    * Clear everything from storage and also stops the SyncQueue from adding anything more to storage
    * @returns {Promise<void>}
    */
-  clear: () => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.clear)(customStore),
+  clear: () => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.clear)(getCustomStore()),
 
   /**
    * Returns all keys available in storage
    * @returns {Promise<String[]>}
    */
-  getAllKeys: () => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.keys)(customStore),
+  getAllKeys: () => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.keys)(getCustomStore()),
 
   /**
    * Get the value of a given key or return `null` if it's not available in storage
    * @param {String} key
    * @return {Promise<*>}
    */
-  getItem: (key) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.get)(key, customStore),
+  getItem: (key) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.get)(key, getCustomStore()),
 
   /**
    * Remove given key and it's value from storage
    * @param {String} key
    * @returns {Promise<void>}
    */
-  removeItem: (key) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.del)(key, customStore),
+  removeItem: (key) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.del)(key, getCustomStore()),
 
   /**
    * Remove given keys and their values from storage
@@ -2255,7 +2280,26 @@ const provider = {
    * @param {Array} keysParam
    * @returns {Promise}
    */
-  removeItems: (keysParam) => (0,idb_keyval__WEBPACK_IMPORTED_MODULE_0__.delMany)(keysParam, customStore)
+  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);