react-native-onyx 3.0.56 → 3.0.58

package/dist/storage/providers/IDBKeyValProvider/createStore.js

@@ -34,25 +34,39 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 const IDB = __importStar(require("idb-keyval"));
-const Logger_1 = require("../../../Logger");
+const Logger = __importStar(require("../../../Logger"));
 // This is a copy of the createStore function from idb-keyval, we need a custom implementation
 // because we need to create the database manually in order to ensure that the store exists before we use it.
 // If the store does not exist, idb-keyval will throw an error
 // source: https://github.com/jakearchibald/idb-keyval/blob/9d19315b4a83897df1e0193dccdc29f78466a0f3/src/index.ts#L12
 function createStore(dbName, storeName) {
     let dbp;
+    const attachHandlers = (db) => {
+        // Browsers may close idle IDB connections at any time, especially Safari.
+        // We clear the cached promise so the next operation opens a fresh connection.
+        // https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/close_event
+        // eslint-disable-next-line no-param-reassign
+        db.onclose = () => {
+            Logger.logInfo('IDB connection closed by browser', { dbName, storeName });
+            dbp = undefined;
+        };
+        // When another tab triggers a DB version upgrade, we must close the connection
+        // to unblock the upgrade; otherwise the other tab's open request hangs indefinitely.
+        // https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase/versionchange_event
+        // eslint-disable-next-line no-param-reassign
+        db.onversionchange = () => {
+            Logger.logInfo('IDB connection closing due to version change', { dbName, storeName });
+            db.close();
+            dbp = undefined;
+        };
+    };
     const getDB = () => {
         if (dbp)
             return dbp;
         const request = indexedDB.open(dbName);
         request.onupgradeneeded = () => request.result.createObjectStore(storeName);
         dbp = IDB.promisifyRequest(request);
-        dbp.then((db) => {
-            // It seems like Safari sometimes likes to just close the connection.
-            // It's supposed to fire this event when that happens. Let's hope it does!
-            // eslint-disable-next-line no-param-reassign
-            db.onclose = () => (dbp = undefined);
-        }, 
+        dbp.then(attachHandlers, 
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         () => { });
         return dbp;
@@ -63,7 +77,7 @@ function createStore(dbName, storeName) {
         if (db.objectStoreNames.contains(storeName)) {
             return db;
         }
-        (0, Logger_1.logInfo)(`Store ${storeName} does not exist in database ${dbName}.`);
+        Logger.logInfo(`Store ${storeName} does not exist in database ${dbName}.`);
         const nextVersion = db.version + 1;
         db.close();
         const request = indexedDB.open(dbName, nextVersion);
@@ -72,14 +86,34 @@ function createStore(dbName, storeName) {
             if (updatedDatabase.objectStoreNames.contains(storeName)) {
                 return;
             }
-            (0, Logger_1.logInfo)(`Creating store ${storeName} in database ${dbName}.`);
+            Logger.logInfo(`Creating store ${storeName} in database ${dbName}.`);
             updatedDatabase.createObjectStore(storeName);
         };
         dbp = IDB.promisifyRequest(request);
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        dbp.then(attachHandlers, () => { });
         return dbp;
     };
-    return (txMode, callback) => getDB()
-        .then(verifyStoreExists)
-        .then((db) => callback(db.transaction(storeName, txMode).objectStore(storeName)));
+    function executeTransaction(txMode, callback) {
+        return getDB()
+            .then(verifyStoreExists)
+            .then((db) => callback(db.transaction(storeName, txMode).objectStore(storeName)));
+    }
+    // If the connection was closed between getDB() resolving and db.transaction() executing,
+    // the transaction throws InvalidStateError. We catch it and retry once with a fresh connection.
+    return (txMode, callback) => executeTransaction(txMode, callback).catch((error) => {
+        if (error instanceof DOMException && error.name === 'InvalidStateError') {
+            Logger.logAlert('IDB InvalidStateError, retrying with fresh connection', {
+                dbName,
+                storeName,
+                txMode,
+                errorMessage: error.message,
+            });
+            dbp = undefined;
+            // Retry only once — this call is not wrapped, so if it also fails the error propagates normally.
+            return executeTransaction(txMode, callback);
+        }
+        throw error;
+    });
 }
 exports.default = createStore;

package/dist/utils.d.ts

@@ -37,7 +37,7 @@ type FastMergeResult<TValue> = {
 declare function fastMerge<TValue>(target: TValue, source: TValue, options?: FastMergeOptions, metadata?: FastMergeMetadata, basePath?: string[]): FastMergeResult<TValue>;
 /** Checks whether the given object is an object and not null/undefined. */
 declare function isEmptyObject<T>(obj: T | EmptyValue): obj is EmptyValue;
-/** Deep removes the nested null values from the given value. */
+/** Deep removes the nested null values from the given value. Returns the original reference if no nulls were found. */
 declare function removeNestedNullValues<TValue extends OnyxInput<OnyxKey> | null>(value: TValue): TValue;
 /** Formats the action name by uppercasing and adding the key if provided. */
 declare function formatActionName(method: string, key?: OnyxKey): string;

package/dist/utils.js

@@ -39,6 +39,9 @@ function fastMerge(target, source, options, metadata, basePath = []) {
 function mergeObject(target, source, options, metadata, basePath) {
     const destination = {};
     const targetObject = isMergeableObject(target) ? target : undefined;
+    // Track whether the merge actually changed anything compared to target.
+    // If nothing changed, we return the original target reference for reference stability.
+    let hasChanged = !targetObject;
     // First we want to copy over all keys from the target into the destination object,
     // in case "target" is a mergable object.
     // If "shouldRemoveNestedNulls" is true, we want to remove null values from the merged object
@@ -51,6 +54,7 @@ function mergeObject(target, source, options, metadata, basePath) {
             // If either the source or target value is null, we want to omit the key from the merged object.
             const shouldOmitNullishProperty = options.shouldRemoveNestedNulls && (targetProperty === null || sourceProperty === null);
             if (targetProperty === undefined || shouldOmitNullishProperty) {
+                hasChanged = true;
                 continue;
             }
             destination[key] = targetProperty;
@@ -68,6 +72,9 @@ function mergeObject(target, source, options, metadata, basePath) {
         }
         // If the source value is not a mergable object, we need to set the key directly.
         if (!isMergeableObject(sourceProperty)) {
+            if (destination[key] !== sourceProperty) {
+                hasChanged = true;
+            }
             destination[key] = sourceProperty;
             continue;
         }
@@ -76,6 +83,7 @@ function mergeObject(target, source, options, metadata, basePath) {
         // To achieve this, we first mark these nested objects with an internal flag.
         // When calling fastMerge again with "mark" removal mode, the marked objects will be removed.
         if (options.objectRemovalMode === 'mark' && targetProperty === null) {
+            hasChanged = true;
             targetProperty = { [ONYX_INTERNALS__REPLACE_OBJECT_MARK]: true };
             metadata.replaceNullPatches.push([[...basePath, key], Object.assign({}, sourceProperty)]);
         }
@@ -83,6 +91,7 @@ function mergeObject(target, source, options, metadata, basePath) {
         // has the internal flag set, we replace the entire destination object with the source one and remove
         // the flag.
         if (options.objectRemovalMode === 'replace' && sourceProperty[ONYX_INTERNALS__REPLACE_OBJECT_MARK]) {
+            hasChanged = true;
             // We do a spread here in order to have a new object reference and allow us to delete the internal flag
             // of the merged object only.
             const sourcePropertyWithoutMark = Object.assign({}, sourceProperty);
@@ -90,9 +99,13 @@ function mergeObject(target, source, options, metadata, basePath) {
             destination[key] = sourcePropertyWithoutMark;
             continue;
         }
-        destination[key] = fastMerge(targetProperty, sourceProperty, options, metadata, [...basePath, key]).result;
+        const merged = fastMerge(targetProperty, sourceProperty, options, metadata, [...basePath, key]).result;
+        if (merged !== targetProperty) {
+            hasChanged = true;
+        }
+        destination[key] = merged;
     }
-    return destination;
+    return hasChanged ? destination : targetObject;
 }
 /** Checks whether the given object is an object and not null/undefined. */
 function isEmptyObject(obj) {
@@ -106,30 +119,32 @@ function isMergeableObject(value) {
     const isNonNullObject = value != null ? typeof value === 'object' : false;
     return isNonNullObject && !(value instanceof RegExp) && !(value instanceof Date) && !Array.isArray(value);
 }
-/** Deep removes the nested null values from the given value. */
+/** Deep removes the nested null values from the given value. Returns the original reference if no nulls were found. */
 function removeNestedNullValues(value) {
-    if (value === null || value === undefined || typeof value !== 'object') {
+    if (value === null || value === undefined || typeof value !== 'object' || Array.isArray(value)) {
         return value;
     }
-    if (Array.isArray(value)) {
-        return [...value];
-    }
+    let hasChanged = false;
     const result = {};
     // eslint-disable-next-line no-restricted-syntax, guard-for-in
     for (const key in value) {
         const propertyValue = value[key];
         if (propertyValue === null || propertyValue === undefined) {
+            hasChanged = true;
             continue;
         }
         if (typeof propertyValue === 'object' && !Array.isArray(propertyValue)) {
-            const valueWithoutNestedNulls = removeNestedNullValues(propertyValue);
-            result[key] = valueWithoutNestedNulls;
+            const cleaned = removeNestedNullValues(propertyValue);
+            if (cleaned !== propertyValue) {
+                hasChanged = true;
+            }
+            result[key] = cleaned;
         }
         else {
             result[key] = propertyValue;
         }
     }
-    return result;
+    return hasChanged ? result : value;
 }
 /** Formats the action name by uppercasing and adding the key if provided. */
 function formatActionName(method, key) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "3.0.56",
+  "version": "3.0.58",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",